@cocos/cocos-cli-types 0.0.1-alpha.21.2 → 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[]>;
 
 /**
@@ -23,6 +25,7 @@ export declare interface IBaseConfiguration extends EventEmitterMethods {
      * 默认配置数据
      */
     getDefaultConfig(): Record<string, any> | undefined;
+    mergeDefaultConfig(defaultConfig?: Record<string, any>): void;
     /**
      * 获取配置值
      * @param key 配置键名，支持点号分隔的嵌套路径
@@ -61,26 +64,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 +97,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/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,5 +1,6 @@
 /// <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';
@@ -259,6 +260,8 @@ export declare namespace Assets {
         queryAssetUserDataConfig,
         updateAssetUserData,
         queryAssetConfigMap,
+        queryThumbnailHandlers,
+        generateThumbnail,
         onAssetAdded,
         onAssetChanged,
         onAssetRemoved,
@@ -456,6 +459,8 @@ export declare namespace Configuration {
         set,
         remove,
         save,
+        getConfigPath,
+        onDidSave,
         getMetadata,
         IConfiguration,
         ConfigurationScope,
@@ -549,6 +554,8 @@ export declare namespace Engine {
         getConfig,
         initEngine,
         startEngineCompilation,
+        queryLayerBuiltin,
+        querySortingLayerBuiltin,
         EngineInfo,
         IFlags,
         MakeRequired,
@@ -657,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>;
@@ -879,7 +893,6 @@ declare interface IAssetConfig {
     description?: string;
     docURL?: string;
     userDataConfig?: Record<string, IUerDataConfigItem>;
-    iconInfo?: ThumbnailInfo;
 }
 
 declare interface IAssetDBInfo extends AssetDBOptions {
@@ -926,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'> {
@@ -981,6 +995,7 @@ declare interface IBaseConfiguration extends EventEmitterMethods {
      * 默认配置数据
      */
     getDefaultConfig(): Record<string, any> | undefined;
+    mergeDefaultConfig(defaultConfig?: Record<string, any>): void;
     /**
      * 获取配置值
      * @param key 配置键名，支持点号分隔的嵌套路径
@@ -1024,26 +1039,21 @@ 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 {
@@ -1802,6 +1812,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.
  *
@@ -2132,6 +2149,11 @@ declare function queryAssetUsers(uuidOrUrl: string, type?: QueryAssetType): Prom
  */
 declare function queryCreateMap(): Promise<ICreateMenuInfo[]>;
 
+declare function queryLayerBuiltin(): Promise<{
+    name: string;
+    value: number;
+}[]>;
+
 /**
  * Query Asset Path // 查询资源路径
  */
@@ -2142,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
  */
@@ -2456,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.

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.2",
     "main": "index.d.ts",
     "types": "index.d.ts",
     "exports": {