@heybox/hb-sdk 0.1.3 → 0.2.0-alpha.1

package/skill/scripts/validate-skill.mjs

@@ -0,0 +1,233 @@
+#!/usr/bin/env node
+import { existsSync, readdirSync, readFileSync, statSync } from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import process from 'node:process';
+import {
+  HB_SDK_PACKAGE_NAME,
+  HB_SDK_SKILL_NAME,
+  validateSkillManifest,
+} from './skill-metadata.mjs';
+
+const scriptDir = path.dirname(fileURLToPath(import.meta.url));
+const skillRoot = path.resolve(scriptDir, '..');
+const packageRoot = path.resolve(skillRoot, '..');
+const repoRoot = findRepoRoot(process.cwd()) ?? findRepoRoot(skillRoot) ?? process.cwd();
+const errors = [];
+const warnings = [];
+
+function findRepoRoot(startDir) {
+  let dir = path.resolve(startDir);
+  while (true) {
+    if (existsSync(path.join(dir, 'package.json')) && existsSync(path.join(dir, 'packages/hb-sdk/package.json'))) {
+      return dir;
+    }
+    const parent = path.dirname(dir);
+    if (parent === dir) return null;
+    dir = parent;
+  }
+}
+
+function rel(filePath) {
+  return path.relative(repoRoot, filePath).split(path.sep).join('/');
+}
+
+function skillRel(filePath) {
+  return path.relative(skillRoot, filePath).split(path.sep).join('/');
+}
+
+function fail(message) {
+  errors.push(message);
+}
+
+function warn(message) {
+  warnings.push(message);
+}
+
+function read(filePath) {
+  return readFileSync(filePath, 'utf8');
+}
+
+function walk(dir) {
+  const out = [];
+  for (const entry of readdirSync(dir)) {
+    const fullPath = path.join(dir, entry);
+    const stat = statSync(fullPath);
+    if (stat.isDirectory()) out.push(...walk(fullPath));
+    else out.push(fullPath);
+  }
+  return out;
+}
+
+function parseFrontmatter(markdown) {
+  const match = markdown.match(/^---\n([\s\S]*?)\n---\n/);
+  if (!match) return null;
+  const fields = new Map();
+  for (const line of match[1].split('\n')) {
+    const field = line.match(/^([A-Za-z0-9_-]+):\s*(.*)$/);
+    if (field) fields.set(field[1], field[2].replace(/^['"]|['"]$/g, ''));
+  }
+  return fields;
+}
+
+const requiredFiles = [
+  'SKILL.md',
+  'skill.json',
+  'references/api-root.md',
+  'references/api-protocol.md',
+  'references/cli.md',
+  'references/recipes.md',
+  'references/safety-boundaries.md',
+  'references/llms-index.md',
+  'references/examples.md',
+  'references/smoke-evaluation.md',
+  'scripts/sync-references.mjs',
+  'scripts/check-references.mjs',
+  'scripts/skill-metadata.mjs',
+  'scripts/validate-skill.mjs',
+  'scripts/package-skill.mjs',
+  'scripts/package-skill.sh',
+];
+
+for (const file of requiredFiles) {
+  const absolutePath = path.join(skillRoot, file);
+  if (!existsSync(absolutePath)) fail(`Missing required file: ${rel(absolutePath)}`);
+}
+
+const skillMdPath = path.join(skillRoot, 'SKILL.md');
+const packageJsonPath = path.join(repoRoot, 'packages/hb-sdk/package.json');
+const skillJsonPath = path.join(skillRoot, 'skill.json');
+
+if (existsSync(skillJsonPath) && existsSync(packageJsonPath)) {
+  try {
+    const skillJson = JSON.parse(read(skillJsonPath));
+    const packageJson = JSON.parse(read(packageJsonPath));
+
+    for (const error of validateSkillManifest({ manifest: skillJson, sdkVersion: packageJson.version })) {
+      fail(error);
+    }
+  } catch (error) {
+    fail(`skill.json must be valid JSON: ${error instanceof Error ? error.message : String(error)}`);
+  }
+}
+
+if (existsSync(skillMdPath)) {
+  const skillMd = read(skillMdPath);
+  const frontmatter = parseFrontmatter(skillMd);
+  if (!frontmatter) {
+    fail('SKILL.md must start with YAML frontmatter.');
+  } else {
+    const allowedFrontmatter = new Set(['name', 'description']);
+    for (const key of frontmatter.keys()) {
+      if (!allowedFrontmatter.has(key)) fail(`SKILL.md frontmatter must only include name and description; found ${key}.`);
+    }
+    const name = frontmatter.get('name');
+    const description = frontmatter.get('description');
+    if (name !== HB_SDK_SKILL_NAME) fail('SKILL.md frontmatter name must be `hb-sdk`.');
+    if (!description) fail('SKILL.md frontmatter description is required.');
+    if (description && description.length > 1024) fail('SKILL.md description must be <= 1024 characters.');
+    if (description && !description.includes("Don't use")) warn('Description should include negative triggers for discoverability.');
+  }
+
+  const lineCount = skillMd.split('\n').length;
+  if (lineCount > 500) fail(`SKILL.md must stay under 500 lines; found ${lineCount}.`);
+  if (!skillMd.includes('references/api-root.md')) fail('SKILL.md must point agents to references/api-root.md.');
+  if (!skillMd.includes('references/api-protocol.md')) fail('SKILL.md must point agents to references/api-protocol.md.');
+  if (!skillMd.includes('references/cli.md')) fail('SKILL.md must point agents to references/cli.md.');
+  if (!skillMd.includes('references/smoke-evaluation.md')) fail('SKILL.md must point evaluators to references/smoke-evaluation.md.');
+  if (!skillMd.includes('host/runtime') && !skillMd.includes('Host/runtime')) fail('SKILL.md must gate protocol usage to host/runtime tasks.');
+}
+
+const nestedReferenceFiles = existsSync(path.join(skillRoot, 'references'))
+  ? walk(path.join(skillRoot, 'references')).filter(file => path.dirname(path.relative(path.join(skillRoot, 'references'), file)).includes(path.sep))
+  : [];
+for (const file of nestedReferenceFiles) fail(`References must be one level deep: ${skillRel(file)}`);
+
+if (existsSync(path.join(skillRoot, 'README.md'))) fail('Do not create README.md inside hb-sdk skill; keep human distribution docs outside the skill folder.');
+if (existsSync(path.join(skillRoot, 'CHANGELOG.md'))) fail('Do not create CHANGELOG.md inside hb-sdk skill.');
+if (existsSync(path.join(skillRoot, 'INSTALLATION_GUIDE.md'))) fail('Do not create INSTALLATION_GUIDE.md inside hb-sdk skill.');
+
+const textFiles = existsSync(skillRoot)
+  ? walk(skillRoot).filter(file => /\.(md|yaml|yml|json|txt)$/.test(file))
+  : [];
+
+const negativeMarkers = [
+  'do not',
+  "don't",
+  'does not',
+  'must not',
+  'never',
+  'no ',
+  'without',
+  'forbidden',
+  'refuse',
+  'block',
+  'fail',
+  'negative',
+  '不会',
+  '不应',
+  '不要',
+  '不能',
+  '不开放',
+  '无',
+  '禁止',
+];
+const positiveCredentialPattern = /\b(read|extract|forward|store|persist|depend on|use|request|expose|get|parse|send)\b.*\b(token|cookie|credentials?|phone number|login state)\b/i;
+const unsupportedStoragePattern = /\b(removeStorage|clearStorage|getStorageInfo|getStorageV2|delete storage|clear storage)\b/i;
+const rawProtocolPattern = /\b(raw postMessage|construct bridge|bridge envelope|nonce handling|mutate bridge|sdk\.handshake)\b/i;
+const removedUserLoginPattern = /\b(?:hbSDK\.)?user\.login\s*\(/;
+
+for (const file of textFiles) {
+  const relative = skillRel(file);
+  const content = read(file);
+  if (removedUserLoginPattern.test(content)) {
+    fail(`Removed API guidance found in ${relative}: use auth.login() instead of user.login().`);
+  }
+
+  if (new RegExp(`${HB_SDK_PACKAGE_NAME.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')}\\/(?!protocol\\b)[A-Za-z0-9_./-]+`).test(content)) {
+    fail(`Deep/internal hb-sdk import guidance found in ${relative}. Only @heybox/hb-sdk and @heybox/hb-sdk/protocol are allowed.`);
+  }
+
+  const lines = content.split('\n');
+  lines.forEach((line, index) => {
+    const lower = line.toLowerCase();
+    const isNegative = negativeMarkers.some(marker => lower.includes(marker));
+    if (positiveCredentialPattern.test(line) && !isNegative) {
+      fail(`Unsafe positive credential guidance in ${relative}:${index + 1}: ${line.trim()}`);
+    }
+    if (unsupportedStoragePattern.test(line) && !isNegative) {
+      fail(`Unsupported storage capability guidance in ${relative}:${index + 1}: ${line.trim()}`);
+    }
+    if (rawProtocolPattern.test(line) && !isNegative && !/host\/runtime|runtime|protocol|parent-container|parent container|父容器/i.test(line)) {
+      fail(`Raw protocol guidance without host/runtime context in ${relative}:${index + 1}: ${line.trim()}`);
+    }
+  });
+}
+
+const recipesPath = path.join(skillRoot, 'references/recipes.md');
+if (existsSync(recipesPath)) {
+  const recipes = read(recipesPath);
+  if (/api-protocol\.md/.test(recipes) && !/host\/runtime-only|host\/runtime|runtime only/i.test(recipes)) {
+    fail('references/recipes.md references api-protocol.md without a nearby host/runtime-only warning.');
+  }
+}
+
+const protocolPath = path.join(skillRoot, 'references/api-protocol.md');
+if (existsSync(protocolPath)) {
+  const protocol = read(protocolPath);
+  if (!/Host\/runtime-only warning/i.test(protocol)) fail('references/api-protocol.md must include a Host/runtime-only warning section.');
+}
+
+const zipPath = path.join(packageRoot, 'hb-sdk.zip');
+if (existsSync(zipPath)) {
+  const size = statSync(zipPath).size;
+  if (size <= 0) fail('packages/hb-sdk/hb-sdk.zip exists but is empty.');
+}
+
+for (const warning of warnings) console.error(`warning: ${warning}`);
+if (errors.length > 0) {
+  for (const error of errors) console.error(`error: ${error}`);
+  process.exit(1);
+}
+
+console.log(JSON.stringify({ ok: true, skillRoot: rel(skillRoot), checkedFiles: textFiles.length, warnings: warnings.length }));

package/skill/skill.json

@@ -0,0 +1,11 @@
+{
+  "name": "hb-sdk",
+  "skillVersion": "0.2.0-alpha.1+skill.66c7559e5e13",
+  "sdk": {
+    "package": "@heybox/hb-sdk",
+    "version": "0.2.0-alpha.1",
+    "compatibility": "0.2.0-alpha.1"
+  },
+  "source": "https://open.xiaoheihe.cn/agent-skills/hb-sdk",
+  "integrity": "sha256-66c7559e5e13eaaefc9718b0f643dffd5853c864913e57e5a65ab0c663553797"
+}

package/types/core/client.d.ts

@@ -1,5 +1,10 @@
 import type { MiniProgramEventHandler, MiniProgramEventName } from '../protocol/types';
-/** 创建 SDK bridge client 的配置项。 */
+/**
+ * 创建 SDK bridge client 的配置项。
+ *
+ * @remarks
+ * 该配置主要用于独立实例、自定义宿主环境注入和测试场景。
+ */
 export interface MiniProgramSDKOptions {
     /** 请求与握手超时时间，单位毫秒。 */
     timeout?: number;
@@ -9,10 +14,24 @@ export interface MiniProgramSDKOptions {
     selfWindow?: Window;
     /** 父窗口，测试环境可注入；显式传 null 可模拟非 iframe 环境。 */
     targetWindow?: Window | null;
+    /** 精准 postMessage 目标 origin；未传时尝试推断，失败则回退为 `*`。 */
+    targetOrigin?: string;
 }
-/** 模块 API 发起请求所需的最小能力。 */
+/**
+ * 模块 API 发起请求所需的最小能力。
+ *
+ * @remarks
+ * 各公开模块只依赖该最小接口发起 bridge 请求，以保持模块层与底层实现解耦。
+ */
 export interface MiniProgramRequester {
-    /** 向父容器调用指定开放能力。 */
+    /**
+     * 向父容器调用指定开放能力。
+     *
+     * @typeParam T 标准化后的返回值类型。
+     * @param method bridge method 名称。
+     * @param payload 可序列化请求载荷。
+     * @returns 由父容器返回的标准化结果。
+     */
     request<T>(method: string, payload?: unknown): Promise<T>;
 }
 /** 底层 bridge client，负责握手、请求响应、事件分发与超时清理。 */
@@ -20,6 +39,7 @@ export declare class MiniProgramBridgeClient implements MiniProgramRequester {
     private readonly timeout;
     private readonly selfWindow?;
     private readonly targetWindow;
+    private readonly targetOrigin;
     private readonly nonce;
     private readonly pendingRequests;
     private readonly eventBus;

package/types/core/errors.d.ts

@@ -1,5 +1,13 @@
 import type { MiniProgramBridgeError } from '../protocol/types';
-/** SDK 对外抛出的标准错误类型。 */
+import type { MiniProgramNetworkRequestConfig, MiniProgramNetworkResponse } from '../modules/network';
+/**
+ * SDK 对外抛出的标准 bridge / runtime 错误类型。
+ *
+ * @remarks
+ * 该错误用于表示握手失败、bridge 调用失败、父容器运行时错误等
+ * 非 HTTP 结果错误。其 `code` 字段可用于业务分支处理，
+ * `data` 仅作为可选调试信息，不保证结构稳定。
+ */
 export declare class HbMiniProgramSDKError extends Error {
     /** 稳定错误码。 */
     code: string;
@@ -7,5 +15,40 @@ export declare class HbMiniProgramSDKError extends Error {
     data?: unknown;
     constructor(error: MiniProgramBridgeError);
 }
-/** 创建 SDK 标准错误。 */
+/**
+ * 创建 SDK 标准错误。
+ *
+ * @param code 稳定错误码。
+ * @param message 面向开发者的错误说明。
+ * @param data 可选调试数据。
+ * @returns 标准化 `HbMiniProgramSDKError` 实例。
+ *
+ * @remarks
+ * 仅供 SDK 内部或同仓运行时层统一构造 bridge / runtime 错误。
+ */
 export declare function createSDKError(code: string, message: string, data?: unknown): HbMiniProgramSDKError;
+/**
+ * SDK 对外抛出的 HTTP 错误类型。
+ *
+ * @remarks
+ * 仅在请求已经成功走完 bridge / runtime / 宿主调用链、但最终 HTTP 状态不满足
+ * `validateStatus` 时抛出。它不表示握手失败或 bridge 级错误。
+ *
+ * @typeParam T 标准化响应数据的类型。
+ */
+export declare class HbMiniProgramNetworkError<T = unknown> extends Error {
+    /** HTTP 状态码。 */
+    status: number;
+    /** 标准化响应数据。 */
+    data: T;
+    /** 标准化响应头。 */
+    headers: Record<string, string>;
+    /** SDK 公共请求配置快照。 */
+    config: MiniProgramNetworkRequestConfig;
+    /** 完整标准化响应。 */
+    response: MiniProgramNetworkResponse<T>;
+    /**
+     * @param response 已完成请求的标准化网络响应。
+     */
+    constructor(response: MiniProgramNetworkResponse<T>);
+}

package/types/core/sdk.d.ts

@@ -1,26 +1,94 @@
 import { type MiniProgramSDKOptions } from './client';
+import { type MiniProgramAuthModule } from '../modules/auth';
 import { type MiniProgramShareModule } from '../modules/share';
+import { type MiniProgramStorageModule } from '../modules/storage';
+import { type MiniProgramNetworkModule } from '../modules/network';
+import { type MiniProgramViewportModule } from '../modules/viewport';
 import { type MiniProgramUserModule } from '../modules/user';
-import { type MiniProgramSystemModule } from '../modules/system';
 import type { MiniProgramEventHandler, MiniProgramEventName } from '../protocol/types';
-/** 外部小程序 SDK 实例。 */
+/**
+ * 外部小程序 SDK 实例。
+ *
+ * @remarks
+ * 该实例负责组织授权、用户、分享、容器、存储与网络等开放能力，并维护
+ * iframe 内小程序与父容器之间的 bridge 生命周期。
+ *
+ * 多数业务页直接使用默认单例即可；只有在测试、多实例或需要定制运行参数时，
+ * 才建议显式创建独立实例。
+ *
+ * @example
+ * ```ts
+ * import { createMiniProgramSDK } from '@heybox/hb-sdk'
+ *
+ * const sdk = createMiniProgramSDK({
+ *   timeout: 15000,
+ * })
+ *
+ * await sdk.ready()
+ * ```
+ */
 export declare class MiniProgramSDK {
     private readonly client;
-    /** 用户相关开放能力。 */
+    /** 授权相关开放能力。 */
+    readonly auth: MiniProgramAuthModule;
+    /** 用户资料相关开放能力。 */
     readonly user: MiniProgramUserModule;
     /** 分享相关开放能力。 */
     readonly share: MiniProgramShareModule;
-    /** 系统相关开放能力。 */
-    readonly system: MiniProgramSystemModule;
+    /** 视口相关开放能力。 */
+    readonly viewport: MiniProgramViewportModule;
+    /** Storage 相关开放能力。 */
+    readonly storage: MiniProgramStorageModule;
+    /** 网络请求相关开放能力。 */
+    readonly network: MiniProgramNetworkModule;
     constructor(options?: MiniProgramSDKOptions);
-    /** 等待 SDK 与父容器完成握手。 */
+    /**
+     * 等待 SDK 与父容器完成握手。
+     *
+     * @returns 当 bridge 握手成功后 resolve。
+     * @throws {HbMiniProgramSDKError} 当当前页面不在 iframe 中、缺少 nonce 或握手超时时抛出。
+     */
     ready(): Promise<void>;
-    /** 注册小程序生命周期或业务事件。 */
+    /**
+     * 注册小程序生命周期或业务事件。
+     *
+     * @param eventName 要监听的事件名。
+     * @param handler 事件处理函数。
+     * @returns 事件解绑函数。
+     */
     on<T extends MiniProgramEventName>(eventName: T, handler: MiniProgramEventHandler<T>): () => void;
-    /** 移除小程序生命周期或业务事件。 */
+    /**
+     * 移除小程序生命周期或业务事件。
+     *
+     * @param eventName 要移除的事件名。
+     * @param handler 对应的事件处理函数。
+     */
     off<T extends MiniProgramEventName>(eventName: T, handler: MiniProgramEventHandler<T>): void;
-    /** 销毁 SDK 实例。 */
+    /**
+     * 销毁 SDK 实例。
+     *
+     * @remarks
+     * 销毁后会移除 message 监听，并拒绝尚未完成的 bridge 请求。
+     * 已销毁实例不应继续复用。
+     */
     destroy(): void;
 }
-/** 创建独立 SDK 实例，主要用于测试或多实例场景。 */
+/**
+ * 创建独立 SDK 实例。
+ *
+ * @param options SDK 运行配置，例如超时时间、nonce 或测试环境注入的 window。
+ * @returns 可独立管理生命周期的 `MiniProgramSDK` 实例。
+ *
+ * @remarks
+ * 适用于测试、多实例场景，或需要自定义 `timeout`、`targetWindow` 等运行参数的场景。
+ *
+ * @example
+ * ```ts
+ * import { createMiniProgramSDK } from '@heybox/hb-sdk'
+ *
+ * const sdk = createMiniProgramSDK({
+ *   timeout: 15000,
+ * })
+ * ```
+ */
 export declare function createMiniProgramSDK(options?: MiniProgramSDKOptions): MiniProgramSDK;

package/types/core/singleton.d.ts

@@ -1,18 +1,44 @@
+import type { MiniProgramAuthModule } from '../modules/auth';
 import type { MiniProgramShareModule } from '../modules/share';
+import type { MiniProgramStorageModule } from '../modules/storage';
+import type { MiniProgramNetworkModule } from '../modules/network';
+import type { MiniProgramViewportModule } from '../modules/viewport';
 import type { MiniProgramUserModule } from '../modules/user';
-import type { MiniProgramSystemModule } from '../modules/system';
 import type { MiniProgramEventHandler, MiniProgramEventName } from '../protocol/types';
-/** 等待默认 SDK 实例与父容器完成握手。 */
+/**
+ * 等待默认 SDK 实例与父容器完成握手。
+ *
+ * @returns 当默认 SDK 单例与父容器握手成功后 resolve。
+ * @throws {HbMiniProgramSDKError} 当当前页面不在 iframe 中、缺少 nonce 或握手超时时抛出。
+ */
 export declare function ready(): Promise<void>;
-/** 注册默认 SDK 实例的事件监听。 */
+/**
+ * 注册默认 SDK 实例的事件监听。
+ *
+ * @param eventName 要监听的事件名。
+ * @param handler 事件处理函数。
+ * @returns 事件解绑函数。
+ */
 export declare function on<T extends MiniProgramEventName>(eventName: T, handler: MiniProgramEventHandler<T>): () => void;
-/** 移除默认 SDK 实例的事件监听。 */
+/**
+ * 移除默认 SDK 实例的事件监听。
+ *
+ * @param eventName 要移除的事件名。
+ * @param handler 对应的事件处理函数。
+ * @returns 无返回值。
+ */
 export declare function off<T extends MiniProgramEventName>(eventName: T, handler: MiniProgramEventHandler<T>): void;
-/** 默认 SDK 实例的用户模块。 */
+/** 默认 SDK 实例的授权模块。 */
+export declare const auth: MiniProgramAuthModule;
+/** 默认 SDK 实例的用户资料模块。 */
 export declare const user: MiniProgramUserModule;
 /** 默认 SDK 实例的分享模块。 */
 export declare const share: MiniProgramShareModule;
-/** 默认 SDK 实例的系统模块。 */
-export declare const system: MiniProgramSystemModule;
+/** 默认 SDK 实例的 Viewport 模块。 */
+export declare const viewport: MiniProgramViewportModule;
+/** 默认 SDK 实例的 storage 模块。 */
+export declare const storage: MiniProgramStorageModule;
+/** 默认 SDK 实例的 network 模块。 */
+export declare const network: MiniProgramNetworkModule;
 /** 重置默认 SDK 实例，仅用于测试。 */
 export declare function resetDefaultSDKForTest(): void;

package/types/core/utils.d.ts

@@ -2,6 +2,8 @@
 export declare function getGlobalWindow(): Window | undefined;
 /** 获取父窗口；非 iframe 环境返回 null。 */
 export declare function getParentWindow(currentWindow?: Window): Window | null;
+/** 尝试读取父窗口 origin；跨域读取失败时回退到 document.referrer。 */
+export declare function readParentOrigin(currentWindow?: Window): string;
 /** 从父容器注入到 URL 的 query 中读取 bridge nonce。 */
 export declare function readBridgeNonce(currentWindow?: Window): string;
 /** 创建请求 ID。 */

package/types/index.d.ts

@@ -1,20 +1,28 @@
 export { createMiniProgramSDK, MiniProgramSDK } from './core/sdk';
-export { HbMiniProgramSDKError } from './core/errors';
+export { HbMiniProgramSDKError, HbMiniProgramNetworkError } from './core/errors';
 export type { MiniProgramRequester, MiniProgramSDKOptions } from './core/client';
-export { ready, on, off, user, share, system } from './core/singleton';
+export { ready, on, off, auth, user, share, viewport, storage, network } from './core/singleton';
 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 * from './modules/user';
-export * from './modules/share';
-export * from './modules/system';
+export { AUTH_LOGIN_METHOD, 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, MiniProgramAuthModule } from './modules/auth';
+export type { GetUserInfoPayload, GetUserInfoResult, MiniProgramUserInfo, MiniProgramUserInfoResult, MiniProgramUserModule, } from './modules/user';
+export type { MiniProgramScreenshotOptions, MiniProgramScreenshotRect, MiniProgramShareChannel, MiniProgramShareModule, MiniProgramShowShareMenuOptions, ScreenshotPayload, ScreenshotResult, ShowShareMenuPayload, ShowShareMenuResult, } from './modules/share';
+export type { GetWindowInfoPayload, GetWindowInfoResult, MiniProgramSafeArea, MiniProgramViewportModule, MiniProgramWindowInfoResult, } from './modules/viewport';
+export type { GetStoragePayload, GetStorageResult, MiniProgramStorageModule, SetStoragePayload, } from './modules/storage';
+export type { MiniProgramNetworkHeaders, MiniProgramNetworkModule, MiniProgramNetworkParams, MiniProgramNetworkRequestConfig, MiniProgramNetworkRequestMethod, MiniProgramNetworkResponse, MiniProgramNetworkValidateStatus, NetworkRequestPayload, NetworkResponsePayload, } from './modules/network';
 import { off, on, ready } from './core/singleton';
 declare const hbSDK: {
     ready: typeof ready;
     on: typeof on;
     off: typeof off;
+    auth: import(".").MiniProgramAuthModule;
     user: import(".").MiniProgramUserModule;
     share: import(".").MiniProgramShareModule;
-    system: import(".").MiniProgramSystemModule;
+    viewport: import(".").MiniProgramViewportModule;
+    storage: import(".").MiniProgramStorageModule;
+    network: import(".").MiniProgramNetworkModule;
 };
 export default hbSDK;

package/types/modules/auth/index.d.ts

@@ -0,0 +1,35 @@
+import type { MiniProgramRequester } from '../../core/client';
+import type { MiniProgramUserInfoResult } from '../user';
+export { AUTH_LOGIN_METHOD } from '../../protocol/capabilities';
+/** `auth.login` 不需要入参。 */
+export type LoginPayload = void;
+/** `auth.login` 返回登录流程结束后的最新用户登录态与公开基础资料。 */
+export type LoginResult = MiniProgramUserInfoResult;
+export type { MiniProgramAuthMethod } from '../../protocol/capabilities';
+/** 外部小程序可调用的授权模块。 */
+export interface MiniProgramAuthModule {
+    /**
+     * 唤起登录授权，并返回登录后的最新用户信息。
+     *
+     * 该能力不会向小程序暴露 token、cookie 或任何登录凭据。
+     */
+    login(): Promise<LoginResult>;
+}
+/**
+ * 唤起登录授权，并在流程返回后刷新用户公开基础资料。
+ *
+ * @param requester 底层 bridge 请求能力。
+ * @returns 登录流程完成后的最新用户登录态与公开资料。
+ * @throws {HbMiniProgramSDKError} 当 bridge、父容器或宿主运行时调用失败时抛出。
+ *
+ * @remarks
+ * 该能力不会向小程序暴露 token、cookie 或其他登录凭据。
+ */
+export declare function login(requester: MiniProgramRequester): Promise<LoginResult>;
+/**
+ * 创建授权模块。
+ *
+ * @param requester 底层 bridge 请求能力。
+ * @returns 面向业务层的授权模块对象。
+ */
+export declare function createAuthModule(requester: MiniProgramRequester): MiniProgramAuthModule;