import { SubApplicationType } from './app.list'; import { TYPES_BUNDLEID } from './util'; export interface LocalBuild { debugQrcodeUrl: string; deployVersion: string; packageUrlSchema: string; } export interface CloudBuild { data: CloudBuildData; errorCode: string; message: string; success: boolean; } export interface CloudBuildData { taskId: string; } export interface CloudBuildResult { data: CloudBuildData; errorCode: string; message: string; success: boolean; } export interface CloudBuildData { cdnError: null; components: any[]; packageQrcode: string | null; cdnSuccess: null; zipFile: string; cdnRoot: null; packageSchema: string; sourceUrl: null; size: number; plugin: null; subPackages: any[]; artifactUrl: null; status: 'BUILDING' | 'PUSHING' | 'COMPLETE' | 'PUSHCOMPLETE'; } export interface MiniPreviewOptions { isDebug?: boolean; /** * 构建模式 */ buildMode?: EPreviewMode; localBuild?: boolean; /** * 本地项目地址 */ project: string; /** * 小程序appId */ appId: string; /** * 云构建是否不做缓存 */ disableCache?: boolean; /** * clientType */ clientType?: keyof typeof TYPES_BUNDLEID; /** * 落地页 * @example * 'page/shop/detail?id=10&from=name' */ page?: string; /** * app.js的onLaunch中取得 * @example * 'name=demo&fromId=11' */ launch?: string; /** * 返回二维码文件的格式 * @default image */ qrcodeFormat?: 'terminal' | 'base64' | 'image'; /** * 二维码文件保存路径 */ qrcodeOutput?: string; /** * 忽略 Webview 域名合法性检查 * @default false */ ignoreWebviewCheck?: boolean; /** * 预览流程回调 */ onProgressUpdate?(info: { /** * LOCAL_PACKAGE: 本地打包成功 * UPLOAD_SUCCESS: 上传代码成功 * BUILD_SUCCESS: 云端构建成功 */ status: 'LOCAL_PACKAGE' | 'UPLOAD_SUCCESS' | 'BUILD_SUCCESS'; data: any; }): void; cacheDir?: string; } declare enum EPreviewResultStat { ok = "ok", failed = "failed", abort = "abort" } export interface MiniPreviewResult { /** * 预览的结果 */ stat?: EPreviewResultStat; message?: string; /** * 错误信息 - 云构建失败时,抛出错误信息 */ data?: { message?: string; buildMessage?: string; }; /** * 预览二维码的在线地址 */ packageQrcode?: string; /** * 支付宝schema链接 */ schema?: string; /** * schema对应的二维码 */ qrcode?: string; /** * 程序类型 */ subApplicationType?: SubApplicationType; /** * 真机调试使用 */ uuid?: string; } export declare enum EPreviewMode { CLOUD = "CLOUD", LOCAL = "LOCAL" } /** * 本地小程序代码预览 */ export default function miniPreview(options: MiniPreviewOptions): Promise; export {};