hm-tracking-sdk 0.1.3 → 0.1.4
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 +37 -27
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -49,21 +49,31 @@
|
|
|
49
49
|
```
|
|
50
50
|
|
|
51
51
|
- 函数说明：初始化 SDK，先创建 HmTrackingSDK 对象，然后调用 init 方法完成初始化。
|
|
52
|
-
-
|
|
53
|
-
|
|
54
|
-
|
|
52
|
+
- 参数说明: `SDKInitOptions` 初始化SDK时的可选参数，数据结构及内部结构说明为：
|
|
53
|
+
|
|
54
|
+
```ts
|
|
55
|
+
export interface SDKInitOptions {
|
|
56
|
+
/** 自定义接口地址（可选）。不传则使用默认正式环境 */
|
|
57
|
+
baseURL?: string;
|
|
58
|
+
/** 本地存储 Key 前缀，避免冲突 */
|
|
59
|
+
storageKeyPrefix?: string;
|
|
60
|
+
/** 自定义用户信息（可选） */
|
|
61
|
+
customUser?: TelegramUserInfo;
|
|
62
|
+
}
|
|
63
|
+
```
|
|
55
64
|
|
|
56
|
-
- baseURL（可选）
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
- storageKeyPrefix（可选）
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
- customUser（可选）
|
|
63
|
-
|
|
64
|
-
|
|
65
|
+
- baseURL（可选）
|
|
66
|
+
- 说明：后端服务地址；不传则使用 SDK 内置默认地址。
|
|
67
|
+
- 类型：`string`
|
|
68
|
+
- storageKeyPrefix（可选）
|
|
69
|
+
- 说明：本地缓存命名空间前缀；用于隔离不同项目的存储键。
|
|
70
|
+
- 类型：`string`
|
|
71
|
+
- customUser（可选）
|
|
72
|
+
- 说明：自定义用户数据，仅在非 Telegram 环境可用；若不传，SDK 会自动使用“匿名浏览器用户”（基于 Cookie 生成并持久化随机 userId），从而可以直接完成鉴权与后续请求。
|
|
73
|
+
- 类型：`TelegramUserInfo`
|
|
74
|
+
- 返回值：`Promise<void>`。
|
|
65
75
|
|
|
66
|
-
### 2.
|
|
76
|
+
### 2.1 环境
|
|
67
77
|
|
|
68
78
|
- Telegram 环境
|
|
69
79
|
- SDK 自动读取当前Telegram用户的信息。
|
|
@@ -74,7 +84,7 @@
|
|
|
74
84
|
- 便于无登录状态下完成鉴权，拿到 token 后再进行广告或调试。
|
|
75
85
|
- 自定义用户：也可传入 `customUser` 替代匿名用户。
|
|
76
86
|
|
|
77
|
-
### 2.
|
|
87
|
+
### 2.2 环境判断
|
|
78
88
|
|
|
79
89
|
- 接口: isTelegramEnv()
|
|
80
90
|
|
|
@@ -106,19 +116,19 @@
|
|
|
106
116
|
- 函数说明：在 Telegram 环境下返回 `TelegramUserInfo`；获取失败返回 `null`。
|
|
107
117
|
- 返回值：`TelegramUserInfo | null`，数据结构为：
|
|
108
118
|
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
119
|
+
```ts
|
|
120
|
+
export interface TelegramUserInfo {
|
|
121
|
+
id?: number;
|
|
122
|
+
first_name?: string;
|
|
123
|
+
last_name?: string;
|
|
124
|
+
username?: string;
|
|
125
|
+
language_code?: string;
|
|
126
|
+
allows_write_to_pm?: boolean;
|
|
127
|
+
auth_date?: number;
|
|
128
|
+
hash?: string;
|
|
129
|
+
[key: string]: unknown;
|
|
130
|
+
}
|
|
131
|
+
```
|
|
122
132
|
|
|
123
133
|
- 环境要求：仅 Telegram WebApp 可用；在浏览器环境（非 Telegram）将返回 `null`。
|
|
124
134
|
|