@cocos/cocos-cli-types 0.0.1-alpha.17.4 → 0.0.1-alpha.19.1

package/builder.d.ts

@@ -1,7 +1,9 @@
 /// <reference types="node" />
 
-import { EventEmitter } from 'events';
+import EventEmitter from 'events';
+import { EventEmitter as EventEmitter_2 } from 'stream';
 import type { PluginItem } from '@babel/core';
+import { SpriteFrame } from 'cc';
 
 declare interface AcornNode {
     	end: number;
@@ -447,7 +449,7 @@ export declare interface BuildCheckResult {
     level: IConsoleType;
 }
 
-declare interface BuildConfiguration {
+export declare interface BuildConfiguration {
     common: IBuildCommonOptions;
     platforms: {
         'web-desktop'?: WebDesktopBuildOptions & OverwriteProjectSettings;
@@ -460,6 +462,99 @@ declare interface BuildConfiguration {
     textureCompressConfig: UserCompressConfig;
 }
 
+/**
+ * 资源管理器，主要负责资源的缓存查询缓存等
+ * 所有 __ 开头的属性方法都不对外公开
+ */
+declare class BuilderAssetCache implements BuilderCache {
+    readonly scenes: Array<IBuildSceneItem>;
+    readonly scriptUuids: Array<string>;
+    assetUuids: Array<string>;
+    private readonly instanceMap;
+    private readonly _task?;
+    constructor(task?: IBuilder);
+    /**
+     * 初始化
+     */
+    init(): Promise<void>;
+    /**
+     * 查询某个 uuid 是否存在
+     * @param uuid
+     * @returns
+     */
+    hasAsset(uuid: string): Promise<boolean>;
+    /**
+     * 添加一个资源到缓存
+     * @param asset
+     */
+    addAsset(asset: IAsset, type?: string): void;
+    /**
+     * 删除一个资源的缓存
+     */
+    removeAsset(uuid: string, type?: string): void;
+    /**
+     * 查询指定 uuid 的资源信息
+     * @param uuid
+     */
+    getAssetInfo(uuid: string): IAssetInfo;
+    /**
+     * 添加或修改一个实例化对象到缓存
+     * @param instance
+     */
+    addInstance(instance: any): void;
+    /**
+     * 删除一个资源的缓存
+     * @param uuid
+     */
+    clearAsset(uuid: string): void;
+    /**
+     * 查询一个资源的 meta 数据
+     * @param uuid
+     */
+    getMeta(uuid: string): Promise<any>;
+    addMeta(uuid: string, meta: any): Promise<void>;
+    /**
+     * 获取指定 uuid 资源的依赖资源 uuid 列表
+     * @param uuid
+     */
+    getDependUuids(uuid: string): Promise<readonly string[]>;
+    /**
+     * 深度获取指定 uuid 资源的依赖资源 uuid 列表
+     * @param uuid
+     */
+    getDependUuidsDeep(uuid: string): Promise<string[]>;
+    /**
+     *
+     * 获取指定 uuid 资源在 library 内的序列化 JSON 内容
+     * @param uuid
+     */
+    getLibraryJSON(uuid: string): Promise<any>;
+    /**
+     * 获取指定 uuid 资源的重新序列化后的 JSON 内容（最终输出）
+     * @param uuid
+     * @param options
+     */
+    getSerializedJSON(uuid: string, options: ISerializedOptions): Promise<any>;
+    /**
+     * 直接输出某个资源序列化 JSON 到指定包内
+     * @param uuid
+     * @param destDir
+     * @param options
+     */
+    outputAssetJson(uuid: string, destDir: string, options: IInternalBuildOptions): Promise<void>;
+    /**
+     * 循环一种数据
+     * @param type
+     * @param handle
+     */
+    forEach(type: string, handle: Function): Promise<undefined>;
+    /**
+     * 查询一个资源反序列化后的实例
+     * @param uuid
+     */
+    getInstance(uuid: string): Promise<any>;
+}
+
 export declare interface BuilderCache {
     readonly scenes: Array<IBuildSceneItem>;
     readonly scriptUuids: Array<string>;
@@ -515,6 +610,163 @@ export declare namespace BuildPlugin {
     export type Unload = () => Promise<void> | void;
 }
 
+declare class BuildResult implements IBuildResult {
+    private readonly __task;
+    settings?: ISettings;
+    dest: string;
+    get paths(): IBuildPaths;
+    constructor(task: IBuilder);
+    /**
+     * 指定的 uuid 资源是否包含在构建资源中
+     */
+    containsAsset(uuid: string): boolean;
+    /**
+     * 获取指定 uuid 原始资源的存放路径（不包括序列化 json）
+     * 自动图集的小图 uuid 和自动图集的 uuid 都将会查询到合图大图的生成路径
+     * 实际返回多个路径的情况：查询 uuid 为自动图集资源，且对应图集生成多张大图，纹理压缩会有多个图片格式路径
+     */
+    getRawAssetPaths(uuid: string): IRawAssetPathInfo[];
+    /**
+     * 获取指定 uuid 资源的路径相关信息
+     * @return Array<{raw?: string | string[]; import?: string; groupIndex?: number;}>
+     * @return.raw: 该资源源文件的实际存储位置，存在多个为数组，不存在则为空
+     * @return.import: 该资源序列化数据的实际存储位置，不存在为空，可能是 .bin 或者 .json 格式
+     * @return.groupIndex: 若该资源的序列化数据在某个分组内，这里标识在分组内的 index，不存在为空
+     */
+    getAssetPathInfo(uuid: string): IAssetPathInfo[];
+    /**
+     * @deprecated please use getImportAssetPaths instead
+     * @param uuid
+     */
+    getJsonPathInfo(uuid: string): IImportAssetPathInfo[];
+    /**
+     * 指定 uuid 资源的序列化信息在构建后的信息
+     * @param uuid
+     */
+    getImportAssetPaths(uuid: string): IImportAssetPathInfo[];
+}
+
+declare class BuildStageTask extends BuildTaskBase implements IBuildStageTask {
+    options: IBuildOptionBase;
+    hooksInfo: IBuildHooksInfo;
+    private root;
+    hookMap: Record<string, string>;
+    constructor(id: string, config: IBuildStageConfig);
+    run(): Promise<boolean>;
+    break(reason: string): void;
+    handleHook(func: Function, internal: boolean): Promise<void>;
+    saveOptions(): Promise<void>;
+}
+
+declare class BuildTask extends BuildTaskBase implements IBuilder {
+    cache: BuilderAssetCache;
+    result: InternalBuildResult_2;
+    buildTemplate: BuildTemplate;
+    buildResult?: BuildResult;
+    options: IInternalBuildOptions;
+    hooksInfo: IBuildHooksInfo;
+    taskManager: TaskManager;
+    private mainTaskWeight;
+    static isCommandBuild: boolean;
+    private currentStageTask?;
+    bundleManager: BundleManager;
+    hookMap: Record<IPluginHookName, IPluginHookName>;
+    pipeline: (string | Function | IBuildTask[])[];
+    /**
+     * 构建任务的结果缓存，只允许接口访问
+     */
+    private taskResMap;
+    static utils: IBuildUtils;
+    get utils(): IBuildUtils;
+    constructor(id: string, options: IBuildOptionBase);
+    get stage(): string;
+    /**
+     * 获取某个任务结果
+     * @param name
+     */
+    getTaskResult(name: keyof ITaskResultMap_2): {
+        projectJs: string;
+        systemJs: string;
+        polyfillsJs: string | null;
+    } | IBuildPacResult_2 | undefined;
+    /**
+     * 开始整理构建需要的参数
+     */
+    init(): Promise<void>;
+    /**
+     * 执行具体的构建任务
+     */
+    run(): Promise<boolean>;
+    /**
+     * 仅构建 Bundle 流程
+     */
+    buildBundleOnly(): Promise<void>;
+    private postBuild;
+    private handleBuildStageTask;
+    private initBundleManager;
+    break(reason: string): void;
+    lockAssetDB(): Promise<void>;
+    unLockAssetDB(): void;
+    /**
+     * 获取预览 settings 信息
+     */
+    getPreviewSettings(): Promise<ISettings>;
+    private initOptions;
+    /**
+     * 执行某个任务列表
+     * @param buildTasks 任务列表数组
+     * @param weight 全部任务列表所占权重
+     * @param args 需要传递给任务的其他参数
+     */
+    private runBuildTask;
+    handleHook(func: Function, internal: boolean, ...args: any[]): Promise<void>;
+    onError(error: Error, throwError?: boolean): void;
+    runErrorHook(): Promise<void>;
+}
+
+declare abstract class BuildTaskBase extends EventEmitter {
+    breakReason?: string;
+    name: string;
+    progress: number;
+    error?: Error;
+    abstract hooksInfo: IBuildHooksInfo;
+    abstract options: IBuildOptionBase;
+    abstract hookMap: Record<string, string>;
+    hookWeight: number;
+    id: string;
+    buildExitRes: IBuildResultSuccess;
+    constructor(id: string, name: string);
+    break(reason: string): void;
+    onError(error: Error, throwError?: boolean): void;
+    /**
+     * 更新进度消息 log
+     * @param message
+     * @param increment
+     * @param outputType
+     */
+    updateProcess(message: string, increment?: number, outputType?: IConsoleType): void;
+    abstract handleHook(func: Function, internal: boolean, ...args: any[]): Promise<void>;
+    abstract run(): Promise<boolean>;
+    runPluginTask(funcName: string, weight?: number): Promise<void>;
+}
+
+declare class BuildTemplate implements IBuildTemplate {
+    _buildTemplateDirs: string[];
+    map: Record<string, {
+        url: string;
+        path: string;
+    }>;
+    _versionUser: string;
+    config?: BuildTemplateConfig;
+    get isEnable(): boolean;
+    constructor(platform: Platform | string, taskName: string, config?: BuildTemplateConfig);
+    query(name: string): string;
+    private _initVersion;
+    findFile(relativeUrl: string): string;
+    initUrl(relativeUrl: string, name?: string): string | undefined;
+    copyTo(dest: string): Promise<void>;
+}
+
 export declare interface BuildTemplateConfig {
     templates: {
         path: string;
@@ -532,6 +784,13 @@ export declare const enum BuiltinBundleName {
     INTERNAL = 'internal'
 }
 
+declare enum BuiltinBundleName_2 {
+    RESOURCES = 'resources',
+    MAIN = 'main',
+    START_SCENE = 'start-scene',
+    INTERNAL = 'internal'
+}
+
 export declare type BundleCompressionType = 'none' | 'merge_dep' | 'merge_all_json' | 'subpackage' | 'zip';
 
 export declare const enum BundleCompressionTypes {
@@ -542,6 +801,14 @@ export declare const enum BundleCompressionTypes {
     ZIP = 'zip'
 }
 
+declare enum BundleCompressionTypes_2 {
+    NONE = 'none',
+    MERGE_DEP = 'merge_dep',
+    MERGE_ALL_JSON = 'merge_all_json',
+    SUBPACKAGE = 'subpackage',
+    ZIP = 'zip'
+}
+
 export declare interface BundleConfigItem {
     isRemote?: boolean;
     compressionType: BundleCompressionType;
@@ -559,6 +826,114 @@ export declare interface BundleFilterConfig {
     assets?: string[];
 }
 
+declare class BundleManager extends BuildTaskBase implements IBundleManager {
+    static BuiltinBundleName: typeof BuiltinBundleName_2;
+    static BundleConfigs: Record<string, Record<string, {
+        isRemote: boolean;
+        compressionType: BundleCompressionTypes_2;
+    }>>;
+    private _task?;
+    options: IInternalBundleBuildOptions;
+    destDir: string;
+    hooksInfo: IBuildHooksInfo;
+    bundleMap: Record<string, IBundle>;
+    bundles: IBundle[];
+    _pacAssets: string[];
+    _bundleGroupInPriority?: Array<IBundle[]>;
+    imageCompressManager?: TextureCompress_2;
+    scriptBuilder: ScriptBuilder_2;
+    packResults: PacInfo[];
+    cache: BuilderAssetCache;
+    hookMap: {
+        onBeforeBundleInit: string;
+        onAfterBundleInit: string;
+        onBeforeBundleDataTask: string;
+        onAfterBundleDataTask: string;
+        onBeforeBundleBuildTask: string;
+        onAfterBundleBuildTask: string;
+    };
+    pipeline: (string | Function)[];
+    get bundleGroupInPriority(): IBundle[][];
+    static internalBundlePriority: Record<string, number>;
+    private constructor();
+    static create(options: IBuildOptionBase, task?: IBuilder): Promise<BundleManager>;
+    loadScript(scriptUuids: string[], pluginScripts: IPluginScriptInfo[]): Promise<void>;
+    /**
+     * 初始化项目设置的一些 bundle 配置信息
+     */
+    static initStaticBundleConfig(): Promise<void>;
+    getUserConfig(ID?: string): {
+        isRemote: boolean;
+        compressionType: BundleCompressionTypes_2;
+    } | null;
+    /**
+     * 对 options 上的数据做补全处理
+     */
+    initOptions(): Promise<void>;
+    clearBundleDest(): void;
+    /**
+     * 初始化整理资源列表
+     */
+    initAsset(): Promise<void>;
+    initBundleConfig(): Promise<void>;
+    buildAsset(): Promise<void>;
+    /**
+     * 独立构建 Bundle 时调用
+     * @returns
+     */
+    run(): Promise<boolean>;
+    outputBundle(): Promise<void>;
+    private addBundle;
+    private getDefaultBundleConfig;
+    /**
+     * 根据参数初始化一些信息配置，整理所有的 bundle 分组信息
+     */
+    initBundle(): Promise<void>;
+    /**
+     * 初始化内置 Bundle（由于一些历史的 bundle 行为配置，内置 Bundle 的配置需要单独处理）
+     */
+    private initInternalBundleConfigs;
+    /**
+     * 填充成完整可用的项目 Bundle 配置（传入自定义配置 > Bundle 文件夹配置 > 默认配置）
+     * @param customConfig
+     * @returns IBundleInitOptions | null
+     */
+    private patchProjectBundleConfig;
+    /**
+     * 初始化 bundle 分组内的根资源信息
+     * 初始化 bundle 内的各项不同的处理任务
+     */
+    private initBundleRootAssets;
+    /**
+     * 按照 Bundle 优先级整理 Bundle 的资源列表
+     */
+    private initBundleShareAssets;
+    /**
+     * 根据不同的选项做不同的 bundle 任务注册
+     */
+    bundleDataTask(): Promise<void>;
+    /**
+     * 纹理压缩处理
+     * @returns
+     */
+    private compressImage;
+    /**
+     * 执行自动图集任务
+     */
+    private packImage;
+    /**
+     * 编译项目脚本
+     */
+    buildScript(): Promise<any>;
+    /**
+     * 输出所有的 bundle 资源，包含脚本、json、普通资源、纹理压缩、图集等
+     */
+    private outputAssets;
+    handleHook(func: Function, internal: boolean, ...args: any[]): Promise<void>;
+    runAllTask(): Promise<void>;
+    runBuildTask(handle: Function, increment: number): Promise<void>;
+}
+
 export declare type BundlePlatformType = 'native' | 'miniGame' | 'web';
 
 export declare interface BundleRenderConfig {
@@ -568,6 +943,8 @@ export declare interface BundleRenderConfig {
     minOptionList?: Record<string, any[]>;
 }
 
+declare type CCEnvConstants = ConstantManager.CCEnvConstants;
+
 declare type ChangeEvent = 'create' | 'update' | 'delete';
 
 declare interface ChokidarOptions {
@@ -646,11 +1023,33 @@ declare class CocosParams<T> {
     constructor(params: CocosParams<T>);
 }
 
+declare interface CompressCacheInfo {
+    option: {
+        mtime: number | string;
+        src: string;
+        compressOptions: Record<string, Record<string, string | number>>;
+    };
+    mipmapFiles: string[] | undefined;
+    customConfigs: Record<string, ICustomConfig>;
+    dest?: string[];
+}
+
 export declare interface CompressedInfo {
     suffixs: string[];
     imagePathNoExt: string;
 }
 
+declare interface CompressExecuteInfo {
+    busyFormatType: Partial<Record<ITextureCompressFormatType | string, number>>;
+    busyAsset: Set<string>;
+    resolve: Function;
+    reject: Function;
+    state: 'progress' | 'success' | 'failed';
+    complete: number;
+    total: number;
+    childProcess: number;
+}
+
 declare interface Config {
     /**
      * Engine features. Keys are feature IDs.
@@ -709,6 +1108,12 @@ declare interface Context {
     buildTimeConstants?: object;
 }
 
+export declare function createBuildStageTask(taskId: string, stageName: string, options: IBuildStageOptions): Promise<BuildStageTask>;
+
+export declare function createBuildTask<P extends Platform>(platform: P, options?: IBuildCommandOption): Promise<BuildTask>;
+
+export declare function createBundleBuildTask(bundleOptions: IBundleBuildOptions): Promise<BundleManager>;
+
 export declare interface CustomBundleConfig {
     displayName: string;
     configs: Record<BundlePlatformType, CustomBundleConfigItem>;
@@ -1675,6 +2080,12 @@ export declare interface IBuildPacResult {
     imageToPac: Record<string, string>;
 }
 
+declare interface IBuildPacResult_2 {
+    spriteToImage: Record<string, string>;
+    textureToImage: Record<string, string>;
+    imageToPac: Record<string, string>;
+}
+
 export declare interface IBuildPanel {
     Vue: any;
     validator: {
@@ -1845,6 +2256,12 @@ export declare interface IBuildSeparateEngineResult {
 
 export declare type IBuildStage = 'build' | 'bundle' | 'make' | 'run' | string;
 
+declare interface IBuildStageConfig extends IBuildStageItem {
+    root: string;
+    hooksInfo: IBuildHooksInfo;
+    buildTaskOptions: IBuildOptionBase;
+}
+
 export declare type IBuildStageHooks = (root: string, options: IBuildOptionBase) => Promise<void> | void;
 
 export declare interface IBuildStageItem {
@@ -2359,6 +2776,8 @@ declare interface IConstantInfo {
     dynamic?: boolean;
 }
 
+declare type ICustomAssetHandlerType = 'compressTextures';
+
 export declare type ICustomBuildIconInfo = IBuildIconItem & {
     pkgName: string;
 };
@@ -2803,6 +3222,12 @@ export declare interface ImportMap {
     scopes?: Record<string, Record<string, string>>;
 }
 
+declare interface ImportMapOptions {
+    data: ImportMapWithImports;
+    format?: 'commonjs' | 'esm';
+    output: string;
+}
+
 export declare type ImportMapWithImports = ImportMap & {
     imports: NonNullable<ImportMap['imports']>;
 };
@@ -2940,10 +3365,44 @@ export declare interface InternalBuildResult {
     separateEngineResult?: IBuildSeparateEngineResult;
 }
 
+declare class InternalBuildResult_2 extends EventEmitter implements InternalBuildResult {
+    settings: ISettings;
+    scriptPackages: string[];
+    pluginVers: Record<string, string>;
+    compressImageResult: ICompressImageResult;
+    /**
+     * @param name
+     * @param options
+     * 导入映射
+     */
+    importMap: ImportMapWithImports;
+    rawOptions: IBuildOptionBase;
+    paths: IBuildPaths;
+    compileOptions: any;
+    private __task;
+    pluginScripts: Array<{
+        uuid: string;
+        url: string;
+        file: string;
+    }>;
+    separateEngineResult?: IBuildSeparateEngineResult;
+    get dest(): string;
+    constructor(task: IBuilder, preview: boolean);
+}
+
 declare type InternalModuleFormat = 'amd' | 'cjs' | 'es' | 'iife' | 'system' | 'umd';
 
 declare type InternalNativePlatform = 'mac' | 'android' | 'google-play' | 'windows' | 'ios' | 'ohos' | 'harmonyos-next';
 
+declare interface InternalPackageInfo {
+    name: string;
+    path: string;
+    buildPath: string;
+    doc?: string;
+    displayName?: string;
+    version: string;
+}
+
 export declare type InternalPlatform = 'web-desktop' | 'web-mobile' | 'mac' | 'ios' | 'android' | 'google-play' | 'windows' | 'ohos' | 'harmonyos-next';
 
 declare type InteropType = boolean | 'auto' | 'esModule' | 'default' | 'defaultOnly';
@@ -3109,6 +3568,10 @@ export declare interface IPluginRegisterInfo {
     type: 'plugin';
 }
 
+declare interface IPluginScriptInfo extends PluginScriptInfo {
+    url: string;
+}
+
 export declare interface IPolyFills {
     /**
      * True if async functions polyfills(i.e. regeneratorRuntime) needs to be included.
@@ -3181,6 +3644,15 @@ export declare interface IScriptOptions {
     bundleCommonChunk: boolean;
 }
 
+declare interface IScriptProjectOption extends SharedSettings {
+    ccEnvConstants: CCEnvConstants;
+    dbInfos: {
+        dbID: string;
+        target: string;
+    }[];
+    customMacroList: MacroItem[];
+}
+
 export declare interface ISerializedOptions {
     debug: boolean;
     useCCONB?: boolean;
@@ -3384,6 +3856,15 @@ export declare interface ITaskResultMap {
     'build-task/pac'?: IBuildPacResult;
 }
 
+declare interface ITaskResultMap_2 {
+    'build-task/script'?: {
+        projectJs: string;
+        systemJs: string;
+        polyfillsJs: string | null;
+    };
+    'build-task/pac'?: IBuildPacResult_2;
+}
+
 export declare type ITaskState = 'waiting' | 'success' | 'failure' | 'cancel' | 'processing' | 'none';
 
 export declare interface ITextureCompressConfig {
@@ -3984,6 +4465,36 @@ export declare interface OverwriteProjectSettings extends IEngineConfig {
     engineInfo: EngineInfo;
 }
 
+/**
+ * 一个图集信息
+ */
+declare class PacInfo implements IPacInfo {
+    spriteFrameInfos: SpriteFrameInfo[];
+    spriteFrames: SpriteFrame[];
+    relativePath: string;
+    relativeDir: string;
+    path: string;
+    uuid: string;
+    imagePath: string;
+    imageUuid: string;
+    textureUuid: string;
+    name: string;
+    width: number;
+    height: number;
+    dirty: boolean;
+    packOptions: IPackOptions;
+    storeInfo: PacStoreInfo;
+    result?: IPackResult;
+    constructor(pacAsset: IAsset, options?: Partial<IPackOptions>);
+    initSpriteFramesWithRange(includeAssets?: string[]): Promise<this>;
+    /**
+     * @param {Object} pacAssetInfo 从 db 中获取出来的 pac 信息
+     */
+    initSpriteFrames(spriteFrameAssets: (IAsset)[]): Promise<this>;
+    private queryInvalidSpriteAssets;
+    toJSON(): void;
+}
+
 export declare interface PacStoreInfo {
     pac: StoreInfo;
     sprites: ISpriteFrameInfo[];
@@ -4221,6 +4732,103 @@ declare type PluginHooks = {
  */
 declare type PluginImpl<O extends object = object> = (options?: O) => Plugin_2;
 
+declare class PluginManager extends EventEmitter {
+    bundleConfigs: Record<string, PlatformBundleConfig>;
+    commonOptionConfig: Record<string, Record<string, IBuilderConfigItem & {
+        verifyKey: string;
+    }>>;
+    pkgOptionConfigs: Record<string, Record<string, IDisplayOptions>>;
+    platformConfig: Record<string, IPlatformConfig>;
+    buildTemplateConfigMap: Record<string, BuildTemplateConfig>;
+    configMap: Record<string, Record<string, IInternalBuildPluginConfig>>;
+    private builderPathsMap;
+    private customBuildStagesMap;
+    protected customBuildStages: Record<string, {
+        [pkgName: string]: IBuildStageItem[];
+    }>;
+    private assetHandlers;
+    protected readonly pkgPriorities: Record<string, number>;
+    packageRegisterInfo: Map<string, InternalPackageInfo>;
+    private platformRegisterInfoPool;
+    constructor();
+    init(): Promise<void>;
+    registerAllPlatform(): Promise<void>;
+    register(platform: string): Promise<void>;
+    checkPlatform(platform: string): boolean;
+    private registerPlatform;
+    private internalRegister;
+    _registerI18n(registerInfo: IBuilderRegisterInfo): void;
+    getCommonOptionConfigs(platform: Platform): Record<string, IBuilderConfigItem>;
+    getCommonOptionConfigByKey(key: keyof IBuildTaskOption, options: IBuildTaskOption): IBuilderConfigItem | null;
+    getPackageOptionConfigByKey(key: string, pkgName: string, options: IBuildTaskOption): IBuilderConfigItem | null;
+    getOptionConfigByKey(key: keyof IBuildTaskOption, options: IBuildTaskOption): IBuilderConfigItem | null;
+    /**
+     * 完整校验构建参数（校验平台插件相关的参数校验）
+     * @param options
+     */
+    checkOptions(options: MakeRequired<IBuildCommandOption, 'platform' | 'mainBundleCompressionType'>): Promise<undefined | IBuildTaskOption>;
+    checkCommonOptions(options: IBuildTaskOption): Promise<Record<string, BuildCheckResult>>;
+    checkCommonOptionByKey(key: keyof IBuildTaskOption, value: any, options: IBuildTaskOption): Promise<BuildCheckResult>;
+    /**
+     * 校验构建插件注册的构建参数
+     * @param options
+     */
+    private checkPluginOptions;
+    shouldGenerateOptions(platform: Platform | string): boolean;
+    /**
+     * 获取平台默认值
+     * @param platform
+     */
+    getOptionsByPlatform<P extends Platform | string>(platform: P): Promise<IBuildTaskOption>;
+    getTexturePlatformConfigs(): Record<string, ITextureCompressConfig>;
+    queryPlatformConfig(): {
+        native: string[];
+        config: Record<string, IPlatformConfig>;
+    };
+    /**
+     * 获取带有钩子函数的构建阶段任务
+     * @param platform
+     * @returns
+     */
+    getBuildStageWithHookTasks(platform: Platform | string, taskName: string): IBuildStageItem | null;
+    /**
+     * 查询某个平台的阶段性任务按钮配置信息
+     * @param platform
+     */
+    getBuildStageConfigByPlatform(platform: Platform): Record<string, any> | null;
+    /**
+     * 根据插件权重传参的插件数组
+     * @param pkgNames
+     * @returns
+     */
+    private sortPkgNameWidthPriority;
+    /**
+     * 获取平台插件的构建路径信息
+     * @param platform
+     */
+    getHooksInfo(platform: Platform | string): IBuildHooksInfo;
+    getBuildTemplateConfig(platform: string): BuildTemplateConfig;
+    /**
+     * 根据类型获取对应的执行方法
+     * @param type
+     * @returns
+     */
+    getAssetHandlers(type: ICustomAssetHandlerType): {
+        pkgNameOrder: string[];
+        handles: Record<string, Function>;
+    };
+}
+
+export declare const pluginManager: PluginManager;
+
+declare interface PluginScriptInfo {
+    /**
+     * 脚本文件。
+     */
+    file: string;
+    uuid: string;
+}
+
 /** JavaScript 插件脚本的 userData */
 declare interface PluginScriptUserData {
     isPlugin: true;
@@ -4637,6 +5245,28 @@ export declare class ScriptBuilder {
     static outputImportMap(importMap: ImportMap, options: IImportMapOptions): Promise<void>;
 }
 
+declare class ScriptBuilder_2 {
+    _scriptOptions: IScriptOptions;
+    _importMapOptions: ImportMapOptions;
+    scriptPackages: string[];
+    static projectOptions: IScriptProjectOption;
+    initTaskOptions(options: IInternalBuildOptions | IInternalBundleBuildOptions): {
+        scriptOptions: IScriptOptions;
+        importMapOptions: {
+            format: 'esm' | 'commonjs' | undefined;
+            data: {
+                imports: {};
+            };
+            output: string;
+        };
+    };
+    initProjectOptions(options: IInternalBuildOptions | IInternalBundleBuildOptions): Promise<void>;
+    buildBundleScript(bundles: IBundle[]): Promise<any>;
+    static buildPolyfills(options: IPolyFills | undefined, dest: string): Promise<any>;
+    static buildSystemJs(options: IBuildSystemJsOption): Promise<any>;
+    static outputImportMap(importMap: ImportMap, options: IImportMapOptions): Promise<void>;
+}
+
 /** JavaScript 脚本模块的 userData */
 declare interface ScriptModuleUserData {
     isPlugin: false;
@@ -4667,6 +5297,22 @@ declare interface SerializedTimings {
     	[label: string]: [number, number, number];
 }
 
+declare interface SharedSettings {
+    useDefineForClassFields: boolean;
+    allowDeclareFields: boolean;
+    loose: boolean;
+    guessCommonJsExports: boolean;
+    exportsConditions: string[];
+    preserveSymlinks: boolean;
+    importMap?: {
+        json: {
+            imports?: Record<string, string>;
+            scopes?: Record<string, Record<string, string>>;
+        };
+        url: string;
+    };
+}
+
 declare type ShouldTransformCachedModuleHook = (
 	this: PluginContext,
 	options: {
@@ -4774,6 +5420,34 @@ declare interface SpriteFrameBaseAssetUserData {
     vertices: SpriteFrameVertices;
 }
 
+declare class SpriteFrameInfo {
+    name: string;
+    uuid: string;
+    imageUuid: string;
+    textureUuid: string;
+    spriteFrame: SpriteFrame;
+    trim: {
+        width: number;
+        height: number;
+        rotatedWidth: number;
+        rotatedHeight: number;
+        x: number;
+        y: number;
+    };
+    rawWidth: number;
+    rawHeight: number;
+    width: number;
+    height: number;
+    originalPath: string;
+    rotated: boolean;
+    _file: string;
+    _libraryPath: string;
+    _pacUuid: string;
+    private _mtime;
+    constructor(spriteFrame: SpriteFrame, assetInfo: IAsset, options: IPackOptions);
+    toJSON(): any;
+}
+
 declare interface SpriteFrameVertices {
     rawPosition: number[];
     indexes: number[];
@@ -5001,6 +5675,21 @@ export declare const enum TaskAddResult {
     PARAM_ERROR = 2
 }
 
+declare class TaskManager {
+    private static readonly tasks;
+    static readonly pluginTasks: Record<IPluginHookName, IPluginHookName>;
+    private static buildTaskMap;
+    activeTasks: Set<TaskType>;
+    get taskWeight(): number;
+    static getBuildTask(type: TaskType): any[];
+    static getTaskHandleFromNames(taskNames: string[]): any[];
+    static getCustomTaskName(name: string): string;
+    activeTask(type: TaskType): any[];
+    activeCustomTask(name: string, taskNames: string[]): any[];
+}
+
+declare type TaskType = 'dataTasks' | 'settingTasks' | 'buildTasks' | 'md5Tasks' | 'postprocessTasks' | string;
+
 declare type Test = string;
 
 declare interface Texture2DAssetUserData extends TextureBaseAssetUserData {
@@ -5025,6 +5714,99 @@ export declare interface TextureCompress {
     run(): Promise<void>;
 }
 
+declare class TextureCompress_2 extends EventEmitter_2 {
+    _taskMap: Record<string, IImageTaskInfo>;
+    platform: string;
+    static overwriteFormats: Record<string, string>;
+    static _presetIdToCompressOption: Record<string, Record<string, Record<string, number | string>>>;
+    static allTextureCompressConfig: AllTextureCompressConfig;
+    static userCompressConfig: UserCompressConfig;
+    static compressCacheDir: string;
+    static storedCompressInfo: Record<string, CompressCacheInfo>;
+    static storedCompressInfoPath: string;
+    static enableMipMaps: boolean;
+    _waitingCompressQueue: Set<ICompressConfig>;
+    _compressAssetLen: number;
+    _compressExecuteInfo: CompressExecuteInfo | null;
+    textureCompress: boolean;
+    constructor(platform: string, textureCompress?: boolean);
+    static initCommonOptions(): Promise<void>;
+    init(): Promise<void>;
+    /**
+     * 更新缓存的纹理压缩项目配置
+     */
+    updateUserConfig(): Promise<void>;
+    static queryTextureCompressCache(uuid: string): CompressCacheInfo;
+    /**
+     * 根据资源信息返回资源的纹理压缩任务，无压缩任务的返回 null
+     * @param assetInfo
+     * @returns IImageTaskInfo | null
+     */
+    addTask(uuid: string, task: IImageTaskInfo): IImageTaskInfo;
+    /**
+     * 根据 Image 信息添加资源的压缩任务
+     * @param assetInfo （不支持自动图集）
+     * @returns
+     */
+    addTaskWithAssetInfo(assetInfo: Asset | VirtualAsset): IImageTaskInfo | {
+        src: string;
+        presetId: any;
+        compressOptions: Record<string, Record<string, string | number>>;
+        hasAlpha: any;
+        mtime: any;
+        hasMipmaps: boolean;
+        dest: never[];
+        suffix: never[];
+    } | undefined;
+    /**
+     * 根据图集或者 Image 资源信息返回资源的纹理压缩任务，无压缩任务的返回 null
+     */
+    genTaskInfoFromAssetInfo(assetInfo: Asset | VirtualAsset): IImageTaskInfo | {
+        src: string;
+        presetId: any;
+        compressOptions: Record<string, Record<string, string | number>>;
+        hasAlpha: any;
+        mtime: any;
+        hasMipmaps: boolean;
+        dest: never[];
+        suffix: never[];
+    } | null | undefined;
+    /**
+     * 根据纹理压缩配置 id 获取对应的纹理压缩选项
+     * @param presetId
+     * @returns Record<string, number | string> | null
+     */
+    getCompressOptions(presetId: string): (Record<string, Record<string, number | string>>) | null;
+    /**
+     * 查询某个指定 uuid 资源的纹理压缩任务
+     * @param uuid
+     * @returns
+     */
+    queryTask(uuid: string): IImageTaskInfo;
+    removeTask(uuid: string): void;
+    /**
+     * 执行所有纹理压缩任务，支持限定任务，否则将执行收集的所有纹理压缩任务
+     */
+    run(taskMap?: Record<string, IImageTaskInfo>): Promise<Record<string, IImageTaskInfo> | undefined>;
+    /**
+     * 筛选整理压缩任务中缓存失效的实际需要压缩的任务队列
+     * @param taskMap
+     * @returns
+     */
+    private sortImageTask;
+    executeCompressQueue(): Promise<unknown> | undefined;
+    _getNextTask(): ICompressConfig | null;
+    _checkTaskCanExecute(taskConfig: ICompressConfig): boolean;
+    _compressImage(config: ICompressConfig): Promise<void>;
+    /**
+     * 检查压缩任务是否已经完成，如未完成，则继续执行剩下的任务
+     * @returns
+     */
+    _step(): Promise<any>;
+    private customCompressImage;
+    compressImageByConfig(optionItem: ICompressConfig): Promise<void>;
+}
+
 declare interface TextureCubeAssetUserData extends TextureBaseAssetUserData {
     imageDatabaseUri?: string;
     isRGBE: boolean;

package/package.json

@@ -2,7 +2,7 @@
     "name": "@cocos/cocos-cli-types",
     "description": "types for cocos cli",
     "author": "cocos cli",
-    "version": "0.0.1-alpha.17.4",
+    "version": "0.0.1-alpha.19.1",
     "main": "index.d.ts",
     "types": "index.d.ts",
     "exports": {