@cocos/cocos-cli-types 0.0.1-alpha.23.1 → 0.0.1-alpha.24.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/assets.d.ts CHANGED
@@ -1,12 +1,12 @@
1
1
  /// <reference types="node" />
2
2
 
3
3
  /** 动画剪辑资源的 userData */
4
- declare interface AnimationClipAssetUserData {
4
+ export declare interface AnimationClipAssetUserData {
5
5
  /** 动画名称 */
6
6
  name: string;
7
7
  }
8
8
 
9
- declare interface AnimationImportSetting {
9
+ export declare interface AnimationImportSetting {
10
10
  /**
11
11
  * glTf 中原始动画资源的名称。
12
12
  */
@@ -96,7 +96,7 @@ declare interface AnimationImportSetting {
96
96
  }
97
97
 
98
98
  /** 所有资源处理器类型的常量数组(用于 Zod enum 和 TypeScript type) */
99
- declare const ASSET_HANDLER_TYPES: string[];
99
+ export declare const ASSET_HANDLER_TYPES: string[];
100
100
 
101
101
  export declare interface AssetDBOptions {
102
102
  name: string;
@@ -122,7 +122,7 @@ export declare interface AssetDBOptions {
122
122
  /**
123
123
  * 资源数据库启动参数
124
124
  */
125
- declare interface AssetDBOptions_2 {
125
+ export declare interface AssetDBOptions_2 {
126
126
  name: string;
127
127
  target: string;
128
128
  library: string;
@@ -243,13 +243,13 @@ export declare interface AssetUserDataMap {
243
243
  }
244
244
 
245
245
  /** 音频资源的 userData */
246
- declare interface AudioClipAssetUserData {
246
+ export declare interface AudioClipAssetUserData {
247
247
  /** 下载模式:0-Web Audio, 1-DOM Audio */
248
248
  downloadMode: number;
249
249
  }
250
250
 
251
251
  /** 自动图集资源的 userData */
252
- declare interface AutoAtlasAssetUserData {
252
+ export declare interface AutoAtlasAssetUserData {
253
253
  compressed: boolean;
254
254
  dest: any;
255
255
  /** 打包图像的尺寸 */
@@ -274,7 +274,7 @@ declare interface AutoAtlasAssetUserData {
274
274
  }
275
275
 
276
276
  /** 位图字体资源的 userData */
277
- declare interface BitmapFontAssetUserData {
277
+ export declare interface BitmapFontAssetUserData {
278
278
  /** 字体配置 */
279
279
  _fntConfig: any;
280
280
  /** 字体大小 */
@@ -336,7 +336,7 @@ export declare interface CreateAssetOptions {
336
336
  export declare function deleteAsset(dbPath: string): Promise<IAssetInfo | null>;
337
337
 
338
338
  /** 文件夹资源的 userData */
339
- declare interface DirectoryAssetUserData {
339
+ export declare interface DirectoryAssetUserData {
340
340
  /** 是否是资源包 */
341
341
  isBundle?: boolean;
342
342
  /** 资源包配置 ID */
@@ -348,7 +348,7 @@ declare interface DirectoryAssetUserData {
348
348
  }
349
349
 
350
350
  /** Effect 着色器资源的 userData */
351
- declare interface EffectAssetUserData {
351
+ export declare interface EffectAssetUserData {
352
352
  /** 预编译组合 */
353
353
  combinations?: any;
354
354
  /** 编辑器相关数据 */
@@ -361,7 +361,7 @@ export declare interface ExecuteAssetDBScriptMethodOptions {
361
361
  args?: any[];
362
362
  }
363
363
 
364
- declare interface FileNameCheckConfig {
364
+ export declare interface FileNameCheckConfig {
365
365
  // 匹配规则
366
366
  regStr: string;
367
367
  // 匹配失败时的提示类型
@@ -370,7 +370,7 @@ declare interface FileNameCheckConfig {
370
370
  failedInfo: string;
371
371
  }
372
372
 
373
- declare type Filter = 'none' | 'nearest' | 'linear';
373
+ export declare type Filter = 'none' | 'nearest' | 'linear';
374
374
 
375
375
  export declare interface FilterPluginOptions {
376
376
  loadPluginInEditor?: boolean;
@@ -379,7 +379,7 @@ export declare interface FilterPluginOptions {
379
379
  loadPluginInMiniGame?: boolean;
380
380
  }
381
381
 
382
- declare interface FntData {
382
+ export declare interface FntData {
383
383
  commonHeight?: number;
384
384
  fontSize?: number;
385
385
  atlasName?: string;
@@ -387,7 +387,7 @@ declare interface FntData {
387
387
  kerningDict?: KerningDict;
388
388
  }
389
389
 
390
- declare interface FontDef {
390
+ export declare interface FontDef {
391
391
  rect: {
392
392
  x: number;
393
393
  y: number;
@@ -399,7 +399,7 @@ declare interface FontDef {
399
399
  xAdvance: number;
400
400
  }
401
401
 
402
- declare interface FontDefDictionary {
402
+ export declare interface FontDefDictionary {
403
403
  [charId: number]: FontDef;
404
404
  }
405
405
 
@@ -409,7 +409,7 @@ declare interface FontDefDictionary {
409
409
  export declare function generateThumbnail(urlOrUUIDOrPath: string, size?: ThumbnailSize): Promise<ThumbnailInfo | null>;
410
410
 
411
411
  /** glTF 动画资源的 userData */
412
- declare interface GltfAnimationAssetUserData {
412
+ export declare interface GltfAnimationAssetUserData {
413
413
  gltfIndex: number;
414
414
  events: Array<{
415
415
  frame: number;
@@ -445,20 +445,20 @@ declare interface GltfAnimationAssetUserData {
445
445
  }
446
446
 
447
447
  /** glTF 嵌入图片子资源的 userData */
448
- declare interface GltfEmbededImageAssetUserData extends IVirtualAssetUserData {
448
+ export declare interface GltfEmbededImageAssetUserData extends IVirtualAssetUserData {
449
449
  /** 是否修复 Alpha 透明度瑕疵 */
450
450
  fixAlphaTransparencyArtifacts?: boolean;
451
451
  }
452
452
 
453
- declare type GltfpackOptions = Record<string, any>;
453
+ export declare type GltfpackOptions = Record<string, any>;
454
454
 
455
455
  /** glTF Skeleton 子资源的 userData */
456
- declare interface GltfSkeletonAssetUserData extends IVirtualAssetUserData {
456
+ export declare interface GltfSkeletonAssetUserData extends IVirtualAssetUserData {
457
457
  /** 骨骼数量 */
458
458
  jointsLength?: number;
459
459
  }
460
460
 
461
- declare interface GlTFUserData {
461
+ export declare interface GlTFUserData {
462
462
  assetFinder?: SerializedAssetFinder;
463
463
 
464
464
  imageMetas: ImageMeta[];
@@ -707,7 +707,7 @@ export declare interface ICreateMenuInfo {
707
707
  fileNameCheckConfigs?: FileNameCheckConfig[];
708
708
  }
709
709
 
710
- declare interface IFbxSetting {
710
+ export declare interface IFbxSetting {
711
711
  /**
712
712
  * https://github.com/cocos-creator/FBX-glTF-conv/pull/26
713
713
  */
@@ -744,7 +744,7 @@ declare interface IFbxSetting {
744
744
  }
745
745
 
746
746
  /** 图片资源的 userData */
747
- declare interface ImageAssetUserData {
747
+ export declare interface ImageAssetUserData {
748
748
  /** 图片类型 */
749
749
  type: ImageImportType;
750
750
  /** 垂直翻转 */
@@ -768,9 +768,9 @@ declare interface ImageAssetUserData {
768
768
  alpha?: string;
769
769
  }
770
770
 
771
- declare type ImageImportType = 'raw' | 'texture' | 'normal map' | 'sprite-frame' | 'texture cube';
771
+ export declare type ImageImportType = 'raw' | 'texture' | 'normal map' | 'sprite-frame' | 'texture cube';
772
772
 
773
- declare interface ImageMeta {
773
+ export declare interface ImageMeta {
774
774
  /**
775
775
  * 图片名字。
776
776
  */
@@ -852,7 +852,7 @@ export declare interface IUerDataConfigItem {
852
852
  }
853
853
 
854
854
  /** glTF 虚拟子资源的通用 userData */
855
- declare interface IVirtualAssetUserData {
855
+ export declare interface IVirtualAssetUserData {
856
856
  /** 在 glTF 文件中的索引 */
857
857
  gltfIndex?: number;
858
858
  /** mesh 资源的面数 */
@@ -868,20 +868,20 @@ declare interface IVirtualAssetUserData {
868
868
  }
869
869
 
870
870
  /** JavaScript 资源的 userData */
871
- declare type JavaScriptAssetUserData = ScriptModuleUserData | PluginScriptUserData;
871
+ export declare type JavaScriptAssetUserData = ScriptModuleUserData | PluginScriptUserData;
872
872
 
873
873
  /** JSON 资源的 userData */
874
- declare interface JsonAssetUserData {
874
+ export declare interface JsonAssetUserData {
875
875
  /** 是否启用 JSON5 解析 */
876
876
  json5?: boolean;
877
877
  }
878
878
 
879
- declare interface KerningDict {
879
+ export declare interface KerningDict {
880
880
  [key: number]: number;
881
881
  }
882
882
 
883
883
  /** 标签图集资源的 userData */
884
- declare interface LabelAtlasAssetUserData {
884
+ export declare interface LabelAtlasAssetUserData {
885
885
  itemWidth: number;
886
886
  itemHeight: number;
887
887
  startChar: string;
@@ -890,14 +890,14 @@ declare interface LabelAtlasAssetUserData {
890
890
  _fntConfig: FntData;
891
891
  }
892
892
 
893
- declare interface LODsOption {
893
+ export declare interface LODsOption {
894
894
  // 屏占比
895
895
  screenRatio: number;
896
896
  // 和 lod0 的减面比
897
897
  faceCount: number;
898
898
  }
899
899
 
900
- declare const enum LogLevel {
900
+ export declare const enum LogLevel {
901
901
  NONE = 0,
902
902
  Error = 1,
903
903
  WARN = 2,
@@ -905,26 +905,26 @@ declare const enum LogLevel {
905
905
  DEBUG = 4
906
906
  }
907
907
 
908
- declare interface MeshClusterOptions {
908
+ export declare interface MeshClusterOptions {
909
909
  enable: boolean;
910
910
  coneCluster?: boolean;
911
911
  }
912
912
 
913
- declare interface MeshCompressOptions {
913
+ export declare interface MeshCompressOptions {
914
914
  enable: boolean;
915
915
  encode?: boolean;
916
916
  compress?: boolean;
917
917
  quantize?: boolean;
918
918
  }
919
919
 
920
- declare interface MeshOptimizeOptions {
920
+ export declare interface MeshOptimizeOptions {
921
921
  enable: boolean;
922
922
  vertexCache?: boolean;
923
923
  vertexFetch?: boolean;
924
924
  overdraw?: boolean;
925
925
  }
926
926
 
927
- declare interface MeshOptimizerOption {
927
+ export declare interface MeshOptimizerOption {
928
928
  // 是否启用此功能
929
929
  enable: boolean;
930
930
  // 减面算法,默认 simplify
@@ -934,7 +934,7 @@ declare interface MeshOptimizerOption {
934
934
  gltfpackOptions?: GltfpackOptions;
935
935
  }
936
936
 
937
- declare interface MeshSimplifyOptions {
937
+ export declare interface MeshSimplifyOptions {
938
938
  enable: boolean;
939
939
  targetRatio?: number;
940
940
  autoErrorRate?: boolean;
@@ -947,7 +947,7 @@ declare interface MeshSimplifyOptions {
947
947
  */
948
948
  export declare function moveAsset(source: string, target: string, options?: AssetOperationOption): Promise<any>;
949
949
 
950
- declare enum NormalImportSetting {
950
+ export declare enum NormalImportSetting {
951
951
  /**
952
952
  * 如果模型文件中包含法线信息则导出法线,否则不导出法线。
953
953
  */
@@ -1060,7 +1060,7 @@ export declare function onProgress(listener: (current: number, total: number, ur
1060
1060
  export declare function onReady(listener: () => void): () => void;
1061
1061
 
1062
1062
  /** 粒子资源的 userData */
1063
- declare interface ParticleAssetUserData {
1063
+ export declare interface ParticleAssetUserData {
1064
1064
  totalParticles: number;
1065
1065
  life: number;
1066
1066
  lifeVar: number;
@@ -1103,7 +1103,7 @@ declare interface ParticleAssetUserData {
1103
1103
  spriteFrameUuid: string;
1104
1104
  }
1105
1105
 
1106
- declare interface PluginScriptInfo {
1106
+ export declare interface PluginScriptInfo {
1107
1107
  /**
1108
1108
  * 脚本文件。
1109
1109
  */
@@ -1112,7 +1112,7 @@ declare interface PluginScriptInfo {
1112
1112
  }
1113
1113
 
1114
1114
  /** JavaScript 插件脚本的 userData */
1115
- declare interface PluginScriptUserData {
1115
+ export declare interface PluginScriptUserData {
1116
1116
  isPlugin: true;
1117
1117
  /** 界面没有开放给用户。默认开启 */
1118
1118
  experimentalHideCommonJs?: boolean;
@@ -1130,7 +1130,7 @@ declare interface PluginScriptUserData {
1130
1130
  }
1131
1131
 
1132
1132
  /** 场景/预制体资源的 userData */
1133
- declare interface PrefabAssetUserData {
1133
+ export declare interface PrefabAssetUserData {
1134
1134
  /** 是否为持久节点 */
1135
1135
  persistent?: boolean;
1136
1136
  /** 同步节点名称 */
@@ -1241,13 +1241,13 @@ export declare function reimportAsset(pathOrUrlOrUUID: string): Promise<IAssetIn
1241
1241
  export declare function renameAsset(source: string, target: string, options?: AssetOperationOption): Promise<any>;
1242
1242
 
1243
1243
  /** 渲染纹理资源的 userData */
1244
- declare interface RenderTextureAssetUserData extends TextureBaseAssetUserData {
1244
+ export declare interface RenderTextureAssetUserData extends TextureBaseAssetUserData {
1245
1245
  width: number;
1246
1246
  height: number;
1247
1247
  }
1248
1248
 
1249
1249
  /** 渲染纹理精灵帧的 userData */
1250
- declare interface RtSpriteFrameAssetUserData {
1250
+ export declare interface RtSpriteFrameAssetUserData {
1251
1251
  /** 图片 UUID 或数据库 URI */
1252
1252
  imageUuidOrDatabaseUri: string;
1253
1253
  /** 宽度 */
@@ -1262,11 +1262,11 @@ declare interface RtSpriteFrameAssetUserData {
1262
1262
  export declare function saveAsset(pathOrUrlOrUUID: string, data: string | Buffer): Promise<IAssetInfo>;
1263
1263
 
1264
1264
  /** JavaScript 脚本模块的 userData */
1265
- declare interface ScriptModuleUserData {
1265
+ export declare interface ScriptModuleUserData {
1266
1266
  isPlugin: false;
1267
1267
  }
1268
1268
 
1269
- declare interface SerializedAssetFinder {
1269
+ export declare interface SerializedAssetFinder {
1270
1270
  meshes?: Array<string | null>;
1271
1271
  animations?: Array<string | null>;
1272
1272
  skeletons?: Array<string | null>;
@@ -1275,7 +1275,7 @@ declare interface SerializedAssetFinder {
1275
1275
  scenes?: Array<string | null>;
1276
1276
  }
1277
1277
 
1278
- declare interface SimplifyOptions {
1278
+ export declare interface SimplifyOptions {
1279
1279
  // 压缩比例
1280
1280
  targetRatio?: number;
1281
1281
  // 防止破面
@@ -1287,13 +1287,13 @@ declare interface SimplifyOptions {
1287
1287
  }
1288
1288
 
1289
1289
  /** Spine 资源的 userData */
1290
- declare interface SpineAssetUserData {
1290
+ export declare interface SpineAssetUserData {
1291
1291
  /** 图集资源的 UUID */
1292
1292
  atlasUuid: string;
1293
1293
  }
1294
1294
 
1295
1295
  /** 精灵图集资源的 userData */
1296
- declare interface SpriteAtlasAssetUserData {
1296
+ export declare interface SpriteAtlasAssetUserData {
1297
1297
  /** 图集纹理名称 */
1298
1298
  atlasTextureName: string;
1299
1299
  /** 纹理 UUID */
@@ -1306,12 +1306,12 @@ declare interface SpriteAtlasAssetUserData {
1306
1306
  format: number;
1307
1307
  }
1308
1308
 
1309
- declare interface SpriteFrameAssetUserData extends SpriteFrameBaseAssetUserData {
1309
+ export declare interface SpriteFrameAssetUserData extends SpriteFrameBaseAssetUserData {
1310
1310
  isUuid?: boolean;
1311
1311
  imageUuidOrDatabaseUri: string;
1312
1312
  }
1313
1313
 
1314
- declare interface SpriteFrameBaseAssetUserData {
1314
+ export declare interface SpriteFrameBaseAssetUserData {
1315
1315
  trimType?: string;
1316
1316
  trimThreshold: number;
1317
1317
  rotated: boolean;
@@ -1335,7 +1335,7 @@ declare interface SpriteFrameBaseAssetUserData {
1335
1335
  vertices: SpriteFrameVertices;
1336
1336
  }
1337
1337
 
1338
- declare interface SpriteFrameVertices {
1338
+ export declare interface SpriteFrameVertices {
1339
1339
  rawPosition: number[];
1340
1340
  indexes: number[];
1341
1341
  uv: number[];
@@ -1351,9 +1351,9 @@ declare interface SpriteFrameVertices {
1351
1351
  export declare function start(): Promise<void>;
1352
1352
 
1353
1353
  /** 支持创建的资源类型常量数组(用于 Zod enum 和 TypeScript type) */
1354
- declare const SUPPORT_CREATE_TYPES: readonly ['animation-clip', 'typescript', 'auto-atlas', 'effect', 'scene', 'prefab', 'material', 'terrain', 'physics-material', 'label-atlas', 'render-texture', 'directory', 'effect-header'];
1354
+ export declare const SUPPORT_CREATE_TYPES: readonly ['animation-clip', 'typescript', 'auto-atlas', 'effect', 'scene', 'prefab', 'material', 'terrain', 'physics-material', 'label-atlas', 'render-texture', 'directory', 'effect-header'];
1355
1355
 
1356
- declare enum TangentImportSetting {
1356
+ export declare enum TangentImportSetting {
1357
1357
  /**
1358
1358
  * 不在导出的网格中包含正切信息。
1359
1359
  */
@@ -1372,12 +1372,12 @@ declare enum TangentImportSetting {
1372
1372
  recalculate = 3
1373
1373
  }
1374
1374
 
1375
- declare interface Texture2DAssetUserData extends TextureBaseAssetUserData {
1375
+ export declare interface Texture2DAssetUserData extends TextureBaseAssetUserData {
1376
1376
  isUuid?: boolean;
1377
1377
  imageUuidOrDatabaseUri?: string;
1378
1378
  }
1379
1379
 
1380
- declare interface TextureBaseAssetUserData {
1380
+ export declare interface TextureBaseAssetUserData {
1381
1381
  wrapModeS: WrapMode;
1382
1382
  wrapModeT: WrapMode;
1383
1383
  minfilter: Filter;
@@ -1386,7 +1386,7 @@ declare interface TextureBaseAssetUserData {
1386
1386
  anisotropy: number;
1387
1387
  }
1388
1388
 
1389
- declare interface TextureCubeAssetUserData extends TextureBaseAssetUserData {
1389
+ export declare interface TextureCubeAssetUserData extends TextureBaseAssetUserData {
1390
1390
  imageDatabaseUri?: string;
1391
1391
  isRGBE: boolean;
1392
1392
 
@@ -1407,12 +1407,12 @@ declare interface TextureCubeAssetUserData extends TextureBaseAssetUserData {
1407
1407
  bottom?: string;
1408
1408
  }
1409
1409
 
1410
- declare interface ThumbnailInfo {
1410
+ export declare interface ThumbnailInfo {
1411
1411
  type: 'icon' | 'image',
1412
1412
  value: string; // 具体 icon 名字或者 image 路径,image 路径支持绝对路径、 db:// 、 project:// 、和 packages:// 下的路径
1413
1413
  }
1414
1414
 
1415
- declare type ThumbnailSize = 'large' | 'small' | 'middle' | 'origin';
1415
+ export declare type ThumbnailSize = 'large' | 'small' | 'middle' | 'origin';
1416
1416
 
1417
1417
  /**
1418
1418
  * Update Asset User Data // 更新资源用户数据
@@ -1424,6 +1424,6 @@ export declare function updateAssetUserData(urlOrUuidOrPath: string, path: strin
1424
1424
  */
1425
1425
  export declare function updateDefaultUserData(handler: string, path: string, value: any): Promise<void>;
1426
1426
 
1427
- declare type WrapMode = 'repeat' | 'clamp-to-edge' | 'mirrored-repeat';
1427
+ export declare type WrapMode = 'repeat' | 'clamp-to-edge' | 'mirrored-repeat';
1428
1428
 
1429
1429
  export { };