@heycatch/sdk 0.8.3 → 0.8.5-dev.2545

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.
@@ -260,6 +260,15 @@ interface HeyCatchConfig {
260
260
  optOutCapturingByDefault?: boolean;
261
261
  /** Honor the browser's Do Not Track signal. */
262
262
  respectDnt?: boolean;
263
+ /**
264
+ * Set `false` to stop collecting the visitor's IP address: no event
265
+ * stores it and no country or city is derived from it. Decided per
266
+ * visitor, so it can follow your consent state - pass the visitor's
267
+ * answer here, or flip it later with `analytics.setIpCollection()`.
268
+ * Defaults to collecting. Costs the country column and every geo
269
+ * breakdown for those events. Browser and React Native.
270
+ */
271
+ collectIp?: boolean;
263
272
  /**
264
273
  * Batch captured events for a few seconds before sending (the default).
265
274
  * Set `false` on a multi-page site - one where each click is a full page
@@ -277,6 +286,12 @@ interface HeyCatchConfig {
277
286
  * window. Browser only.
278
287
  */
279
288
  flushIntervalMs?: number;
289
+ /**
290
+ * Set to `'landing'` when this project is your marketing site / landing
291
+ * page / waitlist, so its visits read apart from your app's. Leave it out
292
+ * when your site and app are one project. Browser only.
293
+ */
294
+ site?: 'landing';
280
295
  }
281
296
 
282
297
  export { type HeyCatchBeforeSend as H, KNOWN_FRAMEWORKS as K, type PersonPropertyUpdate as P, SDK_VERSION as S, TRACING_HEADERS as T, UNKNOWN_INSTALL_VALUE as U, type HeyCatchCapturedEvent as a, type HeyCatchConfig as b, type HeyCatchPersistence as c, type HeyCatchPersonProperties as d, type HeyCatchProperties as e, type HeyCatchSanitizeProperties as f, KNOWN_INSTALL_AGENTS as g, STAGE as h, type ServerTrackOptions as i, type TrackOptions as j };
@@ -260,6 +260,15 @@ interface HeyCatchConfig {
260
260
  optOutCapturingByDefault?: boolean;
261
261
  /** Honor the browser's Do Not Track signal. */
262
262
  respectDnt?: boolean;
263
+ /**
264
+ * Set `false` to stop collecting the visitor's IP address: no event
265
+ * stores it and no country or city is derived from it. Decided per
266
+ * visitor, so it can follow your consent state - pass the visitor's
267
+ * answer here, or flip it later with `analytics.setIpCollection()`.
268
+ * Defaults to collecting. Costs the country column and every geo
269
+ * breakdown for those events. Browser and React Native.
270
+ */
271
+ collectIp?: boolean;
263
272
  /**
264
273
  * Batch captured events for a few seconds before sending (the default).
265
274
  * Set `false` on a multi-page site - one where each click is a full page
@@ -277,6 +286,12 @@ interface HeyCatchConfig {
277
286
  * window. Browser only.
278
287
  */
279
288
  flushIntervalMs?: number;
289
+ /**
290
+ * Set to `'landing'` when this project is your marketing site / landing
291
+ * page / waitlist, so its visits read apart from your app's. Leave it out
292
+ * when your site and app are one project. Browser only.
293
+ */
294
+ site?: 'landing';
280
295
  }
281
296
 
282
297
  export { type HeyCatchBeforeSend as H, KNOWN_FRAMEWORKS as K, type PersonPropertyUpdate as P, SDK_VERSION as S, TRACING_HEADERS as T, UNKNOWN_INSTALL_VALUE as U, type HeyCatchCapturedEvent as a, type HeyCatchConfig as b, type HeyCatchPersistence as c, type HeyCatchPersonProperties as d, type HeyCatchProperties as e, type HeyCatchSanitizeProperties as f, KNOWN_INSTALL_AGENTS as g, STAGE as h, type ServerTrackOptions as i, type TrackOptions as j };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@heycatch/sdk",
3
- "version": "0.8.3",
3
+ "version": "0.8.5-dev.2545",
4
4
  "description": "HeyCatch SDK",
5
5
  "keywords": [
6
6
  "analytics",