@docoi/mys-sdk 1.0.0-beta.0 → 1.0.1
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/dist/api/basic.d.ts +301 -47
- package/dist/api/biz.d.ts +76 -15
- package/dist/api/index.d.ts +2 -2
- package/dist/bridge.d.ts +8 -13
- package/dist/constants/code.d.ts +21 -0
- package/dist/index.d.ts +38 -40
- package/dist/index.mjs +388 -48
- package/dist/types/base.d.ts +54 -0
- package/dist/types/enums.d.ts +42 -0
- package/dist/types/index.d.ts +8 -138
- package/dist/types/params.d.ts +228 -0
- package/dist/types/results.d.ts +144 -0
- package/package.json +14 -48
- package/README.md +0 -110
- package/dist/basic-C58euoyc.js +0 -153
- package/dist/basic-C58euoyc.js.map +0 -1
- package/dist/basic-CSwC4kuv.cjs +0 -2
- package/dist/basic-CSwC4kuv.cjs.map +0 -1
- package/dist/basic.d.ts +0 -32
- package/dist/basic.js +0 -2
- package/dist/basic.js.map +0 -1
- package/dist/basic.mjs +0 -37
- package/dist/basic.mjs.map +0 -1
- package/dist/biz-BUeFEJQb.cjs +0 -2
- package/dist/biz-BUeFEJQb.cjs.map +0 -1
- package/dist/biz-BbTdssY5.js +0 -43
- package/dist/biz-BbTdssY5.js.map +0 -1
- package/dist/biz.d.ts +0 -16
- package/dist/biz.js +0 -2
- package/dist/biz.js.map +0 -1
- package/dist/biz.mjs +0 -21
- package/dist/biz.mjs.map +0 -1
- package/dist/bridge-B5p50L4Z.cjs +0 -2
- package/dist/bridge-B5p50L4Z.cjs.map +0 -1
- package/dist/bridge-BsyNF-2c.js +0 -39
- package/dist/bridge-BsyNF-2c.js.map +0 -1
- package/dist/index.js +0 -2
- package/dist/index.js.map +0 -1
- package/dist/index.mjs.map +0 -1
package/dist/api/basic.d.ts
CHANGED
|
@@ -1,47 +1,301 @@
|
|
|
1
|
-
import
|
|
2
|
-
/**
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
export declare function
|
|
14
|
-
/**
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
export declare function
|
|
36
|
-
/**
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
export declare function
|
|
46
|
-
/**
|
|
47
|
-
|
|
1
|
+
import { ShowToastParams, PlayMediaParams, ChooseMediaParams, ChooseMediaResult, UploadFilesParams, UploadFilesResult, SaveImageToPhotosAlbumParams, SaveVideoToPhotosAlbumParams, StartRecordParams, SetClipboardDataParams, GetClipboardDataResult, OpenInExternalBrowserParams, TriggerVibrateParams, Callbacks, NativeResponse, SystemInfoResult, NetworkTypeResult, OpenPhoneSettingParams, CheckPermissionParams, CheckPermissionResult, KeyboardHeightChangeCallback, CommentPanelChangeCallback, EventListenOptions } from '../types';
|
|
2
|
+
/**
|
|
3
|
+
* 显示消息提示框。
|
|
4
|
+
*
|
|
5
|
+
* @note
|
|
6
|
+
* text 不能为空。
|
|
7
|
+
* duration 默认 ToastDuration.Short,0 表示短时显示,1 表示长时显示。
|
|
8
|
+
*
|
|
9
|
+
* @app 3.0.0
|
|
10
|
+
* @example
|
|
11
|
+
* await mys.showToast({ text: '操作成功' })
|
|
12
|
+
*/
|
|
13
|
+
export declare function showToast(params: ShowToastParams): Promise<NativeResponse<void>>;
|
|
14
|
+
/**
|
|
15
|
+
* 触发原生震动反馈。
|
|
16
|
+
*
|
|
17
|
+
* 支持单段震动、多段变力度震动和循环震动。执行优先级为:有 steps 时走多段震动;无 steps 且有 duration 时走单段震动;两者都没有时由宿主 App 决定默认震动行为。
|
|
18
|
+
*
|
|
19
|
+
* @note
|
|
20
|
+
* iOS 如果不支持自定义力度和精确时长,intensity 和 duration 会被忽略,退化为系统默认触感节奏。
|
|
21
|
+
* repeat 为 true 时会无限循环,需调用 stopVibrate 停止。
|
|
22
|
+
*
|
|
23
|
+
* @app 4.1.0
|
|
24
|
+
* @example
|
|
25
|
+
* await mys.triggerVibrate({ duration: 30, intensity: 0.5 })
|
|
26
|
+
*
|
|
27
|
+
* await mys.triggerVibrate({
|
|
28
|
+
* steps: [
|
|
29
|
+
* { duration: 200, intensity: 1.0 },
|
|
30
|
+
* { duration: 30, intensity: 0 },
|
|
31
|
+
* { duration: 100, intensity: 0.6 },
|
|
32
|
+
* ],
|
|
33
|
+
* })
|
|
34
|
+
*/
|
|
35
|
+
export declare function triggerVibrate(params?: TriggerVibrateParams): Promise<NativeResponse<void>>;
|
|
36
|
+
/**
|
|
37
|
+
* 停止原生震动反馈。
|
|
38
|
+
*
|
|
39
|
+
* 用于停止 triggerVibrate 发起的循环震动。
|
|
40
|
+
*
|
|
41
|
+
* @app 4.1.0
|
|
42
|
+
* @example
|
|
43
|
+
* await mys.stopVibrate()
|
|
44
|
+
*/
|
|
45
|
+
export declare function stopVibrate(params?: Callbacks): Promise<NativeResponse<void>>;
|
|
46
|
+
/**
|
|
47
|
+
* 收起当前 WebView 中已弹出的系统软键盘。
|
|
48
|
+
*
|
|
49
|
+
* @note
|
|
50
|
+
* 该 API 仅用于请求隐藏键盘,不用于主动显示键盘。
|
|
51
|
+
*
|
|
52
|
+
* @app 1.2.3
|
|
53
|
+
* @example
|
|
54
|
+
* await mys.hideKeyboard()
|
|
55
|
+
*/
|
|
56
|
+
export declare function hideKeyboard(params?: Callbacks): Promise<NativeResponse<void>>;
|
|
57
|
+
/**
|
|
58
|
+
* 监听键盘高度变化。
|
|
59
|
+
*
|
|
60
|
+
* 当当前 WebView 中的系统软键盘弹出、收起或高度变化时触发。
|
|
61
|
+
*
|
|
62
|
+
* @note
|
|
63
|
+
* 回调参数 height 单位为 CSS 逻辑像素,可直接用于页面布局。
|
|
64
|
+
* 事件监听类型直接返回原始 payload,不包装 code/msg/result。
|
|
65
|
+
* options.once 为 true 时只触发一次,触发后由 jsbridge 自动取消监听。
|
|
66
|
+
*
|
|
67
|
+
* @app 3.9.0
|
|
68
|
+
* @example
|
|
69
|
+
* mys.onKeyboardHeightChange((height) => {
|
|
70
|
+
* console.log('键盘高度:', height)
|
|
71
|
+
* })
|
|
72
|
+
*
|
|
73
|
+
* mys.onKeyboardHeightChange((height) => {
|
|
74
|
+
* console.log('只监听一次键盘高度:', height)
|
|
75
|
+
* }, { once: true })
|
|
76
|
+
*
|
|
77
|
+
* mys.offKeyboardHeightChange()
|
|
78
|
+
*/
|
|
79
|
+
export declare function onKeyboardHeightChange(callback: KeyboardHeightChangeCallback, options?: EventListenOptions): void;
|
|
80
|
+
/**
|
|
81
|
+
* 取消监听键盘高度变化。
|
|
82
|
+
*
|
|
83
|
+
* 不传 callback 时取消全部键盘高度监听;传入 callback 时只取消指定监听。
|
|
84
|
+
*
|
|
85
|
+
* @app 1.2.3
|
|
86
|
+
* @example
|
|
87
|
+
* mys.offKeyboardHeightChange()
|
|
88
|
+
*/
|
|
89
|
+
export declare function offKeyboardHeightChange(callback?: KeyboardHeightChangeCallback): void;
|
|
90
|
+
/**
|
|
91
|
+
* 监听评论区面板状态变化。
|
|
92
|
+
*
|
|
93
|
+
* 当 Native 评论区面板打开、关闭或状态变化时触发。
|
|
94
|
+
*
|
|
95
|
+
* @note
|
|
96
|
+
* 事件监听类型直接返回原始 payload,不包装 code/msg/result。
|
|
97
|
+
* options.once 为 true 时只触发一次,触发后由 jsbridge 自动取消监听。
|
|
98
|
+
*
|
|
99
|
+
* @app 4.2.0
|
|
100
|
+
* @example
|
|
101
|
+
* mys.onCommentPanelChange((res) => {
|
|
102
|
+
* console.log('评论区面板状态:', res.visible, res.reason)
|
|
103
|
+
* })
|
|
104
|
+
*
|
|
105
|
+
* mys.onCommentPanelChange((res) => {
|
|
106
|
+
* console.log('只监听一次:', res.visible, res.reason)
|
|
107
|
+
* }, { once: true })
|
|
108
|
+
*
|
|
109
|
+
* mys.offCommentPanelChange()
|
|
110
|
+
*/
|
|
111
|
+
export declare function onCommentPanelChange(callback: CommentPanelChangeCallback, options?: EventListenOptions): void;
|
|
112
|
+
/**
|
|
113
|
+
* 取消监听评论区面板状态变化。
|
|
114
|
+
*
|
|
115
|
+
* 不传 callback 时取消全部评论区面板监听;传入 callback 时只取消指定监听。
|
|
116
|
+
*
|
|
117
|
+
* @app 4.2.0
|
|
118
|
+
* @example
|
|
119
|
+
* mys.offCommentPanelChange()
|
|
120
|
+
*/
|
|
121
|
+
export declare function offCommentPanelChange(callback?: CommentPanelChangeCallback): void;
|
|
122
|
+
/**
|
|
123
|
+
* 预览图片。
|
|
124
|
+
*
|
|
125
|
+
* @note
|
|
126
|
+
* urls 不能为空。
|
|
127
|
+
* current 为当前预览图片在 urls 中的数组下标,默认 0。
|
|
128
|
+
*
|
|
129
|
+
* @app 4.3.0
|
|
130
|
+
* @example
|
|
131
|
+
* await mys.previewImage({
|
|
132
|
+
* urls: ['https://example.com/1.jpg', 'mysFile://temp/files/xxx.jpg'],
|
|
133
|
+
* current: 0,
|
|
134
|
+
* })
|
|
135
|
+
*/
|
|
136
|
+
export declare function previewImage(params: PlayMediaParams): Promise<NativeResponse<void>>;
|
|
137
|
+
/**
|
|
138
|
+
* 预览视频。
|
|
139
|
+
*
|
|
140
|
+
* @note
|
|
141
|
+
* 视频预览与图片预览使用相同入参结构:urls 为视频 URL 列表,current 为当前播放视频的数组下标,默认 0。
|
|
142
|
+
*
|
|
143
|
+
* @app 1.2.3
|
|
144
|
+
* @example
|
|
145
|
+
* await mys.previewVideo({
|
|
146
|
+
* urls: ['https://example.com/video.mp4'],
|
|
147
|
+
* current: 0,
|
|
148
|
+
* })
|
|
149
|
+
*/
|
|
150
|
+
export declare function previewVideo(params: PlayMediaParams): Promise<NativeResponse<void>>;
|
|
151
|
+
/**
|
|
152
|
+
* 选择或拍摄图片/视频。
|
|
153
|
+
*
|
|
154
|
+
* @note
|
|
155
|
+
* 成功返回的 files[].tempFilePath 为临时文件路径,例如 mysFile://temp/xxxx.png。
|
|
156
|
+
* tempFilePath 可用于 img / video 预览,也可传给 uploadFiles 上传。
|
|
157
|
+
* 临时文件不应作为长期业务资源保存。
|
|
158
|
+
*
|
|
159
|
+
* @app 4.3.0
|
|
160
|
+
* @example
|
|
161
|
+
* const res = await mys.chooseMedia({
|
|
162
|
+
* count: 1,
|
|
163
|
+
* mediaType: 'image',
|
|
164
|
+
* })
|
|
165
|
+
* console.log(res.result.files[0].tempFilePath)
|
|
166
|
+
*/
|
|
167
|
+
export declare function chooseMedia(params?: ChooseMediaParams): Promise<NativeResponse<ChooseMediaResult>>;
|
|
168
|
+
/**
|
|
169
|
+
* 上传本地临时文件。
|
|
170
|
+
*
|
|
171
|
+
* 批量串行上传 chooseMedia 返回的临时文件路径,成功后返回网络 URL。
|
|
172
|
+
*
|
|
173
|
+
* @note
|
|
174
|
+
* filePath 应为 chooseMedia 返回的临时文件路径,例如 mysFile://temp/xxxx.png。
|
|
175
|
+
* cosDirPath 默认 multipleSource/common/。
|
|
176
|
+
*
|
|
177
|
+
* @app 4.3.0
|
|
178
|
+
* @example
|
|
179
|
+
* const uploadRes = await mys.uploadFiles({
|
|
180
|
+
* files: [chooseRes.result.files[0].tempFilePath],
|
|
181
|
+
* })
|
|
182
|
+
* console.log(uploadRes.result.files[0].url)
|
|
183
|
+
*/
|
|
184
|
+
export declare function uploadFiles(params: UploadFilesParams): Promise<NativeResponse<UploadFilesResult>>;
|
|
185
|
+
/**
|
|
186
|
+
* 保存图片到系统相册。
|
|
187
|
+
*
|
|
188
|
+
* @app 1.2.3
|
|
189
|
+
* @example
|
|
190
|
+
* await mys.saveImageToPhotosAlbum({ filePath: '/tmp/photo.jpg' })
|
|
191
|
+
*/
|
|
192
|
+
export declare function saveImageToPhotosAlbum(params: SaveImageToPhotosAlbumParams): Promise<NativeResponse<void>>;
|
|
193
|
+
/**
|
|
194
|
+
* 保存视频到系统相册。
|
|
195
|
+
*
|
|
196
|
+
* @app 1.2.3
|
|
197
|
+
* @example
|
|
198
|
+
* await mys.saveVideoToPhotosAlbum({ filePath: '/tmp/video.mp4' })
|
|
199
|
+
*/
|
|
200
|
+
export declare function saveVideoToPhotosAlbum(params: SaveVideoToPhotosAlbumParams): Promise<NativeResponse<void>>;
|
|
201
|
+
/**
|
|
202
|
+
* 开始录音。
|
|
203
|
+
*
|
|
204
|
+
* @note
|
|
205
|
+
* maxDuration 表示录音最大时长,具体默认值由宿主 App 决定。
|
|
206
|
+
*
|
|
207
|
+
* @app 1.2.3
|
|
208
|
+
* @example
|
|
209
|
+
* await mys.startRecord({ maxDuration: 60 })
|
|
210
|
+
*/
|
|
211
|
+
export declare function startRecord(params?: StartRecordParams): Promise<NativeResponse<void>>;
|
|
212
|
+
/**
|
|
213
|
+
* 停止录音。
|
|
214
|
+
*
|
|
215
|
+
* @app 1.2.3
|
|
216
|
+
* @example
|
|
217
|
+
* await mys.stopRecord()
|
|
218
|
+
*/
|
|
219
|
+
export declare function stopRecord(params?: Callbacks): Promise<NativeResponse<void>>;
|
|
220
|
+
/**
|
|
221
|
+
* 获取系统信息。
|
|
222
|
+
*
|
|
223
|
+
* @app 1.2.3
|
|
224
|
+
* @example
|
|
225
|
+
* const res = await mys.getSystemInfo()
|
|
226
|
+
* console.log(res.result.platform)
|
|
227
|
+
*/
|
|
228
|
+
export declare function getSystemInfo(params?: Callbacks<SystemInfoResult>): Promise<NativeResponse<SystemInfoResult>>;
|
|
229
|
+
/**
|
|
230
|
+
* 获取当前网络类型。
|
|
231
|
+
*
|
|
232
|
+
* @app 1.2.3
|
|
233
|
+
* @example
|
|
234
|
+
* const res = await mys.getNetworkType()
|
|
235
|
+
* console.log(res.result.networkType)
|
|
236
|
+
*/
|
|
237
|
+
export declare function getNetworkType(params?: Callbacks<NetworkTypeResult>): Promise<NativeResponse<NetworkTypeResult>>;
|
|
238
|
+
/**
|
|
239
|
+
* 设置系统剪贴板的内容。
|
|
240
|
+
*
|
|
241
|
+
* @note
|
|
242
|
+
* data 可以为空字符串,但不能为 undefined。
|
|
243
|
+
*
|
|
244
|
+
* @app 1.2.3
|
|
245
|
+
* @example
|
|
246
|
+
* await mys.setClipboardData({ data: 'hello world' })
|
|
247
|
+
*/
|
|
248
|
+
export declare function setClipboardData(params: SetClipboardDataParams): Promise<NativeResponse<void>>;
|
|
249
|
+
/**
|
|
250
|
+
* 获取系统剪贴板的内容。
|
|
251
|
+
*
|
|
252
|
+
* @app 1.2.3
|
|
253
|
+
* @example
|
|
254
|
+
* const res = await mys.getClipboardData()
|
|
255
|
+
* console.log(res.result.data)
|
|
256
|
+
*/
|
|
257
|
+
export declare function getClipboardData(params?: Callbacks<GetClipboardDataResult>): Promise<NativeResponse<GetClipboardDataResult>>;
|
|
258
|
+
/**
|
|
259
|
+
* 检查应用权限。
|
|
260
|
+
*
|
|
261
|
+
* @note
|
|
262
|
+
* 返回权限类型 permission 和权限检查结果 result,可结合 openPhoneSetting 引导用户前往系统设置。
|
|
263
|
+
*
|
|
264
|
+
* @app 1.2.3
|
|
265
|
+
* @example
|
|
266
|
+
* const res = await mys.checkPermission({ permission: 'camera' })
|
|
267
|
+
* if (res.result.result !== 'granted') {
|
|
268
|
+
* await mys.openPhoneSetting({ type: 'notice' })
|
|
269
|
+
* }
|
|
270
|
+
*/
|
|
271
|
+
export declare function checkPermission(params: CheckPermissionParams): Promise<NativeResponse<CheckPermissionResult>>;
|
|
272
|
+
/**
|
|
273
|
+
* 打开系统通知设置页。
|
|
274
|
+
*
|
|
275
|
+
* 当前仅支持通知设置,用于引导用户前往系统设置中开启通知权限。
|
|
276
|
+
*
|
|
277
|
+
* @note
|
|
278
|
+
* 该 API 只负责请求宿主 App 打开对应系统设置页,不表示用户已经完成授权。
|
|
279
|
+
* 返回成功仅表示已处理打开设置页的请求。
|
|
280
|
+
*
|
|
281
|
+
* @app 1.2.3
|
|
282
|
+
* @example
|
|
283
|
+
* await mys.openPhoneSetting({ type: 'notice' })
|
|
284
|
+
*/
|
|
285
|
+
export declare function openPhoneSetting(params: OpenPhoneSettingParams): Promise<NativeResponse<void>>;
|
|
286
|
+
/**
|
|
287
|
+
* 关闭当前网页视图。
|
|
288
|
+
*
|
|
289
|
+
* @app 1.2.3
|
|
290
|
+
* @example
|
|
291
|
+
* await mys.closeWebView()
|
|
292
|
+
*/
|
|
293
|
+
export declare function closeWebView(params?: Callbacks): Promise<NativeResponse<void>>;
|
|
294
|
+
/**
|
|
295
|
+
* 使用外部浏览器打开链接。
|
|
296
|
+
*
|
|
297
|
+
* @app 1.2.3
|
|
298
|
+
* @example
|
|
299
|
+
* await mys.openInExternalBrowser({ url: 'https://example.com' })
|
|
300
|
+
*/
|
|
301
|
+
export declare function openInExternalBrowser(params: OpenInExternalBrowserParams): Promise<NativeResponse<void>>;
|
package/dist/api/biz.d.ts
CHANGED
|
@@ -1,15 +1,76 @@
|
|
|
1
|
-
import
|
|
2
|
-
/**
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
1
|
+
import { Callbacks, NativeResponse, ShareWebCardParams, ShowAdParams, BindGameRoleParams, LoginResult, GetTokenResult, GetCircleInfoResult } from '../types';
|
|
2
|
+
/**
|
|
3
|
+
* 登录授权,获取用户信息。
|
|
4
|
+
*
|
|
5
|
+
* @app 1.2.3
|
|
6
|
+
* @example
|
|
7
|
+
* const res = await mys.login()
|
|
8
|
+
* console.log(res.result.code)
|
|
9
|
+
*/
|
|
10
|
+
export declare function login(params?: Callbacks<LoginResult>): Promise<NativeResponse<LoginResult>>;
|
|
11
|
+
/**
|
|
12
|
+
* 获取当前用户的登录 Token。
|
|
13
|
+
*
|
|
14
|
+
* @app 1.2.3
|
|
15
|
+
* @example
|
|
16
|
+
* const res = await mys.getToken()
|
|
17
|
+
* console.log(res.result.token)
|
|
18
|
+
*/
|
|
19
|
+
export declare function getToken(params?: Callbacks<GetTokenResult>): Promise<NativeResponse<GetTokenResult>>;
|
|
20
|
+
/**
|
|
21
|
+
* 获取当前社群/圈子信息。
|
|
22
|
+
*
|
|
23
|
+
* @app 1.2.3
|
|
24
|
+
* @example
|
|
25
|
+
* const res = await mys.getCurrentCircleInfo()
|
|
26
|
+
* console.log(res.result.name)
|
|
27
|
+
*/
|
|
28
|
+
export declare function getCurrentCircleInfo(params?: Callbacks<GetCircleInfoResult>): Promise<NativeResponse<GetCircleInfoResult>>;
|
|
29
|
+
/**
|
|
30
|
+
* 分享网页卡片到社交平台(微信、QQ 等)。
|
|
31
|
+
*
|
|
32
|
+
* @note
|
|
33
|
+
* title 不能为空。
|
|
34
|
+
* shareTypes 默认 [1, 2, 3]。
|
|
35
|
+
*
|
|
36
|
+
* @app 1.2.3
|
|
37
|
+
* @example
|
|
38
|
+
* await mys.shareWebCard({
|
|
39
|
+
* title: '精彩文章',
|
|
40
|
+
* content: '点开看看',
|
|
41
|
+
* icon: 'https://example.com/icon.png',
|
|
42
|
+
* shareUrl: 'https://example.com/article/1',
|
|
43
|
+
* shareTypes: [1, 2, 3],
|
|
44
|
+
* })
|
|
45
|
+
*/
|
|
46
|
+
export declare function shareWebCard(params: ShareWebCardParams): Promise<NativeResponse<void>>;
|
|
47
|
+
/**
|
|
48
|
+
* 打开添加自定义表情页面。
|
|
49
|
+
*
|
|
50
|
+
* @app 1.2.3
|
|
51
|
+
* @example
|
|
52
|
+
* await mys.openAddCustomEmoji()
|
|
53
|
+
*/
|
|
54
|
+
export declare function openAddCustomEmoji(params?: Callbacks): Promise<NativeResponse<void>>;
|
|
55
|
+
/**
|
|
56
|
+
* 跳转绑定游戏角色页面。
|
|
57
|
+
*
|
|
58
|
+
* @note
|
|
59
|
+
* gameName 和 serverId 不能为空。
|
|
60
|
+
*
|
|
61
|
+
* @app 1.2.3
|
|
62
|
+
* @example
|
|
63
|
+
* await mys.toBindGameRole({ gameName: '大话西游', serverId: 's123' })
|
|
64
|
+
*/
|
|
65
|
+
export declare function toBindGameRole(params: BindGameRoleParams): Promise<NativeResponse<void>>;
|
|
66
|
+
/**
|
|
67
|
+
* 展示原生广告视频。
|
|
68
|
+
*
|
|
69
|
+
* @note
|
|
70
|
+
* type 不能为空。
|
|
71
|
+
*
|
|
72
|
+
* @app 1.2.3
|
|
73
|
+
* @example
|
|
74
|
+
* await mys.showAd({ type: 1, circle_id: '123' })
|
|
75
|
+
*/
|
|
76
|
+
export declare function showAd(params: ShowAdParams): Promise<NativeResponse<void>>;
|
package/dist/api/index.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export * from
|
|
2
|
-
export * from
|
|
1
|
+
export * from './basic';
|
|
2
|
+
export * from './biz';
|
package/dist/bridge.d.ts
CHANGED
|
@@ -1,16 +1,11 @@
|
|
|
1
|
-
import
|
|
2
|
-
import
|
|
1
|
+
import { default as JSBridgeSdk, CallOptions, JSBridgeInterface } from '@docoi/jsbridge-sdk';
|
|
2
|
+
import { Callbacks, NativeResponse } from './types';
|
|
3
|
+
export { JSBridgeSdk };
|
|
4
|
+
export type NativeHandler<TData = unknown, TResult = unknown> = (data: TData) => TResult | Promise<TResult>;
|
|
3
5
|
declare const bridge: JSBridgeInterface;
|
|
4
|
-
/** 设置调试模式 */
|
|
5
6
|
export declare const setDebug: (enabled: boolean) => JSBridgeInterface;
|
|
6
|
-
/** 获取原始 bridge 实例 */
|
|
7
7
|
export default bridge;
|
|
8
|
-
|
|
9
|
-
export declare function rejectParamError(fnName: string, msg: string, options?: Callbacks): Promise<never>;
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
* - 调用 bridge.invokeAsync (Promise 风格) 实现
|
|
13
|
-
* - 兼容 callbacks (success/fail/complete) 模式
|
|
14
|
-
* - 原生返回 code === 0 视为成功
|
|
15
|
-
*/
|
|
16
|
-
export declare function invoke<T = any>(fnName: string, data?: Record<string, any>, options?: Callbacks<T>, invokeOptions?: InvokeOptions): Promise<T>;
|
|
8
|
+
export declare function registerNativeHandler<TData = unknown, TResult = unknown>(name: string, handler: NativeHandler<TData, TResult>): JSBridgeInterface;
|
|
9
|
+
export declare function rejectParamError<T = void>(fnName: string, msg: string, options?: Callbacks<T>): Promise<never>;
|
|
10
|
+
export declare function isNativeResponse(value: unknown): value is NativeResponse;
|
|
11
|
+
export declare function invoke<T = void>(fnName: string, data?: object, options?: Callbacks<T>, callOptions?: CallOptions): Promise<NativeResponse<T>>;
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 业务响应码常量
|
|
3
|
+
*
|
|
4
|
+
* 统一定义 mys-sdk 协议返回码,供 bridge 层和业务层共同使用。
|
|
5
|
+
*/
|
|
6
|
+
/** 业务成功。 */
|
|
7
|
+
export declare const SUCCESS = 0;
|
|
8
|
+
/** 系统异常。由异常工厂方法使用,业务方不应主动赋值。 */
|
|
9
|
+
export declare const SYSTEM_EXCEPTION = -1;
|
|
10
|
+
/** 通用业务错误:方法不存在(兜底返回)。 */
|
|
11
|
+
export declare const METHOD_NOT_FOUND = 1001;
|
|
12
|
+
/** 参数错误段起点:参数解析失败、入参校验失败、参数缺失、格式错误等。 */
|
|
13
|
+
export declare const PARAMS_ERROR = 1002;
|
|
14
|
+
/** 未登录段起点:未登录、Token 失效、Token 过期等。 */
|
|
15
|
+
export declare const NOT_LOGGED_IN = 2002;
|
|
16
|
+
/** 权限拒绝段起点:权限被拒、权限未开通、用户拒绝授权等。 */
|
|
17
|
+
export declare const PERMISSION_DENIED = 3002;
|
|
18
|
+
/** 网络错误段起点:网络异常、服务端 5xx、超时等。 */
|
|
19
|
+
export declare const NETWORK_ERROR = 4002;
|
|
20
|
+
/** 业务自定义错误段起点:业务方自定义错误兜底。 */
|
|
21
|
+
export declare const CUSTOM = 9002;
|
package/dist/index.d.ts
CHANGED
|
@@ -1,46 +1,44 @@
|
|
|
1
|
-
import { setDebug } from './bridge';
|
|
2
|
-
import
|
|
3
|
-
import JSBridgeSdk from '@docoi/jsbridge-sdk';
|
|
1
|
+
import { default as bridge, registerNativeHandler, setDebug, JSBridgeSdk } from './bridge';
|
|
2
|
+
import { Callbacks, LoginResult, NativeResponse, GetTokenResult, GetCircleInfoResult, ShareWebCardParams, BindGameRoleParams, ShowAdParams, ShowToastParams, TriggerVibrateParams, KeyboardHeightChangeCallback, EventListenOptions, CommentPanelChangeCallback, PlayMediaParams, ChooseMediaParams, ChooseMediaResult, UploadFilesParams, UploadFilesResult, SaveImageToPhotosAlbumParams, SaveVideoToPhotosAlbumParams, StartRecordParams, SystemInfoResult, NetworkTypeResult, SetClipboardDataParams, GetClipboardDataResult, CheckPermissionParams, CheckPermissionResult, OpenPhoneSettingParams, OpenInExternalBrowserParams } from './types';
|
|
4
3
|
declare const mys: {
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
offKeyboardHeightChange(): void;
|
|
4
|
+
registerNativeHandler: typeof registerNativeHandler;
|
|
5
|
+
login(params?: Callbacks<LoginResult>): Promise< NativeResponse<LoginResult>>;
|
|
6
|
+
getToken(params?: Callbacks<GetTokenResult>): Promise< NativeResponse<GetTokenResult>>;
|
|
7
|
+
getCurrentCircleInfo(params?: Callbacks<GetCircleInfoResult>): Promise< NativeResponse<GetCircleInfoResult>>;
|
|
8
|
+
shareWebCard(params: ShareWebCardParams): Promise< NativeResponse<void>>;
|
|
9
|
+
openAddCustomEmoji(params?: Callbacks): Promise< NativeResponse<void>>;
|
|
10
|
+
toBindGameRole(params: BindGameRoleParams): Promise< NativeResponse<void>>;
|
|
11
|
+
showAd(params: ShowAdParams): Promise< NativeResponse<void>>;
|
|
12
|
+
showToast(params: ShowToastParams): Promise< NativeResponse<void>>;
|
|
13
|
+
triggerVibrate(params?: TriggerVibrateParams): Promise< NativeResponse<void>>;
|
|
14
|
+
stopVibrate(params?: Callbacks): Promise< NativeResponse<void>>;
|
|
15
|
+
hideKeyboard(params?: Callbacks): Promise< NativeResponse<void>>;
|
|
16
|
+
onKeyboardHeightChange(callback: KeyboardHeightChangeCallback, options?: EventListenOptions): void;
|
|
17
|
+
offKeyboardHeightChange(callback?: KeyboardHeightChangeCallback): void;
|
|
18
|
+
onCommentPanelChange(callback: CommentPanelChangeCallback, options?: EventListenOptions): void;
|
|
19
|
+
offCommentPanelChange(callback?: CommentPanelChangeCallback): void;
|
|
20
|
+
previewImage(params: PlayMediaParams): Promise< NativeResponse<void>>;
|
|
21
|
+
previewVideo(params: PlayMediaParams): Promise< NativeResponse<void>>;
|
|
22
|
+
chooseMedia(params?: ChooseMediaParams): Promise< NativeResponse<ChooseMediaResult>>;
|
|
23
|
+
uploadFiles(params: UploadFilesParams): Promise< NativeResponse<UploadFilesResult>>;
|
|
24
|
+
saveImageToPhotosAlbum(params: SaveImageToPhotosAlbumParams): Promise< NativeResponse<void>>;
|
|
25
|
+
saveVideoToPhotosAlbum(params: SaveVideoToPhotosAlbumParams): Promise< NativeResponse<void>>;
|
|
26
|
+
startRecord(params?: StartRecordParams): Promise< NativeResponse<void>>;
|
|
27
|
+
stopRecord(params?: Callbacks): Promise< NativeResponse<void>>;
|
|
28
|
+
getSystemInfo(params?: Callbacks<SystemInfoResult>): Promise< NativeResponse<SystemInfoResult>>;
|
|
29
|
+
getNetworkType(params?: Callbacks<NetworkTypeResult>): Promise< NativeResponse<NetworkTypeResult>>;
|
|
30
|
+
setClipboardData(params: SetClipboardDataParams): Promise< NativeResponse<void>>;
|
|
31
|
+
getClipboardData(params?: Callbacks<GetClipboardDataResult>): Promise< NativeResponse<GetClipboardDataResult>>;
|
|
32
|
+
checkPermission(params: CheckPermissionParams): Promise< NativeResponse<CheckPermissionResult>>;
|
|
33
|
+
openPhoneSetting(params: OpenPhoneSettingParams): Promise< NativeResponse<void>>;
|
|
34
|
+
closeWebView(params?: Callbacks): Promise< NativeResponse<void>>;
|
|
35
|
+
openInExternalBrowser(params: OpenInExternalBrowserParams): Promise< NativeResponse<void>>;
|
|
38
36
|
};
|
|
39
37
|
export default mys;
|
|
40
38
|
export * from './api/basic';
|
|
41
39
|
export * from './api/biz';
|
|
42
|
-
export { setDebug,
|
|
40
|
+
export { setDebug, registerNativeHandler, bridge };
|
|
43
41
|
export { JSBridgeSdk };
|
|
44
|
-
export
|
|
45
|
-
export
|
|
46
|
-
export type
|
|
42
|
+
export { ToastDuration } from './types';
|
|
43
|
+
export * from './constants/code';
|
|
44
|
+
export type * from './types';
|