@walkeros/web-destination-heap 3.4.2 → 4.0.0-next-1777463920154

package/README.md

@@ -11,7 +11,7 @@
 [NPM Package](https://www.npmjs.com/package/@walkeros/web-destination-heap)
 • [Documentation](https://www.walkeros.io/docs/destinations/web/heap)
 
-This package forwards walkerOS events to [Heap](https://www.heap.io/) — product
+This package forwards walkerOS events to [Heap](https://www.heap.io/) - product
 analytics with auto-capture, heatmaps, and session replay. Loads the official
 Heap snippet from Heap's CDN and forwards events through `window.heap.track()`.
 
@@ -21,16 +21,16 @@ them as `heap.track()` calls plus identity and persistent property updates.
 
 ## Features
 
-- **Default event forwarding** — every walkerOS event becomes
+- **Default event forwarding** - every walkerOS event becomes
   `heap.track(name, properties)`
-- **Identity** — `heap.identify(id)` and `heap.resetIdentity()` for login/logout
-- **User properties** — `heap.addUserProperties({...})` at destination or rule
+- **Identity** - `heap.identify(id)` and `heap.resetIdentity()` for login/logout
+- **User properties** - `heap.addUserProperties({...})` at destination or rule
   level
-- **Persistent event properties** — `heap.addEventProperties({...})` and
+- **Persistent event properties** - `heap.addEventProperties({...})` and
   `heap.clearEventProperties()` via rule settings
-- **Consent** — `heap.startTracking()` / `heap.stopTracking()` wired to walkerOS
+- **Consent** - `heap.startTracking()` / `heap.stopTracking()` wired to walkerOS
   `config.consent`
-- **Snippet injection** — loads `heap-<appId>.js` from Heap's CDN with
+- **Snippet injection** - loads `heap-<appId>.js` from Heap's CDN with
   `disablePageviewAutocapture: true` and `disableTextCapture: true` defaults so
   walkerOS sources own event capture
 
@@ -73,39 +73,39 @@ await startFlow({
 | `disableSessionReplay`       | `boolean`       | Disable Heap session replay.                                                                     | No       |
 | `secureCookie`               | `boolean`       | SSL-only cookies.                                                                                | No       |
 | `ingestServer`               | `string`        | Custom server endpoint (first-party proxy).                                                      | No       |
-| `identify`                   | `Mapping.Value` | Destination-level identity mapping — resolves to a string for `heap.identify()`                  | No       |
-| `userProperties`             | `Mapping.Value` | Destination-level user properties mapping — resolves to an object for `heap.addUserProperties()` | No       |
+| `identify`                   | `Mapping.Value` | Destination-level identity mapping - resolves to a string for `heap.identify()`                  | No       |
+| `userProperties`             | `Mapping.Value` | Destination-level user properties mapping - resolves to an object for `heap.addUserProperties()` | No       |
 | `heapConfig`                 | `HeapConfig`    | Passthrough for additional `heap.load()` options                                                 | No       |
 
 ### Mapping (`rule.settings`)
 
 | Name                   | Type                       | Description                                                                      |
 | ---------------------- | -------------------------- | -------------------------------------------------------------------------------- |
-| `identify`             | `Mapping.Value`            | Per-event identity — resolves to a string for `heap.identify()`                  |
+| `identify`             | `Mapping.Value`            | Per-event identity - resolves to a string for `heap.identify()`                  |
 | `reset`                | `boolean \| Mapping.Value` | Truthy triggers `heap.resetIdentity()` (e.g. on logout)                          |
-| `userProperties`       | `Mapping.Value`            | Per-event user properties — resolves to object for `heap.addUserProperties()`    |
-| `eventProperties`      | `Mapping.Value`            | Persistent event properties — resolves to object for `heap.addEventProperties()` |
+| `userProperties`       | `Mapping.Value`            | Per-event user properties - resolves to object for `heap.addUserProperties()`    |
+| `eventProperties`      | `Mapping.Value`            | Persistent event properties - resolves to object for `heap.addEventProperties()` |
 | `clearEventProperties` | `boolean \| Mapping.Value` | Truthy triggers `heap.clearEventProperties()`                                    |
 
 Standard mapping features also apply:
 
-- `name` — rename the forwarded event (`heap.track(<new name>, ...)`)
-- `skip` — suppress the default `heap.track(...)` call while still running
+- `name` - rename the forwarded event (`heap.track(<new name>, ...)`)
+- `silent` - suppress the default `heap.track(...)` call while still running
   `identify` / `userProperties` / `reset` / `eventProperties`
-- `ignore` — drop the event entirely
-- `data` — resolve event properties forwarded as the second argument to
+- `ignore` - drop the event entirely
+- `data` - resolve event properties forwarded as the second argument to
   `heap.track(...)`
 
 ## Identity
 
-Heap identity is sticky — call `heap.identify(id)` on login and
+Heap identity is sticky - call `heap.identify(id)` on login and
 `heap.resetIdentity()` on logout. A typical mapping:
 
 ```typescript
 mapping: {
   user: {
     login: {
-      skip: true,
+      silent: true,
       settings: {
         identify: 'data.email',
         userProperties: {
@@ -114,7 +114,7 @@ mapping: {
       },
     },
     logout: {
-      skip: true,
+      silent: true,
       settings: { reset: true },
     },
   },

package/dist/dev.d.mts

@@ -140,7 +140,7 @@ type HeapStepExample = Flow.StepExample & {
     settings?: Partial<Settings>;
 };
 /**
- * Default event forwarding — every walkerOS event becomes
+ * Default event forwarding - every walkerOS event becomes
  * heap.track(event.name, properties). With no mapping, properties is `{}`.
  */
 declare const defaultEventForwarding: HeapStepExample;
@@ -150,36 +150,36 @@ declare const defaultEventForwarding: HeapStepExample;
  */
 declare const destinationLevelInclude: HeapStepExample;
 /**
- * Destination-level settings.identify — heap.identify() resolves user.id,
+ * Destination-level settings.identify - heap.identify() resolves user.id,
  * then the default heap.track() call fires.
  */
 declare const destinationLevelIdentify: HeapStepExample;
 /**
- * Per-event login identify — heap.identify() from data.email + user
- * properties from the same rule. skip: true suppresses the track() call.
+ * Per-event login identify - heap.identify() from data.email + user
+ * properties from the same rule. silent: true suppresses the track() call.
  */
 declare const userLoginIdentify: HeapStepExample;
 /**
- * User logout — heap.resetIdentity(). skip: true suppresses the track() call.
+ * User logout - heap.resetIdentity(). silent: true suppresses the track() call.
  */
 declare const userLogoutReset: HeapStepExample;
 /**
- * Event with user properties from mapping — heap.addUserProperties() fires,
+ * Event with user properties from mapping - heap.addUserProperties() fires,
  * then the default heap.track() call.
  */
 declare const eventWithUserProperties: HeapStepExample;
 /**
- * Global event properties — heap.addEventProperties() sets persistent
- * properties on all subsequent events. skip: true on this rule.
+ * Global event properties - heap.addEventProperties() sets persistent
+ * properties on all subsequent events. silent: true on this rule.
  */
 declare const globalEventProperties: HeapStepExample;
 /**
- * Consent revoked — on('consent') handler calls heap.stopTracking()
+ * Consent revoked - on('consent') handler calls heap.stopTracking()
  * when a required consent key is false.
  */
 declare const consentRevokeStopTracking: HeapStepExample;
 /**
- * Consent granted — on('consent') handler calls heap.startTracking()
+ * Consent granted - on('consent') handler calls heap.startTracking()
  * when all required consent keys are true.
  */
 declare const consentGrantStartTracking: HeapStepExample;

package/dist/dev.d.ts

@@ -140,7 +140,7 @@ type HeapStepExample = Flow.StepExample & {
     settings?: Partial<Settings>;
 };
 /**
- * Default event forwarding — every walkerOS event becomes
+ * Default event forwarding - every walkerOS event becomes
  * heap.track(event.name, properties). With no mapping, properties is `{}`.
  */
 declare const defaultEventForwarding: HeapStepExample;
@@ -150,36 +150,36 @@ declare const defaultEventForwarding: HeapStepExample;
  */
 declare const destinationLevelInclude: HeapStepExample;
 /**
- * Destination-level settings.identify — heap.identify() resolves user.id,
+ * Destination-level settings.identify - heap.identify() resolves user.id,
  * then the default heap.track() call fires.
  */
 declare const destinationLevelIdentify: HeapStepExample;
 /**
- * Per-event login identify — heap.identify() from data.email + user
- * properties from the same rule. skip: true suppresses the track() call.
+ * Per-event login identify - heap.identify() from data.email + user
+ * properties from the same rule. silent: true suppresses the track() call.
  */
 declare const userLoginIdentify: HeapStepExample;
 /**
- * User logout — heap.resetIdentity(). skip: true suppresses the track() call.
+ * User logout - heap.resetIdentity(). silent: true suppresses the track() call.
  */
 declare const userLogoutReset: HeapStepExample;
 /**
- * Event with user properties from mapping — heap.addUserProperties() fires,
+ * Event with user properties from mapping - heap.addUserProperties() fires,
  * then the default heap.track() call.
  */
 declare const eventWithUserProperties: HeapStepExample;
 /**
- * Global event properties — heap.addEventProperties() sets persistent
- * properties on all subsequent events. skip: true on this rule.
+ * Global event properties - heap.addEventProperties() sets persistent
+ * properties on all subsequent events. silent: true on this rule.
  */
 declare const globalEventProperties: HeapStepExample;
 /**
- * Consent revoked — on('consent') handler calls heap.stopTracking()
+ * Consent revoked - on('consent') handler calls heap.stopTracking()
  * when a required consent key is false.
  */
 declare const consentRevokeStopTracking: HeapStepExample;
 /**
- * Consent granted — on('consent') handler calls heap.startTracking()
+ * Consent granted - on('consent') handler calls heap.startTracking()
  * when all required consent keys are true.
  */
 declare const consentGrantStartTracking: HeapStepExample;