@heycatch/sdk 0.8.4-dev.2561 → 0.8.5-dev.2546

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -1,5 +1,5 @@
1
- import { d as HeyCatchPersonProperties, b as HeyCatchConfig, e as HeyCatchProperties, j as TrackOptions } from './shared-jAHOZrzL.cjs';
2
- 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-jAHOZrzL.cjs';
1
+ import { d as HeyCatchPersonProperties, b as HeyCatchConfig, e as HeyCatchProperties, j as TrackOptions } from './shared-nNQmChFP.cjs';
2
+ 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';
3
3
 
4
4
  /**
5
5
  * Starts capturing after `optOutCapturingByDefault` gated `init()` from
@@ -60,6 +60,15 @@ declare function setIdentity(userId: string, properties?: HeyCatchPersonProperti
60
60
  declare function resetIdentity(): void;
61
61
 
62
62
  declare function init(config: HeyCatchConfig): void;
63
+ /**
64
+ * Turns visitor IP collection off (`false`) or back on (`true`) from here on,
65
+ * for a consent banner answered after `init()` - the runtime half of
66
+ * `collectIp`. Not remembered across loads: pass the visitor's answer to
67
+ * `init()` as `collectIp` on every load too.
68
+ *
69
+ * Warns and does nothing before `init()` (see `./consent`).
70
+ */
71
+ declare function setIpCollection(collect: boolean): void;
63
72
 
64
73
  /**
65
74
  * Record a product event.
@@ -110,6 +119,7 @@ declare const analytics: {
110
119
  readonly optOutCapturing: typeof optOutCapturing;
111
120
  readonly resetIdentity: typeof resetIdentity;
112
121
  readonly setIdentity: typeof setIdentity;
122
+ readonly setIpCollection: typeof setIpCollection;
113
123
  readonly setPersonProperties: typeof setPersonProperties;
114
124
  readonly trackEvent: typeof trackEvent;
115
125
  };
package/dist/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { d as HeyCatchPersonProperties, b as HeyCatchConfig, e as HeyCatchProperties, j as TrackOptions } from './shared-jAHOZrzL.js';
2
- 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-jAHOZrzL.js';
1
+ import { d as HeyCatchPersonProperties, b as HeyCatchConfig, e as HeyCatchProperties, j as TrackOptions } from './shared-nNQmChFP.js';
2
+ 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';
3
3
 
4
4
  /**
5
5
  * Starts capturing after `optOutCapturingByDefault` gated `init()` from
@@ -60,6 +60,15 @@ declare function setIdentity(userId: string, properties?: HeyCatchPersonProperti
60
60
  declare function resetIdentity(): void;
61
61
 
62
62
  declare function init(config: HeyCatchConfig): void;
63
+ /**
64
+ * Turns visitor IP collection off (`false`) or back on (`true`) from here on,
65
+ * for a consent banner answered after `init()` - the runtime half of
66
+ * `collectIp`. Not remembered across loads: pass the visitor's answer to
67
+ * `init()` as `collectIp` on every load too.
68
+ *
69
+ * Warns and does nothing before `init()` (see `./consent`).
70
+ */
71
+ declare function setIpCollection(collect: boolean): void;
63
72
 
64
73
  /**
65
74
  * Record a product event.
@@ -110,6 +119,7 @@ declare const analytics: {
110
119
  readonly optOutCapturing: typeof optOutCapturing;
111
120
  readonly resetIdentity: typeof resetIdentity;
112
121
  readonly setIdentity: typeof setIdentity;
122
+ readonly setIpCollection: typeof setIpCollection;
113
123
  readonly setPersonProperties: typeof setPersonProperties;
114
124
  readonly trackEvent: typeof trackEvent;
115
125
  };