@heybox/hb-sdk 0.8.1-alpha.2 → 0.8.1-alpha.6

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

@@ -0,0 +1,57 @@
+import { type CompanionCapability, type CompanionExit, type CompanionInfo, type CompanionNotificationCategory, type CompanionPreparationStatus, type CompanionPrepareProgress, type CompanionTarget } from '@heybox/hb-sdk-protocol';
+import type { MiniProgramOperationRequester } from '../../core/client';
+import type { MiniProgramEventHandler, MiniProgramEventName } from '../../protocol/types';
+import type { FileHandle } from '../files';
+interface CompanionRequester extends MiniProgramOperationRequester {
+    on<T extends MiniProgramEventName>(eventName: T, handler: MiniProgramEventHandler<T>): () => void;
+}
+export interface CompanionPrepareOptions {
+    signal?: AbortSignal;
+    onProgress?: (progress: CompanionPrepareProgress) => void;
+}
+export type CompanionOutputHandler = (data: Uint8Array) => void;
+export type CompanionExitHandler = (exit: CompanionExit) => void;
+export type CompanionOwnershipLostHandler = () => void;
+export type CompanionState = 'running' | 'exited';
+export type CompanionStateChangeHandler = (state: CompanionState) => void;
+export interface CompanionNotification {
+    category: CompanionNotificationCategory;
+}
+export interface CompanionStdio {
+    write(data: Uint8Array): Promise<void>;
+    closeStdin(): Promise<void>;
+    onStdout(handler: CompanionOutputHandler): () => void;
+    onStderr(handler: CompanionOutputHandler): () => void;
+}
+export interface CompanionAttachments {
+    open(id: string): Promise<FileHandle>;
+}
+export interface CompanionNotifications {
+    show(input: CompanionNotification): Promise<void>;
+}
+export interface CompanionSession {
+    readonly id: string;
+    readonly alias: string;
+    readonly target: CompanionTarget;
+    readonly capabilities: readonly CompanionCapability[];
+    readonly state: CompanionState;
+    readonly stdio?: CompanionStdio;
+    readonly attachments?: CompanionAttachments;
+    readonly notifications?: CompanionNotifications;
+    terminate(): Promise<void>;
+    waitForExit(): Promise<CompanionExit>;
+    onStateChange(handler: CompanionStateChangeHandler): () => void;
+    onExit(handler: CompanionExitHandler): () => void;
+    onOwnershipLost(handler: CompanionOwnershipLostHandler): () => void;
+}
+export interface MiniProgramCompanionModule {
+    getInfo(alias: string): Promise<CompanionInfo>;
+    getPreparationStatus(alias: string): Promise<CompanionPreparationStatus>;
+    prepare(alias: string, options?: CompanionPrepareOptions): Promise<CompanionInfo>;
+    cancelPreparation(alias: string): Promise<void>;
+    launch(alias: string): Promise<CompanionSession>;
+    getActiveSession(alias: string): Promise<CompanionSession | undefined>;
+}
+/** 创建当前 SDK session 的 companion 模块。 */
+export declare function createCompanionModule(requester: CompanionRequester): MiniProgramCompanionModule;
+export type { CompanionCapability, CompanionExit, CompanionInfo, CompanionNotificationCategory, CompanionPreparationStatus, CompanionPrepareProgress, CompanionTarget, };

package/types/protocol/dev-session.d.ts

@@ -33,6 +33,12 @@ export interface MiniProgramDevLaunchSnapshot {
     sdk_version?: string;
     mini_program_id?: string;
     local_dev_launch_token?: string;
+    /** CLI 进程身份，重启后变化；不作为授权凭据。 */
+    dev_session_id?: string;
+    /** 启动票过期时间，Unix 毫秒。 */
+    expires_at?: number;
+    companion_manifest_sha256?: string;
+    companion_artifact_access_token?: string;
     dev_context_url?: string;
     runtime_permissions?: MiniProgramRuntimePermissionsSnapshot;
 }

package/types/vite/index.d.ts

@@ -1,3 +1,4 @@
+import type { IncomingMessage, Server, ServerResponse } from 'node:http';
 import { MINIAPP_PLATFORM_VALUES, type MiniappPlatform } from '../miniapp-manifest/schema';
 export interface MiniappManifestPlugin {
     name: string;
@@ -5,11 +6,19 @@ export interface MiniappManifestPlugin {
         command: 'build' | 'serve';
     }) => MiniappManifestUserConfig | void;
     configResolved: (resolved: MiniappManifestResolvedConfig) => void;
+    configureServer: (server: MiniappManifestDevServer) => void;
     /** Rollup 在构建失败后仍会跑 closeBundle；用 buildEnd 记录真实错误，避免二次校验掩盖原因。 */
     buildEnd: (error?: Error) => void;
     transformIndexHtml: (html: string) => string;
     closeBundle: (this: MiniappManifestPluginContext) => Promise<void>;
 }
+export interface MiniappManifestDevServer {
+    httpServer?: Server | null;
+    restart?: (forceOptimize?: boolean) => Promise<void>;
+    middlewares: {
+        use: (handler: (request: IncomingMessage, response: ServerResponse, next: () => void) => void) => void;
+    };
+}
 export interface MiniappManifestUserConfig {
     base?: string;
     define?: Record<string, string>;
@@ -40,7 +49,5 @@ export interface MiniappManifestResolvedConfig {
 }
 export { MINIAPP_PLATFORM_VALUES };
 export type { MiniappPlatform };
-export interface MiniappManifestOptions {
-    platforms: readonly MiniappPlatform[];
-}
-export declare function miniappManifest(options: MiniappManifestOptions): MiniappManifestPlugin;
+export declare const HB_SDK_COMPANION_ARTIFACT_ACCESS_TOKEN_ENV = "HB_SDK_COMPANION_ARTIFACT_ACCESS_TOKEN";
+export declare function miniappManifest(): MiniappManifestPlugin;