@heybox/hb-sdk 0.5.10 → 0.5.11
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 +94 -51
- package/dist/cli-chunks/{create-D1W2pkHZ.cjs → create-BaqN3jeW.cjs} +1 -1
- package/dist/cli-chunks/{dev-DwbE-c1x.cjs → dev-DUZgcgYE.cjs} +1 -1
- package/dist/cli-chunks/{doctor-Bx71WFjM.cjs → doctor-DUjQij7b.cjs} +1 -1
- package/dist/cli-chunks/{index-D5bZjpH9.cjs → index-6W5M4MLF.cjs} +2 -2
- package/dist/cli-chunks/{index-BBatNb1l.cjs → index-BROIiSNN.cjs} +57 -13
- package/dist/cli-chunks/{login-BX0YmVyi.cjs → login-BejyA1mX.cjs} +2 -2
- package/dist/cli-chunks/{remote-YDmSxyYi.cjs → remote-ChGmIJC1.cjs} +117 -3
- package/dist/cli-chunks/{session-BxZBXDZ-.cjs → session-jHF9KWBo.cjs} +1 -1
- package/dist/cli.cjs +1 -1
- package/dist/devtools/mock-host/main.js +590 -0
- package/dist/index.cjs.js +37 -0
- package/dist/index.esm.js +37 -1
- package/dist/miniapp-publish.cjs.js +8 -0
- package/dist/miniapp-publish.esm.js +5 -1
- package/dist/protocol.cjs.js +50 -0
- package/dist/protocol.esm.js +46 -1
- package/package.json +1 -1
- package/skill/references/api-protocol.md +20 -0
- package/skill/references/api-root.md +63 -3
- package/skill/skill.json +4 -4
- package/types/core/client.d.ts +1 -1
- package/types/core/sdk.d.ts +3 -0
- package/types/core/singleton.d.ts +3 -0
- package/types/index.d.ts +3 -1
- package/types/miniapp-publish/index.d.ts +4 -0
- package/types/modules/cloud/index.d.ts +100 -0
- package/types/protocol/capabilities.d.ts +55 -2
- package/types/protocol.d.ts +3 -2
package/dist/index.cjs.js
CHANGED
|
@@ -499,6 +499,16 @@ const NAVIGATION_CLOSE_METHOD = 'navigation.close';
|
|
|
499
499
|
const NAVIGATION_RELOAD_METHOD = 'navigation.reload';
|
|
500
500
|
/** 打开黑盒 App 页面能力方法名。 */
|
|
501
501
|
const NAVIGATION_OPEN_APP_PAGE_METHOD = 'navigation.openAppPage';
|
|
502
|
+
/** 提交当前用户排行榜分数能力方法名。 */
|
|
503
|
+
const CLOUD_LEADERBOARD_SUBMIT_METHOD = 'cloud.leaderboard.submit';
|
|
504
|
+
/** 读取排行榜列表能力方法名。 */
|
|
505
|
+
const CLOUD_LEADERBOARD_GET_LIST_METHOD = 'cloud.leaderboard.getList';
|
|
506
|
+
/** 读取当前用户排行榜记录能力方法名。 */
|
|
507
|
+
const CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD = 'cloud.leaderboard.getCurrentUserEntry';
|
|
508
|
+
/** 删除当前用户排行榜记录能力方法名。 */
|
|
509
|
+
const CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD = 'cloud.leaderboard.deleteCurrentUserEntry';
|
|
510
|
+
/** 读取排行榜基础信息能力方法名。 */
|
|
511
|
+
const CLOUD_LEADERBOARD_GET_INFO_METHOD = 'cloud.leaderboard.getInfo';
|
|
502
512
|
|
|
503
513
|
/**
|
|
504
514
|
* 唤起登录授权,并在流程返回后刷新用户公开基础资料。
|
|
@@ -525,6 +535,18 @@ function createAuthModule(requester) {
|
|
|
525
535
|
};
|
|
526
536
|
}
|
|
527
537
|
|
|
538
|
+
function createCloudModule(requester) {
|
|
539
|
+
return {
|
|
540
|
+
leaderboard: {
|
|
541
|
+
submit: (options) => requester.request(CLOUD_LEADERBOARD_SUBMIT_METHOD, options),
|
|
542
|
+
getList: (options) => requester.request(CLOUD_LEADERBOARD_GET_LIST_METHOD, options),
|
|
543
|
+
getCurrentUserEntry: (options) => requester.request(CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD, options),
|
|
544
|
+
deleteCurrentUserEntry: (options) => requester.request(CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD, options),
|
|
545
|
+
getInfo: (options) => requester.request(CLOUD_LEADERBOARD_GET_INFO_METHOD, options),
|
|
546
|
+
},
|
|
547
|
+
};
|
|
548
|
+
}
|
|
549
|
+
|
|
528
550
|
/**
|
|
529
551
|
* 截图并唤起分享。
|
|
530
552
|
*
|
|
@@ -979,6 +1001,8 @@ class MiniProgramSDK {
|
|
|
979
1001
|
device;
|
|
980
1002
|
/** 导航与容器控制相关开放能力。 */
|
|
981
1003
|
navigation;
|
|
1004
|
+
/** 云端数据相关开放能力。 */
|
|
1005
|
+
cloud;
|
|
982
1006
|
constructor(options) {
|
|
983
1007
|
this.client = new MiniProgramBridgeClient(options);
|
|
984
1008
|
this.auth = createAuthModule(this.client);
|
|
@@ -990,6 +1014,7 @@ class MiniProgramSDK {
|
|
|
990
1014
|
this.ui = createUiModule(this.client);
|
|
991
1015
|
this.device = createDeviceModule(this.client);
|
|
992
1016
|
this.navigation = createNavigationModule(this.client);
|
|
1017
|
+
this.cloud = createCloudModule(this.client);
|
|
993
1018
|
}
|
|
994
1019
|
/**
|
|
995
1020
|
* 等待 SDK 与父容器完成握手。
|
|
@@ -1137,6 +1162,16 @@ const navigation = {
|
|
|
1137
1162
|
reload: () => getDefaultSDK().navigation.reload(),
|
|
1138
1163
|
openAppPage: options => getDefaultSDK().navigation.openAppPage(options),
|
|
1139
1164
|
};
|
|
1165
|
+
/** 默认 SDK 实例的 cloud 模块。 */
|
|
1166
|
+
const cloud = {
|
|
1167
|
+
leaderboard: {
|
|
1168
|
+
submit: options => getDefaultSDK().cloud.leaderboard.submit(options),
|
|
1169
|
+
getList: options => getDefaultSDK().cloud.leaderboard.getList(options),
|
|
1170
|
+
getCurrentUserEntry: options => getDefaultSDK().cloud.leaderboard.getCurrentUserEntry(options),
|
|
1171
|
+
deleteCurrentUserEntry: options => getDefaultSDK().cloud.leaderboard.deleteCurrentUserEntry(options),
|
|
1172
|
+
getInfo: options => getDefaultSDK().cloud.leaderboard.getInfo(options),
|
|
1173
|
+
},
|
|
1174
|
+
};
|
|
1140
1175
|
|
|
1141
1176
|
const hbSDK = {
|
|
1142
1177
|
ready,
|
|
@@ -1151,12 +1186,14 @@ const hbSDK = {
|
|
|
1151
1186
|
ui,
|
|
1152
1187
|
device,
|
|
1153
1188
|
navigation,
|
|
1189
|
+
cloud,
|
|
1154
1190
|
};
|
|
1155
1191
|
|
|
1156
1192
|
exports.HbMiniProgramNetworkError = HbMiniProgramNetworkError;
|
|
1157
1193
|
exports.HbMiniProgramSDKError = HbMiniProgramSDKError;
|
|
1158
1194
|
exports.MiniProgramSDK = MiniProgramSDK;
|
|
1159
1195
|
exports.auth = auth;
|
|
1196
|
+
exports.cloud = cloud;
|
|
1160
1197
|
exports.createMiniProgramSDK = createMiniProgramSDK;
|
|
1161
1198
|
exports.default = hbSDK;
|
|
1162
1199
|
exports.device = device;
|
package/dist/index.esm.js
CHANGED
|
@@ -495,6 +495,16 @@ const NAVIGATION_CLOSE_METHOD = 'navigation.close';
|
|
|
495
495
|
const NAVIGATION_RELOAD_METHOD = 'navigation.reload';
|
|
496
496
|
/** 打开黑盒 App 页面能力方法名。 */
|
|
497
497
|
const NAVIGATION_OPEN_APP_PAGE_METHOD = 'navigation.openAppPage';
|
|
498
|
+
/** 提交当前用户排行榜分数能力方法名。 */
|
|
499
|
+
const CLOUD_LEADERBOARD_SUBMIT_METHOD = 'cloud.leaderboard.submit';
|
|
500
|
+
/** 读取排行榜列表能力方法名。 */
|
|
501
|
+
const CLOUD_LEADERBOARD_GET_LIST_METHOD = 'cloud.leaderboard.getList';
|
|
502
|
+
/** 读取当前用户排行榜记录能力方法名。 */
|
|
503
|
+
const CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD = 'cloud.leaderboard.getCurrentUserEntry';
|
|
504
|
+
/** 删除当前用户排行榜记录能力方法名。 */
|
|
505
|
+
const CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD = 'cloud.leaderboard.deleteCurrentUserEntry';
|
|
506
|
+
/** 读取排行榜基础信息能力方法名。 */
|
|
507
|
+
const CLOUD_LEADERBOARD_GET_INFO_METHOD = 'cloud.leaderboard.getInfo';
|
|
498
508
|
|
|
499
509
|
/**
|
|
500
510
|
* 唤起登录授权,并在流程返回后刷新用户公开基础资料。
|
|
@@ -521,6 +531,18 @@ function createAuthModule(requester) {
|
|
|
521
531
|
};
|
|
522
532
|
}
|
|
523
533
|
|
|
534
|
+
function createCloudModule(requester) {
|
|
535
|
+
return {
|
|
536
|
+
leaderboard: {
|
|
537
|
+
submit: (options) => requester.request(CLOUD_LEADERBOARD_SUBMIT_METHOD, options),
|
|
538
|
+
getList: (options) => requester.request(CLOUD_LEADERBOARD_GET_LIST_METHOD, options),
|
|
539
|
+
getCurrentUserEntry: (options) => requester.request(CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD, options),
|
|
540
|
+
deleteCurrentUserEntry: (options) => requester.request(CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD, options),
|
|
541
|
+
getInfo: (options) => requester.request(CLOUD_LEADERBOARD_GET_INFO_METHOD, options),
|
|
542
|
+
},
|
|
543
|
+
};
|
|
544
|
+
}
|
|
545
|
+
|
|
524
546
|
/**
|
|
525
547
|
* 截图并唤起分享。
|
|
526
548
|
*
|
|
@@ -975,6 +997,8 @@ class MiniProgramSDK {
|
|
|
975
997
|
device;
|
|
976
998
|
/** 导航与容器控制相关开放能力。 */
|
|
977
999
|
navigation;
|
|
1000
|
+
/** 云端数据相关开放能力。 */
|
|
1001
|
+
cloud;
|
|
978
1002
|
constructor(options) {
|
|
979
1003
|
this.client = new MiniProgramBridgeClient(options);
|
|
980
1004
|
this.auth = createAuthModule(this.client);
|
|
@@ -986,6 +1010,7 @@ class MiniProgramSDK {
|
|
|
986
1010
|
this.ui = createUiModule(this.client);
|
|
987
1011
|
this.device = createDeviceModule(this.client);
|
|
988
1012
|
this.navigation = createNavigationModule(this.client);
|
|
1013
|
+
this.cloud = createCloudModule(this.client);
|
|
989
1014
|
}
|
|
990
1015
|
/**
|
|
991
1016
|
* 等待 SDK 与父容器完成握手。
|
|
@@ -1133,6 +1158,16 @@ const navigation = {
|
|
|
1133
1158
|
reload: () => getDefaultSDK().navigation.reload(),
|
|
1134
1159
|
openAppPage: options => getDefaultSDK().navigation.openAppPage(options),
|
|
1135
1160
|
};
|
|
1161
|
+
/** 默认 SDK 实例的 cloud 模块。 */
|
|
1162
|
+
const cloud = {
|
|
1163
|
+
leaderboard: {
|
|
1164
|
+
submit: options => getDefaultSDK().cloud.leaderboard.submit(options),
|
|
1165
|
+
getList: options => getDefaultSDK().cloud.leaderboard.getList(options),
|
|
1166
|
+
getCurrentUserEntry: options => getDefaultSDK().cloud.leaderboard.getCurrentUserEntry(options),
|
|
1167
|
+
deleteCurrentUserEntry: options => getDefaultSDK().cloud.leaderboard.deleteCurrentUserEntry(options),
|
|
1168
|
+
getInfo: options => getDefaultSDK().cloud.leaderboard.getInfo(options),
|
|
1169
|
+
},
|
|
1170
|
+
};
|
|
1136
1171
|
|
|
1137
1172
|
const hbSDK = {
|
|
1138
1173
|
ready,
|
|
@@ -1147,6 +1182,7 @@ const hbSDK = {
|
|
|
1147
1182
|
ui,
|
|
1148
1183
|
device,
|
|
1149
1184
|
navigation,
|
|
1185
|
+
cloud,
|
|
1150
1186
|
};
|
|
1151
1187
|
|
|
1152
|
-
export { HbMiniProgramNetworkError, HbMiniProgramSDKError, MiniProgramSDK, auth, createMiniProgramSDK, hbSDK as default, device, navigation, network, off, on, ready, share, storage, ui, user, viewport };
|
|
1188
|
+
export { HbMiniProgramNetworkError, HbMiniProgramSDKError, MiniProgramSDK, auth, cloud, createMiniProgramSDK, hbSDK as default, device, navigation, network, off, on, ready, share, storage, ui, user, viewport };
|
|
@@ -2821,6 +2821,10 @@ const CREATE_USER_MINIPROGRAM_API_PATH = '/mall/developer/user_miniprogram/creat
|
|
|
2821
2821
|
const DETAIL_USER_MINIPROGRAM_API_PATH = '/mall/developer/user_miniprogram/detail';
|
|
2822
2822
|
const USER_MINIPROGRAM_PREVIEW_ALLOWLIST_API_PATH = '/mall/developer/user_miniprogram/preview_allowlist';
|
|
2823
2823
|
const UPDATE_USER_MINIPROGRAM_PREVIEW_ALLOWLIST_API_PATH = '/mall/developer/user_miniprogram/preview_allowlist/update';
|
|
2824
|
+
const CREATE_USER_MINIPROGRAM_LEADERBOARD_API_PATH = '/mall/developer/user_miniprogram/leaderboard/create';
|
|
2825
|
+
const DETAIL_USER_MINIPROGRAM_LEADERBOARD_API_PATH = '/mall/developer/user_miniprogram/leaderboard/detail';
|
|
2826
|
+
const LIST_USER_MINIPROGRAM_LEADERBOARD_API_PATH = '/mall/developer/user_miniprogram/leaderboard/list';
|
|
2827
|
+
const DELETE_USER_MINIPROGRAM_LEADERBOARD_API_PATH = '/mall/developer/user_miniprogram/leaderboard/delete';
|
|
2824
2828
|
const PRECHECK_USER_MINIPROGRAM_VERSION_API_PATH = '/mall/developer/user_miniprogram/version/precheck';
|
|
2825
2829
|
const SUBMIT_USER_MINIPROGRAM_AUDIT_API_PATH = '/mall/developer/user_miniprogram/version/submit_audit';
|
|
2826
2830
|
const USER_MINIPROGRAM_VERSION_PREVIEW_INFO_API_PATH = '/mall/developer/user_miniprogram/version/preview_info';
|
|
@@ -2901,10 +2905,14 @@ function shouldUploadDistFile(relativePath) {
|
|
|
2901
2905
|
|
|
2902
2906
|
exports.ACTIVITY_UPLOAD_KEY_MAX_LENGTH = ACTIVITY_UPLOAD_KEY_MAX_LENGTH;
|
|
2903
2907
|
exports.CREATE_USER_MINIPROGRAM_API_PATH = CREATE_USER_MINIPROGRAM_API_PATH;
|
|
2908
|
+
exports.CREATE_USER_MINIPROGRAM_LEADERBOARD_API_PATH = CREATE_USER_MINIPROGRAM_LEADERBOARD_API_PATH;
|
|
2909
|
+
exports.DELETE_USER_MINIPROGRAM_LEADERBOARD_API_PATH = DELETE_USER_MINIPROGRAM_LEADERBOARD_API_PATH;
|
|
2904
2910
|
exports.DETAIL_USER_MINIPROGRAM_API_PATH = DETAIL_USER_MINIPROGRAM_API_PATH;
|
|
2911
|
+
exports.DETAIL_USER_MINIPROGRAM_LEADERBOARD_API_PATH = DETAIL_USER_MINIPROGRAM_LEADERBOARD_API_PATH;
|
|
2905
2912
|
exports.DEVELOPER_ENTITY_LIST_API_PATH = DEVELOPER_ENTITY_LIST_API_PATH;
|
|
2906
2913
|
exports.DEVELOPER_ENTITY_SWITCH_API_PATH = DEVELOPER_ENTITY_SWITCH_API_PATH;
|
|
2907
2914
|
exports.LIST_USER_MINIPROGRAM_API_PATH = LIST_USER_MINIPROGRAM_API_PATH;
|
|
2915
|
+
exports.LIST_USER_MINIPROGRAM_LEADERBOARD_API_PATH = LIST_USER_MINIPROGRAM_LEADERBOARD_API_PATH;
|
|
2908
2916
|
exports.LIST_USER_MINIPROGRAM_VERSION_API_PATH = LIST_USER_MINIPROGRAM_VERSION_API_PATH;
|
|
2909
2917
|
exports.MINIAPP_UPLOAD_BATCH_SIZE = MINIAPP_UPLOAD_BATCH_SIZE;
|
|
2910
2918
|
exports.MINIAPP_UPLOAD_SCOPE = MINIAPP_UPLOAD_SCOPE;
|
|
@@ -2819,6 +2819,10 @@ const CREATE_USER_MINIPROGRAM_API_PATH = '/mall/developer/user_miniprogram/creat
|
|
|
2819
2819
|
const DETAIL_USER_MINIPROGRAM_API_PATH = '/mall/developer/user_miniprogram/detail';
|
|
2820
2820
|
const USER_MINIPROGRAM_PREVIEW_ALLOWLIST_API_PATH = '/mall/developer/user_miniprogram/preview_allowlist';
|
|
2821
2821
|
const UPDATE_USER_MINIPROGRAM_PREVIEW_ALLOWLIST_API_PATH = '/mall/developer/user_miniprogram/preview_allowlist/update';
|
|
2822
|
+
const CREATE_USER_MINIPROGRAM_LEADERBOARD_API_PATH = '/mall/developer/user_miniprogram/leaderboard/create';
|
|
2823
|
+
const DETAIL_USER_MINIPROGRAM_LEADERBOARD_API_PATH = '/mall/developer/user_miniprogram/leaderboard/detail';
|
|
2824
|
+
const LIST_USER_MINIPROGRAM_LEADERBOARD_API_PATH = '/mall/developer/user_miniprogram/leaderboard/list';
|
|
2825
|
+
const DELETE_USER_MINIPROGRAM_LEADERBOARD_API_PATH = '/mall/developer/user_miniprogram/leaderboard/delete';
|
|
2822
2826
|
const PRECHECK_USER_MINIPROGRAM_VERSION_API_PATH = '/mall/developer/user_miniprogram/version/precheck';
|
|
2823
2827
|
const SUBMIT_USER_MINIPROGRAM_AUDIT_API_PATH = '/mall/developer/user_miniprogram/version/submit_audit';
|
|
2824
2828
|
const USER_MINIPROGRAM_VERSION_PREVIEW_INFO_API_PATH = '/mall/developer/user_miniprogram/version/preview_info';
|
|
@@ -2897,4 +2901,4 @@ function shouldUploadDistFile(relativePath) {
|
|
|
2897
2901
|
return true;
|
|
2898
2902
|
}
|
|
2899
2903
|
|
|
2900
|
-
export { ACTIVITY_UPLOAD_KEY_MAX_LENGTH, CREATE_USER_MINIPROGRAM_API_PATH, DETAIL_USER_MINIPROGRAM_API_PATH, DEVELOPER_ENTITY_LIST_API_PATH, DEVELOPER_ENTITY_SWITCH_API_PATH, LIST_USER_MINIPROGRAM_API_PATH, LIST_USER_MINIPROGRAM_VERSION_API_PATH, MINIAPP_UPLOAD_BATCH_SIZE, MINIAPP_UPLOAD_SCOPE, MINIAPP_UPLOAD_TOTAL_SIZE_LIMIT_BYTES, PRECHECK_USER_MINIPROGRAM_VERSION_API_PATH, RELEASE_USER_MINIPROGRAM_VERSION_API_PATH, REOPEN_USER_MINIPROGRAM_API_PATH, SUBMIT_USER_MINIPROGRAM_AUDIT_API_PATH, TAKE_DOWN_USER_MINIPROGRAM_API_PATH, UPDATE_SQUARE_DISPLAY_API_PATH, UPDATE_USER_MINIPROGRAM_PREVIEW_ALLOWLIST_API_PATH, USER_MINIPROGRAM_ACCESS_STATUS_API_PATH, USER_MINIPROGRAM_PREVIEW_ALLOWLIST_API_PATH, USER_MINIPROGRAM_VERSION_PREVIEW_INFO_API_PATH, WITHDRAW_USER_MINIPROGRAM_VERSION_API_PATH, getMiniProgramUploadAlias, getMiniappUploadKey, isValidMiniappManifestVersion as isValidVersion, normalizeRelativePath, relativePathContainsNodeModulesSegment, shouldUploadDistFile, validateUploadPaths, validateUploadTotalSize };
|
|
2904
|
+
export { ACTIVITY_UPLOAD_KEY_MAX_LENGTH, CREATE_USER_MINIPROGRAM_API_PATH, CREATE_USER_MINIPROGRAM_LEADERBOARD_API_PATH, DELETE_USER_MINIPROGRAM_LEADERBOARD_API_PATH, DETAIL_USER_MINIPROGRAM_API_PATH, DETAIL_USER_MINIPROGRAM_LEADERBOARD_API_PATH, DEVELOPER_ENTITY_LIST_API_PATH, DEVELOPER_ENTITY_SWITCH_API_PATH, LIST_USER_MINIPROGRAM_API_PATH, LIST_USER_MINIPROGRAM_LEADERBOARD_API_PATH, LIST_USER_MINIPROGRAM_VERSION_API_PATH, MINIAPP_UPLOAD_BATCH_SIZE, MINIAPP_UPLOAD_SCOPE, MINIAPP_UPLOAD_TOTAL_SIZE_LIMIT_BYTES, PRECHECK_USER_MINIPROGRAM_VERSION_API_PATH, RELEASE_USER_MINIPROGRAM_VERSION_API_PATH, REOPEN_USER_MINIPROGRAM_API_PATH, SUBMIT_USER_MINIPROGRAM_AUDIT_API_PATH, TAKE_DOWN_USER_MINIPROGRAM_API_PATH, UPDATE_SQUARE_DISPLAY_API_PATH, UPDATE_USER_MINIPROGRAM_PREVIEW_ALLOWLIST_API_PATH, USER_MINIPROGRAM_ACCESS_STATUS_API_PATH, USER_MINIPROGRAM_PREVIEW_ALLOWLIST_API_PATH, USER_MINIPROGRAM_VERSION_PREVIEW_INFO_API_PATH, WITHDRAW_USER_MINIPROGRAM_VERSION_API_PATH, getMiniProgramUploadAlias, getMiniappUploadKey, isValidMiniappManifestVersion as isValidVersion, normalizeRelativePath, relativePathContainsNodeModulesSegment, shouldUploadDistFile, validateUploadPaths, validateUploadTotalSize };
|
package/dist/protocol.cjs.js
CHANGED
|
@@ -115,6 +115,16 @@ const NAVIGATION_CLOSE_METHOD = 'navigation.close';
|
|
|
115
115
|
const NAVIGATION_RELOAD_METHOD = 'navigation.reload';
|
|
116
116
|
/** 打开黑盒 App 页面能力方法名。 */
|
|
117
117
|
const NAVIGATION_OPEN_APP_PAGE_METHOD = 'navigation.openAppPage';
|
|
118
|
+
/** 提交当前用户排行榜分数能力方法名。 */
|
|
119
|
+
const CLOUD_LEADERBOARD_SUBMIT_METHOD = 'cloud.leaderboard.submit';
|
|
120
|
+
/** 读取排行榜列表能力方法名。 */
|
|
121
|
+
const CLOUD_LEADERBOARD_GET_LIST_METHOD = 'cloud.leaderboard.getList';
|
|
122
|
+
/** 读取当前用户排行榜记录能力方法名。 */
|
|
123
|
+
const CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD = 'cloud.leaderboard.getCurrentUserEntry';
|
|
124
|
+
/** 删除当前用户排行榜记录能力方法名。 */
|
|
125
|
+
const CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD = 'cloud.leaderboard.deleteCurrentUserEntry';
|
|
126
|
+
/** 读取排行榜基础信息能力方法名。 */
|
|
127
|
+
const CLOUD_LEADERBOARD_GET_INFO_METHOD = 'cloud.leaderboard.getInfo';
|
|
118
128
|
/**
|
|
119
129
|
* 小程序开放能力目录。
|
|
120
130
|
*
|
|
@@ -276,9 +286,49 @@ const MINI_PROGRAM_PROTOCOL_CAPABILITIES = [
|
|
|
276
286
|
permission: 'navigation.openAppPage',
|
|
277
287
|
risk: 'medium',
|
|
278
288
|
},
|
|
289
|
+
{
|
|
290
|
+
method: CLOUD_LEADERBOARD_SUBMIT_METHOD,
|
|
291
|
+
module: 'cloud',
|
|
292
|
+
capability: CLOUD_LEADERBOARD_SUBMIT_METHOD,
|
|
293
|
+
permission: 'cloud.leaderboard.write',
|
|
294
|
+
risk: 'medium',
|
|
295
|
+
},
|
|
296
|
+
{
|
|
297
|
+
method: CLOUD_LEADERBOARD_GET_LIST_METHOD,
|
|
298
|
+
module: 'cloud',
|
|
299
|
+
capability: CLOUD_LEADERBOARD_GET_LIST_METHOD,
|
|
300
|
+
permission: 'cloud.leaderboard.read',
|
|
301
|
+
risk: 'low',
|
|
302
|
+
},
|
|
303
|
+
{
|
|
304
|
+
method: CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD,
|
|
305
|
+
module: 'cloud',
|
|
306
|
+
capability: CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD,
|
|
307
|
+
permission: 'cloud.leaderboard.currentUserEntry.read',
|
|
308
|
+
risk: 'medium',
|
|
309
|
+
},
|
|
310
|
+
{
|
|
311
|
+
method: CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD,
|
|
312
|
+
module: 'cloud',
|
|
313
|
+
capability: CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD,
|
|
314
|
+
permission: 'cloud.leaderboard.currentUserEntry.delete',
|
|
315
|
+
risk: 'medium',
|
|
316
|
+
},
|
|
317
|
+
{
|
|
318
|
+
method: CLOUD_LEADERBOARD_GET_INFO_METHOD,
|
|
319
|
+
module: 'cloud',
|
|
320
|
+
capability: CLOUD_LEADERBOARD_GET_INFO_METHOD,
|
|
321
|
+
permission: 'cloud.leaderboard.info.read',
|
|
322
|
+
risk: 'low',
|
|
323
|
+
},
|
|
279
324
|
];
|
|
280
325
|
|
|
281
326
|
exports.AUTH_LOGIN_METHOD = AUTH_LOGIN_METHOD;
|
|
327
|
+
exports.CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD = CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD;
|
|
328
|
+
exports.CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD = CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD;
|
|
329
|
+
exports.CLOUD_LEADERBOARD_GET_INFO_METHOD = CLOUD_LEADERBOARD_GET_INFO_METHOD;
|
|
330
|
+
exports.CLOUD_LEADERBOARD_GET_LIST_METHOD = CLOUD_LEADERBOARD_GET_LIST_METHOD;
|
|
331
|
+
exports.CLOUD_LEADERBOARD_SUBMIT_METHOD = CLOUD_LEADERBOARD_SUBMIT_METHOD;
|
|
282
332
|
exports.DEVICE_SET_CLIPBOARD_METHOD = DEVICE_SET_CLIPBOARD_METHOD;
|
|
283
333
|
exports.DEVICE_VIBRATE_METHOD = DEVICE_VIBRATE_METHOD;
|
|
284
334
|
exports.MINI_PROGRAM_BRIDGE_NONCE_PARAM = MINI_PROGRAM_BRIDGE_NONCE_PARAM;
|
package/dist/protocol.esm.js
CHANGED
|
@@ -113,6 +113,16 @@ const NAVIGATION_CLOSE_METHOD = 'navigation.close';
|
|
|
113
113
|
const NAVIGATION_RELOAD_METHOD = 'navigation.reload';
|
|
114
114
|
/** 打开黑盒 App 页面能力方法名。 */
|
|
115
115
|
const NAVIGATION_OPEN_APP_PAGE_METHOD = 'navigation.openAppPage';
|
|
116
|
+
/** 提交当前用户排行榜分数能力方法名。 */
|
|
117
|
+
const CLOUD_LEADERBOARD_SUBMIT_METHOD = 'cloud.leaderboard.submit';
|
|
118
|
+
/** 读取排行榜列表能力方法名。 */
|
|
119
|
+
const CLOUD_LEADERBOARD_GET_LIST_METHOD = 'cloud.leaderboard.getList';
|
|
120
|
+
/** 读取当前用户排行榜记录能力方法名。 */
|
|
121
|
+
const CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD = 'cloud.leaderboard.getCurrentUserEntry';
|
|
122
|
+
/** 删除当前用户排行榜记录能力方法名。 */
|
|
123
|
+
const CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD = 'cloud.leaderboard.deleteCurrentUserEntry';
|
|
124
|
+
/** 读取排行榜基础信息能力方法名。 */
|
|
125
|
+
const CLOUD_LEADERBOARD_GET_INFO_METHOD = 'cloud.leaderboard.getInfo';
|
|
116
126
|
/**
|
|
117
127
|
* 小程序开放能力目录。
|
|
118
128
|
*
|
|
@@ -274,6 +284,41 @@ const MINI_PROGRAM_PROTOCOL_CAPABILITIES = [
|
|
|
274
284
|
permission: 'navigation.openAppPage',
|
|
275
285
|
risk: 'medium',
|
|
276
286
|
},
|
|
287
|
+
{
|
|
288
|
+
method: CLOUD_LEADERBOARD_SUBMIT_METHOD,
|
|
289
|
+
module: 'cloud',
|
|
290
|
+
capability: CLOUD_LEADERBOARD_SUBMIT_METHOD,
|
|
291
|
+
permission: 'cloud.leaderboard.write',
|
|
292
|
+
risk: 'medium',
|
|
293
|
+
},
|
|
294
|
+
{
|
|
295
|
+
method: CLOUD_LEADERBOARD_GET_LIST_METHOD,
|
|
296
|
+
module: 'cloud',
|
|
297
|
+
capability: CLOUD_LEADERBOARD_GET_LIST_METHOD,
|
|
298
|
+
permission: 'cloud.leaderboard.read',
|
|
299
|
+
risk: 'low',
|
|
300
|
+
},
|
|
301
|
+
{
|
|
302
|
+
method: CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD,
|
|
303
|
+
module: 'cloud',
|
|
304
|
+
capability: CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD,
|
|
305
|
+
permission: 'cloud.leaderboard.currentUserEntry.read',
|
|
306
|
+
risk: 'medium',
|
|
307
|
+
},
|
|
308
|
+
{
|
|
309
|
+
method: CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD,
|
|
310
|
+
module: 'cloud',
|
|
311
|
+
capability: CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD,
|
|
312
|
+
permission: 'cloud.leaderboard.currentUserEntry.delete',
|
|
313
|
+
risk: 'medium',
|
|
314
|
+
},
|
|
315
|
+
{
|
|
316
|
+
method: CLOUD_LEADERBOARD_GET_INFO_METHOD,
|
|
317
|
+
module: 'cloud',
|
|
318
|
+
capability: CLOUD_LEADERBOARD_GET_INFO_METHOD,
|
|
319
|
+
permission: 'cloud.leaderboard.info.read',
|
|
320
|
+
risk: 'low',
|
|
321
|
+
},
|
|
277
322
|
];
|
|
278
323
|
|
|
279
|
-
export { AUTH_LOGIN_METHOD, DEVICE_SET_CLIPBOARD_METHOD, DEVICE_VIBRATE_METHOD, MINI_PROGRAM_BRIDGE_NONCE_PARAM, MINI_PROGRAM_MESSAGE_NAMESPACE, MINI_PROGRAM_MESSAGE_VERSION, MINI_PROGRAM_PROTOCOL_CAPABILITIES, NAVIGATION_CLOSE_METHOD, NAVIGATION_OPEN_APP_PAGE_METHOD, NAVIGATION_RELOAD_METHOD, NETWORK_REQUEST_METHOD, SDK_HANDSHAKE_METHOD, SHARE_SCREENSHOT_METHOD, SHARE_SHOW_SHARE_MENU_METHOD, STORAGE_GET_STORAGE_METHOD, STORAGE_SET_STORAGE_METHOD, UI_HIDE_LOADING_METHOD, UI_SHOW_LOADING_METHOD, UI_SHOW_TOAST_METHOD, USER_GET_CURRENT_USER_DETAIL_METHOD, USER_GET_CURRENT_USER_PROFILE_METHOD, USER_GET_INFO_METHOD, USER_GET_PLATFORM_ACCOUNT_INFO_METHOD, USER_GET_PLATFORM_ACCOUNT_OVERVIEW_METHOD, USER_GET_STEAM_GAME_LIST_METHOD, VIEWPORT_GET_WINDOW_INFO_METHOD, VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD, isMiniProgramBridgeMessage };
|
|
324
|
+
export { AUTH_LOGIN_METHOD, CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD, CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD, CLOUD_LEADERBOARD_GET_INFO_METHOD, CLOUD_LEADERBOARD_GET_LIST_METHOD, CLOUD_LEADERBOARD_SUBMIT_METHOD, DEVICE_SET_CLIPBOARD_METHOD, DEVICE_VIBRATE_METHOD, MINI_PROGRAM_BRIDGE_NONCE_PARAM, MINI_PROGRAM_MESSAGE_NAMESPACE, MINI_PROGRAM_MESSAGE_VERSION, MINI_PROGRAM_PROTOCOL_CAPABILITIES, NAVIGATION_CLOSE_METHOD, NAVIGATION_OPEN_APP_PAGE_METHOD, NAVIGATION_RELOAD_METHOD, NETWORK_REQUEST_METHOD, SDK_HANDSHAKE_METHOD, SHARE_SCREENSHOT_METHOD, SHARE_SHOW_SHARE_MENU_METHOD, STORAGE_GET_STORAGE_METHOD, STORAGE_SET_STORAGE_METHOD, UI_HIDE_LOADING_METHOD, UI_SHOW_LOADING_METHOD, UI_SHOW_TOAST_METHOD, USER_GET_CURRENT_USER_DETAIL_METHOD, USER_GET_CURRENT_USER_PROFILE_METHOD, USER_GET_INFO_METHOD, USER_GET_PLATFORM_ACCOUNT_INFO_METHOD, USER_GET_PLATFORM_ACCOUNT_OVERVIEW_METHOD, USER_GET_STEAM_GAME_LIST_METHOD, VIEWPORT_GET_WINDOW_INFO_METHOD, VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD, isMiniProgramBridgeMessage };
|
package/package.json
CHANGED
|
@@ -38,6 +38,11 @@ export type {
|
|
|
38
38
|
} from './protocol/types';
|
|
39
39
|
export {
|
|
40
40
|
AUTH_LOGIN_METHOD,
|
|
41
|
+
CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD,
|
|
42
|
+
CLOUD_LEADERBOARD_GET_CURRENT_USER_ENTRY_METHOD,
|
|
43
|
+
CLOUD_LEADERBOARD_GET_INFO_METHOD,
|
|
44
|
+
CLOUD_LEADERBOARD_GET_LIST_METHOD,
|
|
45
|
+
CLOUD_LEADERBOARD_SUBMIT_METHOD,
|
|
41
46
|
DEVICE_SET_CLIPBOARD_METHOD,
|
|
42
47
|
DEVICE_VIBRATE_METHOD,
|
|
43
48
|
MINI_PROGRAM_PROTOCOL_CAPABILITIES,
|
|
@@ -72,6 +77,7 @@ export type {
|
|
|
72
77
|
MiniProgramCapabilityResult,
|
|
73
78
|
MiniProgramCapabilityResultMap,
|
|
74
79
|
MiniProgramCapabilityRisk,
|
|
80
|
+
MiniProgramCloudMethod,
|
|
75
81
|
MiniProgramNavigationMethod,
|
|
76
82
|
MiniProgramNetworkMethod,
|
|
77
83
|
MiniProgramShareMethod,
|
|
@@ -81,6 +87,20 @@ export type {
|
|
|
81
87
|
MiniProgramViewportMethod,
|
|
82
88
|
} from './protocol/capabilities';
|
|
83
89
|
export type { LoginPayload, LoginResult } from './modules/auth';
|
|
90
|
+
export type {
|
|
91
|
+
DeleteCurrentUserLeaderboardEntryPayload,
|
|
92
|
+
DeleteCurrentUserLeaderboardEntryResult,
|
|
93
|
+
GetCurrentUserLeaderboardEntryPayload,
|
|
94
|
+
GetCurrentUserLeaderboardEntryResult,
|
|
95
|
+
GetLeaderboardInfoPayload,
|
|
96
|
+
GetLeaderboardInfoResult,
|
|
97
|
+
GetLeaderboardListPayload,
|
|
98
|
+
GetLeaderboardListResult,
|
|
99
|
+
LeaderboardEntry,
|
|
100
|
+
LeaderboardOrder,
|
|
101
|
+
SubmitLeaderboardEntryPayload,
|
|
102
|
+
SubmitLeaderboardEntryResult,
|
|
103
|
+
} from './modules/cloud';
|
|
84
104
|
export type {
|
|
85
105
|
GetCurrentUserDetailPayload,
|
|
86
106
|
GetCurrentUserDetailResult,
|
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
## Package metadata
|
|
20
20
|
|
|
21
21
|
- Package: `@heybox/hb-sdk`
|
|
22
|
-
- Version at generation time: `0.5.
|
|
22
|
+
- Version at generation time: `0.5.11`
|
|
23
23
|
- Public root export: `@heybox/hb-sdk`
|
|
24
24
|
- Protocol export: `@heybox/hb-sdk/protocol`
|
|
25
25
|
- Vite plugin export: `@heybox/hb-sdk/vite`
|
|
@@ -30,13 +30,29 @@
|
|
|
30
30
|
export { createMiniProgramSDK, MiniProgramSDK } from './core/sdk';
|
|
31
31
|
export { HbMiniProgramSDKError, HbMiniProgramNetworkError } from './core/errors';
|
|
32
32
|
export type { MiniProgramSDKOptions } from './core/client';
|
|
33
|
-
export { ready, on, off, auth, user, share, viewport, storage, network, ui, device, navigation } from './core/singleton';
|
|
33
|
+
export { ready, on, off, auth, user, share, viewport, storage, network, ui, device, navigation, cloud } from './core/singleton';
|
|
34
34
|
export type {
|
|
35
35
|
MiniProgramEventHandler,
|
|
36
36
|
MiniProgramEventName,
|
|
37
37
|
MiniProgramEventPayloadMap,
|
|
38
38
|
} from './protocol/types';
|
|
39
39
|
export type { LoginPayload, LoginResult, MiniProgramAuthModule } from './modules/auth';
|
|
40
|
+
export type {
|
|
41
|
+
DeleteCurrentUserLeaderboardEntryPayload,
|
|
42
|
+
DeleteCurrentUserLeaderboardEntryResult,
|
|
43
|
+
GetCurrentUserLeaderboardEntryPayload,
|
|
44
|
+
GetCurrentUserLeaderboardEntryResult,
|
|
45
|
+
GetLeaderboardInfoPayload,
|
|
46
|
+
GetLeaderboardInfoResult,
|
|
47
|
+
GetLeaderboardListPayload,
|
|
48
|
+
GetLeaderboardListResult,
|
|
49
|
+
LeaderboardEntry,
|
|
50
|
+
LeaderboardOrder,
|
|
51
|
+
MiniProgramCloudLeaderboardModule,
|
|
52
|
+
MiniProgramCloudModule,
|
|
53
|
+
SubmitLeaderboardEntryPayload,
|
|
54
|
+
SubmitLeaderboardEntryResult,
|
|
55
|
+
} from './modules/cloud';
|
|
40
56
|
export type {
|
|
41
57
|
BasePlatformAccountInfo,
|
|
42
58
|
CurrentUserAvatarConfig,
|
|
@@ -157,7 +173,7 @@ export type {
|
|
|
157
173
|
ReloadResult,
|
|
158
174
|
} from './modules/navigation';
|
|
159
175
|
|
|
160
|
-
import { auth, device, navigation, network, off, on, ready, share, storage, ui, viewport, user } from './core/singleton';
|
|
176
|
+
import { auth, cloud, device, navigation, network, off, on, ready, share, storage, ui, viewport, user } from './core/singleton';
|
|
161
177
|
|
|
162
178
|
const hbSDK = {
|
|
163
179
|
ready,
|
|
@@ -172,6 +188,7 @@ const hbSDK = {
|
|
|
172
188
|
ui,
|
|
173
189
|
device,
|
|
174
190
|
navigation,
|
|
191
|
+
cloud,
|
|
175
192
|
};
|
|
176
193
|
|
|
177
194
|
export default hbSDK;
|
|
@@ -543,6 +560,49 @@ const { data } = await storage.getStorage<{ theme: string }>({
|
|
|
543
560
|
|
|
544
561
|
storage key 只允许 1-128 位字母、数字、下划线和连字符。父容器会按小程序维度隔离 key,外部小程序不能读写黑盒客户端全局 storage。
|
|
545
562
|
|
|
563
|
+
### 云端排行榜
|
|
564
|
+
|
|
565
|
+
`cloud.leaderboard` 是平台托管的远端排行榜能力,不是本地 storage,也不是通用网络请求。小程序页面不能传 `userId`;宿主和服务端会按当前登录用户注入身份。
|
|
566
|
+
|
|
567
|
+
```ts
|
|
568
|
+
import { cloud } from '@heybox/hb-sdk';
|
|
569
|
+
|
|
570
|
+
const entry = await cloud.leaderboard.submit({
|
|
571
|
+
key: 'cube_run_total',
|
|
572
|
+
score: 150,
|
|
573
|
+
extra: {
|
|
574
|
+
run: 2,
|
|
575
|
+
},
|
|
576
|
+
});
|
|
577
|
+
|
|
578
|
+
const list = await cloud.leaderboard.getList({
|
|
579
|
+
key: 'cube_run_total',
|
|
580
|
+
limit: 20,
|
|
581
|
+
});
|
|
582
|
+
|
|
583
|
+
const current = await cloud.leaderboard.getCurrentUserEntry({
|
|
584
|
+
key: 'cube_run_total',
|
|
585
|
+
});
|
|
586
|
+
|
|
587
|
+
await cloud.leaderboard.deleteCurrentUserEntry({
|
|
588
|
+
key: 'cube_run_total',
|
|
589
|
+
});
|
|
590
|
+
|
|
591
|
+
const info = await cloud.leaderboard.getInfo({
|
|
592
|
+
key: 'cube_run_total',
|
|
593
|
+
});
|
|
594
|
+
```
|
|
595
|
+
|
|
596
|
+
排行榜需要先通过管理端创建;管理端创建成功时服务端会同步准备记录集合,之后运行时可立即读写。`key` 不传时服务端会查找当前小程序已创建的 `default` 榜单,不存在时会拒绝请求,不会自动创建空榜。单个小程序最多创建 3 个排行榜,超出时服务端返回 `LEADERBOARD_LIMIT_EXCEEDED`。
|
|
597
|
+
|
|
598
|
+
`order` 在创建榜单时固定,`desc` 表示分数越大越靠前,`asc` 表示分数越小越靠前。同分时按更早更新时间优先,再按 `userId` 稳定排序。`rankLimit` 为 `0` 表示列表不限制展示名次;大于 `0` 时限制 `getList()` 展示范围。当前用户记录仍会保留,但 `submit()` 和 `getCurrentUserEntry()` 只精确计算前 5000 名,且会优先受 `rankLimit` 限制;超过 `min(rankLimit, 5000)`(`rankLimit=0` 时按 5000)时返回 `ranked: false`、`rank: 0`。
|
|
599
|
+
|
|
600
|
+
`submit()` 只在本次 `score` 更优时更新当前用户记录,并返回最终 `LeaderboardEntry`;如果分数不更优,`extra` 也不会更新。同一用户同一榜单的并发提交由服务端串行保护,锁冲突时返回 `LEADERBOARD_SUBMIT_LOCKED`,业务可稍后重试。首次提交未传 `extra` 会保存为空对象;已有记录提交更优分数但未传 `extra` 时会保留旧 `extra`,需要清空时请显式传 `{}`。`score` 必须是有限安全数字,绝对值不能超过 `Number.MAX_SAFE_INTEGER`;`extra` 必须是 JSON 对象,序列化后的 UTF-8 长度不能超过 2048 字节。
|
|
601
|
+
|
|
602
|
+
`getList()` 默认 20 条、最多 100 条;`cursor` 是服务端返回的不透明分页游标,只能把上一页返回的值原样传给下一次 `getList()`,不要解析、拼接或自行构造。非法 cursor 会按参数错误拒绝。服务端会短暂缓存榜单头部结果,当前缓存前 500 条或 `rankLimit` 范围内记录,`submit()`、`deleteCurrentUserEntry()` 和管理端删榜会触发缓存失效;业务不要依赖毫秒级实时刷新。`getInfo()` 返回 `key/order/rankLimit`,其中 `rankLimit` 不包含当前用户记录的 5000 名精确排名计算上限。
|
|
603
|
+
|
|
604
|
+
排行榜后端错误会保留为 `HbMiniProgramSDKError.code`,常见值包括 `LEADERBOARD_DEFAULT_NOT_FOUND`、`LEADERBOARD_LIMIT_EXCEEDED`、`LEADERBOARD_SUBMIT_LOCKED`、`LEADERBOARD_TABLE_NOT_READY`、`InvalidArgument`、`NotFound`、`ResourceExhausted`、`Unauthenticated`。业务可以按 `code` 区分未建榜、并发提交、数据表配置异常、参数错误、容量限制和未登录等场景。
|
|
605
|
+
|
|
546
606
|
### 网络请求
|
|
547
607
|
|
|
548
608
|
`network.request()` 提供窄化的 axios-like 接口。SDK 只接受公开请求字段,真实请求由父容器运行时映射到宿主网络能力。
|
package/skill/skill.json
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "hb-sdk",
|
|
3
|
-
"skillVersion": "0.5.
|
|
3
|
+
"skillVersion": "0.5.11+skill.20c209340580",
|
|
4
4
|
"sdk": {
|
|
5
5
|
"package": "@heybox/hb-sdk",
|
|
6
|
-
"version": "0.5.
|
|
7
|
-
"compatibility": "0.5.
|
|
6
|
+
"version": "0.5.11",
|
|
7
|
+
"compatibility": "0.5.11"
|
|
8
8
|
},
|
|
9
9
|
"source": "https://open.xiaoheihe.cn/agent-skills/hb-sdk",
|
|
10
|
-
"integrity": "sha256-
|
|
10
|
+
"integrity": "sha256-20c209340580ee5507bb72eb8cd044693b29e109472e93fc3d8302a53b4770d2"
|
|
11
11
|
}
|
package/types/core/client.d.ts
CHANGED
|
@@ -18,7 +18,7 @@ export interface MiniProgramSDKOptions {
|
|
|
18
18
|
/** 精准 postMessage 目标 origin;未传时尝试推断,失败则回退为 `*`。 */
|
|
19
19
|
targetOrigin?: string;
|
|
20
20
|
}
|
|
21
|
-
type MiniProgramRequesterArgs<Method extends MiniProgramBridgeMethod> = MiniProgramCapabilityPayload<Method> extends void ? [payload?: MiniProgramCapabilityPayload<Method>] : [payload: MiniProgramCapabilityPayload<Method>];
|
|
21
|
+
type MiniProgramRequesterArgs<Method extends MiniProgramBridgeMethod> = MiniProgramCapabilityPayload<Method> extends void ? [payload?: MiniProgramCapabilityPayload<Method>] : undefined extends MiniProgramCapabilityPayload<Method> ? [payload?: MiniProgramCapabilityPayload<Method>] : [payload: MiniProgramCapabilityPayload<Method>];
|
|
22
22
|
/** 模块 API 发起请求所需的最小能力。 */
|
|
23
23
|
export interface MiniProgramRequester {
|
|
24
24
|
/** 向父容器调用指定开放能力。 */
|
package/types/core/sdk.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { type MiniProgramSDKOptions } from './client';
|
|
2
2
|
import { type MiniProgramAuthModule } from '../modules/auth';
|
|
3
|
+
import { type MiniProgramCloudModule } from '../modules/cloud';
|
|
3
4
|
import { type MiniProgramShareModule } from '../modules/share';
|
|
4
5
|
import { type MiniProgramStorageModule } from '../modules/storage';
|
|
5
6
|
import { type MiniProgramNetworkModule } from '../modules/network';
|
|
@@ -50,6 +51,8 @@ export declare class MiniProgramSDK {
|
|
|
50
51
|
readonly device: MiniProgramDeviceModule;
|
|
51
52
|
/** 导航与容器控制相关开放能力。 */
|
|
52
53
|
readonly navigation: MiniProgramNavigationModule;
|
|
54
|
+
/** 云端数据相关开放能力。 */
|
|
55
|
+
readonly cloud: MiniProgramCloudModule;
|
|
53
56
|
constructor(options?: MiniProgramSDKOptions);
|
|
54
57
|
/**
|
|
55
58
|
* 等待 SDK 与父容器完成握手。
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import type { MiniProgramAuthModule } from '../modules/auth';
|
|
2
|
+
import type { MiniProgramCloudModule } from '../modules/cloud';
|
|
2
3
|
import type { MiniProgramShareModule } from '../modules/share';
|
|
3
4
|
import type { MiniProgramStorageModule } from '../modules/storage';
|
|
4
5
|
import type { MiniProgramNetworkModule } from '../modules/network';
|
|
@@ -49,5 +50,7 @@ export declare const ui: MiniProgramUiModule;
|
|
|
49
50
|
export declare const device: MiniProgramDeviceModule;
|
|
50
51
|
/** 默认 SDK 实例的 navigation 模块。 */
|
|
51
52
|
export declare const navigation: MiniProgramNavigationModule;
|
|
53
|
+
/** 默认 SDK 实例的 cloud 模块。 */
|
|
54
|
+
export declare const cloud: MiniProgramCloudModule;
|
|
52
55
|
/** 重置默认 SDK 实例,仅用于测试。 */
|
|
53
56
|
export declare function resetDefaultSDKForTest(): void;
|
package/types/index.d.ts
CHANGED
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
export { createMiniProgramSDK, MiniProgramSDK } from './core/sdk';
|
|
2
2
|
export { HbMiniProgramSDKError, HbMiniProgramNetworkError } from './core/errors';
|
|
3
3
|
export type { MiniProgramSDKOptions } from './core/client';
|
|
4
|
-
export { ready, on, off, auth, user, share, viewport, storage, network, ui, device, navigation } from './core/singleton';
|
|
4
|
+
export { ready, on, off, auth, user, share, viewport, storage, network, ui, device, navigation, cloud } from './core/singleton';
|
|
5
5
|
export type { MiniProgramEventHandler, MiniProgramEventName, MiniProgramEventPayloadMap, } from './protocol/types';
|
|
6
6
|
export type { LoginPayload, LoginResult, MiniProgramAuthModule } from './modules/auth';
|
|
7
|
+
export type { DeleteCurrentUserLeaderboardEntryPayload, DeleteCurrentUserLeaderboardEntryResult, GetCurrentUserLeaderboardEntryPayload, GetCurrentUserLeaderboardEntryResult, GetLeaderboardInfoPayload, GetLeaderboardInfoResult, GetLeaderboardListPayload, GetLeaderboardListResult, LeaderboardEntry, LeaderboardOrder, MiniProgramCloudLeaderboardModule, MiniProgramCloudModule, SubmitLeaderboardEntryPayload, SubmitLeaderboardEntryResult, } from './modules/cloud';
|
|
7
8
|
export type { BasePlatformAccountInfo, CurrentUserAvatarConfig, CurrentUserAvatarDecoration, CurrentUserBbsInfo, CurrentUserDetail, CurrentUserLevelInfo, CurrentUserMedal, CurrentUserProfile, EpicPlatformAccountInfo, GetCurrentUserDetailPayload, GetCurrentUserDetailResult, GetCurrentUserProfilePayload, GetCurrentUserProfileResult, GetPlatformAccountInfoPayload, GetPlatformAccountInfoResult, GetPlatformAccountOverviewPayload, GetPlatformAccountOverviewResult, GetSteamGameListOptions, GetSteamGameListPayload, GetSteamGameListResult, GetUserInfoPayload, GetUserInfoResult, MiniProgramUserInfo, MiniProgramUserInfoResult, MiniProgramUserModule, MobilePlatformAccountInfo, PcHardwareAccountInfo, PlatformAccountInfoMap, PlatformAccountOverview, PlatformAccountResult, PlatformAccountType, PlatformStatItem, PsnPlatformAccountInfo, SteamGameListData, SteamGameListItem, SteamGameListSort, SteamGamePrice, SteamPlatformAccountInfo, SwitchPlatformAccountInfo, UserScopedResult, XboxPlatformAccountInfo, } from './modules/user';
|
|
8
9
|
export type { MiniProgramScreenshotOptions, MiniProgramScreenshotRect, MiniProgramShareChannel, MiniProgramShareModule, MiniProgramShowShareMenuOptions, ScreenshotPayload, ScreenshotResult, ShowShareMenuPayload, ShowShareMenuResult, } from './modules/share';
|
|
9
10
|
export type { GetWindowInfoPayload, GetWindowInfoResult, MiniProgramNavigationBarForegroundStyle, MiniProgramSafeArea, MiniProgramSetNavigationBarStyleOptions, MiniProgramViewportModule, MiniProgramWindowInfoResult, SetNavigationBarStylePayload, SetNavigationBarStyleResult, } from './modules/viewport';
|
|
@@ -26,5 +27,6 @@ declare const hbSDK: {
|
|
|
26
27
|
ui: import(".").MiniProgramUiModule;
|
|
27
28
|
device: import(".").MiniProgramDeviceModule;
|
|
28
29
|
navigation: import(".").MiniProgramNavigationModule;
|
|
30
|
+
cloud: import(".").MiniProgramCloudModule;
|
|
29
31
|
};
|
|
30
32
|
export default hbSDK;
|
|
@@ -10,6 +10,10 @@ export declare const CREATE_USER_MINIPROGRAM_API_PATH = "/mall/developer/user_mi
|
|
|
10
10
|
export declare const DETAIL_USER_MINIPROGRAM_API_PATH = "/mall/developer/user_miniprogram/detail";
|
|
11
11
|
export declare const USER_MINIPROGRAM_PREVIEW_ALLOWLIST_API_PATH = "/mall/developer/user_miniprogram/preview_allowlist";
|
|
12
12
|
export declare const UPDATE_USER_MINIPROGRAM_PREVIEW_ALLOWLIST_API_PATH = "/mall/developer/user_miniprogram/preview_allowlist/update";
|
|
13
|
+
export declare const CREATE_USER_MINIPROGRAM_LEADERBOARD_API_PATH = "/mall/developer/user_miniprogram/leaderboard/create";
|
|
14
|
+
export declare const DETAIL_USER_MINIPROGRAM_LEADERBOARD_API_PATH = "/mall/developer/user_miniprogram/leaderboard/detail";
|
|
15
|
+
export declare const LIST_USER_MINIPROGRAM_LEADERBOARD_API_PATH = "/mall/developer/user_miniprogram/leaderboard/list";
|
|
16
|
+
export declare const DELETE_USER_MINIPROGRAM_LEADERBOARD_API_PATH = "/mall/developer/user_miniprogram/leaderboard/delete";
|
|
13
17
|
export declare const PRECHECK_USER_MINIPROGRAM_VERSION_API_PATH = "/mall/developer/user_miniprogram/version/precheck";
|
|
14
18
|
export declare const SUBMIT_USER_MINIPROGRAM_AUDIT_API_PATH = "/mall/developer/user_miniprogram/version/submit_audit";
|
|
15
19
|
export declare const USER_MINIPROGRAM_VERSION_PREVIEW_INFO_API_PATH = "/mall/developer/user_miniprogram/version/preview_info";
|