@heybox/hb-sdk 0.2.0-alpha.0 → 0.2.0-alpha.2

package/types/protocol/capabilities.d.ts

@@ -0,0 +1,180 @@
+import type { LoginPayload, LoginResult } from '../modules/auth';
+import type { NetworkRequestPayload, NetworkResponsePayload } from '../modules/network';
+import type { ScreenshotPayload, ScreenshotResult, ShowShareMenuPayload, ShowShareMenuResult } from '../modules/share';
+import type { GetStoragePayload, GetStorageResult, SetStoragePayload } from '../modules/storage';
+import type { GetUserInfoPayload, GetUserInfoResult } from '../modules/user';
+import type { GetWindowInfoPayload, GetWindowInfoResult } from '../modules/viewport';
+/**
+ * 登录授权能力方法名。
+ *
+ * @remarks
+ * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
+ */
+export declare const AUTH_LOGIN_METHOD: "auth.login";
+/**
+ * 用户信息能力方法名。
+ *
+ * @remarks
+ * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
+ */
+export declare const USER_GET_INFO_METHOD: "user.getInfo";
+/**
+ * 展示分享面板能力方法名。
+ *
+ * @remarks
+ * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
+ */
+export declare const SHARE_SHOW_SHARE_MENU_METHOD: "share.showShareMenu";
+/**
+ * 截图分享能力方法名。
+ *
+ * @remarks
+ * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
+ */
+export declare const SHARE_SCREENSHOT_METHOD: "share.screenshot";
+/**
+ * 视口窗口信息能力方法名。
+ *
+ * @remarks
+ * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
+ */
+export declare const VIEWPORT_GET_WINDOW_INFO_METHOD: "viewport.getWindowInfo";
+/**
+ * 读取小程序隔离 storage 能力方法名。
+ *
+ * @remarks
+ * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
+ */
+export declare const STORAGE_GET_STORAGE_METHOD: "storage.getStorage";
+/**
+ * 写入小程序隔离 storage 能力方法名。
+ *
+ * @remarks
+ * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
+ */
+export declare const STORAGE_SET_STORAGE_METHOD: "storage.setStorage";
+/**
+ * 发起网络请求能力方法名。
+ *
+ * @remarks
+ * 供 SDK 与父容器 runtime 共享同一 bridge method 标识。
+ */
+export declare const NETWORK_REQUEST_METHOD: "network.request";
+/** 授权模块开放的方法名。 */
+export type MiniProgramAuthMethod = typeof AUTH_LOGIN_METHOD;
+/** 用户模块开放的方法名。 */
+export type MiniProgramUserMethod = typeof USER_GET_INFO_METHOD;
+/** 分享模块开放的方法名。 */
+export type MiniProgramShareMethod = typeof SHARE_SHOW_SHARE_MENU_METHOD | typeof SHARE_SCREENSHOT_METHOD;
+/** Viewport 模块开放的方法名。 */
+export type MiniProgramViewportMethod = typeof VIEWPORT_GET_WINDOW_INFO_METHOD;
+/** Storage 模块开放的方法名。 */
+export type MiniProgramStorageMethod = typeof STORAGE_GET_STORAGE_METHOD | typeof STORAGE_SET_STORAGE_METHOD;
+/** 网络模块开放的方法名。 */
+export type MiniProgramNetworkMethod = typeof NETWORK_REQUEST_METHOD;
+/** 父容器开放给小程序调用的 bridge method。 */
+export type MiniProgramBridgeMethod = MiniProgramAuthMethod | MiniProgramUserMethod | MiniProgramShareMethod | MiniProgramViewportMethod | MiniProgramStorageMethod | MiniProgramNetworkMethod;
+/** 小程序开放能力所属模块。 */
+export type MiniProgramCapabilityModule = 'auth' | 'user' | 'share' | 'viewport' | 'storage' | 'network';
+/** 小程序开放能力风险级别，用于权限、审计和灰度策略。 */
+export type MiniProgramCapabilityRisk = 'low' | 'medium' | 'high';
+/**
+ * 小程序开放能力定义。
+ *
+ * @remarks
+ * 这是 SDK 与 runtime 共享的能力目录元数据。runtime 可以在此基础上绑定 handler，
+ * 但 method、module、capability、permission 与 risk 不应在 runtime 侧重复维护。
+ */
+export interface MiniProgramCapabilityDefinition {
+    /** bridge method exposed to iframe SDK. */
+    method: MiniProgramBridgeMethod;
+    /** Module that owns this capability. */
+    module: MiniProgramCapabilityModule;
+    /** Runtime instance switch key. */
+    capability: MiniProgramBridgeMethod;
+    /** Platform permission key reserved for mini-program level authorization. */
+    permission: string;
+    /** Audit / rollout hint for policy composition. */
+    risk: MiniProgramCapabilityRisk;
+}
+/**
+ * 小程序开放能力目录。
+ *
+ * @remarks
+ * 新增 bridge method 时应先更新这里，再分别补齐 SDK 模块、runtime handler 与测试。
+ */
+export declare const MINI_PROGRAM_PROTOCOL_CAPABILITIES: readonly [{
+    readonly method: "auth.login";
+    readonly module: "auth";
+    readonly capability: "auth.login";
+    readonly permission: "auth.login";
+    readonly risk: "medium";
+}, {
+    readonly method: "user.getInfo";
+    readonly module: "user";
+    readonly capability: "user.getInfo";
+    readonly permission: "user.getInfo";
+    readonly risk: "medium";
+}, {
+    readonly method: "share.showShareMenu";
+    readonly module: "share";
+    readonly capability: "share.showShareMenu";
+    readonly permission: "share.basic";
+    readonly risk: "low";
+}, {
+    readonly method: "share.screenshot";
+    readonly module: "share";
+    readonly capability: "share.screenshot";
+    readonly permission: "share.screenshot";
+    readonly risk: "medium";
+}, {
+    readonly method: "viewport.getWindowInfo";
+    readonly module: "viewport";
+    readonly capability: "viewport.getWindowInfo";
+    readonly permission: "viewport.windowInfo";
+    readonly risk: "low";
+}, {
+    readonly method: "storage.getStorage";
+    readonly module: "storage";
+    readonly capability: "storage.getStorage";
+    readonly permission: "storage.read";
+    readonly risk: "low";
+}, {
+    readonly method: "storage.setStorage";
+    readonly module: "storage";
+    readonly capability: "storage.setStorage";
+    readonly permission: "storage.write";
+    readonly risk: "medium";
+}, {
+    readonly method: "network.request";
+    readonly module: "network";
+    readonly capability: "network.request";
+    readonly permission: "network.request";
+    readonly risk: "high";
+}];
+/** bridge method 到请求 payload 的映射。 */
+export interface MiniProgramCapabilityPayloadMap {
+    [AUTH_LOGIN_METHOD]: LoginPayload;
+    [USER_GET_INFO_METHOD]: GetUserInfoPayload;
+    [SHARE_SHOW_SHARE_MENU_METHOD]: ShowShareMenuPayload;
+    [SHARE_SCREENSHOT_METHOD]: ScreenshotPayload;
+    [VIEWPORT_GET_WINDOW_INFO_METHOD]: GetWindowInfoPayload;
+    [STORAGE_GET_STORAGE_METHOD]: GetStoragePayload;
+    [STORAGE_SET_STORAGE_METHOD]: SetStoragePayload;
+    [NETWORK_REQUEST_METHOD]: NetworkRequestPayload;
+}
+/** bridge method 到标准化响应 payload 的映射。 */
+export interface MiniProgramCapabilityResultMap {
+    [AUTH_LOGIN_METHOD]: LoginResult;
+    [USER_GET_INFO_METHOD]: GetUserInfoResult;
+    [SHARE_SHOW_SHARE_MENU_METHOD]: ShowShareMenuResult;
+    [SHARE_SCREENSHOT_METHOD]: ScreenshotResult;
+    [VIEWPORT_GET_WINDOW_INFO_METHOD]: GetWindowInfoResult;
+    [STORAGE_GET_STORAGE_METHOD]: GetStorageResult;
+    [STORAGE_SET_STORAGE_METHOD]: void;
+    [NETWORK_REQUEST_METHOD]: NetworkResponsePayload;
+}
+/** 指定 bridge method 的请求 payload。 */
+export type MiniProgramCapabilityPayload<T extends MiniProgramBridgeMethod> = MiniProgramCapabilityPayloadMap[T];
+/** 指定 bridge method 的标准化响应 payload。 */
+export type MiniProgramCapabilityResult<T extends MiniProgramBridgeMethod> = MiniProgramCapabilityResultMap[T];

package/types/protocol.d.ts

@@ -1,18 +1,13 @@
 export { MINI_PROGRAM_BRIDGE_NONCE_PARAM, MINI_PROGRAM_MESSAGE_NAMESPACE, MINI_PROGRAM_MESSAGE_VERSION, SDK_HANDSHAKE_METHOD, } from './protocol/constants';
 export { isMiniProgramBridgeMessage } from './protocol/guards';
 export type { MiniProgramBridgeError, MiniProgramBridgeMessage, MiniProgramBridgeMessageType, MiniProgramEventHandler, MiniProgramEventName, MiniProgramEventPayloadMap, } from './protocol/types';
-export { AUTH_LOGIN_METHOD } from './modules/auth';
-export type { LoginPayload, LoginResult, MiniProgramAuthMethod } from './modules/auth';
-export { USER_GET_INFO_METHOD } from './modules/user';
-export type { GetUserInfoPayload, GetUserInfoResult, MiniProgramUserInfo, MiniProgramUserInfoResult, MiniProgramUserMethod, } from './modules/user';
-export { SHARE_SCREENSHOT_METHOD } from './modules/share/screenshot';
+export { AUTH_LOGIN_METHOD, MINI_PROGRAM_PROTOCOL_CAPABILITIES, NETWORK_REQUEST_METHOD, SHARE_SCREENSHOT_METHOD, SHARE_SHOW_SHARE_MENU_METHOD, STORAGE_GET_STORAGE_METHOD, STORAGE_SET_STORAGE_METHOD, USER_GET_INFO_METHOD, VIEWPORT_GET_WINDOW_INFO_METHOD, } from './protocol/capabilities';
+export type { MiniProgramAuthMethod, MiniProgramBridgeMethod, MiniProgramCapabilityDefinition, MiniProgramCapabilityModule, MiniProgramCapabilityPayload, MiniProgramCapabilityPayloadMap, MiniProgramCapabilityResult, MiniProgramCapabilityResultMap, MiniProgramCapabilityRisk, MiniProgramNetworkMethod, MiniProgramShareMethod, MiniProgramStorageMethod, MiniProgramUserMethod, MiniProgramViewportMethod, } from './protocol/capabilities';
+export type { LoginPayload, LoginResult } from './modules/auth';
+export type { GetUserInfoPayload, GetUserInfoResult, MiniProgramUserInfo, MiniProgramUserInfoResult, } from './modules/user';
 export type { ScreenshotPayload, ScreenshotResult } from './modules/share/screenshot';
-export { SHARE_SHOW_SHARE_MENU_METHOD } from './modules/share/show-share-menu';
 export type { ShowShareMenuPayload, ShowShareMenuResult } from './modules/share/show-share-menu';
-export type { MiniProgramScreenshotOptions, MiniProgramScreenshotRect, MiniProgramShareChannel, MiniProgramShareMethod, MiniProgramShowShareMenuOptions, } from './modules/share';
-export { STORAGE_GET_STORAGE_METHOD, STORAGE_SET_STORAGE_METHOD, } from './modules/storage';
-export type { GetStoragePayload, GetStorageResult, MiniProgramStorageMethod, SetStoragePayload, } from './modules/storage';
-export { VIEWPORT_GET_WINDOW_INFO_METHOD } from './modules/viewport';
-export type { GetWindowInfoPayload, GetWindowInfoResult, MiniProgramSafeArea, MiniProgramViewportMethod, MiniProgramWindowInfoResult, } from './modules/viewport';
-export { NETWORK_REQUEST_METHOD } from './modules/network';
-export type { MiniProgramNetworkHeaders, MiniProgramNetworkMethod, MiniProgramNetworkParams, MiniProgramNetworkRequestConfig, MiniProgramNetworkResponse, MiniProgramNetworkValidateStatus, NetworkRequestPayload, NetworkResponsePayload, } from './modules/network';
+export type { MiniProgramScreenshotOptions, MiniProgramScreenshotRect, MiniProgramShareChannel, MiniProgramShowShareMenuOptions, } from './modules/share';
+export type { GetStoragePayload, GetStorageResult, SetStoragePayload, } from './modules/storage';
+export type { GetWindowInfoPayload, GetWindowInfoResult, MiniProgramSafeArea, MiniProgramWindowInfoResult, } from './modules/viewport';
+export type { MiniProgramNetworkHeaders, MiniProgramNetworkParams, MiniProgramNetworkRequestConfig, MiniProgramNetworkRequestMethod, MiniProgramNetworkResponse, MiniProgramNetworkValidateStatus, NetworkRequestPayload, NetworkResponsePayload, } from './modules/network';

package/types/vite/index.d.ts

@@ -0,0 +1,17 @@
+type MiniappManifestPlugin = {
+    name: string;
+    apply: 'build';
+    configResolved: (resolved: MiniappManifestResolvedConfig) => void;
+    writeBundle: (this: MiniappManifestPluginContext) => void;
+};
+interface MiniappManifestPluginContext {
+    warn: (message: string) => void;
+}
+interface MiniappManifestResolvedConfig {
+    root: string;
+    build: {
+        outDir: string;
+    };
+}
+export declare function miniappManifest(): MiniappManifestPlugin;
+export {};