obi-sdk 0.19.35 → 0.19.36
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 +11 -0
- package/dist/index.js +15 -15
- package/dist/obi-sdk.standalone.iife.js +15 -15
- package/dist/src/engagement.d.ts +16 -0
- package/dist/src/engagement.test.d.ts +1 -0
- package/dist/src/sdk.d.ts +40 -0
- package/dist/src/sdk.engagement.prompts.test.d.ts +1 -0
- package/dist/src/sdk.engagement.test.d.ts +1 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -78,6 +78,17 @@ Key features of session persistence:
|
|
|
78
78
|
|
|
79
79
|
No additional configuration is required to enable this feature.
|
|
80
80
|
|
|
81
|
+
## Engagement Sessions
|
|
82
|
+
|
|
83
|
+
The SDK also tracks lightweight engagement sessions per product + onboardee for analytics. A new engagement session starts after 30 minutes of inactivity and is stored in `localStorage`. You can subscribe to the `engagementSessionStarted` event and read current values via `getEngagementInfo()` on the SDK instance (available as `window.obi` when using the loader).
|
|
84
|
+
|
|
85
|
+
- Event: `engagementSessionStarted` with `{ sessionCount, lastSessionStartAt, lastActivityAt, scopeKey }`.
|
|
86
|
+
- Accessor: `sdk.getEngagementInfo()` returns the latest stored info for the current scope.
|
|
87
|
+
- Blacklist: URLs matching the product blacklist do not count toward engagement sessions.
|
|
88
|
+
- Cross-tab: Duplicate suppression, if enabled, is best-effort within a small window.
|
|
89
|
+
|
|
90
|
+
See architecture details and examples in STRUCTURE.md under “Engagement Sessions”: `STRUCTURE.md#engagement-sessions`.
|
|
91
|
+
|
|
81
92
|
## License
|
|
82
93
|
|
|
83
94
|
SEE LICENSE IN LICENSE.txt
|