userlens-analytics-sdk 1.2.2 → 1.2.3
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/package.json +11 -1
- package/dist/types/EventCollector/index.d.ts +0 -22
- package/dist/types/SessionRecorder/index.d.ts +0 -13
- package/dist/types/api/index.d.ts +0 -8
- package/dist/types/react/index.d.ts +0 -13
- package/dist/types/types/index.d.ts +0 -93
- package/dist/types/utils.d.ts +0 -4
- package/dist/userlens.cjs.js +0 -9
- package/dist/userlens.cjs.js.map +0 -1
- package/dist/userlens.esm.js +0 -9
- package/dist/userlens.esm.js.map +0 -1
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "userlens-analytics-sdk",
|
|
3
|
-
"version": "1.2.
|
|
3
|
+
"version": "1.2.3",
|
|
4
4
|
"main": "./dist/main.cjs.js",
|
|
5
5
|
"module": "./dist/main.esm.js",
|
|
6
6
|
"types": "./dist/types/index.d.ts",
|
|
@@ -8,6 +8,10 @@
|
|
|
8
8
|
"test": "echo \"Error: no test specified\" && exit 1",
|
|
9
9
|
"build": "rollup -c rollup.config.mjs"
|
|
10
10
|
},
|
|
11
|
+
"repository": {
|
|
12
|
+
"type": "git",
|
|
13
|
+
"url": "https://github.com/wudpecker/userlens-analytics-sdk"
|
|
14
|
+
},
|
|
11
15
|
"author": "Wudpecker",
|
|
12
16
|
"license": "ISC",
|
|
13
17
|
"description": "",
|
|
@@ -31,6 +35,8 @@
|
|
|
31
35
|
],
|
|
32
36
|
"sideEffects": false,
|
|
33
37
|
"devDependencies": {
|
|
38
|
+
"@changesets/changelog-github": "^0.5.2",
|
|
39
|
+
"@changesets/cli": "^2.29.8",
|
|
34
40
|
"@rollup/plugin-commonjs": "^28.0.3",
|
|
35
41
|
"@rollup/plugin-node-resolve": "^16.0.0",
|
|
36
42
|
"@rollup/plugin-terser": "^0.4.4",
|
|
@@ -55,5 +61,9 @@
|
|
|
55
61
|
"chrome-dompath": "^2.0.1",
|
|
56
62
|
"rollup-plugin-peer-deps-external": "^2.2.4",
|
|
57
63
|
"tslib": "^2.8.1"
|
|
64
|
+
},
|
|
65
|
+
"publishConfig": {
|
|
66
|
+
"access": "public",
|
|
67
|
+
"provenance": true
|
|
58
68
|
}
|
|
59
69
|
}
|
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
import { EventCollectorConfig } from "../types";
|
|
2
|
-
export default class EventCollector {
|
|
3
|
-
#private;
|
|
4
|
-
private userId?;
|
|
5
|
-
private userTraits?;
|
|
6
|
-
private autoUploadModeEnabled;
|
|
7
|
-
private callback?;
|
|
8
|
-
private intervalTime;
|
|
9
|
-
private events;
|
|
10
|
-
private userContext;
|
|
11
|
-
private debug;
|
|
12
|
-
constructor(config: EventCollectorConfig);
|
|
13
|
-
pushEvent(event: {
|
|
14
|
-
event: string;
|
|
15
|
-
properties?: Record<string, any>;
|
|
16
|
-
}): void;
|
|
17
|
-
identify(userId: string, userTraits: Record<string, any>): void;
|
|
18
|
-
updateUserTraits(newUserTraits: Record<string, any>): void;
|
|
19
|
-
stop(): void;
|
|
20
|
-
private getUserContext;
|
|
21
|
-
private getPageMetadata;
|
|
22
|
-
}
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
import { SessionRecorderConfig } from "../types";
|
|
2
|
-
export default class SessionRecorder {
|
|
3
|
-
#private;
|
|
4
|
-
private userId;
|
|
5
|
-
private TIMEOUT;
|
|
6
|
-
private BUFFER_SIZE;
|
|
7
|
-
private maskingOptions;
|
|
8
|
-
private sessionUuid;
|
|
9
|
-
private sessionEvents;
|
|
10
|
-
private rrwebStop;
|
|
11
|
-
constructor({ WRITE_CODE, userId, recordingOptions, }: SessionRecorderConfig);
|
|
12
|
-
stop(): void;
|
|
13
|
-
}
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
import type { eventWithTime } from "rrweb";
|
|
2
|
-
import { PushedEvent, PageViewEvent, RawEvent } from "../types";
|
|
3
|
-
export declare const identify: (user: {
|
|
4
|
-
userId: string;
|
|
5
|
-
traits: Record<string, any>;
|
|
6
|
-
}) => Promise<"ok" | undefined>;
|
|
7
|
-
export declare const track: (events: (PushedEvent | PageViewEvent | RawEvent)[]) => Promise<string>;
|
|
8
|
-
export declare const uploadSessionEvents: (userId: string, sessionUuid: string, events: eventWithTime[], chunkTimestamp: number) => Promise<string>;
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
import EventCollector from "../EventCollector";
|
|
2
|
-
import SessionRecorder from "../SessionRecorder";
|
|
3
|
-
import { UserlensProviderConfig } from "../types";
|
|
4
|
-
type UserlensContextType = {
|
|
5
|
-
collector: EventCollector | null;
|
|
6
|
-
sessionRecorder: SessionRecorder | null;
|
|
7
|
-
};
|
|
8
|
-
declare const UserlensProvider: React.FC<{
|
|
9
|
-
children: React.ReactNode;
|
|
10
|
-
config?: UserlensProviderConfig;
|
|
11
|
-
}>;
|
|
12
|
-
export declare const useUserlens: () => UserlensContextType;
|
|
13
|
-
export default UserlensProvider;
|
|
@@ -1,93 +0,0 @@
|
|
|
1
|
-
export type AutoUploadConfig = {
|
|
2
|
-
userId: string;
|
|
3
|
-
WRITE_CODE: string;
|
|
4
|
-
userTraits?: Record<string, any>;
|
|
5
|
-
callback?: undefined;
|
|
6
|
-
intervalTime?: number;
|
|
7
|
-
};
|
|
8
|
-
export type CallbackModeConfig = {
|
|
9
|
-
callback: (events: (PushedEvent | PageViewEvent | RawEvent)[]) => void;
|
|
10
|
-
userId?: undefined;
|
|
11
|
-
WRITE_CODE?: undefined;
|
|
12
|
-
intervalTime?: number;
|
|
13
|
-
};
|
|
14
|
-
export type EventCollectorConfig = AutoUploadConfig | CallbackModeConfig;
|
|
15
|
-
export interface UserContext {
|
|
16
|
-
$ul_browser: string;
|
|
17
|
-
$ul_browser_version: string;
|
|
18
|
-
$ul_os: string;
|
|
19
|
-
$ul_os_version: string;
|
|
20
|
-
$ul_browser_language: string;
|
|
21
|
-
$ul_browser_language_prefix: string;
|
|
22
|
-
$ul_screen_width: number;
|
|
23
|
-
$ul_screen_height: number;
|
|
24
|
-
$ul_viewport_width: number;
|
|
25
|
-
$ul_viewport_height: number;
|
|
26
|
-
$ul_lib: string;
|
|
27
|
-
$ul_lib_version: string;
|
|
28
|
-
$ul_device_type: "Mobile" | "Desktop";
|
|
29
|
-
$ul_timezone: string;
|
|
30
|
-
}
|
|
31
|
-
export type PageMetadata = {
|
|
32
|
-
$ul_page: string;
|
|
33
|
-
$ul_pathname: string;
|
|
34
|
-
$ul_host: string;
|
|
35
|
-
$ul_referrer: string;
|
|
36
|
-
$ul_referring_domain: string;
|
|
37
|
-
$ul_query: string;
|
|
38
|
-
};
|
|
39
|
-
export type SnapshotNode = {
|
|
40
|
-
tag_name: string;
|
|
41
|
-
attr_class?: string[];
|
|
42
|
-
attr_id?: string;
|
|
43
|
-
href?: string;
|
|
44
|
-
nth_child: number;
|
|
45
|
-
nth_of_type: number;
|
|
46
|
-
attributes: Record<string, string>;
|
|
47
|
-
text?: string;
|
|
48
|
-
is_target?: true;
|
|
49
|
-
leads_to_target?: true;
|
|
50
|
-
children?: SnapshotNode[];
|
|
51
|
-
};
|
|
52
|
-
export type SnapshotOptions = {
|
|
53
|
-
isTarget?: boolean;
|
|
54
|
-
includeChildren?: boolean;
|
|
55
|
-
leadsToTarget?: boolean;
|
|
56
|
-
};
|
|
57
|
-
export interface RawEvent {
|
|
58
|
-
userId?: string;
|
|
59
|
-
event: string;
|
|
60
|
-
is_raw: true;
|
|
61
|
-
snapshot: SnapshotNode[];
|
|
62
|
-
properties: UserContext;
|
|
63
|
-
}
|
|
64
|
-
export interface PushedEvent {
|
|
65
|
-
userId?: string;
|
|
66
|
-
event: string;
|
|
67
|
-
is_raw: false;
|
|
68
|
-
properties?: Record<string, any>;
|
|
69
|
-
}
|
|
70
|
-
export interface PageViewEvent {
|
|
71
|
-
userId?: string;
|
|
72
|
-
event: string;
|
|
73
|
-
properties: PageMetadata;
|
|
74
|
-
}
|
|
75
|
-
export type MaskingOption = "passwords" | "all";
|
|
76
|
-
export interface SessionRecordingOptions {
|
|
77
|
-
TIMEOUT?: number;
|
|
78
|
-
BUFFER_SIZE?: number;
|
|
79
|
-
maskingOptions?: MaskingOption[];
|
|
80
|
-
}
|
|
81
|
-
export interface SessionRecorderConfig {
|
|
82
|
-
WRITE_CODE: string;
|
|
83
|
-
userId: string;
|
|
84
|
-
recordingOptions?: SessionRecordingOptions;
|
|
85
|
-
}
|
|
86
|
-
export type UserlensProviderConfig = {
|
|
87
|
-
WRITE_CODE: string;
|
|
88
|
-
userId: string;
|
|
89
|
-
userTraits: Record<string, any>;
|
|
90
|
-
eventCollector: EventCollectorConfig;
|
|
91
|
-
enableSessionReplay?: boolean;
|
|
92
|
-
sessionRecorder?: SessionRecordingOptions;
|
|
93
|
-
};
|
package/dist/types/utils.d.ts
DELETED