@hupu-tech/shaper 0.2.12 → 0.2.13
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/CHANGELOG.md +6 -0
- package/README.md +6 -0
- package/dist/cli.js +2 -2
- package/dist/cloud/client.d.ts +0 -1
- package/dist/cloud/service-build.d.ts +2 -4
- package/dist/index.js +1 -1
- package/dist/project/create.d.ts +9 -3
- package/dist/project/delivery.d.ts +5 -5
- package/dist/runtime.d.ts +2 -1
- package/dist/runtime.js +1 -1
- package/dist/shared-2WDEQ3AQ.js +19 -0
- package/package.json +1 -1
- package/skills/business/SKILL.md +158 -0
- package/skills/business/activity/README.md +14 -0
- package/skills/business/activity/hupu-leaderboard-template/SKILL.md +52 -0
- package/skills/business/activity/hupu-leaderboard-template/example/README.md +20 -0
- package/skills/business/activity/hupu-leaderboard-template/example/cloudfunctions/activity_api/.cloudignore +3 -0
- package/skills/business/activity/hupu-leaderboard-template/example/cloudfunctions/activity_api/index.js +218 -0
- package/skills/business/activity/hupu-leaderboard-template/example/cloudfunctions/activity_api/package.json +15 -0
- package/skills/business/activity/hupu-leaderboard-template/example/cloudfunctions/activity_api/scf_bootstrap +3 -0
- package/skills/business/activity/hupu-leaderboard-template/example/index.html +291 -0
- package/skills/business/activity/hupu-leaderboard-template/example/migrations/20260828210000_create_leaderboard.sql +54 -0
- package/skills/business/activity/hupu-lottery-draw/SKILL.md +50 -0
- package/skills/business/activity/hupu-lottery-draw/example/README.md +21 -0
- package/skills/business/activity/hupu-lottery-draw/example/cloudfunctions/activity_api/.cloudignore +3 -0
- package/skills/business/activity/hupu-lottery-draw/example/cloudfunctions/activity_api/index.js +142 -0
- package/skills/business/activity/hupu-lottery-draw/example/cloudfunctions/activity_api/package.json +9 -0
- package/skills/business/activity/hupu-lottery-draw/example/cloudfunctions/activity_api/scf_bootstrap +3 -0
- package/skills/business/activity/hupu-lottery-draw/example/index.html +178 -0
- package/skills/business/activity/hupu-lottery-draw/example/migrations/20260828220000_create_draw.sql +193 -0
- package/skills/business/activity/hupu-pk-voting/SKILL.md +54 -0
- package/skills/business/activity/hupu-pk-voting/example/README.md +44 -0
- package/skills/business/activity/hupu-pk-voting/example/cloudfunctions/activity_api/.cloudignore +3 -0
- package/skills/business/activity/hupu-pk-voting/example/cloudfunctions/activity_api/index.js +370 -0
- package/skills/business/activity/hupu-pk-voting/example/cloudfunctions/activity_api/package.json +15 -0
- package/skills/business/activity/hupu-pk-voting/example/cloudfunctions/activity_api/scf_bootstrap +2 -0
- package/skills/business/activity/hupu-pk-voting/example/index.html +729 -0
- package/skills/business/activity/hupu-pk-voting/example/migrations/20260828220000_create_pk_vote.sql +168 -0
- package/skills/business/activity/hupu-request-activity-execute-vote-task/SKILL.md +77 -0
- package/skills/business/activity/hupu-request-activity-get-vote-detail/SKILL.md +84 -0
- package/skills/business/activity/hupu-request-activity-get-vote-task-list/SKILL.md +86 -0
- package/skills/business/activity/hupu-request-activity-list-by-biz-keys/SKILL.md +153 -0
- package/skills/business/activity/hupu-request-activity-report-vote-task/SKILL.md +58 -0
- package/skills/business/activity/hupu-request-activity-submit-vote/SKILL.md +58 -0
- package/skills/business/activity/hupu-vote-task/SKILL.md +47 -0
- package/skills/business/community/README.md +13 -0
- package/skills/business/community/hupu-request-bbs-detail/SKILL.md +197 -0
- package/skills/business/community/hupu-request-bbs-get-tag-thread-list/SKILL.md +257 -0
- package/skills/business/community/hupu-request-bbs-get-topic-threads/SKILL.md +159 -0
- package/skills/business/community/hupu-request-bbs-gets-thread-post-list/SKILL.md +124 -0
- package/skills/business/community/hupu-request-bbs-open-post-editor/SKILL.md +75 -0
- package/skills/business/community/hupu-request-bbs-reply-post/SKILL.md +59 -0
- package/skills/business/community/hupu-score-add-score/SKILL.md +57 -0
- package/skills/business/community/hupu-score-get-item-detail/SKILL.md +173 -0
- package/skills/business/community/hupu-score-get-score/SKILL.md +263 -0
- package/skills/business/quality/README.md +7 -0
- package/skills/business/quality/hupu-security-check-audit/SKILL.md +39 -0
- package/skills/business/quality/hupu-wasm-compression/SKILL.md +69 -0
- package/skills/business/quality/hupu-wasm-compression/agents/openai.yaml +4 -0
- package/skills/business/quality/hupu-wasm-compression/tool/checks.mjs +90 -0
- package/skills/business/quality/hupu-wasm-compression/tool/compress-worker.mjs +40 -0
- package/skills/business/quality/hupu-wasm-compression/tool/public/app.js +84 -0
- package/skills/business/quality/hupu-wasm-compression/tool/public/index.html +80 -0
- package/skills/business/quality/hupu-wasm-compression/tool/public/style.css +3 -0
- package/skills/business/quality/hupu-wasm-compression/tool/server.mjs +126 -0
- package/skills/business/quality/hupu-web-security-audit/SKILL.md +45 -0
- package/skills/business/quality/hupu-web-security-audit/agents/openai.yaml +4 -0
- package/skills/business/rewards/README.md +13 -0
- package/skills/business/rewards/hupu-vacoin/SKILL.md +70 -0
- package/skills/business/rewards/hupu-vacoin-consume-coins/SKILL.md +47 -0
- package/skills/business/rewards/hupu-vacoin-get-coin-overview/SKILL.md +52 -0
- package/skills/business/rewards/hupu-vacoin-get-session-coins/SKILL.md +44 -0
- package/skills/business/rewards/hupu-vacoin-reset-session-id/SKILL.md +39 -0
- package/skills/business/rewards/hupu-vatask/SKILL.md +63 -0
- package/skills/business/rewards/hupu-vatask-complete-reward-video/SKILL.md +43 -0
- package/skills/business/rewards/hupu-vatask-consume-activity-chance/SKILL.md +48 -0
- package/skills/business/rewards/hupu-vatask-get-activity-task-state/SKILL.md +49 -0
- package/skills/business/runtime/README.md +13 -0
- package/skills/business/runtime/hupu-add-to-desktop/SKILL.md +51 -0
- package/skills/business/runtime/hupu-close-webview/SKILL.md +48 -0
- package/skills/business/runtime/hupu-cloud-auth/SKILL.md +43 -0
- package/skills/business/runtime/hupu-cloud-request/SKILL.md +56 -0
- package/skills/business/runtime/hupu-fullscreen-safe-top/SKILL.md +33 -0
- package/skills/business/runtime/hupu-navigate-to/SKILL.md +45 -0
- package/skills/business/runtime/hupu-request/SKILL.md +67 -0
- package/skills/business/runtime/hupu-seer-chat/SKILL.md +183 -0
- package/skills/business/runtime/hupu-track-report/SKILL.md +71 -0
- package/skills/business/sharing/README.md +7 -0
- package/skills/business/sharing/hupu-oss-upload-file/SKILL.md +40 -0
- package/skills/business/sharing/hupu-result-poster-posting/SKILL.md +37 -0
- package/skills/business/sharing/hupu-result-poster-posting/example/README.md +14 -0
- package/skills/business/sharing/hupu-result-poster-posting/example/cloudfunctions/activity_api/.cloudignore +3 -0
- package/skills/business/sharing/hupu-result-poster-posting/example/cloudfunctions/activity_api/index.js +187 -0
- package/skills/business/sharing/hupu-result-poster-posting/example/cloudfunctions/activity_api/package.json +15 -0
- package/skills/business/sharing/hupu-result-poster-posting/example/cloudfunctions/activity_api/scf_bootstrap +3 -0
- package/skills/business/sharing/hupu-result-poster-posting/example/index.html +256 -0
- package/skills/business/sharing/hupu-result-poster-posting/example/migrations/20260828213000_create_result_poster_results.sql +60 -0
- package/skills/business/sharing/hupu-result-poster-posting/references/api-contract.md +46 -0
- package/skills/business/sharing/hupu-social-share/SKILL.md +27 -0
- package/skills/business/sports/README.md +27 -0
- package/skills/business/sports/hupu-request-basketball-player-info/SKILL.md +131 -0
- package/skills/business/sports/hupu-request-basketball-single-match/SKILL.md +158 -0
- package/skills/business/sports/hupu-request-basketball-team-info/SKILL.md +96 -0
- package/skills/business/sports/hupu-request-basketball-team-player-list/SKILL.md +108 -0
- package/skills/business/sports/hupu-request-basketball-team-salary-info/SKILL.md +85 -0
- package/skills/business/sports/hupu-request-football-coach-info/SKILL.md +76 -0
- package/skills/business/sports/hupu-request-football-live-room-news-list/SKILL.md +85 -0
- package/skills/business/sports/hupu-request-football-match-info/SKILL.md +126 -0
- package/skills/business/sports/hupu-request-football-player-info/SKILL.md +82 -0
- package/skills/business/sports/hupu-request-football-team-info/SKILL.md +83 -0
- package/skills/business/sports/hupu-request-football-team-player-season-stats/SKILL.md +73 -0
- package/skills/business/sports/hupu-request-football-team-season-year/SKILL.md +68 -0
- package/skills/business/sports/hupu-request-kog-playbyplay/SKILL.md +77 -0
- package/skills/business/sports/hupu-request-live-tab-info-list/SKILL.md +85 -0
- package/skills/business/sports/hupu-request-live-tab-list/SKILL.md +66 -0
- package/skills/business/sports/hupu-request-lol-playbyplay/SKILL.md +77 -0
- package/skills/business/sports/hupu-request-match-get-tab-detail-schedule-list/SKILL.md +113 -0
- package/skills/business/sports/hupu-request-match-query-all-diagram-info-by-id/SKILL.md +79 -0
- package/skills/business/sports/hupu-request-match-query-match-stats-by-match-info/SKILL.md +85 -0
- package/skills/business/sports/hupu-request-news-news-common-list/SKILL.md +90 -0
- package/skills/business/sports/hupu-request-news-player-news-list/SKILL.md +79 -0
- package/skills/business/sports/hupu-request-news-subject-news/SKILL.md +89 -0
- package/skills/business/sports/hupu-request-news-team-news-list/SKILL.md +76 -0
- package/skills/business/storage/README.md +9 -0
- package/skills/business/storage/hupu-cloud-save/SKILL.md +129 -0
- package/skills/business/storage/hupu-cloud-save/references/legacy-migration.md +111 -0
- package/skills/business/storage/hupu-cloud-save-load/SKILL.md +41 -0
- package/skills/business/storage/hupu-cloud-save-save/SKILL.md +45 -0
- package/skills/business/storage/hupu-storage-get-value/SKILL.md +26 -0
- package/skills/business/storage/hupu-storage-set-value/SKILL.md +42 -0
- package/skills/business/user/README.md +6 -0
- package/skills/business/user/hupu-auth-get-user-info/SKILL.md +47 -0
- package/skills/business/user/hupu-game-auth/SKILL.md +46 -0
- package/skills/core/hupu-business/SKILL.md +1 -1
- package/skills/core/hupu-business/references/runtime.md +17 -11
- package/skills/core/shaper-backend/SKILL.md +1 -1
- package/skills/core/shaper-backend/references/database.md +2 -2
- package/skills/core/shaper-backend/references/legacy.md +1 -1
- package/skills/core/shaper-backend/references/node-server.md +29 -20
- package/skills/core/shaper-development/SKILL.md +5 -1
- package/skills/core/shaper-development/references/project-setup.md +1 -1
- package/skills/core/shaper-game-development/SKILL.md +1 -1
- package/skills/core/shaper-release/SKILL.md +1 -1
- package/templates/cloud-service/README.md +4 -30
- package/templates/cloud-service/cloud.json +5 -8
- package/templates/cloud-service/package-lock.json +922 -15
- package/templates/cloud-service/release.json +4 -4
- package/templates/cloud-service/server.cjs +37 -0
- package/templates/leaderboard/README.md +3 -0
- package/templates/leaderboard/cloud/database/migrations/202611130001_leaderboard.sql +6 -0
- package/templates/leaderboard/cloud/functions/api/cloud.json +10 -0
- package/templates/leaderboard/cloud/functions/api/leaderboard.cjs +49 -0
- package/templates/leaderboard/cloud/functions/api/package-lock.json +1093 -0
- package/templates/leaderboard/cloud/functions/api/package.json +19 -0
- package/templates/leaderboard/cloud/functions/api/server.cjs +25 -0
- package/templates/leaderboard/cloud/gateway/routes.json +15 -0
- package/templates/leaderboard/docs/design.md +1 -0
- package/templates/leaderboard/docs/integration.md +12 -0
- package/templates/leaderboard/docs/product.md +1 -0
- package/templates/leaderboard/docs/validation.md +1 -0
- package/templates/leaderboard/index.html +12 -0
- package/templates/leaderboard/package-lock.json +828 -0
- package/templates/leaderboard/package.json +17 -0
- package/templates/leaderboard/public/.gitkeep +1 -0
- package/templates/leaderboard/shaper.config.json +7 -0
- package/templates/leaderboard/src/main.js +67 -0
- package/templates/leaderboard/src/style.css +69 -0
- package/templates/leaderboard/test/leaderboard.test.cjs +93 -0
- package/templates/offline-game/README.md +3 -0
- package/templates/offline-game/docs/design.md +1 -0
- package/templates/offline-game/docs/integration.md +10 -0
- package/templates/offline-game/docs/product.md +1 -0
- package/templates/offline-game/docs/validation.md +1 -0
- package/templates/offline-game/index.html +1 -0
- package/templates/offline-game/package-lock.json +828 -0
- package/templates/offline-game/package.json +16 -0
- package/templates/offline-game/public/.gitkeep +1 -0
- package/templates/offline-game/shaper.config.json +7 -0
- package/templates/offline-game/src/game.js +11 -0
- package/templates/offline-game/src/main.js +12 -0
- package/templates/offline-game/src/style.css +1 -0
- package/templates/offline-game/test/game.test.js +7 -0
- package/dist/shared-APGA5MU5.js +0 -19
- package/templates/cloud-service/handlers.cjs +0 -46
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: hupu-vacoin-consume-coins
|
|
3
|
+
description: 从当前登录用户的金币余额中扣除指定数量的金币。用户身份由请求凭证解析,无需也不能传入 puid 等身份参数;发放金币是后端行为,不在本能力范围内。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Usage
|
|
7
|
+
|
|
8
|
+
- JS Path: `window.ShaperAI.vacoin.consumeCoins(params)`
|
|
9
|
+
|
|
10
|
+
# Constraints
|
|
11
|
+
|
|
12
|
+
- 必须由用户点击等明确交互触发,禁止在页面加载、渲染、循环、轮询或自动重试中调用
|
|
13
|
+
- 只允许通过 window.ShaperAI.vacoin.consumeCoins(params) 调用,禁止直接请求金币接口
|
|
14
|
+
- coins 必须是正整数;非正整数会直接返回 code 400(reason 为 INVALID_COINS)且不会发出请求
|
|
15
|
+
- SDK 不做重复消费去重,重复调用会重复扣币;消费进行中必须禁用触发按钮,一次交互只允许发起一次
|
|
16
|
+
- desc 必须使用简短固定文案,禁止拼接报错信息、模型输出等动态内容——它会出现在用户可见的金币流水中
|
|
17
|
+
- 该能力不做登录态本地校验,未登录时由后端拒绝并通过 message 返回提示
|
|
18
|
+
- 成功后应调用 window.ShaperAI.vacoin.getCoinOverview 刷新余额;失败时同样建议刷新余额再提示,避免展示与实际不一致
|
|
19
|
+
- 余额是否充足由后端裁决,禁止仅凭前端余额判断就跳过错误处理
|
|
20
|
+
|
|
21
|
+
# Parameters
|
|
22
|
+
|
|
23
|
+
| 参数名 | 类型 | 是否必填 | 说明 |
|
|
24
|
+
| --- | --- | --- | --- |
|
|
25
|
+
| coins | number | 是 | 消费的金币数量,必须是正整数 |
|
|
26
|
+
| desc | string | 否 | 消费描述,选填。会展示在用户可见的金币流水中,必须使用简短固定文案,如"抽奖消费" |
|
|
27
|
+
|
|
28
|
+
# Returns
|
|
29
|
+
|
|
30
|
+
- Type: `Promise<Response>`
|
|
31
|
+
|
|
32
|
+
### Response Properties
|
|
33
|
+
|
|
34
|
+
| 属性名 | 类型 | 是否必填 | 说明 |
|
|
35
|
+
| --- | --- | --- | --- |
|
|
36
|
+
| code | number | 是 | 状态码,200 表示扣费成功 |
|
|
37
|
+
| message | string | 是 | 成功信息或面向用户的失败提示 |
|
|
38
|
+
| data | object | 是 | 金币消费结果 |
|
|
39
|
+
| data.consumed | boolean | 是 | 是否已成功扣除金币;仅 true 代表扣费完成 |
|
|
40
|
+
| data.reason | string | 否 | 失败原因,取值:INVALID_COINS(coins 非正整数,未发出请求)、REQUEST_FAILED(请求或后端拒绝)、INVALID_RESPONSE(响应格式错误);成功时不返回 |
|
|
41
|
+
| data.backendCode | number | 否 | 后端返回的原始非零业务码,仅后端拒绝时存在 |
|
|
42
|
+
|
|
43
|
+
# Examples
|
|
44
|
+
|
|
45
|
+
```javascript
|
|
46
|
+
window.ShaperAI.vacoin.consumeCoins({ coins: 50, desc: "抽奖消费" }).then(res => { if (res.code === 200) { return window.ShaperAI.vacoin.getCoinOverview(); } console.warn(res.message); });
|
|
47
|
+
```
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: hupu-vacoin-get-coin-overview
|
|
3
|
+
description: 查询当前登录用户的金币概览,包含余额、今日获得和今日消耗。用户身份由请求凭证解析,无需也不能传入 puid 等身份参数。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Usage
|
|
7
|
+
|
|
8
|
+
- JS Path: `window.ShaperAI.vacoin.getCoinOverview()`
|
|
9
|
+
|
|
10
|
+
# Constraints
|
|
11
|
+
|
|
12
|
+
- 只允许通过 window.ShaperAI.vacoin.getCoinOverview() 调用,禁止直接请求金币接口
|
|
13
|
+
- 用户身份由后端从请求凭证解析,禁止传入 puid 或任何身份参数
|
|
14
|
+
- 在页面初始化、金币消费后或用户主动刷新时调用;禁止在循环、轮询或自动重试中高频调用
|
|
15
|
+
- 该能力不做登录态本地校验,未登录时由后端拒绝并通过 message 返回提示,页面需做好未登录兜底
|
|
16
|
+
- 失败时 data.overview 为 null,禁止把失败当成"余额为 0"展示
|
|
17
|
+
- 余额可渲染成可点击入口(如 "83747 >"),点击后用 window.ShaperAI.navigate.to({ url: "https://m.hupu.com/pdt/welfare-center" }) 打开虎扑福利中心;该 URL 是固定常量,禁止自行拼接、替换或改写,跳转本身仍需遵循 navigate.to 的约束
|
|
18
|
+
- 必须根据返回的 code 判断是否成功,若 code 不等于 200,必须使用返回的 message 对用户进行友好提示(如 Toast 或弹窗)。
|
|
19
|
+
|
|
20
|
+
# Parameters
|
|
21
|
+
|
|
22
|
+
| 参数名 | 类型 | 是否必填 | 说明 |
|
|
23
|
+
| --- | --- | --- | --- |
|
|
24
|
+
|
|
25
|
+
# Returns
|
|
26
|
+
|
|
27
|
+
- Type: `Promise<Response>`
|
|
28
|
+
|
|
29
|
+
### Response Properties
|
|
30
|
+
|
|
31
|
+
| 属性名 | 类型 | 是否必填 | 说明 |
|
|
32
|
+
| --- | --- | --- | --- |
|
|
33
|
+
| code | number | 是 | 状态码,200 表示成功 |
|
|
34
|
+
| message | string | 是 | 成功信息或面向用户的失败提示 |
|
|
35
|
+
| data | object | 是 | 金币概览结果 |
|
|
36
|
+
| data.overview | object | 是 | 金币概览;失败时为 null |
|
|
37
|
+
| data.overview.puid | number | 是 | 用户 id |
|
|
38
|
+
| data.overview.balance | number | 是 | 当前金币余额 |
|
|
39
|
+
| data.overview.todayEarned | number | 是 | 今日获得的金币数 |
|
|
40
|
+
| data.overview.todayConsumed | number | 是 | 今日消耗的金币数 |
|
|
41
|
+
| data.reason | string | 否 | 失败原因,取值:REQUEST_FAILED(请求或后端拒绝)、INVALID_RESPONSE(响应格式错误);成功时不返回 |
|
|
42
|
+
| data.backendCode | number | 否 | 后端返回的原始非零业务码,仅后端拒绝时存在 |
|
|
43
|
+
|
|
44
|
+
# Examples
|
|
45
|
+
|
|
46
|
+
```javascript
|
|
47
|
+
window.ShaperAI.vacoin.getCoinOverview().then(res => { if (res.code === 200) { console.log("余额", res.data.overview.balance); } else { console.warn(res.message); } });
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
```javascript
|
|
51
|
+
window.ShaperAI.navigate.to({ url: "https://m.hupu.com/pdt/welfare-center" })
|
|
52
|
+
```
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: hupu-vacoin-get-session-coins
|
|
3
|
+
description: 查询当前一轮玩法会话累计获得的金币数。会话 id 由 SDK 内部维护(与激励视频归因同一份),页面无需也不能传入。coins 为 0 表示本轮未获得金币,是合法结果。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Usage
|
|
7
|
+
|
|
8
|
+
- JS Path: `window.ShaperAI.vacoin.getSessionCoins()`
|
|
9
|
+
|
|
10
|
+
# Constraints
|
|
11
|
+
|
|
12
|
+
- 只允许通过 window.ShaperAI.vacoin.getSessionCoins() 调用,禁止直接请求会话金币接口
|
|
13
|
+
- 会话 id 由 SDK 内部维护,页面禁止读取、存储或作为参数传入
|
|
14
|
+
- 只在本轮玩法结束后调用一次,禁止在循环、轮询或自动重试中高频调用
|
|
15
|
+
- 成功并向用户展示结果后,必须立刻调用 window.ShaperAI.vacoin.resetSessionId 开启下一轮;不调用会导致下一轮累加本轮金币
|
|
16
|
+
- 失败时禁止调用 resetSessionId——会话 id 未变化,本轮结果仍可重试查询
|
|
17
|
+
- code 等于 200 且 data.coins 等于 0 表示本轮未获得金币,不是失败
|
|
18
|
+
- 该能力不做登录态本地校验,未登录时由后端拒绝并通过 message 返回提示
|
|
19
|
+
|
|
20
|
+
# Parameters
|
|
21
|
+
|
|
22
|
+
| 参数名 | 类型 | 是否必填 | 说明 |
|
|
23
|
+
| --- | --- | --- | --- |
|
|
24
|
+
|
|
25
|
+
# Returns
|
|
26
|
+
|
|
27
|
+
- Type: `Promise<Response>`
|
|
28
|
+
|
|
29
|
+
### Response Properties
|
|
30
|
+
|
|
31
|
+
| 属性名 | 类型 | 是否必填 | 说明 |
|
|
32
|
+
| --- | --- | --- | --- |
|
|
33
|
+
| code | number | 是 | 状态码,200 表示查询成功 |
|
|
34
|
+
| message | string | 是 | 成功信息或面向用户的失败提示 |
|
|
35
|
+
| data | object | 是 | 本轮会话金币结果 |
|
|
36
|
+
| data.coins | number | 是 | 本轮会话累计获得的金币数;0 是合法值,失败时为 null |
|
|
37
|
+
| data.reason | string | 否 | 失败原因,取值:REQUEST_FAILED(请求或后端拒绝)、INVALID_RESPONSE(响应格式错误);成功时不返回 |
|
|
38
|
+
| data.backendCode | number | 否 | 后端返回的原始非零业务码,仅后端拒绝时存在 |
|
|
39
|
+
|
|
40
|
+
# Examples
|
|
41
|
+
|
|
42
|
+
```javascript
|
|
43
|
+
window.ShaperAI.vacoin.getSessionCoins().then(res => { if (res.code === 200) { showRoundCoins(res.data.coins); window.ShaperAI.vacoin.resetSessionId(); } else { console.warn(res.message); } });
|
|
44
|
+
```
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: hupu-vacoin-reset-session-id
|
|
3
|
+
description: 结束当前一轮玩法会话并开启下一轮:重置 SDK 内部的会话 id,保留入口来源。不发起任何请求,恒定成功。重置后 vacoin.getSessionCoins 与激励视频归因都会使用新的会话 id。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Usage
|
|
7
|
+
|
|
8
|
+
- JS Path: `window.ShaperAI.vacoin.resetSessionId()`
|
|
9
|
+
|
|
10
|
+
# Constraints
|
|
11
|
+
|
|
12
|
+
- 只允许通过 window.ShaperAI.vacoin.resetSessionId() 调用
|
|
13
|
+
- 只能在 window.ShaperAI.vacoin.getSessionCoins 查询成功并向用户展示结果之后立刻调用
|
|
14
|
+
- 禁止在页面加载时、查询失败后或"以防万一"的场景调用——它会同时切换后续 vatask.completeRewardVideo 的归因会话
|
|
15
|
+
- 重置后上一轮的会话金币将无法再查询,务必先展示结果再重置
|
|
16
|
+
- 该能力不发起请求,恒定返回 code 200
|
|
17
|
+
|
|
18
|
+
# Parameters
|
|
19
|
+
|
|
20
|
+
| 参数名 | 类型 | 是否必填 | 说明 |
|
|
21
|
+
| --- | --- | --- | --- |
|
|
22
|
+
|
|
23
|
+
# Returns
|
|
24
|
+
|
|
25
|
+
- Type: `Promise<Response>`
|
|
26
|
+
|
|
27
|
+
### Response Properties
|
|
28
|
+
|
|
29
|
+
| 属性名 | 类型 | 是否必填 | 说明 |
|
|
30
|
+
| --- | --- | --- | --- |
|
|
31
|
+
| code | number | 是 | 状态码,恒为 200 |
|
|
32
|
+
| message | string | 是 | 固定为 success |
|
|
33
|
+
| data | null | 是 | 无返回数据,恒为 null |
|
|
34
|
+
|
|
35
|
+
# Examples
|
|
36
|
+
|
|
37
|
+
```javascript
|
|
38
|
+
window.ShaperAI.vacoin.resetSessionId().then(() => { startNextRound(); });
|
|
39
|
+
```
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: hupu-vatask
|
|
3
|
+
description: 为你的游戏接入激励广告变现:玩家看视频获得奖励次数,可用于抽奖或游戏内权益。零配置接入,平台自动完成活动与广告位绑定。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# 激励广告(业务介绍)
|
|
7
|
+
|
|
8
|
+
为游戏接入激励广告能力:玩家在虎扑 App 内观看一段激励视频,完整看完后获得奖励次数,可用于抽奖或兑换游戏内权益。
|
|
9
|
+
|
|
10
|
+
## 开发者接入
|
|
11
|
+
|
|
12
|
+
- 创建应用时勾选「激励广告」即可,无需任何配置;活动、广告位与奖励规则由平台自动创建和绑定
|
|
13
|
+
- 玩家在页面看到「看视频领奖励」入口和剩余次数展示
|
|
14
|
+
- 仅虎扑 App 内生效,玩家需登录后参与
|
|
15
|
+
- 广告收益按完播结算,由平台统一处理
|
|
16
|
+
|
|
17
|
+
## 实现指引(供生成代码的 AI 使用)
|
|
18
|
+
|
|
19
|
+
本能力组包含三个 `hupu-vatask` 任务能力,具体参数、返回值与约束以各子 Skill 定义为准:
|
|
20
|
+
|
|
21
|
+
| 子 Skill | JS Path | 作用 |
|
|
22
|
+
| --- | --- | --- |
|
|
23
|
+
| 完成激励视频 | `window.ShaperAI.vatask.completeRewardVideo()` | 拉起激励视频,完播后奖励到账 |
|
|
24
|
+
| 查询活动任务状态 | `window.ShaperAI.vatask.getActivityTaskState()` | 查询剩余次数与任务完成情况 |
|
|
25
|
+
| 消耗活动次数抽奖 | `window.ShaperAI.vatask.consumeActivityChance()` | 消耗一次次数并返回抽奖结果 |
|
|
26
|
+
|
|
27
|
+
活动 id 由底座配置自动注入(`SDK 内部的活动标识`),调用时无需也不能传参。
|
|
28
|
+
|
|
29
|
+
### 任务链路如何运行
|
|
30
|
+
|
|
31
|
+
1. **看广告拿奖励**:用户点击 → `completeRewardVideo()` → 原生拉起激励视频 → 完播后原生确认奖励到账 → 服务端自动增加次数。页面只负责成功后刷新状态,不可自行加次数
|
|
32
|
+
2. **查询次数**:页面初始化 / 任务完成 / 用户刷新时调用 `getActivityTaskState()` 获取剩余次数与任务状态;`taskCode` 为 `"reward"` 即激励视频任务
|
|
33
|
+
3. **消耗次数**:用户点击抽奖时调用 `consumeActivityChance()` 消耗一次并返回结果;`data.prize` 为 `null` 表示未中奖,不是失败
|
|
34
|
+
|
|
35
|
+
### 组合方式(由业务场景决定)
|
|
36
|
+
|
|
37
|
+
- **直接权益兑换**:看广告成功 → 页面发放游戏内权益,次数可不展示
|
|
38
|
+
- **抽奖玩法**:看广告得次数 → 展示剩余次数 → 抽奖消耗 → 中奖弹窗
|
|
39
|
+
- **任务墙**:展示 reward 任务与剩余次数,可叠加签到、分享等自有任务
|
|
40
|
+
|
|
41
|
+
### 通用接入骨架
|
|
42
|
+
|
|
43
|
+
```javascript
|
|
44
|
+
// 1. 页面初始化:查状态(只读)
|
|
45
|
+
const state = await window.ShaperAI.vatask.getActivityTaskState();
|
|
46
|
+
|
|
47
|
+
// 2. 用户点击"看广告":拉起激励视频
|
|
48
|
+
const res = await window.ShaperAI.vatask.completeRewardVideo();
|
|
49
|
+
if (res.code === 200 && res.data.rewarded) {
|
|
50
|
+
await window.ShaperAI.vatask.getActivityTaskState(); // 刷新状态
|
|
51
|
+
// 发放业务奖励(抽奖次数/游戏权益等)
|
|
52
|
+
} else {
|
|
53
|
+
// 按 res.message 提示;禁止自行补发奖励
|
|
54
|
+
}
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### 通用约束
|
|
58
|
+
|
|
59
|
+
- 必须由用户主动点击触发,禁止页面加载、循环、轮询或自动重试中调用
|
|
60
|
+
- 只允许通过 `window.ShaperAI.vatask.*` 调用,禁止直接调用原生 Bridge 或活动任务接口
|
|
61
|
+
- 同一时间只允许一个激励视频流程,进行中必须禁用触发按钮
|
|
62
|
+
- 失败时使用返回的 `message` 提示用户,禁止自行补发奖励
|
|
63
|
+
- 仅支持虎扑 App,暂不支持鸿蒙系统;站外调用返回 `code 403`(reason 为 `APP_REQUIRED`)
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: hupu-vatask-complete-reward-video
|
|
3
|
+
description: 在 App 内拉起激励视频广告,用户完整观看并确认奖励到账后返回成功,用于活动页发放观看奖励。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Usage
|
|
7
|
+
|
|
8
|
+
- JS Path: `window.ShaperAI.vatask.completeRewardVideo()`
|
|
9
|
+
|
|
10
|
+
# Constraints
|
|
11
|
+
|
|
12
|
+
- 必须由用户点击等明确交互触发,禁止在页面加载、渲染、循环、轮询或自动重试中调用
|
|
13
|
+
- 激励流程进行中必须禁用触发按钮;同一页面同一时间只允许一个激励视频流程
|
|
14
|
+
- 只允许通过 window.ShaperAI.vatask.completeRewardVideo() 调用,禁止直接调用原生 Bridge 或激励任务接口
|
|
15
|
+
- 活动 id 由底座配置自动注入,无需也不能通过参数传入
|
|
16
|
+
- 仅 code 等于 200 且 data.rewarded 等于 true 时,才代表原生已确认奖励到账;Bridge 的启动应答不代表获得奖励
|
|
17
|
+
- 成功后应调用 window.ShaperAI.vatask.getActivityTaskState 刷新剩余次数和任务状态;失败时使用 message 向用户提示,禁止自行补发奖励
|
|
18
|
+
- 该能力仅支持虎扑 App;鸿蒙需 App 版本不低于 8.2.41,低于该版本或版本无法识别时返回 code 422(reason 为 UNAVAILABLE);站外调用会返回 code 403(reason 为 APP_REQUIRED),由页面自行决定引导方式
|
|
19
|
+
|
|
20
|
+
# Parameters
|
|
21
|
+
|
|
22
|
+
| 参数名 | 类型 | 是否必填 | 说明 |
|
|
23
|
+
| --- | --- | --- | --- |
|
|
24
|
+
|
|
25
|
+
# Returns
|
|
26
|
+
|
|
27
|
+
- Type: `Promise<Response>`
|
|
28
|
+
|
|
29
|
+
### Response Properties
|
|
30
|
+
|
|
31
|
+
| 属性名 | 类型 | 是否必填 | 说明 |
|
|
32
|
+
| --- | --- | --- | --- |
|
|
33
|
+
| code | number | 是 | 状态码。200 表示奖励已到账;其余状态均不得视为成功 |
|
|
34
|
+
| message | string | 是 | 成功信息或面向用户的失败提示 |
|
|
35
|
+
| data | object | 是 | 激励视频执行结果 |
|
|
36
|
+
| data.rewarded | boolean | 是 | 是否已由原生回调确认奖励到账 |
|
|
37
|
+
| data.reason | string | 否 | 失败原因,取值:APP_REQUIRED(站外)、LOGIN_REQUIRED(未登录)、UNAVAILABLE(任务不可用或已完成)、NOT_REWARDED(未完整观看)、REQUEST_FAILED(任务查询失败)、REWARD_FLOW_FAILED(广告拉起失败);成功时不返回 |
|
|
38
|
+
|
|
39
|
+
# Examples
|
|
40
|
+
|
|
41
|
+
```javascript
|
|
42
|
+
window.ShaperAI.vatask.completeRewardVideo().then(res => { if (res.code === 200 && res.data.rewarded) { console.log("激励奖励已到账"); } else { console.warn(res.message); } });
|
|
43
|
+
```
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: hupu-vatask-consume-activity-chance
|
|
3
|
+
description: 消耗一次抽奖次数并返回抽奖结果,用于活动页抽奖玩法;抽奖次数可通过观看激励视频等任务获得。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Usage
|
|
7
|
+
|
|
8
|
+
- JS Path: `window.ShaperAI.vatask.consumeActivityChance()`
|
|
9
|
+
|
|
10
|
+
# Constraints
|
|
11
|
+
|
|
12
|
+
- 必须由用户点击等明确交互触发,禁止在页面加载、渲染、循环、轮询或自动重试中调用
|
|
13
|
+
- 只允许通过 window.ShaperAI.vatask.consumeActivityChance() 调用,禁止直接请求抽奖接口
|
|
14
|
+
- 活动 id 由底座配置自动注入,无需也不能通过参数传入
|
|
15
|
+
- 调用前应通过 vatask.getActivityTaskState 确认 availableChanceCount 大于 0;抽奖进行中必须禁用触发按钮
|
|
16
|
+
- code 等于 200 且 data.prize 为 null 表示本次未中奖,不是失败;失败时使用 message 向用户提示
|
|
17
|
+
- 成功后应调用 window.ShaperAI.vatask.getActivityTaskState 刷新剩余次数
|
|
18
|
+
- 该能力仅支持虎扑 App;站外调用会返回 code 403,由页面自行决定引导方式
|
|
19
|
+
|
|
20
|
+
# Parameters
|
|
21
|
+
|
|
22
|
+
| 参数名 | 类型 | 是否必填 | 说明 |
|
|
23
|
+
| --- | --- | --- | --- |
|
|
24
|
+
|
|
25
|
+
# Returns
|
|
26
|
+
|
|
27
|
+
- Type: `Promise<Response>`
|
|
28
|
+
|
|
29
|
+
### Response Properties
|
|
30
|
+
|
|
31
|
+
| 属性名 | 类型 | 是否必填 | 说明 |
|
|
32
|
+
| --- | --- | --- | --- |
|
|
33
|
+
| code | number | 是 | 状态码,200 表示抽奖完成(无论是否中奖) |
|
|
34
|
+
| message | string | 是 | 成功信息或面向用户的失败提示 |
|
|
35
|
+
| data | object | 是 | 抽奖结果;失败时为 null |
|
|
36
|
+
| data.prize | object | 是 | 中奖信息;未中奖时为 null |
|
|
37
|
+
| data.prize.id | string | 是 | 中奖记录 id |
|
|
38
|
+
| data.prize.name | string | 是 | 奖品名称 |
|
|
39
|
+
| data.prize.imageUrl | string | 否 | 奖品图片 URL,可能不存在 |
|
|
40
|
+
| data.prize.description | string | 否 | 奖品描述,可能不存在 |
|
|
41
|
+
| data.prize.actionUrl | string | 否 | 奖品后续操作跳转地址,可能不存在 |
|
|
42
|
+
| data.prize.redemptionCode | string | 否 | 兑换码,仅兑换码类奖品存在 |
|
|
43
|
+
|
|
44
|
+
# Examples
|
|
45
|
+
|
|
46
|
+
```javascript
|
|
47
|
+
window.ShaperAI.vatask.consumeActivityChance().then(res => { if (res.code === 200) { console.log(res.data.prize ? `中奖:${res.data.prize.name}` : "未中奖"); } else { console.warn(res.message); } });
|
|
48
|
+
```
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: hupu-vatask-get-activity-task-state
|
|
3
|
+
description: 查看用户当前的剩余抽奖次数与激励视频等任务完成情况,用于在活动页展示抽奖机会,并在任务完成后及时刷新状态。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Usage
|
|
7
|
+
|
|
8
|
+
- JS Path: `window.ShaperAI.vatask.getActivityTaskState()`
|
|
9
|
+
|
|
10
|
+
# Constraints
|
|
11
|
+
|
|
12
|
+
- 只允许通过 window.ShaperAI.vatask.getActivityTaskState() 调用,禁止直接请求活动任务接口
|
|
13
|
+
- 活动 id 由底座配置自动注入,无需也不能通过参数传入
|
|
14
|
+
- 在页面初始化、任务完成后或用户主动刷新时调用;禁止在循环、轮询或自动重试中高频调用
|
|
15
|
+
- tasks 中 taskCode 为 "reward" 的即激励视频任务;status 为 completed 表示本周期已完成
|
|
16
|
+
- 激励视频任务通过 window.ShaperAI.vatask.completeRewardVideo 完成,抽奖通过 window.ShaperAI.vatask.consumeActivityChance 发起
|
|
17
|
+
- 必须根据返回的 code 判断是否成功,若 code 不等于 200,必须使用返回的 message 对用户进行友好提示(如 Toast 或弹窗)。
|
|
18
|
+
|
|
19
|
+
# Parameters
|
|
20
|
+
|
|
21
|
+
| 参数名 | 类型 | 是否必填 | 说明 |
|
|
22
|
+
| --- | --- | --- | --- |
|
|
23
|
+
|
|
24
|
+
# Returns
|
|
25
|
+
|
|
26
|
+
- Type: `Promise<Response>`
|
|
27
|
+
|
|
28
|
+
### Response Properties
|
|
29
|
+
|
|
30
|
+
| 属性名 | 类型 | 是否必填 | 说明 |
|
|
31
|
+
| --- | --- | --- | --- |
|
|
32
|
+
| code | number | 是 | 状态码,200 表示成功 |
|
|
33
|
+
| message | string | 是 | 成功信息或面向用户的失败提示 |
|
|
34
|
+
| data | object | 是 | 活动任务状态;失败时为 null |
|
|
35
|
+
| data.availableChanceCount | number | 是 | 当前剩余的活动抽奖次数 |
|
|
36
|
+
| data.tasks | array | 是 | 按后端顺序返回的任务列表 |
|
|
37
|
+
| data.tasks[].id | string | 是 | 任务 id |
|
|
38
|
+
| data.tasks[].taskCode | string | 是 | 任务类型编码,激励视频任务为 "reward" |
|
|
39
|
+
| data.tasks[].title | string | 是 | 运营配置的任务标题 |
|
|
40
|
+
| data.tasks[].description | string | 否 | 任务描述,可能不存在 |
|
|
41
|
+
| data.tasks[].iconUrl | string | 否 | 任务图标 URL,可能不存在 |
|
|
42
|
+
| data.tasks[].status | string | 是 | 任务完成状态:pending 表示可完成,completed 表示本周期已完成 |
|
|
43
|
+
| data.tasks[].chanceGrantCount | number | 是 | 完成一次任务可获得的活动次数 |
|
|
44
|
+
|
|
45
|
+
# Examples
|
|
46
|
+
|
|
47
|
+
```javascript
|
|
48
|
+
window.ShaperAI.vatask.getActivityTaskState().then(res => { if (res.code === 200) { console.log("剩余次数", res.data.availableChanceCount); } else { console.warn(res.message); } });
|
|
49
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# 页面能力接入
|
|
2
|
+
|
|
3
|
+
业务请求、云请求、跳转、安全区、埋点与 AI 对话。本目录仅分类,技能内容暂不重构。
|
|
4
|
+
|
|
5
|
+
- [hupu-add-to-desktop](hupu-add-to-desktop/SKILL.md)
|
|
6
|
+
- [hupu-close-webview](hupu-close-webview/SKILL.md)
|
|
7
|
+
- [hupu-cloud-auth](hupu-cloud-auth/SKILL.md)
|
|
8
|
+
- [hupu-cloud-request](hupu-cloud-request/SKILL.md)
|
|
9
|
+
- [hupu-fullscreen-safe-top](hupu-fullscreen-safe-top/SKILL.md)
|
|
10
|
+
- [hupu-navigate-to](hupu-navigate-to/SKILL.md)
|
|
11
|
+
- [hupu-request](hupu-request/SKILL.md)
|
|
12
|
+
- [hupu-seer-chat](hupu-seer-chat/SKILL.md)
|
|
13
|
+
- [hupu-track-report](hupu-track-report/SKILL.md)
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: hupu-add-to-desktop
|
|
3
|
+
description: 在虎扑 App 内将当前游戏添加到桌面,创建桌面快捷方式。用户提到添加到桌面、加到桌面、桌面快捷方式、收藏到桌面或创建桌面入口时使用;仅在用户明确点击相关按钮后调用。游戏名称、Shell 链接、Icon 地址和是否全屏由 Shell 自动注入。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Usage
|
|
7
|
+
|
|
8
|
+
- JS Path: `window.ShaperAI.addToDesktop()`
|
|
9
|
+
|
|
10
|
+
# Constraints
|
|
11
|
+
|
|
12
|
+
- 必须使用 window.ShaperAI.addToDesktop(),底层调用 hupu.common.shortcut.add,并传递由 Shell 自动生成的 name、originalUrl、iconUrl
|
|
13
|
+
- 只允许在用户明确点击添加到桌面后调用,禁止页面加载后自动触发
|
|
14
|
+
- SDK 在调用 Bridge 前自动上报点击埋点:act=click、pg=PHBS7947、blk=BMC001、eid=535、ext.label=添加到桌面。ext.pi、ext.pl、et 和 custom 由 Shell 按 onload 同一套规则补齐,页面不要再单独打这条点击
|
|
15
|
+
- SDK 会将客户端 hasShortcut 和 result 的 true/false、1/0、字符串 true/false 和 1/0 统一为布尔值,字符串忽略大小写与首尾空格。页面对归一化结果使用严格布尔判断,不使用 Boolean(value) 或直接按真值判断;未知值归一化为 undefined,不当成成功或未添加
|
|
16
|
+
- 仅安卓:SDK 先调用 hupu.common.shortcut.check,originalUrl 由 Shell 生成为 huputiyu://webview/openencodeurl?fullscreen=0或1&url=编码后的当前链接,当前链接带 entrance=fromdesktop,fullscreen 读取 容器提供的全屏配置,缺省为 0。这条链接与添加使用的 originalUrl 相同。客户端返回 hasShortcut === true 时跳过添加,SDK 返回 data.alreadyAdded === true,页面提示已添加过,请勿重复添加;hasShortcut === false 时继续添加。检查结果无效时返回异常,不继续添加。页面无需自行调用检查 Bridge
|
|
17
|
+
- 客户端添加回调格式:成功为 { result: true },安卓(data.platform === android)提示已添加,其他系统保持静默;失败为 { result: false, errorCode, errorMsg },展示 errorMsg,缺失或为空时使用添加到桌面失败,请稍后重试。读取 SDK 返回的 data.bridgeResult,使用 result === false 判断客户端异常,不要仅凭外层 code === 200 判断客户端成功。SDK 调用异常时展示 message;添加回调为空时保持静默,不代表失败或已创建快捷方式
|
|
18
|
+
- 仅安卓添加和检查时,Shell 生成的 originalUrl 都使用 huputiyu://webview/openencodeurl 开头,fullscreen 读取 容器提供的全屏配置,缺省为 0;编码后的页面地址带 entrance=fromdesktop,不走 shortcut=prepare,从桌面打开时由虎扑 App 打开游戏页。iOS 添加仍只追加 shortcut=prepare,通用 bridge 不修改传入链接;Safari 首次打开 shortcut=prepare 时不加载游戏,展示添加到主屏幕引导页,并把地址栏更新为 entrance=fromdesktop,用户添加到主屏幕后再次打开才进入简单页面,并按 Shell 的 容器提供的全屏配置 拼接 huputiyu://webview/openencodeurl 跳转虎扑 App
|
|
19
|
+
- 非 App / 无 Bridge 环境可能不会真正添加到桌面,业务代码需做好 Web 预览环境下的降级表现
|
|
20
|
+
|
|
21
|
+
# Parameters
|
|
22
|
+
|
|
23
|
+
| 参数名 | 类型 | 是否必填 | 说明 |
|
|
24
|
+
| --- | --- | --- | --- |
|
|
25
|
+
|
|
26
|
+
# Returns
|
|
27
|
+
|
|
28
|
+
- Type: `Promise<Response>`
|
|
29
|
+
|
|
30
|
+
### Response Properties
|
|
31
|
+
|
|
32
|
+
| 属性名 | 类型 | 是否必填 | 说明 |
|
|
33
|
+
| --- | --- | --- | --- |
|
|
34
|
+
| code | number | 是 | 状态码,200 表示正常返回,不代表快捷方式已创建;安卓可能因已添加而跳过添加调用 |
|
|
35
|
+
| message | string | 是 | 调用结果信息,正常时不展示,仅异常时用于错误提示 |
|
|
36
|
+
| data | object | 否 | Bridge 调用信息 |
|
|
37
|
+
| data.channel | string | 否 | 实际调用通道,固定为 bridge |
|
|
38
|
+
| data.method | string | 否 | 底层 Native Bridge 方法名,添加时为 hupu.common.shortcut.add,安卓已添加时为 hupu.common.shortcut.check |
|
|
39
|
+
| data.platform | string | 否 | android 表示安卓,other 表示其他系统;安卓才展示已添加过,请勿重复添加或已添加提示 |
|
|
40
|
+
| data.alreadyAdded | boolean | 否 | 安卓检查到已有快捷方式时为 true,此时未调用添加 Bridge |
|
|
41
|
+
| data.bridgeResult | object | 否 | 客户端回调结果;安卓已添加时为检查结果,否则为添加结果。添加 result 为 true 时安卓提示已添加,其他系统静默;为 false 时展示 errorMsg;为空时静默 |
|
|
42
|
+
| data.bridgeResult.hasShortcut | boolean | 否 | 安卓检查结果,true 表示已有桌面快捷方式 |
|
|
43
|
+
| data.bridgeResult.result | boolean | 否 | 客户端操作结果,true 表示成功,false 表示失败 |
|
|
44
|
+
| data.bridgeResult.errorCode | number | 否 | 失败时返回的客户端错误码 |
|
|
45
|
+
| data.bridgeResult.errorMsg | string | 否 | 失败时展示的客户端错误信息,可能为空,需提供默认错误提示 |
|
|
46
|
+
|
|
47
|
+
# Examples
|
|
48
|
+
|
|
49
|
+
```javascript
|
|
50
|
+
window.ShaperAI.addToDesktop().then(res => { if (res.code !== 200) { alert(res.message || "添加到桌面失败,请稍后重试"); return; } const data = res.data; if (data?.platform === "android" && data.alreadyAdded === true) { alert("已添加过,请勿重复添加"); return; } const callback = data?.bridgeResult; if (callback?.result === false) { alert(callback.errorMsg || "添加到桌面失败,请稍后重试"); } else if (data?.platform === "android" && callback?.result === true) { alert("已添加"); } }).catch(() => { alert("添加到桌面失败,请稍后重试"); })
|
|
51
|
+
```
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: hupu-close-webview
|
|
3
|
+
description: 在虎扑 App 内关闭当前活动页 WebView。适用于提交成功、任务完成、用户点击关闭按钮等明确交互后的页面收起场景。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Usage
|
|
7
|
+
|
|
8
|
+
- JS Path: `window.ShaperAI.closeWebview(params)`
|
|
9
|
+
|
|
10
|
+
# Constraints
|
|
11
|
+
|
|
12
|
+
- 必须使用 window.ShaperAI.closeWebview({ channel: "bridge" }),严禁直接调用 window.HupuBridge、webkit.messageHandlers、androidBridge 或自行拼接 Bridge 参数
|
|
13
|
+
- 底层固定调用 hupu.ui.pageclose,并通过 Shaper AI shell bridge 代理链路执行
|
|
14
|
+
- 只允许在用户点击关闭、完成、返回等明确交互后调用,禁止页面加载后自动关闭 WebView
|
|
15
|
+
- 调用前如果需要埋点,必须先调用 window.ShaperAI.track(params),再调用 hupu-close-webview
|
|
16
|
+
- 非 App / 无 Bridge 环境可能不会真正关闭页面,业务代码需做好 Web 预览环境下的降级表现
|
|
17
|
+
- 必须根据返回的 code 判断是否成功,若 code 不等于 200,必须使用返回的 message 对用户进行友好提示(如 Toast 或弹窗)。
|
|
18
|
+
|
|
19
|
+
# Parameters
|
|
20
|
+
|
|
21
|
+
| 参数名 | 类型 | 是否必填 | 说明 |
|
|
22
|
+
| --- | --- | --- | --- |
|
|
23
|
+
| channel | string | 否 | 调用通道,固定使用 bridge。默认值为 bridge,可显式传入 "bridge"。 |
|
|
24
|
+
|
|
25
|
+
# Returns
|
|
26
|
+
|
|
27
|
+
- Type: `Promise<Response>`
|
|
28
|
+
|
|
29
|
+
### Response Properties
|
|
30
|
+
|
|
31
|
+
| 属性名 | 类型 | 是否必填 | 说明 |
|
|
32
|
+
| --- | --- | --- | --- |
|
|
33
|
+
| code | number | 是 | 状态码,200 表示已发起关闭 WebView 的 Bridge 调用 |
|
|
34
|
+
| message | string | 是 | 提示信息 |
|
|
35
|
+
| data | object | 否 | Bridge 调用信息 |
|
|
36
|
+
| data.channel | string | 否 | 实际调用通道,固定为 bridge |
|
|
37
|
+
| data.method | string | 否 | 底层 Native Bridge 方法名,固定为 hupu.ui.pageclose |
|
|
38
|
+
| data.bridgeResult | object | 否 | 客户端 Bridge 回调结果;WebView 关闭成功时可能不会返回有效值 |
|
|
39
|
+
|
|
40
|
+
# Examples
|
|
41
|
+
|
|
42
|
+
```javascript
|
|
43
|
+
window.ShaperAI.closeWebview({ channel: "bridge" }).then(res => { if (res.code !== 200) { console.warn(res.message); } })
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
```javascript
|
|
47
|
+
function handleDoneClick() { window.ShaperAI.track({ act: "click", blk: "BMC001", pos: "T1" }); window.ShaperAI.closeWebview({ channel: "bridge" }); }
|
|
48
|
+
```
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: hupu-cloud-auth
|
|
3
|
+
description: SDK 内部换票:用当前虎扑登录态换取活动 CloudBase Bearer。H5 访问需登录的云函数时使用 cloud.request({ auth: true, envId })。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Usage
|
|
7
|
+
|
|
8
|
+
- JS Path: `window.ShaperAI.cloud.auth(params)`
|
|
9
|
+
|
|
10
|
+
# Constraints
|
|
11
|
+
|
|
12
|
+
- H5 使用 window.ShaperAI.cloud.request({ auth: true, envId }),由 SDK 完成登录
|
|
13
|
+
- envId 必须是活动环境的腾讯云 EnvId
|
|
14
|
+
- 禁止 H5 自行处理 ticket、私钥或直连 signin/custom
|
|
15
|
+
- body / query 禁止传 puid 或任何客户端自报身份字段
|
|
16
|
+
- 必须根据返回的 code 判断是否成功,若 code 不等于 200,必须使用返回的 message 对用户进行友好提示(如 Toast 或弹窗)。
|
|
17
|
+
|
|
18
|
+
# Parameters
|
|
19
|
+
|
|
20
|
+
| 参数名 | 类型 | 是否必填 | 说明 |
|
|
21
|
+
| --- | --- | --- | --- |
|
|
22
|
+
| envId | string | 是 | 活动 CloudBase 环境 ID(腾讯云 EnvId,非 alias) |
|
|
23
|
+
|
|
24
|
+
# Returns
|
|
25
|
+
|
|
26
|
+
- Type: `Promise<Response>`
|
|
27
|
+
|
|
28
|
+
### Response Properties
|
|
29
|
+
|
|
30
|
+
| 属性名 | 类型 | 是否必填 | 说明 |
|
|
31
|
+
| --- | --- | --- | --- |
|
|
32
|
+
| code | number | 是 | 状态码,成功为 200 |
|
|
33
|
+
| message | string | 是 | 提示信息 |
|
|
34
|
+
| data | object | 否 | |
|
|
35
|
+
| data.expiresIn | number | 否 | 有效期(秒) |
|
|
36
|
+
| data.envId | string | 否 | 活动环境 EnvId |
|
|
37
|
+
| data.customUserId | string | 否 | 自定义登录用户 ID(通常为虎扑 puid) |
|
|
38
|
+
|
|
39
|
+
# Examples
|
|
40
|
+
|
|
41
|
+
```javascript
|
|
42
|
+
window.ShaperAI.cloud.request({ url: window.ACTIVITY_API_BASE + "/vote", method: "POST", data: { candidateId: "xxx" }, envId: window.ACTIVITY_ENV_ID, auth: true })
|
|
43
|
+
```
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: hupu-cloud-request
|
|
3
|
+
description: 新版 Shaper 应用使用 path 调用已部署路由,SDK 按路由处理玩家登录。旧活动保留 url + envId 调用,两种参数不可混用。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Usage
|
|
7
|
+
|
|
8
|
+
- JS Path: `window.ShaperAI.cloud.request(params)`
|
|
9
|
+
|
|
10
|
+
# Constraints
|
|
11
|
+
|
|
12
|
+
- CloudBase 活动接口必须使用 window.ShaperAI.cloud.request,禁止手写 fetch 拼 Bearer
|
|
13
|
+
- 新版 path 只传 path、method、data;路由决定是否登录,壳提供应用与服务配置,禁止自行填写 Token
|
|
14
|
+
- 旧 url 调用保持原协议:用户接口传 auth:true 与 envId;不得将旧参数带入 path 调用
|
|
15
|
+
- body / query 禁止传 puid 或任何客户端自报身份字段
|
|
16
|
+
- 普通虎扑业务接口继续用 window.ShaperAI.request,不要混用
|
|
17
|
+
- 必须根据返回的 code 判断是否成功,若 code 不等于 200,必须使用返回的 message 对用户进行友好提示(如 Toast 或弹窗)。
|
|
18
|
+
|
|
19
|
+
# Parameters
|
|
20
|
+
|
|
21
|
+
| 参数名 | 类型 | 是否必填 | 说明 |
|
|
22
|
+
| --- | --- | --- | --- |
|
|
23
|
+
| path | string | 否 | 新版应用相对路径,例如 /api/progress;只与 method、data 一起使用 |
|
|
24
|
+
| url | string | 否 | 完整请求 URL(通常为 ACTIVITY_API_BASE + path) |
|
|
25
|
+
| method | string | 否 | 默认 GET;path 支持 GET/POST/PUT/PATCH/DELETE/HEAD,旧 url 支持 GET/POST |
|
|
26
|
+
| headers | object | 否 | 自定义请求头,可选 |
|
|
27
|
+
| data | object | 否 | 请求数据;GET 作为 query,POST 作为 JSON body,可选 |
|
|
28
|
+
| envId | string | 否 | 活动 EnvId;auth 为 true 或需要自动登录时必填 |
|
|
29
|
+
| auth | boolean | 否 | 是否要求登录。true 时若无登录态会由 SDK 自动完成登录;默认 false |
|
|
30
|
+
|
|
31
|
+
# Returns
|
|
32
|
+
|
|
33
|
+
- Type: `Promise<Response>`
|
|
34
|
+
|
|
35
|
+
### Response Properties
|
|
36
|
+
|
|
37
|
+
| 属性名 | 类型 | 是否必填 | 说明 |
|
|
38
|
+
| --- | --- | --- | --- |
|
|
39
|
+
| statusCode | number | 是 | HTTP 状态码 |
|
|
40
|
+
| code | string | 否 | 业务码或 SDK 错误码 |
|
|
41
|
+
| message | string | 否 | 提示信息 |
|
|
42
|
+
| data | object | 否 | 响应 data 字段或完整 JSON |
|
|
43
|
+
|
|
44
|
+
# Examples
|
|
45
|
+
|
|
46
|
+
```javascript
|
|
47
|
+
window.ShaperAI.cloud.request({ path: "/api/progress", method: "POST", data: { score: 100 } }).then(res => console.log(res));
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
```javascript
|
|
51
|
+
window.ShaperAI.cloud.request({ url: window.ACTIVITY_API_BASE + "/candidates" }).then(res => console.log(res.data));
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
```javascript
|
|
55
|
+
window.ShaperAI.cloud.request({ url: window.ACTIVITY_API_BASE + "/vote", method: "POST", data: { candidateId: "xxx" }, envId: window.ACTIVITY_ENV_ID, auth: true }).then(res => console.log(res));
|
|
56
|
+
```
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: hupu-fullscreen-safe-top
|
|
3
|
+
description: 获取全屏活动 H5 的顶部安全距离,用于自定义头部、顶部固定按钮和页面内容避让状态栏或刘海。
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Usage
|
|
7
|
+
|
|
8
|
+
- JS Path: `window.ShaperAI.getFullscreenSafeTop()`
|
|
9
|
+
|
|
10
|
+
# Constraints
|
|
11
|
+
|
|
12
|
+
- 同步调用 window.ShaperAI.getFullscreenSafeTop(),无需参数,直接返回数字,单位为 CSS px,可直接用于 height、padding-top 或 top。
|
|
13
|
+
- 游戏启动时按固定全屏页面使用;仅在宿主未预留顶部空间时应用,同一内容只避让一次。
|
|
14
|
+
- 返回值可直接使用,无需自行计算或换算单位;无法获取安全距离时返回 0。
|
|
15
|
+
- 在 SDK 就绪后调用;游戏启动时读取一次即可,不要高频轮询。
|
|
16
|
+
|
|
17
|
+
# Parameters
|
|
18
|
+
|
|
19
|
+
| 参数名 | 类型 | 是否必填 | 说明 |
|
|
20
|
+
| --- | --- | --- | --- |
|
|
21
|
+
|
|
22
|
+
# Returns
|
|
23
|
+
|
|
24
|
+
- Type: `number`
|
|
25
|
+
|
|
26
|
+
顶部安全距离,单位 CSS px,非负数;无法获取时返回 0。
|
|
27
|
+
|
|
28
|
+
# Examples
|
|
29
|
+
|
|
30
|
+
```javascript
|
|
31
|
+
const height = window.ShaperAI.getFullscreenSafeTop();
|
|
32
|
+
document.querySelector(".header").style.height = `${height}px`;
|
|
33
|
+
```
|