userlens-analytics-sdk 0.1.46 → 0.1.49
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 +18 -6
- package/dist/types/index.d.ts +0 -1
- package/dist/types/react.d.ts +1 -0
- package/dist/userlens.cjs.js +3 -3
- package/dist/userlens.cjs.js.map +1 -1
- package/dist/userlens.esm.js +3 -3
- package/dist/userlens.esm.js.map +1 -1
- package/dist/userlens.umd.js +3 -3
- package/dist/userlens.umd.js.map +1 -1
- package/package.json +5 -1
- package/rollup.config.js +1 -0
- package/src/index.ts +0 -1
- package/src/react.ts +1 -0
- package/src/utils.ts +1 -1
package/README.md
CHANGED
|
@@ -1,11 +1,27 @@
|
|
|
1
|
-
# 📊 userlens
|
|
1
|
+
# 📊 userlens-analytics-sdk
|
|
2
2
|
|
|
3
3
|
Powerful and lightweight event tracking + session replay SDK for web apps. Works standalone or with React. Built for modern frontend teams.
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
## 📚 Table of Contents
|
|
8
|
-
|
|
8
|
+
- [📘 Introduction](#-introduction)
|
|
9
|
+
- [📦 Installation](#installation)
|
|
10
|
+
- [⚡ Quickstart](#quickstart)
|
|
11
|
+
- [🧠 SDK Overview](#-sdk-overview)
|
|
12
|
+
- [✍️ EventCollector — Two Modes](#️-eventcollector--two-modes)
|
|
13
|
+
- [1. Manual Upload Mode (RECOMMENDED)](#1-manual-upload-mode-recommended)
|
|
14
|
+
- [2. Auto-Upload Mode](#2-auto-upload-mode)
|
|
15
|
+
- [🎥 SessionRecorder](#-sessionrecorder)
|
|
16
|
+
- [⚛️ React Wrapper](#react-wrapper)
|
|
17
|
+
- [✅ What It Does](#️-what-it-does)
|
|
18
|
+
- [🛠 Usage Example](#-usage-example)
|
|
19
|
+
- [🔁 Behavior Details](#-behavior-details)
|
|
20
|
+
- [📌 Tracking Custom Events](#️-tracking-custom-events)
|
|
21
|
+
- [✍️ Example](#️-example)
|
|
22
|
+
- [🧠 How it works](#-how-it-works)
|
|
23
|
+
- [🚨 Runtime Notes](#️-typeerror-cannot-read-properties-of-undefined)
|
|
24
|
+
|
|
9
25
|
## 📘 Introduction
|
|
10
26
|
|
|
11
27
|
`userlens-analytics-sdk` is a lightweight, framework-agnostic JavaScript SDK for collecting user interaction events and recording session replays directly in the browser.
|
|
@@ -23,10 +39,6 @@ npm install userlens-analytics-sdk
|
|
|
23
39
|
|
|
24
40
|
## Quickstart
|
|
25
41
|
|
|
26
|
-
You can use `userlens-analytics-sdk` in two main ways:
|
|
27
|
-
|
|
28
|
-
---
|
|
29
|
-
|
|
30
42
|
### 🧠 SDK Overview
|
|
31
43
|
|
|
32
44
|
There are **two layers** to this SDK:
|
package/dist/types/index.d.ts
CHANGED
|
@@ -1,4 +1,3 @@
|
|
|
1
1
|
export { default as SessionRecorder } from "./SessionRecorder";
|
|
2
2
|
export { default as EventCollector } from "./EventCollector";
|
|
3
|
-
export { default as UserlensProvider, useUserlens } from "./react";
|
|
4
3
|
export type { SessionRecorderConfig, SessionRecordingOptions, SnapshotNode, SnapshotOptions, RawEvent, PageViewEvent, PushedEvent, MaskingOption, } from "./types";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { default as UserlensProvider, useUserlens } from "./react/index";
|