@heybox/hb-sdk-protocol 0.9.1-alpha.0 → 0.9.1-alpha.10

package/types/workspace-card-actions.d.ts

@@ -0,0 +1,7 @@
+/** 小程序固定受管动作入口。 */
+declare const WORKSPACE_CARD_COMMANDS: {
+    readonly invoke: "ai-desktop.heybox-user-miniprogram.workspace-cards.invoke";
+    readonly openMiniProgram: "ai-desktop.heybox-user-miniprogram.workspace-cards.open-mini-program";
+};
+
+export { WORKSPACE_CARD_COMMANDS };

package/src/bridge.ts

@@ -1,196 +0,0 @@
-import {
-  COMPANION_SESSION_EXIT_EVENT,
-  COMPANION_SESSION_OUTPUT_EVENT,
-  COMPANION_SESSION_OWNERSHIP_LOST_EVENT,
-  MINI_PROGRAM_MESSAGE_NAMESPACE,
-  MINI_PROGRAM_OPERATION_PROGRESS_METHOD,
-} from './constants';
-import type {
-  CompanionSessionExitPayload,
-  CompanionSessionOutputPayload,
-  CompanionSessionOwnershipLostPayload,
-  DownloadProgressPayload,
-  MiniProgramRuntimeEnvironmentInfo,
-  UserInfoAuthorization,
-} from './payloads';
-import type { MiniProgramCapabilityProgress, MiniProgramProgressMethod } from './capabilities';
-
-export type MiniProgramBridgeMessageType = 'handshake' | 'request' | 'response' | 'event' | 'cancel';
-/**
- * 小程序可订阅的生命周期、展示状态及业务事件名。
- *
- * @remarks
- * 每个事件的载荷见 {@link MiniProgramEventPayloadMap}。事件不会向晚订阅者重放；`ready`
- * 是握手成功通知，不是可查询的持久状态，也不保证只收到一次。具体事件能否产生取决于
- * Host 的能力与生命周期，不能仅凭事件名称推导状态去重或投递保证。
- */
-export type MiniProgramEventName =
-  | 'launch'
-  | 'viewport_change'
-  | 'display_change'
-  | 'ready'
-  | 'show'
-  | 'hide'
-  | 'unload'
-  | 'error'
-  | 'heybox_app_login_change'
-  | 'user_info_authorization_change'
-  | typeof COMPANION_SESSION_OUTPUT_EVENT
-  | typeof COMPANION_SESSION_EXIT_EVENT
-  | typeof COMPANION_SESSION_OWNERSHIP_LOST_EVENT;
-
-export interface MiniProgramBridgeError {
-  code: string;
-  message: string;
-  data?: unknown;
-}
-export interface SDKHandshakePayload {
-  href: string;
-  userAgent: string;
-  sdkVersion: string;
-}
-/** Runtime 对 SDK 握手的可选扩展响应。 */
-export interface SDKHandshakeResult {
-  /** Host 与 Runtime 归一化后的环境快照。 */
-  environment: MiniProgramRuntimeEnvironmentInfo;
-}
-export interface RuntimeLocationProbePayload {
-  probeId: string;
-  timestamp: number;
-}
-export type SDKLocationReportTrigger = 'probe' | 'history' | 'popstate' | 'hashchange' | 'pageshow' | 'resume';
-export interface SDKLocationReportPayload {
-  probeId?: string;
-  href: string;
-  sdkVersion: string;
-  trigger: SDKLocationReportTrigger;
-  timestamp: number;
-}
-export type SDKCSPBlockedResourceType = 'url' | 'inline' | 'eval' | 'unknown';
-export interface SDKCSPViolationPayload {
-  effectiveDirective: string;
-  violatedDirective: string;
-  disposition: string;
-  blockedResourceType: SDKCSPBlockedResourceType;
-  blockedOrigin?: string;
-  redactedPathname?: string;
-  sanitizedPathnameHash?: string;
-  sdkVersion: string;
-  timestamp: number;
-}
-
-/**
- * SDK 与 Host Runtime 跨 iframe 传输时共用的顶层 bridge envelope。
- *
- * @typeParam TPayload - 当前 method 对应的 payload 类型；未知或尚未按 method 收窄时默认为 `unknown`。
- *
- * @remarks
- * 该类型刻意保留为宽 envelope，以同时表达 handshake、request、response、event 与 cancel。
- * 字段组合的运行时约束由 {@link isMiniProgramBridgeMessage} 执行；v2 cancel 和 operation progress
- * 可分别使用 {@link MiniProgramBridgeCancelMessage} 与 {@link MiniProgramBridgeProgressMessage}
- * 获得更精确的静态类型。
- *
- * 类型匹配不建立信任边界。从 `postMessage` 接收数据时，先以 `unknown` 交给 guard，再独立校验
- * `MessageEvent.source`、预期 nonce、握手状态，以及具体 method 的 payload；当 origin 可以固定且
- * 当前协议模式要求时，再校验 `MessageEvent.origin`。
- */
-export interface MiniProgramBridgeMessage<TPayload = unknown> {
-  /** 固定协议 namespace，用于从其他页面消息中识别候选 envelope。 */
-  namespace: typeof MINI_PROGRAM_MESSAGE_NAMESPACE;
-  /** 当前消息采用的 wire 版本；新消息使用 v2，接收端为兼容握手接受 v1。 */
-  version: 1 | 2;
-  /** Runtime 创建 iframe 时分配并由双方逐条回传的实例 nonce。 */
-  nonce: string;
-  /** 决定 id、method、payload 与 error 组合规则的消息类别。 */
-  type: MiniProgramBridgeMessageType;
-  /** 请求关联 ID；普通生命周期 event 可省略，request、response、handshake、cancel 与 progress 必须提供。 */
-  id?: string;
-  /** capability 或事件名；response 可省略，cancel 禁止携带。 */
-  method?: string;
-  /** method 对应的 wire payload；必须在按 method 分发后继续校验。 */
-  payload?: TPayload;
-  /** 失败 response 的结构化错误；其他消息类型不得携带。 */
-  error?: MiniProgramBridgeError;
-}
-
-export interface MiniProgramBridgeCancelMessage extends MiniProgramBridgeMessage<never> {
-  version: 2;
-  type: 'cancel';
-  id: string;
-  method?: never;
-  payload?: never;
-  error?: never;
-}
-
-export interface MiniProgramBridgeProgressMessage<
-  TMethod extends MiniProgramProgressMethod = MiniProgramProgressMethod,
-> extends MiniProgramBridgeMessage<MiniProgramCapabilityProgress<TMethod>> {
-  version: 2;
-  type: 'event';
-  id: string;
-  method: typeof MINI_PROGRAM_OPERATION_PROGRESS_METHOD;
-  payload: MiniProgramCapabilityProgress<TMethod>;
-  error?: never;
-}
-/**
- * 公开事件名与对应载荷的映射，供 SDK 的类型化事件监听使用。
- *
- * @remarks
- * 生命周期 `timestamp` 是 Runtime 发出通知时的 Unix 毫秒时间，不是 iframe 收到事件的
- * 时间或单调时钟。事件只通知已注册的监听器；业务需要当前状态时应使用相应读取 API。
- */
-export interface MiniProgramEventPayloadMap {
-  /** 展示状态实际变化后通知；不回放初始状态，不支持或失败时不通知。 */
-  display_change: import('./payloads').MiniProgramDisplayState & {
-    /** api 为开发者调用；user 为用户点击宿主退出全屏按钮。同目标合并时保留首次发起来源。旧宿主可能不提供。 */
-    source?: 'api' | 'user';
-  };
-  /** 窗口信息变化通知；载荷与 `viewport.getWindowInfo()` 的结果结构一致。 */
-  viewport_change: import('./payloads').MiniProgramWindowInfoResult;
-  /** 初次握手时的启动通知；晚订阅不能补收。 */
-  launch: {
-    /** Runtime 发出通知时的 Unix 毫秒时间。 */
-    timestamp: number;
-    /** Host 加载 iframe 时的启动 URL；可缺失，不代表页面当前导航地址。 */
-    url?: string;
-  };
-  /** 握手成功通知；重复握手可再次产生，应查询持久握手状态驱动 UI。 */
-  ready: {
-    /** Runtime 发出通知时的 Unix 毫秒时间。 */
-    timestamp: number;
-  };
-  /** Host 通知小程序进入展示状态。 */
-  show: {
-    /** Runtime 发出通知时的 Unix 毫秒时间。 */
-    timestamp: number;
-    /** Host 可选提供的来源描述；不保证存在或采用固定枚举。 */
-    source?: string;
-  };
-  /** Host 通知小程序进入隐藏状态。 */
-  hide: {
-    /** Runtime 发出通知时的 Unix 毫秒时间。 */
-    timestamp: number;
-    /** Host 可选提供的来源描述；不保证存在或采用固定枚举。 */
-    source?: string;
-  };
-  /** Runtime 卸载的尽力通知；不能保证页面销毁前一定收到。 */
-  unload: {
-    /** Runtime 发出通知时的 Unix 毫秒时间。 */
-    timestamp: number;
-  };
-  /** 结构化 Runtime 错误通知；载荷不是 JavaScript `Error` 实例。 */
-  error: MiniProgramBridgeError;
-  /** Host 当前登录状态通知；相同状态可能重复出现，不能仅凭事件判断账号身份是否变化。 */
-  heybox_app_login_change: {
-    /** Host 当前是否有已登录的小黑盒账号，不表示开发者服务端会话状态。 */
-    isHeyboxAppLoggedIn: boolean;
-  };
-  /** 当前用户授权状态通知；可包含可选 `steam_account`，不是 Manifest 权限状态。 */
-  user_info_authorization_change: UserInfoAuthorization;
-  /** 当前 Companion controller 收到的输出片段；去重与确认依据见载荷中的 sequence。 */
-  [COMPANION_SESSION_OUTPUT_EVENT]: CompanionSessionOutputPayload;
-  /** Companion session 的进程退出通知。 */
-  [COMPANION_SESSION_EXIT_EVENT]: CompanionSessionExitPayload;
-  /** 当前 controller 失去 Companion session 控制权的通知。 */
-  [COMPANION_SESSION_OWNERSHIP_LOST_EVENT]: CompanionSessionOwnershipLostPayload;
-}