@heybox/hb-sdk-protocol 0.7.4-alpha.4 → 0.7.4-alpha.5

package/dist/index.cjs.js

@@ -4,6 +4,7 @@ const AUTH_LOGIN_METHOD = 'auth.login';
 const USER_GET_INFO_METHOD = 'user.getInfo';
 const USER_REVOKE_AUTHORIZATION_METHOD = 'user.revokeAuthorization';
 const USER_GET_STEAM_GAME_LIST_METHOD = 'user.getSteamGameList';
+const SHARE_COPY_LINK_METHOD = 'share.copyLink';
 const SHARE_SHOW_SHARE_MENU_METHOD = 'share.showShareMenu';
 const SHARE_SCREENSHOT_METHOD = 'share.screenshot';
 const VIEWPORT_GET_WINDOW_INFO_METHOD = 'viewport.getWindowInfo';
@@ -41,6 +42,7 @@ const MINI_PROGRAM_PROTOCOL_CAPABILITIES = [
         permission: 'user.platformAccount.steam',
         risk: 'high',
     },
+    { method: SHARE_COPY_LINK_METHOD, module: 'share', capability: SHARE_COPY_LINK_METHOD, permission: 'share.copyLink', risk: 'medium' },
     { method: SHARE_SHOW_SHARE_MENU_METHOD, module: 'share', capability: SHARE_SHOW_SHARE_MENU_METHOD, permission: 'share.basic', risk: 'low' },
     { method: SHARE_SCREENSHOT_METHOD, module: 'share', capability: SHARE_SCREENSHOT_METHOD, permission: 'share.screenshot', risk: 'medium' },
     {
@@ -197,6 +199,7 @@ exports.RUNTIME_LOCATION_PROBE_METHOD = RUNTIME_LOCATION_PROBE_METHOD;
 exports.SDK_CSP_VIOLATION_METHOD = SDK_CSP_VIOLATION_METHOD;
 exports.SDK_HANDSHAKE_METHOD = SDK_HANDSHAKE_METHOD;
 exports.SDK_LOCATION_REPORT_METHOD = SDK_LOCATION_REPORT_METHOD;
+exports.SHARE_COPY_LINK_METHOD = SHARE_COPY_LINK_METHOD;
 exports.SHARE_SCREENSHOT_METHOD = SHARE_SCREENSHOT_METHOD;
 exports.SHARE_SHOW_SHARE_MENU_METHOD = SHARE_SHOW_SHARE_MENU_METHOD;
 exports.STORAGE_GET_STORAGE_METHOD = STORAGE_GET_STORAGE_METHOD;

package/dist/index.esm.js

@@ -2,6 +2,7 @@ const AUTH_LOGIN_METHOD = 'auth.login';
 const USER_GET_INFO_METHOD = 'user.getInfo';
 const USER_REVOKE_AUTHORIZATION_METHOD = 'user.revokeAuthorization';
 const USER_GET_STEAM_GAME_LIST_METHOD = 'user.getSteamGameList';
+const SHARE_COPY_LINK_METHOD = 'share.copyLink';
 const SHARE_SHOW_SHARE_MENU_METHOD = 'share.showShareMenu';
 const SHARE_SCREENSHOT_METHOD = 'share.screenshot';
 const VIEWPORT_GET_WINDOW_INFO_METHOD = 'viewport.getWindowInfo';
@@ -39,6 +40,7 @@ const MINI_PROGRAM_PROTOCOL_CAPABILITIES = [
         permission: 'user.platformAccount.steam',
         risk: 'high',
     },
+    { method: SHARE_COPY_LINK_METHOD, module: 'share', capability: SHARE_COPY_LINK_METHOD, permission: 'share.copyLink', risk: 'medium' },
     { method: SHARE_SHOW_SHARE_MENU_METHOD, module: 'share', capability: SHARE_SHOW_SHARE_MENU_METHOD, permission: 'share.basic', risk: 'low' },
     { method: SHARE_SCREENSHOT_METHOD, module: 'share', capability: SHARE_SCREENSHOT_METHOD, permission: 'share.screenshot', risk: 'medium' },
     {
@@ -175,4 +177,4 @@ function isRecord(value) {
     return typeof value === 'object' && value !== null && !Array.isArray(value);
 }
 
-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, RUNTIME_LOCATION_PROBE_METHOD, SDK_CSP_VIOLATION_METHOD, SDK_HANDSHAKE_METHOD, SDK_LOCATION_REPORT_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_INFO_METHOD, USER_GET_STEAM_GAME_LIST_METHOD, USER_INFO_AUTHORIZATION_SCOPES, USER_REVOKE_AUTHORIZATION_METHOD, VIEWPORT_GET_WINDOW_INFO_METHOD, VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD, isManagedMiniProgramRuntimePermissionKey, isMiniProgramBridgeMessage, parseMiniProgramRuntimePermissions };
+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, RUNTIME_LOCATION_PROBE_METHOD, SDK_CSP_VIOLATION_METHOD, SDK_HANDSHAKE_METHOD, SDK_LOCATION_REPORT_METHOD, SHARE_COPY_LINK_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_INFO_METHOD, USER_GET_STEAM_GAME_LIST_METHOD, USER_INFO_AUTHORIZATION_SCOPES, USER_REVOKE_AUTHORIZATION_METHOD, VIEWPORT_GET_WINDOW_INFO_METHOD, VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD, isManagedMiniProgramRuntimePermissionKey, isMiniProgramBridgeMessage, parseMiniProgramRuntimePermissions };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@heybox/hb-sdk-protocol",
-  "version": "0.7.4-alpha.4",
+  "version": "0.7.4-alpha.5",
   "description": "Heybox mini-program iframe bridge wire contracts.",
   "sideEffects": false,
   "exports": {

package/src/capabilities.ts

@@ -1,6 +1,8 @@
 import type {
   ClosePayload,
   CloseResult,
+  CopyLinkPayload,
+  CopyLinkResult,
   DeleteCurrentUserLeaderboardEntryPayload,
   DeleteCurrentUserLeaderboardEntryResult,
   GetCurrentUserLeaderboardEntryPayload,
@@ -50,6 +52,7 @@ export const AUTH_LOGIN_METHOD = 'auth.login' as const;
 export const USER_GET_INFO_METHOD = 'user.getInfo' as const;
 export const USER_REVOKE_AUTHORIZATION_METHOD = 'user.revokeAuthorization' as const;
 export const USER_GET_STEAM_GAME_LIST_METHOD = 'user.getSteamGameList' as const;
+export const SHARE_COPY_LINK_METHOD = 'share.copyLink' as const;
 export const SHARE_SHOW_SHARE_MENU_METHOD = 'share.showShareMenu' as const;
 export const SHARE_SCREENSHOT_METHOD = 'share.screenshot' as const;
 export const VIEWPORT_GET_WINDOW_INFO_METHOD = 'viewport.getWindowInfo' as const;
@@ -73,7 +76,7 @@ export const CLOUD_LEADERBOARD_GET_INFO_METHOD = 'cloud.leaderboard.getInfo' as
 
 export type MiniProgramAuthMethod = typeof AUTH_LOGIN_METHOD;
 export type MiniProgramUserMethod = typeof USER_GET_INFO_METHOD | typeof USER_REVOKE_AUTHORIZATION_METHOD | typeof USER_GET_STEAM_GAME_LIST_METHOD;
-export type MiniProgramShareMethod = typeof SHARE_SHOW_SHARE_MENU_METHOD | typeof SHARE_SCREENSHOT_METHOD;
+export type MiniProgramShareMethod = typeof SHARE_COPY_LINK_METHOD | typeof SHARE_SHOW_SHARE_MENU_METHOD | typeof SHARE_SCREENSHOT_METHOD;
 export type MiniProgramViewportMethod = typeof VIEWPORT_GET_WINDOW_INFO_METHOD | typeof VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD;
 export type MiniProgramStorageMethod = typeof STORAGE_GET_STORAGE_METHOD | typeof STORAGE_SET_STORAGE_METHOD;
 export type MiniProgramNetworkMethod = typeof NETWORK_REQUEST_METHOD;
@@ -125,6 +128,7 @@ export const MINI_PROGRAM_PROTOCOL_CAPABILITIES = [
     permission: 'user.platformAccount.steam',
     risk: 'high',
   },
+  { method: SHARE_COPY_LINK_METHOD, module: 'share', capability: SHARE_COPY_LINK_METHOD, permission: 'share.copyLink', risk: 'medium' },
   { method: SHARE_SHOW_SHARE_MENU_METHOD, module: 'share', capability: SHARE_SHOW_SHARE_MENU_METHOD, permission: 'share.basic', risk: 'low' },
   { method: SHARE_SCREENSHOT_METHOD, module: 'share', capability: SHARE_SCREENSHOT_METHOD, permission: 'share.screenshot', risk: 'medium' },
   {
@@ -206,6 +210,7 @@ export interface MiniProgramCapabilityPayloadMap {
   [USER_GET_INFO_METHOD]: GetUserInfoPayload;
   [USER_REVOKE_AUTHORIZATION_METHOD]: void;
   [USER_GET_STEAM_GAME_LIST_METHOD]: GetSteamGameListPayload;
+  [SHARE_COPY_LINK_METHOD]: CopyLinkPayload;
   [SHARE_SHOW_SHARE_MENU_METHOD]: ShowShareMenuPayload;
   [SHARE_SCREENSHOT_METHOD]: ScreenshotPayload;
   [VIEWPORT_GET_WINDOW_INFO_METHOD]: GetWindowInfoPayload;
@@ -233,6 +238,7 @@ export interface MiniProgramCapabilityResultMap {
   [USER_GET_INFO_METHOD]: GetUserInfoResult;
   [USER_REVOKE_AUTHORIZATION_METHOD]: void;
   [USER_GET_STEAM_GAME_LIST_METHOD]: GetSteamGameListResult;
+  [SHARE_COPY_LINK_METHOD]: CopyLinkResult;
   [SHARE_SHOW_SHARE_MENU_METHOD]: ShowShareMenuResult;
   [SHARE_SCREENSHOT_METHOD]: ScreenshotResult;
   [VIEWPORT_GET_WINDOW_INFO_METHOD]: GetWindowInfoResult;

package/src/payloads.ts

@@ -117,11 +117,14 @@ export type ShowShareMenuPayload = {
   title: string;
   desc: string;
   url?: string;
+  extra?: unknown;
   imageUrl?: string;
   channel?: MiniProgramShareChannel;
   post?: MiniProgramSharePostOptions | null;
 };
 export type ShowShareMenuResult = unknown;
+export type CopyLinkPayload = { extra?: unknown } | undefined;
+export type CopyLinkResult = string;
 export type ScreenshotPayload =
   | {
       rect?: MiniProgramScreenshotRect;

package/types/capabilities.d.ts

@@ -1,8 +1,9 @@
-import type { ClosePayload, CloseResult, DeleteCurrentUserLeaderboardEntryPayload, DeleteCurrentUserLeaderboardEntryResult, GetCurrentUserLeaderboardEntryPayload, GetCurrentUserLeaderboardEntryResult, GetLeaderboardInfoPayload, GetLeaderboardInfoResult, GetLeaderboardListPayload, GetLeaderboardListResult, GetStoragePayload, GetStorageResult, GetSteamGameListPayload, GetSteamGameListResult, GetUserInfoPayload, GetUserInfoResult, GetWindowInfoPayload, GetWindowInfoResult, HideLoadingPayload, HideLoadingResult, LoginPayload, LoginResult, NetworkRequestPayload, NetworkResponsePayload, OpenAppPagePayload, OpenAppPageResult, ReloadPayload, ReloadResult, ScreenshotPayload, ScreenshotResult, SetClipboardPayload, SetClipboardResult, SetNavigationBarStylePayload, SetNavigationBarStyleResult, SetStoragePayload, ShowLoadingPayload, ShowLoadingResult, ShowShareMenuPayload, ShowShareMenuResult, ShowToastPayload, ShowToastResult, SubmitLeaderboardEntryPayload, SubmitLeaderboardEntryResult, VibratePayload, VibrateResult } from './payloads';
+import type { ClosePayload, CloseResult, CopyLinkPayload, CopyLinkResult, DeleteCurrentUserLeaderboardEntryPayload, DeleteCurrentUserLeaderboardEntryResult, GetCurrentUserLeaderboardEntryPayload, GetCurrentUserLeaderboardEntryResult, GetLeaderboardInfoPayload, GetLeaderboardInfoResult, GetLeaderboardListPayload, GetLeaderboardListResult, GetStoragePayload, GetStorageResult, GetSteamGameListPayload, GetSteamGameListResult, GetUserInfoPayload, GetUserInfoResult, GetWindowInfoPayload, GetWindowInfoResult, HideLoadingPayload, HideLoadingResult, LoginPayload, LoginResult, NetworkRequestPayload, NetworkResponsePayload, OpenAppPagePayload, OpenAppPageResult, ReloadPayload, ReloadResult, ScreenshotPayload, ScreenshotResult, SetClipboardPayload, SetClipboardResult, SetNavigationBarStylePayload, SetNavigationBarStyleResult, SetStoragePayload, ShowLoadingPayload, ShowLoadingResult, ShowShareMenuPayload, ShowShareMenuResult, ShowToastPayload, ShowToastResult, SubmitLeaderboardEntryPayload, SubmitLeaderboardEntryResult, VibratePayload, VibrateResult } from './payloads';
 export declare const AUTH_LOGIN_METHOD: "auth.login";
 export declare const USER_GET_INFO_METHOD: "user.getInfo";
 export declare const USER_REVOKE_AUTHORIZATION_METHOD: "user.revokeAuthorization";
 export declare const USER_GET_STEAM_GAME_LIST_METHOD: "user.getSteamGameList";
+export declare const SHARE_COPY_LINK_METHOD: "share.copyLink";
 export declare const SHARE_SHOW_SHARE_MENU_METHOD: "share.showShareMenu";
 export declare const SHARE_SCREENSHOT_METHOD: "share.screenshot";
 export declare const VIEWPORT_GET_WINDOW_INFO_METHOD: "viewport.getWindowInfo";
@@ -25,7 +26,7 @@ export declare const CLOUD_LEADERBOARD_DELETE_CURRENT_USER_ENTRY_METHOD: "cloud.
 export declare const CLOUD_LEADERBOARD_GET_INFO_METHOD: "cloud.leaderboard.getInfo";
 export type MiniProgramAuthMethod = typeof AUTH_LOGIN_METHOD;
 export type MiniProgramUserMethod = typeof USER_GET_INFO_METHOD | typeof USER_REVOKE_AUTHORIZATION_METHOD | typeof USER_GET_STEAM_GAME_LIST_METHOD;
-export type MiniProgramShareMethod = typeof SHARE_SHOW_SHARE_MENU_METHOD | typeof SHARE_SCREENSHOT_METHOD;
+export type MiniProgramShareMethod = typeof SHARE_COPY_LINK_METHOD | typeof SHARE_SHOW_SHARE_MENU_METHOD | typeof SHARE_SCREENSHOT_METHOD;
 export type MiniProgramViewportMethod = typeof VIEWPORT_GET_WINDOW_INFO_METHOD | typeof VIEWPORT_SET_NAVIGATION_BAR_STYLE_METHOD;
 export type MiniProgramStorageMethod = typeof STORAGE_GET_STORAGE_METHOD | typeof STORAGE_SET_STORAGE_METHOD;
 export type MiniProgramNetworkMethod = typeof NETWORK_REQUEST_METHOD;
@@ -67,6 +68,12 @@ export declare const MINI_PROGRAM_PROTOCOL_CAPABILITIES: readonly [{
     readonly capability: "user.getSteamGameList";
     readonly permission: "user.platformAccount.steam";
     readonly risk: "high";
+}, {
+    readonly method: "share.copyLink";
+    readonly module: "share";
+    readonly capability: "share.copyLink";
+    readonly permission: "share.copyLink";
+    readonly risk: "medium";
 }, {
     readonly method: "share.showShareMenu";
     readonly module: "share";
@@ -193,6 +200,7 @@ export interface MiniProgramCapabilityPayloadMap {
     [USER_GET_INFO_METHOD]: GetUserInfoPayload;
     [USER_REVOKE_AUTHORIZATION_METHOD]: void;
     [USER_GET_STEAM_GAME_LIST_METHOD]: GetSteamGameListPayload;
+    [SHARE_COPY_LINK_METHOD]: CopyLinkPayload;
     [SHARE_SHOW_SHARE_MENU_METHOD]: ShowShareMenuPayload;
     [SHARE_SCREENSHOT_METHOD]: ScreenshotPayload;
     [VIEWPORT_GET_WINDOW_INFO_METHOD]: GetWindowInfoPayload;
@@ -219,6 +227,7 @@ export interface MiniProgramCapabilityResultMap {
     [USER_GET_INFO_METHOD]: GetUserInfoResult;
     [USER_REVOKE_AUTHORIZATION_METHOD]: void;
     [USER_GET_STEAM_GAME_LIST_METHOD]: GetSteamGameListResult;
+    [SHARE_COPY_LINK_METHOD]: CopyLinkResult;
     [SHARE_SHOW_SHARE_MENU_METHOD]: ShowShareMenuResult;
     [SHARE_SCREENSHOT_METHOD]: ScreenshotResult;
     [VIEWPORT_GET_WINDOW_INFO_METHOD]: GetWindowInfoResult;

package/types/payloads.d.ts

@@ -130,11 +130,16 @@ export type ShowShareMenuPayload = {
     title: string;
     desc: string;
     url?: string;
+    extra?: unknown;
     imageUrl?: string;
     channel?: MiniProgramShareChannel;
     post?: MiniProgramSharePostOptions | null;
 };
 export type ShowShareMenuResult = unknown;
+export type CopyLinkPayload = {
+    extra?: unknown;
+} | undefined;
+export type CopyLinkResult = string;
 export type ScreenshotPayload = {
     rect?: MiniProgramScreenshotRect;
     delay?: number;