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

package/assets.d.ts

@@ -403,6 +403,11 @@ declare interface FontDefDictionary {
     [charId: number]: FontDef;
 }
 
+/**
+ * Generate Thumbnail // 生成资源缩略图
+ */
+export declare function generateThumbnail(urlOrUUIDOrPath: string, size?: ThumbnailSize): Promise<ThumbnailInfo | null>;
+
 /** glTF 动画资源的 userData */
 declare interface GltfAnimationAssetUserData {
     gltfIndex: number;
@@ -589,7 +594,6 @@ export declare interface IAssetConfig {
     description?: string;
     docURL?: string;
     userDataConfig?: Record<string, IUerDataConfigItem>;
-    iconInfo?: ThumbnailInfo;
 }
 
 export declare interface IAssetDBInfo extends AssetDBOptions_2 {
@@ -636,6 +640,7 @@ export declare interface IAssetInfo {
     mtime?: number; // 资源文件的 mtime
     depends?: string[]; // 依赖的资源 uuid 信息
     dependeds?: string[]; // 被依赖的资源 uuid 信息
+    temp?: string; // 资源临时文件目录
 }
 
 export declare interface IAssetMeta<T extends ISupportCreateType | 'unknown' = 'unknown'> {
@@ -1205,6 +1210,11 @@ export declare function queryPath(urlOrUuid: string): Promise<string>;
  */
 export declare function querySortedPlugins(filterOptions?: FilterPluginOptions): Promise<IPluginScriptInfo[]>;
 
+/**
+ * Query Thumbnail Handlers // 查询支持缩略图生成的资源处理器列表
+ */
+export declare function queryThumbnailHandlers(): string[];
+
 /**
  * Query Asset URL // 查询资源 URL
  */
@@ -1402,6 +1412,8 @@ declare interface ThumbnailInfo {
     value: string; // 具体 icon 名字或者 image 路径，image 路径支持绝对路径、 db:// 、 project:// 、和 packages:// 下的路径
 }
 
+declare type ThumbnailSize = 'large' | 'small' | 'middle' | 'origin';
+
 /**
  * Update Asset User Data // 更新资源用户数据
  */

package/builder.d.ts

@@ -1751,6 +1751,7 @@ declare interface IAssetInfo_2 {
     mtime?: number; // 资源文件的 mtime
     depends?: string[]; // 依赖的资源 uuid 信息
     dependeds?: string[]; // 被依赖的资源 uuid 信息
+    temp?: string; // 资源临时文件目录
 }
 
 export declare type IAssetInfoMap = Record<UUID, IAssetInfo>;

package/configuration.d.ts

@@ -9,6 +9,8 @@ declare type EventEmitterMethods = Pick<EventEmitter, 'on' | 'off' | 'once' | 'e
 
 export declare function get<T>(key: string, scope?: ConfigurationScope): Promise<T>;
 
+export declare function getConfigPath(): Promise<string>;
+
 export declare function getMetadata(): Promise<ICocosConfigurationNode[]>;
 
 /**

package/engine.d.ts

@@ -1,3 +1,5 @@
+import { __private } from 'cc';
+
 export declare interface BaseItem {
     /**
      * @zh 在项目设置上显示的模块名称，支持 i18n 格式
@@ -352,6 +354,13 @@ export declare interface ModuleRenderConfig {
     migrationScript?: string;
 }
 
+export declare function queryLayerBuiltin(): Promise<{
+    name: string;
+    value: number;
+}[]>;
+
+export declare function querySortingLayerBuiltin(): Promise<readonly __private._cocos_sorting_sorting_layers__SortingItem[]>;
+
 export declare function startEngineCompilation(force?: boolean): Promise<void>;
 
 export { };

package/index.d.ts

@@ -1,16 +1,12 @@
 /// <reference types="node" />
 
+import { __private } from 'cc';
 import { ChunkInfo } from '@cocos/creator-programming-quick-pack/lib/loader';
 import { EventEmitter } from 'events';
 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 {
     /** 动画名称 */
@@ -264,6 +260,8 @@ export declare namespace Assets {
         queryAssetUserDataConfig,
         updateAssetUserData,
         queryAssetConfigMap,
+        queryThumbnailHandlers,
+        generateThumbnail,
         onAssetAdded,
         onAssetChanged,
         onAssetRemoved,
@@ -451,19 +449,6 @@ 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,
@@ -474,6 +459,7 @@ export declare namespace Configuration {
         set,
         remove,
         save,
+        getConfigPath,
         onDidSave,
         getMetadata,
         IConfiguration,
@@ -536,11 +522,6 @@ declare interface CreateAssetOptions {
     customOptions?: Record<string, any>;
 }
 
-/**
- * Add component to node // 添加组件到节点
- */
-declare function createComponent(options: IAddComponentOptions): Promise<boolean>;
-
 /**
  * Delete Asset // 删除资源
  */
@@ -573,6 +554,8 @@ export declare namespace Engine {
         getConfig,
         initEngine,
         startEngineCompilation,
+        queryLayerBuiltin,
+        querySortingLayerBuiltin,
         EngineInfo,
         IFlags,
         MakeRequired,
@@ -635,8 +618,6 @@ declare interface ExecuteAssetDBScriptMethodOptions {
     args?: any[];
 }
 
-declare function executeComponentMethod(options: IExecuteComponentMethodOptions): Promise<boolean>;
-
 declare interface Features {
     [feature: string]: IModuleItem;
 }
@@ -683,12 +664,19 @@ declare interface FontDefDictionary {
     [charId: number]: FontDef;
 }
 
+/**
+ * Generate Thumbnail // 生成资源缩略图
+ */
+declare function generateThumbnail(urlOrUUIDOrPath: string, size?: ThumbnailSize): Promise<ThumbnailInfo | null>;
+
 declare function get<T>(key: string, scope?: ConfigurationScope): Promise<T>;
 
 declare function get_2(): Promise<Project_2>;
 
 declare function getConfig(useDefault?: boolean): Promise<IEngineConfig>;
 
+declare function getConfigPath(): Promise<string>;
+
 declare function getInfo(): Promise<EngineInfo>;
 
 declare function getInfo_2(): Promise<ProjectInfo>;
@@ -900,20 +888,11 @@ declare interface GlTFUserData {
     };
 }
 
-/**
- * 创建/添加组件
- */
-declare interface IAddComponentOptions {
-    nodePathOrUuid: string;
-    component: string;
-}
-
 declare interface IAssetConfig {
     displayName?: string;
     description?: string;
     docURL?: string;
     userDataConfig?: Record<string, IUerDataConfigItem>;
-    iconInfo?: ThumbnailInfo;
 }
 
 declare interface IAssetDBInfo extends AssetDBOptions {
@@ -960,6 +939,7 @@ declare interface IAssetInfo {
     mtime?: number; // 资源文件的 mtime
     depends?: string[]; // 依赖的资源 uuid 信息
     dependeds?: string[]; // 被依赖的资源 uuid 信息
+    temp?: string; // 资源临时文件目录
 }
 
 declare interface IAssetMeta<T extends ISupportCreateType | 'unknown' = 'unknown'> {
@@ -1080,41 +1060,6 @@ 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;
-}
-
 /**
  * 配置的格式
  */
@@ -1247,15 +1192,6 @@ 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
@@ -1561,78 +1497,6 @@ 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;
@@ -1640,20 +1504,6 @@ 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;
@@ -1799,28 +1649,6 @@ 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,
@@ -2258,11 +2086,6 @@ declare interface ProjectInfo {
  */
 declare type ProjectType = '2d' | '3d';
 
-/**
- * Query all component names // 查询所有组件名称
- */
-declare function queryAllComponent(): Promise<string[]>;
-
 /**
  * Query Asset Config Map // 查询资源配置映射表
  */
@@ -2321,16 +2144,16 @@ 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 // 查询可创建资源映射表
  */
 declare function queryCreateMap(): Promise<ICreateMenuInfo[]>;
 
+declare function queryLayerBuiltin(): Promise<{
+    name: string;
+    value: number;
+}[]>;
+
 /**
  * Query Asset Path // 查询资源路径
  */
@@ -2341,6 +2164,13 @@ declare function queryPath(urlOrUuid: string): Promise<string>;
  */
 declare function querySortedPlugins(filterOptions?: FilterPluginOptions): Promise<IPluginScriptInfo[]>;
 
+declare function querySortingLayerBuiltin(): Promise<readonly __private._cocos_sorting_sorting_layers__SortingItem[]>;
+
+/**
+ * Query Thumbnail Handlers // 查询支持缩略图生成的资源处理器列表
+ */
+declare function queryThumbnailHandlers(): string[];
+
 /**
  * Query Asset URL // 查询资源 URL
  */
@@ -2395,11 +2225,6 @@ 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 // 重命名资源
  */
@@ -2411,8 +2236,6 @@ declare interface RenderTextureAssetUserData extends TextureBaseAssetUserData {
     height: number;
 }
 
-declare function resetComponent(uuid: string): Promise<void>;
-
 /** 渲染纹理精灵帧的 userData */
 declare interface RtSpriteFrameAssetUserData {
     /** 图片 UUID 或数据库 URI */
@@ -2475,11 +2298,6 @@ 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;
@@ -2667,6 +2485,8 @@ declare interface ThumbnailInfo {
     value: string; // 具体 icon 名字或者 image 路径，image 路径支持绝对路径、 db:// 、 project:// 、和 packages:// 下的路径
 }
 
+declare type ThumbnailSize = 'large' | 'small' | 'middle' | 'origin';
+
 /**
  * Clean up MCP state.
  * Note: does NOT stop the Express server — use the Server module for that.
@@ -2683,24 +2503,6 @@ 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.22.1",
+    "version": "0.0.1-alpha.22.2",
     "main": "index.d.ts",
     "types": "index.d.ts",
     "exports": {