jubo-sdk 1.1.3 → 1.2.0
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 +35 -31
- package/dist/JuboSdk.d.ts +4 -0
- package/dist/OldJuboSdk.d.ts +4 -0
- package/dist/channelMessage/ChannelClient.d.ts +52 -0
- package/dist/channelMessage/ChannelParent.d.ts +19 -0
- package/dist/channelMessage/index.d.ts +3 -0
- package/dist/index.cjs.js +2855 -1667
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.esm.js +2854 -1668
- package/dist/index.esm.js.map +1 -1
- package/dist/index.js +2855 -1667
- package/dist/index.js.map +1 -1
- package/dist/index.min.js +1 -1
- package/dist/types/juboSdk.d.ts +6 -1
- package/dist/utils/index.d.ts +5 -3
- package/package.json +4 -2
package/README.md
CHANGED
|
@@ -20,7 +20,7 @@ new JuboSdk(options: JuboSdkOptions);
|
|
|
20
20
|
| oldAppVersion | string | 是 | 无 | app旧版本, 用于判断是否使用新版sdk |
|
|
21
21
|
| ojbRouter | [OjbRouter](https://x44qmhgdj1.feishu.cn/docx/Em74djQxEo32UxxbcYdcAMwSnpf#part-XFz0dd8FioFkJTxWbGlciCr9nce)[] | 是 | 无 | ojb路由 |
|
|
22
22
|
| appHome | string | 否 | 无 | 跳转的首页 |
|
|
23
|
-
| miniProgramAppId | string | 否 |
|
|
23
|
+
| miniProgramAppId | string | 否 | 元气的小程序appid: *wxc2f42496fb5f5b91* | 小程序appid |
|
|
24
24
|
| miniProgramLogin | string | 否 | /pages/login/index | 小程序的登录页 |
|
|
25
25
|
| miniProgramTabBar | string[] | 否 | ['/pages/home/index','/pages/boxHome/index','/pages/csgoPage/index','/pages/mine/index','/pages/ipHome/index'] | 小程序tabBar页面列表 |
|
|
26
26
|
| miniProgramPayPage | string | 否 | 无 | 小程序支付页 |
|
|
@@ -45,17 +45,19 @@ Saigo = "Saigo"
|
|
|
45
45
|
|
|
46
46
|
## **属性**
|
|
47
47
|
|
|
48
|
-
| **属性名** | **类型** | **描述**
|
|
49
|
-
| ------------- | --------------------------------------------------------------------------------------------------------- |
|
|
50
|
-
| name | [AppName](https://x44qmhgdj1.feishu.cn/docx/Em74djQxEo32UxxbcYdcAMwSnpf#part-T1PWdRWf4olDSMxmT1bcSIvxnrb) | 只读属性，app名称
|
|
51
|
-
| isApp | boolean | 只读属性，返回当前是否为app。
|
|
52
|
-
| isMiniProgram | boolean | 只读属性，返回当前是否为小程序。
|
|
53
|
-
| isIos | boolean | 只读属性，返回当前是否为iOS设备。
|
|
54
|
-
|
|
|
55
|
-
|
|
|
56
|
-
|
|
|
57
|
-
|
|
|
58
|
-
|
|
|
48
|
+
| **属性名** | **类型** | **描述** |
|
|
49
|
+
| ------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------- |
|
|
50
|
+
| name | [AppName](https://x44qmhgdj1.feishu.cn/docx/Em74djQxEo32UxxbcYdcAMwSnpf#part-T1PWdRWf4olDSMxmT1bcSIvxnrb) | 只读属性，app名称 |
|
|
51
|
+
| isApp | boolean | 只读属性，返回当前是否为app。 |
|
|
52
|
+
| isMiniProgram | boolean | 只读属性，返回当前是否为小程序。 |
|
|
53
|
+
| isIos | boolean | 只读属性，返回当前是否为iOS设备。 |
|
|
54
|
+
| isH5 | boolean | 只读属性，返回当前是否为H5设备。(版本：1.2.0) |
|
|
55
|
+
| isIframe | boolean | 只读属性，返回当前是否为iframe。(版本：1.2.0) |
|
|
56
|
+
| isCanShowNav | boolean | 只读属性，返回当前是否可以显示自定义导航栏。(弃用属性) |
|
|
57
|
+
| device | `ios` | `android` | `wx` | 只读属性，返回当前设备类型。 |
|
|
58
|
+
| version | string | 只读属性，返回当前sdk版本号。 |
|
|
59
|
+
| channel | string | 只读属性，返回当前渠道。 |
|
|
60
|
+
| isOldApp | boolean | 只读属性，返回当前app是否为旧版本。(兼容属性) |
|
|
59
61
|
|
|
60
62
|
## 方法
|
|
61
63
|
|
|
@@ -109,19 +111,20 @@ Saigo = "Saigo"
|
|
|
109
111
|
|
|
110
112
|
#### ShareMiniProgramOptions的结构
|
|
111
113
|
|
|
112
|
-
| **参数名** | **类型** | **是否必填** | **默认值**
|
|
113
|
-
| ------------- | -------------------------------------------------------------------------------------------------------------- | -------- |
|
|
114
|
-
| title | string | 是 | 无
|
|
115
|
-
| descr | string | 否 | 无
|
|
116
|
-
| webpage | string | 是 | 无
|
|
117
|
-
|
|
|
118
|
-
|
|
|
119
|
-
|
|
|
120
|
-
|
|
|
121
|
-
|
|
|
122
|
-
|
|
|
123
|
-
|
|
|
124
|
-
|
|
|
114
|
+
| **参数名** | **类型** | **是否必填** | **默认值** | **描述** | **平台差异说明** |
|
|
115
|
+
| ------------- | -------------------------------------------------------------------------------------------------------------- | -------- | ------------------------ | ----------------------------------- | ---------- |
|
|
116
|
+
| title | string | 是 | 无 | *分享标题* | |
|
|
117
|
+
| descr | string | 否 | 无 | *分享描述* | |
|
|
118
|
+
| webpage | string | 是 | 无 | *小程序路径* | |
|
|
119
|
+
| appid | string | 否 | options.miniProgramAppId | 小程序原始id (版本: 1.1.4) | 仅app有效 |
|
|
120
|
+
| thumbImage | string | 否 | 无 | *分享图* | |
|
|
121
|
+
| base64 | string | 否 | 无 | *base64分享图, 仅app有效, 与thumbImage二选一* | 仅app有效 |
|
|
122
|
+
| activity_id | string | 否 | 无 | *活动id* | |
|
|
123
|
+
| activity_name | string | 否 | 无 | *活动名称* | |
|
|
124
|
+
| product_id | string | 否 | 无 | *商品id* | |
|
|
125
|
+
| product_name | string | 否 | 无 | *商品名称* | |
|
|
126
|
+
| saInfo | any | 否 | 无 | *神策* *埋点* *数据* | |
|
|
127
|
+
| shareOptions | [shareOptions](https://x44qmhgdj1.feishu.cn/docx/Em74djQxEo32UxxbcYdcAMwSnpf#part-SjsvdDkEkosFLExULY8c4Gwen7b) | 否 | 无 | *分享选项* | 仅小程序有效 |
|
|
125
128
|
|
|
126
129
|
#### shareOptions的结构
|
|
127
130
|
|
|
@@ -229,12 +232,13 @@ Saigo = "Saigo"
|
|
|
229
232
|
|
|
230
233
|
#### ToPayPageOptions的结构
|
|
231
234
|
|
|
232
|
-
| **参数名** | **类型** | **是否必填** | **默认值** | **描述**
|
|
233
|
-
| ---------- | ------ | -------- | ------- |
|
|
234
|
-
|
|
|
235
|
-
|
|
|
236
|
-
|
|
|
237
|
-
|
|
|
235
|
+
| **参数名** | **类型** | **是否必填** | **默认值** | **描述** | **平台差异说明** |
|
|
236
|
+
| ---------- | ------ | -------- | ------- | -------------- | ---------- |
|
|
237
|
+
| orderId | string | 否 | 无 | 订单id（版本：1.2.0） | |
|
|
238
|
+
| amount | string | 是 | 无 | 充值金额 | |
|
|
239
|
+
| activityId | string | 是 | 无 | 活动ID | |
|
|
240
|
+
| success | string | 否 | 无 | 支付成功的回调地址 | 仅小程序有效 |
|
|
241
|
+
| fail | string | 否 | 无 | 支付失败的回调地址 | 仅小程序有效 |
|
|
238
242
|
|
|
239
243
|
#### 返回参数说明
|
|
240
244
|
|
package/dist/JuboSdk.d.ts
CHANGED
|
@@ -8,6 +8,10 @@ declare class JuboSdk {
|
|
|
8
8
|
readonly isApp: boolean;
|
|
9
9
|
/** 是否是小程序 */
|
|
10
10
|
readonly isMiniProgram: boolean;
|
|
11
|
+
/** 是否是h5 */
|
|
12
|
+
readonly isH5: boolean;
|
|
13
|
+
/** 是否是H5内嵌 */
|
|
14
|
+
readonly isIframe: boolean;
|
|
11
15
|
/** 是否是ios */
|
|
12
16
|
readonly isIos: boolean;
|
|
13
17
|
/** 是否可以显示自定义导航栏 */
|
package/dist/OldJuboSdk.d.ts
CHANGED
|
@@ -8,6 +8,10 @@ declare class OldJuboSdk {
|
|
|
8
8
|
readonly isApp: boolean;
|
|
9
9
|
/** 是否是小程序 */
|
|
10
10
|
readonly isMiniProgram: boolean;
|
|
11
|
+
/** 是否是h5 */
|
|
12
|
+
readonly isH5: boolean;
|
|
13
|
+
/** 是否是H5内嵌 */
|
|
14
|
+
readonly isIframe: boolean;
|
|
11
15
|
/** 是否是ios */
|
|
12
16
|
readonly isIos: boolean;
|
|
13
17
|
/** 是否可以显示自定义导航栏 */
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
interface ChannelClientOptions {
|
|
2
|
+
clientWindow: Window;
|
|
3
|
+
parentWindow: Window;
|
|
4
|
+
origin: string;
|
|
5
|
+
/**
|
|
6
|
+
* 超时时间
|
|
7
|
+
* @default 3000
|
|
8
|
+
*/
|
|
9
|
+
failedTime?: number;
|
|
10
|
+
}
|
|
11
|
+
type Callback = {
|
|
12
|
+
success: (response: any) => void;
|
|
13
|
+
failed: (error: any) => void;
|
|
14
|
+
};
|
|
15
|
+
type MessageEventData = {
|
|
16
|
+
requestId: string;
|
|
17
|
+
type: 'response' | 'register';
|
|
18
|
+
isSuccess: boolean;
|
|
19
|
+
handlerName: string;
|
|
20
|
+
body: any;
|
|
21
|
+
};
|
|
22
|
+
declare class ChannelClient {
|
|
23
|
+
constructor(options: ChannelClientOptions);
|
|
24
|
+
clientWindow: Window;
|
|
25
|
+
parentWindow: Window;
|
|
26
|
+
origin: string;
|
|
27
|
+
/**
|
|
28
|
+
* 超时时间
|
|
29
|
+
* @default 3000
|
|
30
|
+
*/
|
|
31
|
+
failedTime: number;
|
|
32
|
+
requestCache: Map<string, Callback>;
|
|
33
|
+
/**
|
|
34
|
+
* 接受回调处理
|
|
35
|
+
* @param ev
|
|
36
|
+
* @returns
|
|
37
|
+
*/
|
|
38
|
+
receiveResponse(ev: MessageEvent<MessageEventData>): void;
|
|
39
|
+
/**
|
|
40
|
+
* 发送事件
|
|
41
|
+
* @param handlerName 事件名
|
|
42
|
+
* @param body 参数
|
|
43
|
+
* @returns Promise
|
|
44
|
+
*/
|
|
45
|
+
call(handlerName: string, body?: any): Promise<unknown>;
|
|
46
|
+
/**
|
|
47
|
+
* 超时处理
|
|
48
|
+
* @param requestId
|
|
49
|
+
*/
|
|
50
|
+
timeoutFailed(requestId: string): void;
|
|
51
|
+
}
|
|
52
|
+
export default ChannelClient;
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
type OnRequest = (request: any) => any;
|
|
2
|
+
declare class ChannelParent {
|
|
3
|
+
constructor();
|
|
4
|
+
requestHandlerMap: Map<string, OnRequest>;
|
|
5
|
+
receiveRequest(ev: MessageEvent): void;
|
|
6
|
+
/**
|
|
7
|
+
* 接受事件处理
|
|
8
|
+
* @param ev
|
|
9
|
+
* @returns
|
|
10
|
+
*/
|
|
11
|
+
handleRequest(request: any): any;
|
|
12
|
+
/**
|
|
13
|
+
* 注册异步事件
|
|
14
|
+
* @param handlerName 事件名
|
|
15
|
+
* @param callback 事件执行函数
|
|
16
|
+
*/
|
|
17
|
+
register(handlerName: string, callback: any): void;
|
|
18
|
+
}
|
|
19
|
+
export default ChannelParent;
|