@walkeros/web-destination-amplitude 3.4.2 → 4.0.0-next-1777882869103

package/README.md

@@ -11,7 +11,7 @@
 [NPM Package](https://www.npmjs.com/package/@walkeros/web-destination-amplitude)
 • [Documentation](https://www.walkeros.io/docs/destinations/web/amplitude)
 
-This package forwards walkerOS events to [Amplitude](https://amplitude.com/) —
+This package forwards walkerOS events to [Amplitude](https://amplitude.com/) -
 product analytics with identity, revenue, groups, and optional session replay,
 experiments, and guides & surveys. Built on the official
 [`@amplitude/unified`](https://www.npmjs.com/package/@amplitude/unified) SDK
@@ -23,23 +23,23 @@ forwards them as Amplitude track, identify, revenue, group, and consent calls.
 
 ## Features
 
-- **Default event forwarding** — every walkerOS event becomes
+- **Default event forwarding** - every walkerOS event becomes
   `amplitude.track(name, event_properties)` with no additional config
-- **Custom event properties** — flatten walkerOS event sections
+- **Custom event properties** - flatten walkerOS event sections
   (`settings.include`) or map freely via the standard walkerOS `mapping.data`
   DSL
-- **Identity** — destination-level and per-event `settings.identify` with the
+- **Identity** - destination-level and per-event `settings.identify` with the
   full Amplitude operation vocabulary (`set`, `setOnce`, `add`, `append`,
   `prepend`, `preInsert`, `postInsert`, `remove`, `unset`, `clearAll`). Runtime
   state diffing skips redundant setter calls.
-- **Revenue** — `settings.revenue` supports both single-object and `loop`-based
+- **Revenue** - `settings.revenue` supports both single-object and `loop`-based
   multi-product orders. Currency defaults to `"EUR"`.
-- **Groups** — `settings.group` and `settings.groupIdentify` for B2B flows
-- **Consent** — `on('consent')` handler derives the consent keys from
+- **Groups** - `settings.group` and `settings.groupIdentify` for B2B flows
+- **Consent** - `on('consent')` handler derives the consent keys from
   `config.consent` and toggles `amplitude.setOptOut()`
 - **Optional plugins** (all npm-bundled via `@amplitude/unified`, opt-in via
   settings): Session Replay, Feature Experiments, Engagement (Guides & Surveys)
-- **Async init** — awaits `amplitude.initAll(...)` so downstream pushes are
+- **Async init** - awaits `amplitude.initAll(...)` so downstream pushes are
   truly ready before returning
 
 > **Bundle cost:** All three plugin packages are statically imported and
@@ -98,7 +98,7 @@ All fields of Amplitude's `BrowserOptions` pass through to
 | `revenue`       | `Mapping.Value`            | Resolves to a single object or (via `loop`) an array, each with `productId`, `price`, `quantity`, `revenueType`, `currency`, `revenue`, `receipt`, `receiptSig`, `eventProperties`. One `amplitude.revenue()` call fires per item. |
 | `group`         | `Mapping.Value`            | Resolves to `{ type, name }` → `amplitude.setGroup(type, name)`                                                                                                                                                                    |
 | `groupIdentify` | `Mapping.Value`            | Resolves to `{ type, name, set?, setOnce?, ... }` → `amplitude.groupIdentify(type, name, identify)`                                                                                                                                |
-| `reset`         | `boolean \| Mapping.Value` | Truthy → `amplitude.reset()` (logout). Typically paired with `skip: true`.                                                                                                                                                         |
+| `reset`         | `boolean \| Mapping.Value` | Truthy → `amplitude.reset()` (logout). Typically paired with `silent: true`.                                                                                                                                                       |
 
 ## Custom Event Properties
 
@@ -120,7 +120,7 @@ Per-rule override via `mapping.settings.include` replaces destination-level
 mapping: {
   user: {
     login: {
-      skip: true, // suppress default track()
+      silent: true, // suppress default track()
       settings: {
         identify: {
           map: {
@@ -150,7 +150,7 @@ mapping: {
 mapping: {
   subscription: {
     renew: {
-      skip: true,
+      silent: true,
       settings: {
         revenue: {
           map: {
@@ -217,7 +217,7 @@ settings: {
 mapping: {
   user: {
     logout: {
-      skip: true,
+      silent: true,
       settings: { reset: true },
     },
   },
@@ -231,7 +231,7 @@ clears its runtime identity cache so the next push re-fires the setters.
 ## Consent
 
 Declare the required consent keys on the destination config, then push a walker
-consent event — the destination's `on('consent')` handler toggles
+consent event - the destination's `on('consent')` handler toggles
 `amplitude.setOptOut()` accordingly. Semantics are strict: all required keys
 must be granted for opt-in; any missing grant opts out.
 

package/dist/dev.d.mts

@@ -173,13 +173,13 @@ type AmplitudeStepExample = Flow.StepExample & {
     configInclude?: string[];
 };
 /**
- * Default event forwarding — every walkerOS event becomes
+ * Default event forwarding - every walkerOS event becomes
  * amplitude.track(event.name, event_properties). With no mapping and
  * no destination-level include, event_properties is `{}`.
  */
 declare const defaultEventForwarding: AmplitudeStepExample;
 /**
- * Wildcard ignore — walkerOS's standard way to drop events. The rule
+ * Wildcard ignore - walkerOS's standard way to drop events. The rule
  * matches but does nothing. The destination fires zero SDK calls.
  */
 declare const wildcardIgnored: AmplitudeStepExample;
@@ -210,20 +210,20 @@ declare const ruleIncludeReplaces: AmplitudeStepExample;
  */
 declare const destinationLevelIdentify: AmplitudeStepExample;
 /**
- * Per-event identify with the full operation vocabulary — this is the
- * "user login" pattern: set user_id, enrich user properties. `skip: true`
+ * Per-event identify with the full operation vocabulary - this is the
+ * "user login" pattern: set user_id, enrich user properties. `silent: true`
  * suppresses the default amplitude.track() call because we're running
  * identity side effects only.
  */
 declare const userLoginIdentify: AmplitudeStepExample;
 /**
- * User logout — reset: true fires amplitude.reset(), which clears userId
- * and regenerates deviceId. `skip: true` because we're only running the
+ * User logout - reset: true fires amplitude.reset(), which clears userId
+ * and regenerates deviceId. `silent: true` because we're only running the
  * reset side effect, no default track().
  */
 declare const userLogoutReset: AmplitudeStepExample;
 /**
- * Single-product revenue — resolves `settings.revenue` to one object and
+ * Single-product revenue - resolves `settings.revenue` to one object and
  * fires one amplitude.revenue() call. Note the `{ key: "data.currency",
  * value: "EUR" }` fallback syntax: try data.currency, default to "EUR".
  *
@@ -231,7 +231,7 @@ declare const userLogoutReset: AmplitudeStepExample;
  */
 declare const subscriptionRenewRevenue: AmplitudeStepExample;
 /**
- * Multi-product order — the canonical Amplitude ecommerce pattern.
+ * Multi-product order - the canonical Amplitude ecommerce pattern.
  * `revenue.loop: ["nested", { map: ... }]` iterates event.nested and
  * resolves one revenue item per entry. Each becomes a separate
  * amplitude.revenue() call. The order-level track() fires once with

package/dist/dev.d.ts

@@ -173,13 +173,13 @@ type AmplitudeStepExample = Flow.StepExample & {
     configInclude?: string[];
 };
 /**
- * Default event forwarding — every walkerOS event becomes
+ * Default event forwarding - every walkerOS event becomes
  * amplitude.track(event.name, event_properties). With no mapping and
  * no destination-level include, event_properties is `{}`.
  */
 declare const defaultEventForwarding: AmplitudeStepExample;
 /**
- * Wildcard ignore — walkerOS's standard way to drop events. The rule
+ * Wildcard ignore - walkerOS's standard way to drop events. The rule
  * matches but does nothing. The destination fires zero SDK calls.
  */
 declare const wildcardIgnored: AmplitudeStepExample;
@@ -210,20 +210,20 @@ declare const ruleIncludeReplaces: AmplitudeStepExample;
  */
 declare const destinationLevelIdentify: AmplitudeStepExample;
 /**
- * Per-event identify with the full operation vocabulary — this is the
- * "user login" pattern: set user_id, enrich user properties. `skip: true`
+ * Per-event identify with the full operation vocabulary - this is the
+ * "user login" pattern: set user_id, enrich user properties. `silent: true`
  * suppresses the default amplitude.track() call because we're running
  * identity side effects only.
  */
 declare const userLoginIdentify: AmplitudeStepExample;
 /**
- * User logout — reset: true fires amplitude.reset(), which clears userId
- * and regenerates deviceId. `skip: true` because we're only running the
+ * User logout - reset: true fires amplitude.reset(), which clears userId
+ * and regenerates deviceId. `silent: true` because we're only running the
  * reset side effect, no default track().
  */
 declare const userLogoutReset: AmplitudeStepExample;
 /**
- * Single-product revenue — resolves `settings.revenue` to one object and
+ * Single-product revenue - resolves `settings.revenue` to one object and
  * fires one amplitude.revenue() call. Note the `{ key: "data.currency",
  * value: "EUR" }` fallback syntax: try data.currency, default to "EUR".
  *
@@ -231,7 +231,7 @@ declare const userLogoutReset: AmplitudeStepExample;
  */
 declare const subscriptionRenewRevenue: AmplitudeStepExample;
 /**
- * Multi-product order — the canonical Amplitude ecommerce pattern.
+ * Multi-product order - the canonical Amplitude ecommerce pattern.
  * `revenue.loop: ["nested", { map: ... }]` iterates event.nested and
  * resolves one revenue item per entry. Each becomes a separate
  * amplitude.revenue() call. The order-level track() fires once with