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

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/README.md CHANGED
@@ -52,9 +52,9 @@ elb('walker destination', destinationOptimizely, {
52
52
 
53
53
  | Key | Type | Default | Description |
54
54
  | ---------------- | --------- | ------- | --------------------------------------------------------------------------------------------------------- |
55
- | `sdkKey` | `string` | | Required. Optimizely Feature Experimentation SDK key (Settings > Environments). |
56
- | `userId` | `Mapping` | | walkerOS mapping value resolving to the userId used for bucketing (e.g. `"user.id"`). Required per event. |
57
- | `attributes` | `Mapping` | | Destination-level user attributes for audience targeting. Applied via `createUserContext()`. |
55
+ | `sdkKey` | `string` | - | Required. Optimizely Feature Experimentation SDK key (Settings > Environments). |
56
+ | `userId` | `Mapping` | - | walkerOS mapping value resolving to the userId used for bucketing (e.g. `"user.id"`). Required per event. |
57
+ | `attributes` | `Mapping` | - | Destination-level user attributes for audience targeting. Applied via `createUserContext()`. |
58
58
  | `updateInterval` | `number` | `60000` | Datafile polling interval (ms). |
59
59
  | `autoUpdate` | `boolean` | `true` | Poll for datafile updates. |
60
60
  | `batchSize` | `number` | `10` | Events per batch (batch event processor). |
@@ -73,13 +73,13 @@ Per-rule overrides under `mapping.<entity>.<action>.settings`:
73
73
  | `eventTags` | `Mapping` | Extra tags. Spread into the `eventTags` object. |
74
74
  | `attributes` | `Mapping` | Per-event user attributes. Applied via `setAttribute()` before the `trackEvent()` call. |
75
75
 
76
- Use `rule.name` to rename the event key and `rule.skip = true` to fire
76
+ Use `rule.name` to rename the event key and `rule.silent = true` to fire
77
77
  attributes without a `trackEvent()` call.
78
78
 
79
79
  ## Revenue
80
80
 
81
81
  Optimizely expects revenue as an **integer in cents** (e.g. `7281` = `$72.81`).
82
- The destination passes the resolved value through without conversion you must
82
+ The destination passes the resolved value through without conversion - you must
83
83
  provide cents.
84
84
 
85
85
  ```json
@@ -100,9 +100,9 @@ provide cents.
100
100
 
101
101
  Two layers:
102
102
 
103
- 1. **`config.consent`** walkerOS gates delivery. Events are queued until
103
+ 1. **`config.consent`** - walkerOS gates delivery. Events are queued until
104
104
  required consent keys resolve to `true`.
105
- 2. **`on('consent')`** the destination closes the Optimizely client (flushing
105
+ 2. **`on('consent')`** - the destination closes the Optimizely client (flushing
106
106
  queued events and stopping polling) when any required key flips to `false`.
107
107
  On re-grant, the next push re-initializes the client.
108
108
 
@@ -112,7 +112,7 @@ Two layers:
112
112
 
113
113
  ## Decide / Feature Flags
114
114
 
115
- This destination intentionally does **not** expose `decide()` experiment
115
+ This destination intentionally does **not** expose `decide()` - experiment
116
116
  decisions belong in application code where UI branching happens. This package
117
117
  covers the outbound conversion-tracking use case.
118
118
 
package/dist/dev.d.mts CHANGED
@@ -158,7 +158,7 @@ declare const wildcardIgnored: OptimizelyStepExample;
158
158
  * Skip track with attributes only -- fires setAttribute calls but no
159
159
  * trackEvent. Useful for enriching user context without a conversion.
160
160
  */
161
- declare const attributesOnlySkipTrack: OptimizelyStepExample;
161
+ declare const attributesOnlySilent: OptimizelyStepExample;
162
162
  /**
163
163
  * Consent revoked -- the destination closes the Optimizely client,
164
164
  * flushing queued events and stopping datafile polling.
@@ -172,7 +172,7 @@ declare const consentRevoked: OptimizelyStepExample;
172
172
  declare const consentGranted: OptimizelyStepExample;
173
173
 
174
174
  type step_OptimizelyStepExample = OptimizelyStepExample;
175
- declare const step_attributesOnlySkipTrack: typeof attributesOnlySkipTrack;
175
+ declare const step_attributesOnlySilent: typeof attributesOnlySilent;
176
176
  declare const step_consentGranted: typeof consentGranted;
177
177
  declare const step_consentRevoked: typeof consentRevoked;
178
178
  declare const step_defaultEventForwarding: typeof defaultEventForwarding;
@@ -181,7 +181,7 @@ declare const step_orderCompleteRevenue: typeof orderCompleteRevenue;
181
181
  declare const step_signupWithAttributes: typeof signupWithAttributes;
182
182
  declare const step_wildcardIgnored: typeof wildcardIgnored;
183
183
  declare namespace step {
184
- export { type step_OptimizelyStepExample as OptimizelyStepExample, step_attributesOnlySkipTrack as attributesOnlySkipTrack, step_consentGranted as consentGranted, step_consentRevoked as consentRevoked, step_defaultEventForwarding as defaultEventForwarding, step_mappedEventName as mappedEventName, step_orderCompleteRevenue as orderCompleteRevenue, step_signupWithAttributes as signupWithAttributes, step_wildcardIgnored as wildcardIgnored };
184
+ export { type step_OptimizelyStepExample as OptimizelyStepExample, step_attributesOnlySilent as attributesOnlySilent, step_consentGranted as consentGranted, step_consentRevoked as consentRevoked, step_defaultEventForwarding as defaultEventForwarding, step_mappedEventName as mappedEventName, step_orderCompleteRevenue as orderCompleteRevenue, step_signupWithAttributes as signupWithAttributes, step_wildcardIgnored as wildcardIgnored };
185
185
  }
186
186
 
187
187
  declare const index_env: typeof env;
package/dist/dev.d.ts CHANGED
@@ -158,7 +158,7 @@ declare const wildcardIgnored: OptimizelyStepExample;
158
158
  * Skip track with attributes only -- fires setAttribute calls but no
159
159
  * trackEvent. Useful for enriching user context without a conversion.
160
160
  */
161
- declare const attributesOnlySkipTrack: OptimizelyStepExample;
161
+ declare const attributesOnlySilent: OptimizelyStepExample;
162
162
  /**
163
163
  * Consent revoked -- the destination closes the Optimizely client,
164
164
  * flushing queued events and stopping datafile polling.
@@ -172,7 +172,7 @@ declare const consentRevoked: OptimizelyStepExample;
172
172
  declare const consentGranted: OptimizelyStepExample;
173
173
 
174
174
  type step_OptimizelyStepExample = OptimizelyStepExample;
175
- declare const step_attributesOnlySkipTrack: typeof attributesOnlySkipTrack;
175
+ declare const step_attributesOnlySilent: typeof attributesOnlySilent;
176
176
  declare const step_consentGranted: typeof consentGranted;
177
177
  declare const step_consentRevoked: typeof consentRevoked;
178
178
  declare const step_defaultEventForwarding: typeof defaultEventForwarding;
@@ -181,7 +181,7 @@ declare const step_orderCompleteRevenue: typeof orderCompleteRevenue;
181
181
  declare const step_signupWithAttributes: typeof signupWithAttributes;
182
182
  declare const step_wildcardIgnored: typeof wildcardIgnored;
183
183
  declare namespace step {
184
- export { type step_OptimizelyStepExample as OptimizelyStepExample, step_attributesOnlySkipTrack as attributesOnlySkipTrack, step_consentGranted as consentGranted, step_consentRevoked as consentRevoked, step_defaultEventForwarding as defaultEventForwarding, step_mappedEventName as mappedEventName, step_orderCompleteRevenue as orderCompleteRevenue, step_signupWithAttributes as signupWithAttributes, step_wildcardIgnored as wildcardIgnored };
184
+ export { type step_OptimizelyStepExample as OptimizelyStepExample, step_attributesOnlySilent as attributesOnlySilent, step_consentGranted as consentGranted, step_consentRevoked as consentRevoked, step_defaultEventForwarding as defaultEventForwarding, step_mappedEventName as mappedEventName, step_orderCompleteRevenue as orderCompleteRevenue, step_signupWithAttributes as signupWithAttributes, step_wildcardIgnored as wildcardIgnored };
185
185
  }
186
186
 
187
187
  declare const index_env: typeof env;