@cocos/cocos-cli-types 0.0.1-alpha.21.2 → 0.0.1-alpha.22.1

package/configuration.d.ts

@@ -23,6 +23,7 @@ export declare interface IBaseConfiguration extends EventEmitterMethods {
      * 默认配置数据
      */
     getDefaultConfig(): Record<string, any> | undefined;
+    mergeDefaultConfig(defaultConfig?: Record<string, any>): void;
     /**
      * 获取配置值
      * @param key 配置键名，支持点号分隔的嵌套路径
@@ -61,26 +62,21 @@ export declare interface ICocosConfigurationNode {
     properties: Record<string, ICocosConfigurationPropertySchema>;
 }
 
-/**
- * Cocos 配置元数据定义。
- *
- * 基于 COCOS_CONFIG 类型（@types/cocos.config.d.ts）展开，
- * 按 group(顶级模块) → node(二级字段) 组织。
- *
- * 供 Pink 配置面板渲染使用，通过 CocosHostConfiguration.getMetadata() 返回。
- */
 export declare interface ICocosConfigurationPropertySchema {
     type: 'string' | 'number' | 'boolean' | 'object' | 'array';
     default?: unknown;
     title?: string;
     description?: string;
-    scope: string[];
-    enum?: any[];
+    enum?: Array<string | number | boolean>;
     enumDescriptions?: string[];
     minimum?: number;
     maximum?: number;
     step?: number;
     order?: number;
+    properties?: Record<string, ICocosConfigurationPropertySchema>;
+    items?: ICocosConfigurationPropertySchema | ICocosConfigurationPropertySchema[];
+    additionalProperties?: boolean | ICocosConfigurationPropertySchema;
+    required?: string[];
 }
 
 /**
@@ -99,6 +95,13 @@ export declare function migrate(): Promise<void>;
 
 export declare function migrateFromProject(): Promise<IConfiguration>;
 
+/**
+ * 注册 configurationManager 保存事件的监听器
+ * 每次 cocos.config.json 被写入磁盘时触发
+ * @returns 取消监听的函数
+ */
+export declare function onDidSave(callback: () => void): () => void;
+
 export declare function reload(): Promise<void>;
 
 export declare function remove(key: string, scope?: ConfigurationScope): Promise<boolean>;

package/index.d.ts

@@ -6,6 +6,11 @@ import { NextFunction } from 'express';
 import { Request as Request_2 } from 'express';
 import { Response as Response_2 } from 'express';
 
+/**
+ * Add component to node // 添加组件到节点
+ */
+declare function addComponent(options: IAddComponentOptions): Promise<IComponent>;
+
 /** 动画剪辑资源的 userData */
 declare interface AnimationClipAssetUserData {
     /** 动画名称 */
@@ -446,6 +451,19 @@ declare type CCEModuleMap = {
 
 declare function close_2(): Promise<void>;
 
+export declare namespace Component {
+    export {
+        addComponent,
+        createComponent,
+        removeComponent,
+        queryComponent,
+        resetComponent,
+        setProperty,
+        executeComponentMethod,
+        queryAllComponent
+    };
+}
+
 export declare namespace Configuration {
     export {
         init_3 as init,
@@ -456,6 +474,7 @@ export declare namespace Configuration {
         set,
         remove,
         save,
+        onDidSave,
         getMetadata,
         IConfiguration,
         ConfigurationScope,
@@ -517,6 +536,11 @@ declare interface CreateAssetOptions {
     customOptions?: Record<string, any>;
 }
 
+/**
+ * Add component to node // 添加组件到节点
+ */
+declare function createComponent(options: IAddComponentOptions): Promise<boolean>;
+
 /**
  * Delete Asset // 删除资源
  */
@@ -611,6 +635,8 @@ declare interface ExecuteAssetDBScriptMethodOptions {
     args?: any[];
 }
 
+declare function executeComponentMethod(options: IExecuteComponentMethodOptions): Promise<boolean>;
+
 declare interface Features {
     [feature: string]: IModuleItem;
 }
@@ -874,6 +900,14 @@ declare interface GlTFUserData {
     };
 }
 
+/**
+ * 创建/添加组件
+ */
+declare interface IAddComponentOptions {
+    nodePathOrUuid: string;
+    component: string;
+}
+
 declare interface IAssetConfig {
     displayName?: string;
     description?: string;
@@ -981,6 +1015,7 @@ declare interface IBaseConfiguration extends EventEmitterMethods {
      * 默认配置数据
      */
     getDefaultConfig(): Record<string, any> | undefined;
+    mergeDefaultConfig(defaultConfig?: Record<string, any>): void;
     /**
      * 获取配置值
      * @param key 配置键名，支持点号分隔的嵌套路径
@@ -1024,32 +1059,62 @@ declare interface ICocosConfigurationNode {
     properties: Record<string, ICocosConfigurationPropertySchema>;
 }
 
-/**
- * Cocos 配置元数据定义。
- *
- * 基于 COCOS_CONFIG 类型（@types/cocos.config.d.ts）展开，
- * 按 group(顶级模块) → node(二级字段) 组织。
- *
- * 供 Pink 配置面板渲染使用，通过 CocosHostConfiguration.getMetadata() 返回。
- */
 declare interface ICocosConfigurationPropertySchema {
     type: 'string' | 'number' | 'boolean' | 'object' | 'array';
     default?: unknown;
     title?: string;
     description?: string;
-    scope: string[];
-    enum?: any[];
+    enum?: Array<string | number | boolean>;
     enumDescriptions?: string[];
     minimum?: number;
     maximum?: number;
     step?: number;
     order?: number;
+    properties?: Record<string, ICocosConfigurationPropertySchema>;
+    items?: ICocosConfigurationPropertySchema | ICocosConfigurationPropertySchema[];
+    additionalProperties?: boolean | ICocosConfigurationPropertySchema;
+    required?: string[];
 }
 
 declare interface ICollisionMatrix {
     [x: string]: number;
 }
 
+/**
+ * 代表组件属性信息
+ */
+declare interface IComponent extends IComponentIdentifier {
+    properties: {
+        [key: string]: IPropertyValueType;
+    };
+    prefab: ICompPrefabInfo | null;
+}
+
+declare interface IComponentForPinK extends IProperty {
+    value: {
+        enabled: IPropertyValueType;
+        uuid: IPropertyValueType;
+        name: IPropertyValueType;
+    } & Record<string, IPropertyValueType>;
+    mountedRoot?: string;
+}
+
+/**
+ * 代表一个组件
+ */
+declare interface IComponentIdentifier {
+    cid: string;
+    path: string;
+    uuid: string;
+    name: string;
+    type: string;
+    enabled: boolean;
+}
+
+declare interface ICompPrefabInfo {
+    fileId: string;
+}
+
 /**
  * 配置的格式
  */
@@ -1182,6 +1247,15 @@ declare interface IEngineProjectConfig extends Exclude<IEngineConfig, 'includeMo
     globalConfigKey?: string;
 }
 
+/**
+ * 执行组件方法选项
+ */
+declare interface IExecuteComponentMethodOptions {
+    uuid: string;
+    name: string;
+    args: any[];
+}
+
 declare interface IFbxSetting {
     /**
      * https://github.com/cocos-creator/FBX-glTF-conv/pull/26
@@ -1487,6 +1561,78 @@ declare interface IProject {
     updateInfo<T>(keyOrValue: string | ProjectInfo, value?: T): Promise<boolean>;
 }
 
+/**
+ * 组件的 dump 数据，以 IProperty 格式编码组件信息
+ * 与 IComponent 不同，所有属性（包括 uuid, name, enabled）都通过 encodeObject 编码为 IProperty
+ */
+declare interface IProperty {
+    value: { [key: string]: IPropertyValueType } | IPropertyValueType;
+    default?: any; // 默认值
+
+    // 多选节点之后，这里存储多个数据，用于自行判断多选后的显示效果，无需更新该数据
+    values?: ({ [key: string]: IPropertyValueType } | IPropertyValueType)[];
+
+    lock?: { [key in keyof Vec4]?: IPropertyLock };
+
+    cid?: string;
+    type?: string;
+    ui?: { name: string; data?: any }; // 是否用指定的 UI 组件，name 是组件的名称
+    readonly?: boolean;
+    visible?: boolean;
+    name?: string;
+
+    elementTypeData?: IProperty; // 数组里的数据的默认值 dump
+
+    path?: string; // 数据的搜索路径，这个是由使用方填充的
+
+    isArray?: boolean;
+    invalid?: boolean;
+    extends?: string[]; // 继承链
+    displayName?: string; // 显示到界面上的名字
+    displayOrder?: number; // 显示排序
+    help?: string; // 帮助文档的 url 地址
+    group?: IPropertyGroupOptions; // tab
+    tooltip?: string; // 提示文本
+    editor?: any; // 组件上定义的编辑器数据
+    animatable?: boolean; // 是否可以在动画中编辑
+    radioGroup?: boolean; // 是否渲染为 RadioGroup
+
+    // Enum
+    enumList?: any[]; // enum 类型的 list 选项数组
+
+    bitmaskList?: any[];
+
+    // Number
+    min?: number; // 数值类型的最小值
+    max?: number; // 数值类型的最大值
+    step?: number; // 数值类型的步进值
+    slide?: boolean; // 数组是否显示为滑块
+    unit?: string; // 显示的单位
+    radian?: boolean; // 标识是否为角度
+
+    // Label
+    multiline?: boolean; // 字符串是否允许换行
+    // nullable?: boolean; 属性是否允许为空
+
+    optionalTypes?: string[]; // 对属性是 object 且是可变类型的数据的支持，比如 render-pipeline
+
+    userData?: { [key: string]: any }; // 用户透传的数据
+}
+
+declare interface IPropertyGroupOptions {
+    id: string // 默认 'default'
+    name: string,
+    displayOrder: number, // 默认 Infinity, 排在最后面
+    style: string // 默认为 'tab'
+}
+
+declare type IPropertyLock = { 
+    default: number; 
+    message: string 
+};
+
+declare type IPropertyValueType = IProperty | IProperty[] | null | undefined | number | boolean | string | Vec4 | Vec3 | Vec2 | Mat4 | any | Array<unknown>
+
 declare interface IRedirectInfo {
     // 跳转资源的类型
     type: string;
@@ -1494,6 +1640,20 @@ declare interface IRedirectInfo {
     uuid: string;
 }
 
+/**
+ * 删除组件
+ */
+declare interface IRemoveComponentOptions {
+    pathOrUuidOrUrl: string;
+}
+
+declare interface ISetPropertyOptionsForPink {
+    uuid: string;
+    path: string;
+    dump: IProperty;
+    record?: boolean;
+}
+
 declare interface ISocketConfig {
     connection: (socket: any) => void;
     disconnect: (socket: any) => void;
@@ -1639,6 +1799,28 @@ declare type MacroItem = {
 
 declare type MakeRequired<T, K extends keyof T> = T & Required<Pick<T, K>>;
 
+declare interface Mat4 {
+    m00: number;
+    m01: number;
+    m02: number;
+    m03: number;
+
+    m04: number;
+    m05: number;
+    m06: number;
+    m07: number;
+
+    m08: number;
+    m09: number;
+    m10: number;
+    m11: number;
+
+    m12: number;
+    m13: number;
+    m14: number;
+    m15: number;
+}
+
 export declare namespace Mcp {
     export {
         register,
@@ -1802,6 +1984,13 @@ declare function onAssetRemoved(listener: (info: IAssetInfo) => void): () => voi
  */
 declare function onDBReady(listener: (dbInfo: IAssetDBInfo) => void): () => void;
 
+/**
+ * 注册 configurationManager 保存事件的监听器
+ * 每次 cocos.config.json 被写入磁盘时触发
+ * @returns 取消监听的函数
+ */
+declare function onDidSave(callback: () => void): () => void;
+
 /**
  * Register listener for initialization progress.
  *
@@ -2069,6 +2258,11 @@ declare interface ProjectInfo {
  */
 declare type ProjectType = '2d' | '3d';
 
+/**
+ * Query all component names // 查询所有组件名称
+ */
+declare function queryAllComponent(): Promise<string[]>;
+
 /**
  * Query Asset Config Map // 查询资源配置映射表
  */
@@ -2127,6 +2321,11 @@ declare function queryAssetUserDataConfig(urlOrUuidOrPath: string): Promise<fals
  */
 declare function queryAssetUsers(uuidOrUrl: string, type?: QueryAssetType): Promise<string[]>;
 
+/**
+ * Query component info // 查询组件信息
+ */
+declare function queryComponent(uuid: string): Promise<IComponentForPinK | null>;
+
 /**
  * Query Creatable Asset Map // 查询可创建资源映射表
  */
@@ -2196,6 +2395,11 @@ declare function reload(): Promise<void>;
 
 declare function remove(key: string, scope?: ConfigurationScope): Promise<boolean>;
 
+/**
+ * Remove component from node // 移除节点上的组件
+ */
+declare function removeComponent(options: IRemoveComponentOptions): Promise<boolean>;
+
 /**
  * Rename Asset // 重命名资源
  */
@@ -2207,6 +2411,8 @@ declare interface RenderTextureAssetUserData extends TextureBaseAssetUserData {
     height: number;
 }
 
+declare function resetComponent(uuid: string): Promise<void>;
+
 /** 渲染纹理精灵帧的 userData */
 declare interface RtSpriteFrameAssetUserData {
     /** 图片 UUID 或数据库 URI */
@@ -2269,6 +2475,11 @@ export declare namespace Server {
 
 declare function set<T>(key: string, value: T, scope?: ConfigurationScope): Promise<boolean>;
 
+/**
+ * Set component property // 设置组件属性
+ */
+declare function setProperty(options: ISetPropertyOptionsForPink): Promise<boolean>;
+
 declare interface SharedSettings {
     useDefineForClassFields: boolean;
     allowDeclareFields: boolean;
@@ -2472,6 +2683,24 @@ declare function updateAssetUserData(urlOrUuidOrPath: string, path: string, valu
  */
 declare function updateDefaultUserData(handler: string, path: string, value: any): Promise<void>;
 
+declare interface Vec2 {
+    x: number;
+    y: number;
+}
+
+declare interface Vec3 {
+    x: number;
+    y: number;
+    z: number;
+}
+
+declare interface Vec4 {
+    x: number;
+    y: number;
+    z: number;
+    w: number;
+}
+
 declare type WrapMode = 'repeat' | 'clamp-to-edge' | 'mirrored-repeat';
 
 export { };

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.21.2",
+    "version": "0.0.1-alpha.22.1",
     "main": "index.d.ts",
     "types": "index.d.ts",
     "exports": {

package/service.d.ts

@@ -245,11 +245,43 @@ declare interface BitmapFontAssetUserData {
  * 在子进程中处理所有节点相关操作
  */
 export declare class ComponentService extends BaseService<IComponentEvents> implements IComponentService {
+    modeName: SceneModeType;
+    protected _sceneEventListener: ISceneEvents[];
+    protected _recycleComponent: Record<string, Component>;
+    constructor();
+    /**
+     * 查询当前正在编辑的模式名字
+     */
+    queryMode(): SceneModeType;
+    onAddComponent(comp: Component, opts?: IOptionBase): void;
+    onRemoveComponent(comp: Component, opts?: IOptionBase): void;
+    onComponentAdded(comp: Component, opts?: IOptionBase): void;
+    onComponentRemoved(comp: Component, opts?: IOptionBase): void;
+    dispatchEvents(eventName: keyof ISceneEvents, ...args: any[any]): void;
     private addComponentImpl;
     addComponent(params: IAddComponentOptions): Promise<IComponent>;
+    /**
+     * 创建组件
+     * @param params
+     */
+    private requireComponentList;
+    createComponent(params: IAddComponentOptions): Promise<boolean>;
+    checkComponentsCollision(node: Node_2): Promise<void>;
+    checkDynamicBodyShape(ndoe: Node_2): void;
+    /**
+     * 通过 path、uuid 或 url 查找组件实例
+     */
+    private findComponent;
     removeComponent(params: IRemoveComponentOptions): Promise<boolean>;
-    queryComponent(params: IQueryComponentOptions): Promise<IComponent | null>;
+    queryComponent(params: IQueryComponentOptions): Promise<IComponent | IComponentForPinK | null>;
     setProperty(options: ISetPropertyOptions): Promise<boolean>;
+    /**
+     * 查询一个节点的实例
+     * @param {*} uuid
+     * @return {cc.Node}
+     */
+    query(uuid: string | undefined): Node_2 | null;
+    setPropertyForPink(uuid: string, path: string, dump: IProperty, record?: boolean): Promise<boolean>;
     private setPropertyImp;
     queryAllComponent(): Promise<string[]>;
     init(): void;
@@ -272,6 +304,12 @@ export declare class ComponentService extends BaseService<IComponentEvents> impl
      * @param {cc.Component} component
      */
     remove(uuid: string, component: Component): void;
+    /**
+     * 重置组件
+     * @param uuid component 的 uuid
+     */
+    resetComponent(params: IQueryComponentOptions): Promise<boolean>;
+    executeComponentMethod(options: IExecuteComponentMethodOptions): Promise<boolean>;
 }
 
 /**
@@ -602,10 +640,10 @@ declare interface GlTFUserData {
 }
 
 /**
- * 创建组件
+ * 创建/添加组件
  */
 declare interface IAddComponentOptions {
-    nodePath: string;
+    nodePathOrUuid: string;
     component: string;
 }
 
@@ -762,13 +800,23 @@ declare interface IComponent extends IComponentIdentifier {
 /**
  * 场景事件类型
  */
-declare interface IComponentEvents {
+declare interface IComponentEvents extends INodeEvents {
     'component:add': [Component];
     'component:before-remove': [Component];
     'component:remove': [Component];
     'component:set-property': [Component, IChangeNodeOptions];
     'component:added': [Component];
     'component:removed': [Component];
+    'component:before-add-component': [string, Node_2];
+}
+
+declare interface IComponentForPinK extends IProperty {
+    value: {
+        enabled: IPropertyValueType;
+        uuid: IPropertyValueType;
+        name: IPropertyValueType;
+    } & Record<string, IPropertyValueType>;
+    mountedRoot?: string;
 }
 
 /**
@@ -788,10 +836,15 @@ declare interface IComponentIdentifier {
  */
 declare interface IComponentService extends IServiceEvents {
     /**
-     * 创建组件
+     * 添加组件
      * @param params
      */
     addComponent(params: IAddComponentOptions): Promise<IComponent>;
+    /**
+     * 创建组件
+     * @param params
+     */
+    createComponent(params: IAddComponentOptions): Promise<boolean>;
     /**
      * 删除组件
      * @param params
@@ -802,14 +855,27 @@ declare interface IComponentService extends IServiceEvents {
      * @param params
      */
     setProperty(params: ISetPropertyOptions): Promise<boolean>;
+    /**
+     * 设置组件属性，pink专属接口，因为结构与ISetPropertyOptions是不同的
+     * @param params
+     */
+    setPropertyForPink(uuid: string, path: string, dump: IProperty, record?: boolean): Promise<boolean>;
     /**
      * 查询组件
      */
-    queryComponent(params: IQueryComponentOptions): Promise<IComponent | null>;
+    queryComponent(params: IQueryComponentOptions): Promise<IComponent | IComponentForPinK | null>;
     /**
      * 获取所有组件名，包含内置与自定义组件
      */
     queryAllComponent(): Promise<string[]>;
+    /**
+     * 复位组件
+     */
+    resetComponent(params: IQueryComponentOptions): Promise<boolean>;
+    /**
+     * 执行组件方法
+     */
+    executeComponentMethod(options: IExecuteComponentMethodOptions): Promise<boolean>;
     init(): void;
     unregisterCompMgrEvents(): void;
 }
@@ -926,6 +992,15 @@ declare interface IEngineService extends IServiceEvents {
     repaintInEditMode(): Promise<void>;
 }
 
+/**
+ * 执行组件方法选项
+ */
+declare interface IExecuteComponentMethodOptions {
+    uuid: string;
+    name: string;
+    args: any[];
+}
+
 declare interface IFbxSetting {
     /**
      * https://github.com/cocos-creator/FBX-glTF-conv/pull/26
@@ -1093,6 +1168,31 @@ declare interface INodeService extends IServiceEvents {
      * 查询节点
      */
     queryNode(params: IQueryNodeParams): Promise<INode | null>;
+    /**
+     * 查询节点树（层级管理器格式）
+     */
+    queryNodeTree(params: IQueryNodeTreeParams): Promise<INodeTreeItem | null>;
+}
+
+declare interface INodeTreeComponent {
+    isCustom: boolean;
+    type: string;
+    value: string;
+    extends: string[];
+}
+
+declare interface INodeTreeItem {
+    name: string;
+    active: boolean;
+    locked: boolean;
+    type: string;
+    children: INodeTreeItem[];
+    prefab: IPrefabStateInfo;
+    parent: string;
+    path: string;
+    isScene: boolean;
+    readonly: boolean;
+    components: INodeTreeComponent[];
 }
 
 /**
@@ -1103,6 +1203,10 @@ declare interface IOpenOptions {
     simpleNode?: boolean;
 }
 
+export declare interface IOptionBase {
+    modeName?: string;
+}
+
 declare interface IPrefab {
     name: string;
     uuid: string;
@@ -1169,16 +1273,86 @@ declare interface IPrefabService extends IServiceEvents {
     removePrefabInfoFromNode(node: Node_2, removeNested?: boolean): void;
 }
 
+declare interface IPrefabStateInfo {
+    state: PrefabState;
+    isUnwrappable: boolean;
+    isRevertable: boolean;
+    isApplicable: boolean;
+    isAddedChild: boolean;
+    isNested: boolean;
+    assetUuid: string;
+}
+
+/**
+ * 组件的 dump 数据，以 IProperty 格式编码组件信息
+ * 与 IComponent 不同，所有属性（包括 uuid, name, enabled）都通过 encodeObject 编码为 IProperty
+ */
 declare interface IProperty {
     value: { [key: string]: IPropertyValueType } | IPropertyValueType;
+    default?: any; // 默认值
+
+    // 多选节点之后，这里存储多个数据，用于自行判断多选后的显示效果，无需更新该数据
+    values?: ({ [key: string]: IPropertyValueType } | IPropertyValueType)[];
+
+    lock?: { [key in keyof Vec4]?: IPropertyLock };
+
+    cid?: string;
     type?: string;
+    ui?: { name: string; data?: any }; // 是否用指定的 UI 组件，name 是组件的名称
     readonly?: boolean;
+    visible?: boolean;
     name?: string;
+
+    elementTypeData?: IProperty; // 数组里的数据的默认值 dump
+
     path?: string; // 数据的搜索路径，这个是由使用方填充的
+
     isArray?: boolean;
+    invalid?: boolean;
+    extends?: string[]; // 继承链
+    displayName?: string; // 显示到界面上的名字
+    displayOrder?: number; // 显示排序
+    help?: string; // 帮助文档的 url 地址
+    group?: IPropertyGroupOptions; // tab
+    tooltip?: string; // 提示文本
+    editor?: any; // 组件上定义的编辑器数据
+    animatable?: boolean; // 是否可以在动画中编辑
+    radioGroup?: boolean; // 是否渲染为 RadioGroup
+
+    // Enum
+    enumList?: any[]; // enum 类型的 list 选项数组
+
+    bitmaskList?: any[];
+
+    // Number
+    min?: number; // 数值类型的最小值
+    max?: number; // 数值类型的最大值
+    step?: number; // 数值类型的步进值
+    slide?: boolean; // 数组是否显示为滑块
+    unit?: string; // 显示的单位
+    radian?: boolean; // 标识是否为角度
+
+    // Label
+    multiline?: boolean; // 字符串是否允许换行
+    // nullable?: boolean; 属性是否允许为空
+
+    optionalTypes?: string[]; // 对属性是 object 且是可变类型的数据的支持，比如 render-pipeline
+
     userData?: { [key: string]: any }; // 用户透传的数据
 }
 
+declare interface IPropertyGroupOptions {
+    id: string // 默认 'default'
+    name: string,
+    displayOrder: number, // 默认 Infinity, 排在最后面
+    style: string // 默认为 'tab'
+}
+
+declare type IPropertyLock = { 
+    default: number; 
+    message: string 
+};
+
 declare interface IPropertyOverrideInfo {
     targetInfo: ITargetInfo | null;
     propertyPath: string[];
@@ -1198,7 +1372,8 @@ declare interface IQuat {
  * 查询组件
  */
 declare interface IQueryComponentOptions {
-    path: string;
+    pathOrUuidOrUrl: string;
+    isFull?: boolean;
 }
 
 declare interface IQueryNodeParams {
@@ -1207,6 +1382,10 @@ declare interface IQueryNodeParams {
     queryComponent: boolean;
 }
 
+declare interface IQueryNodeTreeParams {
+    path?: string;
+}
+
 declare interface IRedirectInfo {
     // 跳转资源的类型
     type: string;
@@ -1225,7 +1404,7 @@ declare interface IReloadOptions {
  * 删除组件
  */
 declare interface IRemoveComponentOptions {
-    path: string;
+    pathOrUuidOrUrl: string;
 }
 
 declare interface IRevertToPrefabParams {
@@ -1249,6 +1428,13 @@ declare interface IScene extends IBaseIdentifier {
     components: IComponentIdentifier[];
 }
 
+export declare interface ISceneEvents {
+    onAddComponent?(comp: Component): void;
+    onRemoveComponent?(comp: Component): void;
+    onComponentAdded?(comp: Component, opts?: IOptionBase): void;
+    onComponentRemoved?(comp: Component, opts?: IOptionBase): void;
+}
+
 declare interface IScriptEvents {
     /**
      * 当脚本刷新并执行完成时触发
@@ -1263,7 +1449,7 @@ declare interface IScriptService extends IServiceEvents {
     scriptChange(): Promise<void>;
     queryScriptCid(uuid: string): Promise<string | null>;
     queryScriptName(uuid: string): Promise<string | null>;
-    isCustomComponent(classConstructor: Function): Promise<boolean>;
+    isCustomComponent(classConstructor: Function): boolean;
     suspend(condition: Promise<any>): void;
 }
 
@@ -1287,6 +1473,9 @@ declare interface IServiceEvents {
     onComponentAdded?(comp: Component): void;
     onComponentRemoved?(comp: Component): void;
     onBeforeRemoveComponent?(comp: Component): void;
+    onComponentBeforeChanged?(node: Node_2): void;
+    onBeforeComponentAdded?(name: string, node: Node_2): void;
+    onComponentChanged?(name: string, opts: IChangeNodeOptions): void;
     onAssetDeleted?(uuid: string): void;
     onAssetChanged?(uuid: string): void;
     onAssetRefreshed?(uuid: string): void;
@@ -1532,6 +1721,7 @@ export declare class NodeService extends BaseService<INodeEvents> implements INo
     private _walkNode;
     updateNode(params: IUpdateNodeParams): Promise<IUpdateNodeResult>;
     queryNode(params: IQueryNodeParams): Promise<INode | null>;
+    queryNodeTree(params: IQueryNodeTreeParams): Promise<INodeTreeItem | null>;
     /**
      * 确保节点有 UITransform 组件
      * 目前只需保障在创建空节点的时候检查任意上级是否为 canvas
@@ -1653,8 +1843,8 @@ declare enum NormalImportSetting {
 
 declare enum OptimizationPolicy {
     AUTO = 0,
-    SINGLE_INSTANCE = 0,
-    MULTI_INSTANCE = 1
+    SINGLE_INSTANCE = 1,
+    MULTI_INSTANCE = 2
 }
 
 /** 粒子资源的 userData */
@@ -1843,6 +2033,13 @@ export declare class PrefabService extends BaseService<IPrefabEvents> implements
     findPathWithRule(root: Node_2, rule: Function): string[];
 }
 
+declare enum PrefabState {
+    NotAPrefab = 0,// Normal node, not a Prefab
+    PrefabChild = 1,// Child node of a Prefab, without PrefabInstance
+    PrefabInstance = 2,// Root node of a Prefab that contains a PrefabInstance
+    PrefabLostAsset = 3
+}
+
 /** 类装饰器：注册 Service 类，自动收集所有公有方法 */
 export declare function register(name?: string): ClassDecorator;
 
@@ -1879,6 +2076,14 @@ declare interface RtSpriteFrameAssetUserData {
  */
 declare const SCENE_TEMPLATE_TYPE: readonly ['2d', '3d', 'quality'];
 
+declare enum SceneModeType {
+    General = 'general',
+    Prefab = 'prefab',
+    Animation = 'animation',
+    Preview = 'preview',
+    Unset = ''
+}
+
 /** JavaScript 脚本模块的 userData */
 declare interface ScriptModuleUserData {
     isPlugin: false;
@@ -1916,7 +2121,7 @@ export declare class ScriptService extends BaseService<IScriptEvents> implements
      * 是否是自定义脚本（不是引擎定义的组件）
      * @param classConstructor
      */
-    isCustomComponent(classConstructor: Function): Promise<boolean>;
+    isCustomComponent(classConstructor: Function): boolean;
     _loadScripts(): Promise<void>;
     /**
      * 加载脚本时触发