@jlceda/pro-api-types 0.2.13 → 0.2.19

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.
Files changed (2) hide show
  1. package/index.d.ts +187 -79
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -218,6 +218,7 @@ declare global {
218
218
  * 分类索引
219
219
  *
220
220
  * @public
221
+ * @deprecated - since EDA v3.2; dropped EDA v3.3
221
222
  * @remarks 本分类索引用于索引指定库内的分类,其中库 UUID 和库类型仅作针对于本索引的识别用途,防止将不同库内的索引互相引用从而引发错误
222
223
  */
223
224
  interface ILIB_ClassificationIndex {
@@ -240,6 +241,7 @@ declare global {
240
241
  * 创建一级分类
241
242
  *
242
243
  * @beta
244
+ * @deprecated - since EDA v3.2; dropped EDA v3.3
243
245
  * @param libraryUuid - 库 UUID
244
246
  * @param libraryType - 库类型
245
247
  * @param primaryClassificationName - 一级分类名称
@@ -250,6 +252,7 @@ declare global {
250
252
  * 创建二级分类
251
253
  *
252
254
  * @beta
255
+ * @deprecated - since EDA v3.2; dropped EDA v3.3
253
256
  * @param libraryUuid - 库 UUID
254
257
  * @param libraryType - 库类型
255
258
  * @param primaryClassificationUuid - 一级分类 UUID
@@ -261,6 +264,7 @@ declare global {
261
264
  * 获取指定名称的分类的分类索引
262
265
  *
263
266
  * @beta
267
+ * @deprecated - since EDA v3.2; dropped EDA v3.3
264
268
  * @remarks 分类索引内包含分类的 UUID,具体可查阅 {@link ILIB_ClassificationIndex}
265
269
  * @param libraryUuid - 库 UUID
266
270
  * @param libraryType - 库类型
@@ -287,6 +291,7 @@ declare global {
287
291
  * 获取指定索引的分类的名称
288
292
  *
289
293
  * @beta
294
+ * @deprecated - since EDA v3.2; dropped EDA v3.3
290
295
  * @param classificationIndex - 分类索引
291
296
  * @returns 两级分类的名称
292
297
  */
@@ -325,6 +330,7 @@ declare global {
325
330
  * 删除指定索引的分类
326
331
  *
327
332
  * @beta
333
+ * @deprecated - since EDA v3.2; dropped EDA v3.3
328
334
  * @param classificationIndex - 分类索引
329
335
  * @returns 操作是否成功
330
336
  */
@@ -373,7 +379,7 @@ declare global {
373
379
  /** 符号名称 */
374
380
  name: string;
375
381
  /** 分类 */
376
- classification?: ILIB_ClassificationIndex;
382
+ classification?: ILIB_ClassificationIndex | Array<string>;
377
383
  /** 符号类型 */
378
384
  type: ELIB_SymbolType;
379
385
  /** 描述 */
@@ -390,7 +396,7 @@ declare global {
390
396
  /** 所属库 UUID */
391
397
  libraryUuid: string;
392
398
  /** 分类 */
393
- classification?: ILIB_ClassificationIndex;
399
+ classification?: ILIB_ClassificationIndex | Array<string>;
394
400
  /** 排序 */
395
401
  ordinal: number;
396
402
  /** 符号名称 */
@@ -423,7 +429,7 @@ declare global {
423
429
  * @param description - 描述
424
430
  * @returns 符号 UUID
425
431
  */
426
- create(libraryUuid: string, symbolName: string, classification?: ILIB_ClassificationIndex, symbolType?: ELIB_SymbolType, description?: string): Promise<string | undefined>;
432
+ create(libraryUuid: string, symbolName: string, classification?: ILIB_ClassificationIndex | Array<string>, symbolType?: ELIB_SymbolType, description?: string): Promise<string | undefined>;
427
433
  /**
428
434
  * 删除符号
429
435
  *
@@ -445,7 +451,7 @@ declare global {
445
451
  * @param description - 描述
446
452
  * @returns 操作是否成功
447
453
  */
448
- modify(symbolUuid: string, libraryUuid: string, symbolName?: string, classification?: ILIB_ClassificationIndex | null, description?: string | null): Promise<boolean>;
454
+ modify(symbolUuid: string, libraryUuid: string, symbolName?: string, classification?: ILIB_ClassificationIndex | Array<string> | null, description?: string | null): Promise<boolean>;
449
455
  /**
450
456
  * 更新符号的文档源码
451
457
  *
@@ -476,7 +482,7 @@ declare global {
476
482
  * @param newSymbolName - 新符号名称,如若目标库内存在重名符号将导致复制失败
477
483
  * @returns 目标库内新符号的 UUID
478
484
  */
479
- copy(symbolUuid: string, libraryUuid: string, targetLibraryUuid: string, targetClassification?: ILIB_ClassificationIndex, newSymbolName?: string): Promise<string | undefined>;
485
+ copy(symbolUuid: string, libraryUuid: string, targetLibraryUuid: string, targetClassification?: ILIB_ClassificationIndex | Array<string>, newSymbolName?: string): Promise<string | undefined>;
480
486
  /**
481
487
  * 搜索符号
482
488
  *
@@ -489,7 +495,7 @@ declare global {
489
495
  * @param page - 页数
490
496
  * @returns 搜索到的符号属性列表
491
497
  */
492
- search(key: string, libraryUuid?: string, classification?: ILIB_ClassificationIndex, symbolType?: ELIB_SymbolType, itemsOfPage?: number, page?: number): Promise<Array<ILIB_SymbolSearchItem>>;
498
+ search(key: string, libraryUuid?: string, classification?: ILIB_ClassificationIndex | Array<string>, symbolType?: ELIB_SymbolType, itemsOfPage?: number, page?: number): Promise<Array<ILIB_SymbolSearchItem>>;
493
499
  /**
494
500
  * 在编辑器打开文档
495
501
  *
@@ -1689,7 +1695,7 @@ declare global {
1689
1695
  /** 3D 模型名称 */
1690
1696
  name: string;
1691
1697
  /** 分类 */
1692
- classification?: ILIB_ClassificationIndex;
1698
+ classification?: ILIB_ClassificationIndex | Array<string>;
1693
1699
  /** 描述 */
1694
1700
  description?: string;
1695
1701
  }
@@ -1704,7 +1710,7 @@ declare global {
1704
1710
  /** 所属库 UUID */
1705
1711
  libraryUuid: string;
1706
1712
  /** 分类 */
1707
- classification?: ILIB_ClassificationIndex;
1713
+ classification?: ILIB_ClassificationIndex | Array<string>;
1708
1714
  /** 排序 */
1709
1715
  ordinal: number;
1710
1716
  /** 3D 模型名称 */
@@ -1735,7 +1741,7 @@ declare global {
1735
1741
  * @param description - 描述
1736
1742
  * @returns 3D 模型 UUID
1737
1743
  */
1738
- create(libraryUuid: string, modelFile: Blob, classification?: ILIB_ClassificationIndex, unit?: ESYS_Unit.MILLIMETER | ESYS_Unit.CENTIMETER | ESYS_Unit.METER | ESYS_Unit.MIL | ESYS_Unit.INCH): Promise<string[] | undefined>;
1744
+ create(libraryUuid: string, modelFile: Blob, classification?: ILIB_ClassificationIndex | Array<string>, unit?: ESYS_Unit.MILLIMETER | ESYS_Unit.CENTIMETER | ESYS_Unit.METER | ESYS_Unit.MIL | ESYS_Unit.INCH): Promise<string[] | undefined>;
1739
1745
  /**
1740
1746
  * 删除 3D 模型
1741
1747
  *
@@ -1757,7 +1763,7 @@ declare global {
1757
1763
  * @param description - 描述
1758
1764
  * @returns 操作是否成功
1759
1765
  */
1760
- modify(modelUuid: string, libraryUuid: string, modelName?: string, classification?: ILIB_ClassificationIndex | null, description?: string | null): Promise<boolean>;
1766
+ modify(modelUuid: string, libraryUuid: string, modelName?: string, classification?: ILIB_ClassificationIndex | Array<string> | null, description?: string | null): Promise<boolean>;
1761
1767
  /**
1762
1768
  * 获取 3D 模型的所有属性
1763
1769
  *
@@ -1778,7 +1784,7 @@ declare global {
1778
1784
  * @param newModelName - 新 3D 模型名称,如若目标库内存在重名 3D 模型将导致复制失败
1779
1785
  * @returns 目标库内新 3D 模型的 UUID
1780
1786
  */
1781
- copy(modelUuid: string, libraryUuid: string, targetLibraryUuid: string, targetClassification?: ILIB_ClassificationIndex, newModelName?: string): Promise<string | undefined>;
1787
+ copy(modelUuid: string, libraryUuid: string, targetLibraryUuid: string, targetClassification?: ILIB_ClassificationIndex | Array<string>, newModelName?: string): Promise<string | undefined>;
1782
1788
  /**
1783
1789
  * 搜索 3D 模型
1784
1790
  *
@@ -1790,7 +1796,7 @@ declare global {
1790
1796
  * @param page - 页数
1791
1797
  * @returns 搜索到的 3D 模型属性列表
1792
1798
  */
1793
- search(key: string, libraryUuid?: string, classification?: ILIB_ClassificationIndex, itemsOfPage?: number, page?: number): Promise<Array<ILIB_3DModelSearchItem>>;
1799
+ search(key: string, libraryUuid?: string, classification?: ILIB_ClassificationIndex | Array<string>, itemsOfPage?: number, page?: number): Promise<Array<ILIB_3DModelSearchItem>>;
1794
1800
  }
1795
1801
 
1796
1802
  /**
@@ -1808,7 +1814,7 @@ declare global {
1808
1814
  /** 复用模块名称 */
1809
1815
  name: string;
1810
1816
  /** 分类 */
1811
- classification?: ILIB_ClassificationIndex;
1817
+ classification?: ILIB_ClassificationIndex | Array<string>;
1812
1818
  /** 描述 */
1813
1819
  description?: string;
1814
1820
  /** 下属板子 */
@@ -1825,7 +1831,7 @@ declare global {
1825
1831
  /** 所属库 UUID */
1826
1832
  libraryUuid: string;
1827
1833
  /** 分类 */
1828
- classification?: ILIB_ClassificationIndex;
1834
+ classification?: ILIB_ClassificationIndex | Array<string>;
1829
1835
  /** 排序 */
1830
1836
  ordinal: number;
1831
1837
  /** 复用模块名称 */
@@ -1855,7 +1861,7 @@ declare global {
1855
1861
  * @param description - 描述
1856
1862
  * @returns 复用模块 UUID
1857
1863
  */
1858
- create(libraryUuid: string, cbbName: string, classification?: ILIB_ClassificationIndex, description?: string): Promise<string | undefined>;
1864
+ create(libraryUuid: string, cbbName: string, classification?: ILIB_ClassificationIndex | Array<string>, description?: string): Promise<string | undefined>;
1859
1865
  /**
1860
1866
  * 删除复用模块
1861
1867
  *
@@ -1877,7 +1883,7 @@ declare global {
1877
1883
  * @param description - 描述
1878
1884
  * @returns 操作是否成功
1879
1885
  */
1880
- modify(cbbUuid: string, libraryUuid: string, cbbName?: string, classification?: ILIB_ClassificationIndex | null, description?: string | null): Promise<boolean>;
1886
+ modify(cbbUuid: string, libraryUuid: string, cbbName?: string, classification?: ILIB_ClassificationIndex | Array<string> | null, description?: string | null): Promise<boolean>;
1881
1887
  /**
1882
1888
  * 获取复用模块的所有属性
1883
1889
  *
@@ -1898,7 +1904,7 @@ declare global {
1898
1904
  * @param newCbbName - 新复用模块名称,如若目标库内存在重名复用模块将导致复制失败
1899
1905
  * @returns 目标库内新复用模块的 UUID
1900
1906
  */
1901
- copy(cbbUuid: string, libraryUuid: string, targetLibraryUuid: string, targetClassification?: ILIB_ClassificationIndex, newCbbName?: string): Promise<string | undefined>;
1907
+ copy(cbbUuid: string, libraryUuid: string, targetLibraryUuid: string, targetClassification?: ILIB_ClassificationIndex | Array<string>, newCbbName?: string): Promise<string | undefined>;
1902
1908
  /**
1903
1909
  * 搜索复用模块
1904
1910
  *
@@ -1910,7 +1916,7 @@ declare global {
1910
1916
  * @param page - 页数
1911
1917
  * @returns 搜索到的复用模块属性列表
1912
1918
  */
1913
- search(key: string, libraryUuid?: string, classification?: ILIB_ClassificationIndex, itemsOfPage?: number, page?: number): Promise<Array<ILIB_CbbSearchItem>>;
1919
+ search(key: string, libraryUuid?: string, classification?: ILIB_ClassificationIndex | Array<string>, itemsOfPage?: number, page?: number): Promise<Array<ILIB_CbbSearchItem>>;
1914
1920
  /**
1915
1921
  * 在编辑器打开复用模块工程
1916
1922
  *
@@ -2024,7 +2030,7 @@ declare global {
2024
2030
  /** 器件名称 */
2025
2031
  name: string;
2026
2032
  /** 器件分类 */
2027
- classification?: ILIB_ClassificationIndex;
2033
+ classification?: ILIB_ClassificationIndex | Array<string>;
2028
2034
  /** 关联 */
2029
2035
  association: ILIB_DeviceAssociationItem;
2030
2036
  /** 描述 */
@@ -2043,7 +2049,7 @@ declare global {
2043
2049
  /** 所属库 UUID */
2044
2050
  libraryUuid: string;
2045
2051
  /** 器件分类 */
2046
- classification?: ILIB_ClassificationIndex;
2052
+ classification?: ILIB_ClassificationIndex | Array<string>;
2047
2053
  /** 排序 */
2048
2054
  ordinal: number;
2049
2055
  /** 器件名称 */
@@ -2208,7 +2214,7 @@ declare global {
2208
2214
  * @param property - 其它参数,仅 `designator`、`addIntoBom`、`addIntoPcb` 存在默认值
2209
2215
  * @returns 器件 UUID
2210
2216
  */
2211
- create(libraryUuid: string, deviceName: string, classification?: ILIB_ClassificationIndex, association?: {
2217
+ create(libraryUuid: string, deviceName: string, classification?: ILIB_ClassificationIndex | Array<string>, association?: {
2212
2218
  symbolType?: ELIB_SymbolType;
2213
2219
  symbolUuid?: string;
2214
2220
  symbol?: {
@@ -2249,7 +2255,7 @@ declare global {
2249
2255
  * @param property - 其它参数
2250
2256
  * @returns 操作是否成功
2251
2257
  */
2252
- modify(deviceUuid: string, libraryUuid: string, deviceName?: string, classification?: ILIB_ClassificationIndex | null, association?: {
2258
+ modify(deviceUuid: string, libraryUuid: string, deviceName?: string, classification?: ILIB_ClassificationIndex | Array<string> | null, association?: {
2253
2259
  symbolUuid?: string;
2254
2260
  symbol?: {
2255
2261
  uuid: string;
@@ -2299,7 +2305,7 @@ declare global {
2299
2305
  * @param newDeviceName - 新器件名称,如若目标库内存在重名器件将导致复制失败
2300
2306
  * @returns 目标库内新器件的 UUID
2301
2307
  */
2302
- copy(deviceUuid: string, libraryUuid: string, targetLibraryUuid: string, targetClassification?: ILIB_ClassificationIndex, newDeviceName?: string): Promise<string | undefined>;
2308
+ copy(deviceUuid: string, libraryUuid: string, targetLibraryUuid: string, targetClassification?: ILIB_ClassificationIndex | Array<string>, newDeviceName?: string): Promise<string | undefined>;
2303
2309
  /**
2304
2310
  * 搜索器件
2305
2311
  *
@@ -2312,7 +2318,7 @@ declare global {
2312
2318
  * @param page - 页数
2313
2319
  * @returns 搜索到的器件属性的列表
2314
2320
  */
2315
- search(key: string, libraryUuid?: string, classification?: ILIB_ClassificationIndex, symbolType?: ELIB_SymbolType, itemsOfPage?: number, page?: number): Promise<Array<ILIB_DeviceSearchItem>>;
2321
+ search(key: string, libraryUuid?: string, classification?: ILIB_ClassificationIndex | Array<string>, symbolType?: ELIB_SymbolType, itemsOfPage?: number, page?: number): Promise<Array<ILIB_DeviceSearchItem>>;
2316
2322
  /**
2317
2323
  * 使用属性精确搜索器件
2318
2324
  *
@@ -2327,7 +2333,7 @@ declare global {
2327
2333
  * @param page - 页数
2328
2334
  * @returns 搜索到的器件属性的列表
2329
2335
  */
2330
- searchByProperties(properties: ILIB_DevicePropertiesForSearch, libraryUuid?: string, classification?: ILIB_ClassificationIndex, symbolType?: ELIB_SymbolType, itemsOfPage?: number, page?: number): Array<ILIB_DeviceSearchItem>;
2336
+ searchByProperties(properties: ILIB_DevicePropertiesForSearch, libraryUuid?: string, classification?: ILIB_ClassificationIndex | Array<string>, symbolType?: ELIB_SymbolType, itemsOfPage?: number, page?: number): Array<ILIB_DeviceSearchItem>;
2331
2337
  /**
2332
2338
  * 使用立创 C 编号获取器件
2333
2339
  *
@@ -2377,7 +2383,7 @@ declare global {
2377
2383
  /** 封装名称 */
2378
2384
  name: string;
2379
2385
  /** 分类 */
2380
- classification?: ILIB_ClassificationIndex;
2386
+ classification?: ILIB_ClassificationIndex | Array<string>;
2381
2387
  /** 描述 */
2382
2388
  description?: string;
2383
2389
  }
@@ -2392,7 +2398,7 @@ declare global {
2392
2398
  /** 所属库 UUID */
2393
2399
  libraryUuid: string;
2394
2400
  /** 分类 */
2395
- classification?: ILIB_ClassificationIndex;
2401
+ classification?: ILIB_ClassificationIndex | Array<string>;
2396
2402
  /** 排序 */
2397
2403
  ordinal: number;
2398
2404
  /** 封装名称 */
@@ -2422,7 +2428,7 @@ declare global {
2422
2428
  * @param description - 描述
2423
2429
  * @returns 封装 UUID
2424
2430
  */
2425
- create(libraryUuid: string, footprintName: string, classification?: ILIB_ClassificationIndex, description?: string): Promise<string | undefined>;
2431
+ create(libraryUuid: string, footprintName: string, classification?: ILIB_ClassificationIndex | Array<string>, description?: string): Promise<string | undefined>;
2426
2432
  /**
2427
2433
  * 删除封装
2428
2434
  *
@@ -2444,7 +2450,7 @@ declare global {
2444
2450
  * @param description - 描述
2445
2451
  * @returns 操作是否成功
2446
2452
  */
2447
- modify(footprintUuid: string, libraryUuid: string, footprintName?: string, classification?: ILIB_ClassificationIndex | null, description?: string | null): Promise<boolean>;
2453
+ modify(footprintUuid: string, libraryUuid: string, footprintName?: string, classification?: ILIB_ClassificationIndex | Array<string> | null, description?: string | null): Promise<boolean>;
2448
2454
  /**
2449
2455
  * 更新封装的文档源码
2450
2456
  *
@@ -2475,7 +2481,7 @@ declare global {
2475
2481
  * @param newFootprintName - 新封装名称,如若目标库内存在重名封装将导致复制失败
2476
2482
  * @returns 目标库内新封装的 UUID
2477
2483
  */
2478
- copy(footprintUuid: string, libraryUuid: string, targetLibraryUuid: string, targetClassification?: ILIB_ClassificationIndex, newFootprintName?: string): Promise<string | undefined>;
2484
+ copy(footprintUuid: string, libraryUuid: string, targetLibraryUuid: string, targetClassification?: ILIB_ClassificationIndex | Array<string>, newFootprintName?: string): Promise<string | undefined>;
2479
2485
  /**
2480
2486
  * 搜索封装
2481
2487
  *
@@ -2487,7 +2493,7 @@ declare global {
2487
2493
  * @param page - 页数
2488
2494
  * @returns 搜索到的封装属性列表
2489
2495
  */
2490
- search(key: string, libraryUuid?: string, classification?: ILIB_ClassificationIndex, itemsOfPage?: number, page?: number): Promise<Array<ILIB_FootprintSearchItem>>;
2496
+ search(key: string, libraryUuid?: string, classification?: ILIB_ClassificationIndex | Array<string>, itemsOfPage?: number, page?: number): Promise<Array<ILIB_FootprintSearchItem>>;
2491
2497
  /**
2492
2498
  * 在编辑器打开文档
2493
2499
  *
@@ -2577,7 +2583,7 @@ declare global {
2577
2583
  query: T & {
2578
2584
  wd?: string;
2579
2585
  listByTitles?: Array<string>;
2580
- classification?: ILIB_ExtendLibraryClassificationIndex;
2586
+ classification?: ILIB_ExtendLibraryClassificationIndex | Array<string>;
2581
2587
  };
2582
2588
  }
2583
2589
  /**
@@ -2603,7 +2609,7 @@ declare global {
2603
2609
  * @public
2604
2610
  */
2605
2611
  interface ILIB_ExtendLibrarySearchResultDataLine {
2606
- classification?: ILIB_ExtendLibraryClassificationIndex;
2612
+ classification?: ILIB_ExtendLibraryClassificationIndex | Array<string>;
2607
2613
  description?: string;
2608
2614
  version?: string;
2609
2615
  updateTime?: number;
@@ -2633,6 +2639,7 @@ declare global {
2633
2639
  * 外部库分类索引
2634
2640
  *
2635
2641
  * @public
2642
+ * @deprecated - since EDA v3.2; dropped EDA v3.3
2636
2643
  * @remarks
2637
2644
  * 支持外部库使用名称或 UUID 作为分类的唯一 ID 索引
2638
2645
  */
@@ -2692,7 +2699,7 @@ declare global {
2692
2699
  };
2693
2700
  symbolType?: ELIB_SymbolType;
2694
2701
  }>) => Promise<ILIB_ExtendLibrarySearchResult<ILIB_ExtendLibraryItemIndex & {
2695
- classification?: ILIB_ExtendLibraryClassificationIndex;
2702
+ classification?: ILIB_ExtendLibraryClassificationIndex | Array<string>;
2696
2703
  symbol?: ILIB_ExtendLibraryItem & {
2697
2704
  symbolType: ELIB_SymbolType;
2698
2705
  };
@@ -2911,7 +2918,7 @@ declare global {
2911
2918
  /** 面板库名称 */
2912
2919
  name: string;
2913
2920
  /** 分类 */
2914
- classification?: ILIB_ClassificationIndex;
2921
+ classification?: ILIB_ClassificationIndex | Array<string>;
2915
2922
  /** 描述 */
2916
2923
  description?: string;
2917
2924
  }
@@ -2926,7 +2933,7 @@ declare global {
2926
2933
  /** 所属库 UUID */
2927
2934
  libraryUuid: string;
2928
2935
  /** 分类 */
2929
- classification?: ILIB_ClassificationIndex;
2936
+ classification?: ILIB_ClassificationIndex | Array<string>;
2930
2937
  /** 排序 */
2931
2938
  ordinal: number;
2932
2939
  /** 面板库名称 */
@@ -2956,7 +2963,7 @@ declare global {
2956
2963
  * @param description - 描述
2957
2964
  * @returns 面板库 UUID
2958
2965
  */
2959
- create(libraryUuid: string, panelLibraryName: string, classification?: ILIB_ClassificationIndex, description?: string): Promise<string | undefined>;
2966
+ create(libraryUuid: string, panelLibraryName: string, classification?: ILIB_ClassificationIndex | Array<string>, description?: string): Promise<string | undefined>;
2960
2967
  /**
2961
2968
  * 删除面板库
2962
2969
  *
@@ -2978,7 +2985,7 @@ declare global {
2978
2985
  * @param description - 描述
2979
2986
  * @returns 操作是否成功
2980
2987
  */
2981
- modify(panelLibraryUuid: string, libraryUuid: string, panelLibraryName?: string, classification?: ILIB_ClassificationIndex | null, description?: string | null): Promise<boolean>;
2988
+ modify(panelLibraryUuid: string, libraryUuid: string, panelLibraryName?: string, classification?: ILIB_ClassificationIndex | Array<string> | null, description?: string | null): Promise<boolean>;
2982
2989
  /**
2983
2990
  * 获取面板库的所有属性
2984
2991
  *
@@ -2999,7 +3006,7 @@ declare global {
2999
3006
  * @param newPanelLibraryName - 新面板库名称,如若目标库内存在重名面板库将导致复制失败
3000
3007
  * @returns 目标库内新面板库的 UUID
3001
3008
  */
3002
- copy(panelLibraryUuid: string, libraryUuid: string, targetLibraryUuid: string, targetClassification?: ILIB_ClassificationIndex, newPanelLibraryName?: string): Promise<string | undefined>;
3009
+ copy(panelLibraryUuid: string, libraryUuid: string, targetLibraryUuid: string, targetClassification?: ILIB_ClassificationIndex | Array<string>, newPanelLibraryName?: string): Promise<string | undefined>;
3003
3010
  /**
3004
3011
  * 搜索面板库
3005
3012
  *
@@ -3011,7 +3018,7 @@ declare global {
3011
3018
  * @param page - 页数
3012
3019
  * @returns 搜索到的面板库属性列表
3013
3020
  */
3014
- search(key: string, libraryUuid?: string, classification?: ILIB_ClassificationIndex, itemsOfPage?: number, page?: number): Promise<Array<ILIB_PanelLibrarySearchItem>>;
3021
+ search(key: string, libraryUuid?: string, classification?: ILIB_ClassificationIndex | Array<string>, itemsOfPage?: number, page?: number): Promise<Array<ILIB_PanelLibrarySearchItem>>;
3015
3022
  /**
3016
3023
  * 在编辑器打开文档
3017
3024
  *
@@ -3348,7 +3355,7 @@ declare global {
3348
3355
  * @remarks
3349
3356
  * 本接口在前端画布上定位到指定的数据层面坐标;
3350
3357
  *
3351
- * 如果希望在进行本操作时前端画布坐标能与传入数据一致,
3358
+ * 如果希望在进行本操作时前端画布坐标能与传入数��一致,
3352
3359
  * 建议调用 {@link PCB_Document.setCanvasOrigin} 方法并设置偏移量为零;
3353
3360
  *
3354
3361
  * 此处的单位为数据层面单位,在跨度上等同于画布层面的 mil
@@ -3815,7 +3822,7 @@ declare global {
3815
3822
  */
3816
3823
  modifyEqualLengthNetGroupName(originalEqualLengthNetGroupName: string, equalLengthNetGroupName: string): Promise<boolean>;
3817
3824
  /**
3818
- * 将网络添加到等长网络组
3825
+ * 将网络添加到等长网��组
3819
3826
  *
3820
3827
  * @beta
3821
3828
  * @param equalLengthNetGroupName - 等长网络组名称
@@ -4242,9 +4249,9 @@ declare global {
4242
4249
  /**
4243
4250
  * 层状态
4244
4251
  */
4245
- enum ELayerStatus {
4252
+ enum EPCB_LayerStatus {
4246
4253
  /** 不使用 */
4247
- NOTUSED = 0,
4254
+ NOT_USED = 0,
4248
4255
  /** 使用并展示 */
4249
4256
  SHOW = 1,
4250
4257
  /** 使用但不展示 */
@@ -4403,7 +4410,7 @@ declare global {
4403
4410
  /** 非激活透明度(%) */
4404
4411
  inactiveTransparency: number;
4405
4412
  /** 层状态 */
4406
- layerStatus: ELayerStatus;
4413
+ layerStatus: EPCB_LayerStatus;
4407
4414
  /** 是否锁定 */
4408
4415
  locked: boolean;
4409
4416
  }
@@ -5101,6 +5108,15 @@ declare global {
5101
5108
  * @returns IPC-D-356A 文件数据
5102
5109
  */
5103
5110
  getIpcD356AFile(fileName?: string): Promise<File | undefined>;
5111
+ /**
5112
+ * 获取 IPC-2581C 文件
5113
+ *
5114
+ * @alpha
5115
+ * @remarks 可以使用 {@link SYS_FileSystem.saveFile} 接口将文件导出到本地文件系统
5116
+ * @param fileName - 文件名
5117
+ * @returns IPC-2581C 文件数据
5118
+ */
5119
+ getIpc2581CFile(fileName?: string, fileType?: 'xml' | 'cvg' | '2581', unit?: ESYS_Unit.INCH | ESYS_Unit.MILLIMETER, oemNumber?: 'Device' | 'Manufacturer Part' | 'Supplier Part' | 'Comment'): Promise<File | undefined>;
5104
5120
  /**
5105
5121
  * 获取 ODB++ 文件
5106
5122
  *
@@ -5463,7 +5479,7 @@ declare global {
5463
5479
  * 校验单多边形
5464
5480
  *
5465
5481
  * @alpha
5466
- * @remarks 校验并整理输入数据,如数据有误,则抛出错误
5482
+ * @remarks 校验并整理输入数据,如数据有误,则��出错误
5467
5483
  * @returns 单多边形数据
5468
5484
  */
5469
5485
  private validateSource;
@@ -5500,7 +5516,7 @@ declare global {
5500
5516
  * 获取复杂多边形数据
5501
5517
  *
5502
5518
  * @public
5503
- * @remarks 强制返回复杂多边形格式数��,即使它仅包含单一的单多边形
5519
+ * @remarks 强制返回复杂多边形格式数据,即使它仅包含单一的单多边形
5504
5520
  * @returns 复杂多边形数据
5505
5521
  */
5506
5522
  getSourceStrictComplex(): Array<TPCB_PolygonSourceArray>;
@@ -6025,7 +6041,7 @@ declare global {
6025
6041
  * @param startX - 起始位置 X
6026
6042
  * @param startY - 起始位置 Y
6027
6043
  * @param endX - 终止位置 X
6028
- * @param endY - 终止位置 Y
6044
+ * @param endY - 终��位置 Y
6029
6045
  * @param lineWidth - 线宽
6030
6046
  * @param primitiveLock - 是否锁定
6031
6047
  * @returns 直线图元对象
@@ -6062,7 +6078,7 @@ declare global {
6062
6078
  *
6063
6079
  * @beta
6064
6080
  * @param primitiveIds - 直线的图元 ID,可以为字符串或字符串数组,如若为数组,则返回的也是数组
6065
- * @returns 直线图元对象,`undefined` 表示获取���败
6081
+ * @returns 直线图元对象,`undefined` 表示获取失败
6066
6082
  */
6067
6083
  get(primitiveIds: string): Promise<IPCB_PrimitiveLine | undefined>;
6068
6084
  /**
@@ -6657,7 +6673,7 @@ declare global {
6657
6673
  */
6658
6674
  isAsync(): boolean;
6659
6675
  /**
6660
- * 将��步图元重置为当前画布状态
6676
+ * 将异步图元重置为当前画布状态
6661
6677
  *
6662
6678
  * @beta
6663
6679
  * @returns 圆弧线图元对象
@@ -7794,7 +7810,7 @@ declare global {
7794
7810
  * @beta
7795
7811
  * @param primitiveId - 图元 ID
7796
7812
  * @param property - 修改参数
7797
- * @returns 区域图元对象,`undefined` 表示修改失败
7813
+ * @returns 区域图元对象,`undefined` 表��修改失败
7798
7814
  */
7799
7815
  modify(primitiveId: string | IPCB_PrimitiveRegion, property: {
7800
7816
  layer?: TPCB_LayersOfRegion;
@@ -9985,7 +10001,7 @@ declare global {
9985
10001
  * 获取属性状态:名称
9986
10002
  *
9987
10003
  * @public
9988
- * @returns 名称
10004
+ * @returns ��称
9989
10005
  */
9990
10006
  getState_Name(): string | undefined;
9991
10007
  /**
@@ -12084,7 +12100,7 @@ declare global {
12084
12100
  */
12085
12101
  getState_ReferenceY(): number;
12086
12102
  /**
12087
- * 获取属性状态:终止点 X
12103
+ * 获��属性状态:终止点 X
12088
12104
  *
12089
12105
  * @public
12090
12106
  * @returns 终止点 X
@@ -15410,7 +15426,7 @@ declare global {
15410
15426
  */
15411
15427
  setState_Y(y: number): ISCH_PrimitiveComponent;
15412
15428
  /**
15413
- * 设置属性状态:旋转角度
15429
+ * 设置属性状态:旋���角度
15414
15430
  *
15415
15431
  * @beta
15416
15432
  * @param rotation - 旋转角度
@@ -16654,6 +16670,29 @@ declare global {
16654
16670
  }, succeedCallFn?: (data: Response) => void | Promise<void>): Promise<Response>;
16655
16671
  }
16656
16672
 
16673
+ interface ImageStoreProps {
16674
+ src: string;
16675
+ width?: number;
16676
+ height?: number;
16677
+ title?: string;
16678
+ }
16679
+ type BoardStoreEvents$1 = {
16680
+ event: 'click';
16681
+ data: boolean;
16682
+ };
16683
+
16684
+ interface BoardStoreProps {
16685
+ padding?: number[];
16686
+ bgColor?: string;
16687
+ width?: number;
16688
+ height?: number;
16689
+ title: string;
16690
+ }
16691
+ type BoardStoreEvents = {
16692
+ event: 'click';
16693
+ data: boolean;
16694
+ };
16695
+
16657
16696
  type IconProps = {
16658
16697
  /** 模板名称 */
16659
16698
  iconClass: string;
@@ -16675,8 +16714,10 @@ declare global {
16675
16714
 
16676
16715
  interface PanelStoreProps {
16677
16716
  value: string;
16678
- font?: string;
16717
+ fontFamily?: string;
16679
16718
  textAlign?: 'left' | 'center' | 'right';
16719
+ fontSize?: number;
16720
+ color?: string;
16680
16721
  }
16681
16722
  type PanelStoreEvents = {
16682
16723
  event: 'change';
@@ -16688,12 +16729,17 @@ declare global {
16688
16729
  borderWidth?: number;
16689
16730
  borderColor?: string;
16690
16731
  hide?: boolean;
16732
+ color?: string;
16733
+ padding?: number[];
16734
+ margin?: number[];
16735
+ width?: number;
16736
+ height?: number;
16737
+ rotate?: number;
16738
+ cursor?: 'pointer' | 'default' | 'none' | 'move' | 'text';
16691
16739
  }
16692
16740
 
16693
16741
  interface FlexItemStoreProps extends ContainerStyleProps {
16694
16742
  flexRatio?: number;
16695
- width?: number;
16696
- height?: number;
16697
16743
  }
16698
16744
  type FlexItemStoreEvents = {
16699
16745
  event: 'change';
@@ -16701,11 +16747,11 @@ declare global {
16701
16747
  };
16702
16748
 
16703
16749
  interface FlexStoreProps extends ContainerStyleProps {
16704
- padding?: number;
16705
16750
  direction?: 'column' | 'column-reverse' | 'row' | 'row-reverse';
16706
- justify?: 'start' | 'center' | 'end';
16707
- align?: 'start' | 'center' | 'end' | 'stretch';
16751
+ alignX?: 'start' | 'center' | 'end';
16752
+ alignY?: 'start' | 'center' | 'end' | 'stretch';
16708
16753
  gap?: number;
16754
+ classes?: string[];
16709
16755
  }
16710
16756
  type FlexStoreEvents = {
16711
16757
  event: 'change';
@@ -16732,30 +16778,61 @@ declare global {
16732
16778
  rowSpan?: number;
16733
16779
  align?: 'start' | 'center' | 'end' | 'stretch';
16734
16780
  }
16735
- type CheckBoxStoreEvents$4 = {
16781
+ type CheckBoxStoreEvents$3 = {
16736
16782
  event: 'resize';
16737
16783
  };
16738
16784
 
16739
16785
  interface GridStoreProps extends ContainerStyleProps {
16740
16786
  columns: number;
16741
- padding?: number;
16742
16787
  rowGap?: number;
16743
16788
  colGap?: number;
16744
16789
  }
16745
- type CheckBoxStoreEvents$3 = {
16790
+ type CheckBoxStoreEvents$2 = {
16746
16791
  event: 'resize';
16747
16792
  };
16748
16793
 
16794
+ interface ListChildren$1 {
16795
+ title: string;
16796
+ id?: string;
16797
+ clearBtn?: boolean;
16798
+ children?: ListChildren$1[];
16799
+ childrenCollapse?: boolean;
16800
+ selected?: boolean;
16801
+ icon?: IconProps;
16802
+ }
16803
+ interface ListProps {
16804
+ width?: number;
16805
+ height?: number;
16806
+ list: ListChildren$1[];
16807
+ itemHeight?: number;
16808
+ border?: boolean;
16809
+ expandEnable?: boolean;
16810
+ }
16811
+ type ListStoreEvents = {
16812
+ event: 'item-click';
16813
+ data: string;
16814
+ } | {
16815
+ event: 'item-dblclick';
16816
+ data: string;
16817
+ } | {
16818
+ event: 'item-contextmenu';
16819
+ data: string;
16820
+ };
16821
+
16822
+ interface ListChildren {
16823
+ title: string;
16824
+ value?: string;
16825
+ clearBtn?: boolean;
16826
+ children?: ListChildren[];
16827
+ selected?: boolean;
16828
+ }
16749
16829
  interface InputProps {
16750
16830
  width?: number;
16751
16831
  disabled?: boolean;
16752
16832
  readonly?: boolean;
16753
16833
  clearBtn?: boolean | 'keepAlive';
16754
- clickBtn?: Function;
16755
- dropDownList?: {
16756
- title: string;
16757
- clearBtn: boolean;
16758
- }[];
16834
+ clickBtn?: boolean;
16835
+ dropDownList?: ListChildren[];
16759
16836
  searchBtn?: boolean;
16760
16837
  value?: string;
16761
16838
  placeholder?: string;
@@ -16766,9 +16843,21 @@ declare global {
16766
16843
  };
16767
16844
  testVal?: string;
16768
16845
  }
16769
- type CheckBoxStoreEvents$2 = {
16846
+ type InputStoreEvents = {
16847
+ event: 'click';
16848
+ data: string;
16849
+ } | {
16850
+ event: 'search-click';
16851
+ data: string;
16852
+ } | {
16853
+ event: 'filter-click';
16854
+ data: string;
16855
+ } | {
16770
16856
  event: 'change';
16771
16857
  data: string;
16858
+ } | {
16859
+ event: 'add-click';
16860
+ data: string;
16772
16861
  };
16773
16862
 
16774
16863
  interface SingleProps {
@@ -16782,6 +16871,7 @@ declare global {
16782
16871
  selectedValue?: string;
16783
16872
  onlyChangeByBox?: boolean;
16784
16873
  lineBreak?: boolean;
16874
+ gap?: number;
16785
16875
  }
16786
16876
  type CheckBoxStoreEvents$1 = {
16787
16877
  event: 'change';
@@ -16817,16 +16907,22 @@ declare global {
16817
16907
  data: boolean;
16818
16908
  };
16819
16909
 
16820
- function Dialog({ children }: {
16910
+ interface DialogProps {
16911
+ title: string;
16912
+ buttons?: (ButtonStoreProps & {
16913
+ clickEventName: string;
16914
+ })[];
16915
+ }
16916
+ function Dialog(props: {
16821
16917
  children?: react__default.ReactElement | react__default.ReactElement[];
16822
- }): react_jsx_runtime.JSX.Element;
16918
+ } & DialogProps): react_jsx_runtime.JSX.Element;
16823
16919
 
16824
16920
  abstract class PortalBase {
16825
16921
  Provider: (props: any) => react_jsx_runtime.JSX.Element;
16826
- abstract createComponent(handl: string, type: string, props: any, parent: string): void;
16827
- abstract updateComponent(handl: string, props: any): void;
16828
- abstract detachComponent(handl: string): void;
16829
- abstract bindEvent(handl: string, callback: (ev: any) => void): void;
16922
+ abstract createComponent(handle: string, type: string, props: any, parent: string): void;
16923
+ abstract updateComponent(handle: string, props: any): void;
16924
+ abstract detachComponent(handle: string): void;
16925
+ abstract bindEvent(handle: string, callback: (ev: any) => void): void;
16830
16926
  }
16831
16927
 
16832
16928
  const Components: {
@@ -16844,15 +16940,19 @@ declare global {
16844
16940
  children?: react.JSX.Element[] | react.JSX.Element;
16845
16941
  }) => react.JSX.Element;
16846
16942
  Input: (props: InputProps & {
16847
- onEvent?: ((ev: CheckBoxStoreEvents$2) => void) | undefined;
16943
+ onEvent?: ((ev: InputStoreEvents) => void) | undefined;
16944
+ children?: react.JSX.Element[] | react.JSX.Element;
16945
+ }) => react.JSX.Element;
16946
+ List: (props: ListProps & {
16947
+ onEvent?: ((ev: ListStoreEvents) => void) | undefined;
16848
16948
  children?: react.JSX.Element[] | react.JSX.Element;
16849
16949
  }) => react.JSX.Element;
16850
16950
  Grid: (props: GridStoreProps & {
16851
- onEvent?: ((ev: CheckBoxStoreEvents$3) => void) | undefined;
16951
+ onEvent?: ((ev: CheckBoxStoreEvents$2) => void) | undefined;
16852
16952
  children?: react.JSX.Element[] | react.JSX.Element;
16853
16953
  }) => react.JSX.Element;
16854
16954
  GridItem: (props: GridSItemtoreProps & {
16855
- onEvent?: ((ev: CheckBoxStoreEvents$4) => void) | undefined;
16955
+ onEvent?: ((ev: CheckBoxStoreEvents$3) => void) | undefined;
16856
16956
  children?: react.JSX.Element[] | react.JSX.Element;
16857
16957
  }) => react.JSX.Element;
16858
16958
  Modal: (props: ModalStoreProps & {
@@ -16875,6 +16975,14 @@ declare global {
16875
16975
  onEvent?: ((ev: ButtonStoreEvents) => void) | undefined;
16876
16976
  children?: react.JSX.Element[] | react.JSX.Element;
16877
16977
  }) => react.JSX.Element;
16978
+ Board: (props: BoardStoreProps & {
16979
+ onEvent?: ((ev: BoardStoreEvents) => void) | undefined;
16980
+ children?: react.JSX.Element[] | react.JSX.Element;
16981
+ }) => react.JSX.Element;
16982
+ Image: (props: ImageStoreProps & {
16983
+ onEvent?: ((ev: BoardStoreEvents$1) => void) | undefined;
16984
+ children?: react.JSX.Element[] | react.JSX.Element;
16985
+ }) => react.JSX.Element;
16878
16986
  };
16879
16987
  type Components = typeof Components;
16880
16988
 
@@ -18573,7 +18681,7 @@ declare global {
18573
18681
  * 注册快捷键
18574
18682
  *
18575
18683
  * @beta
18576
- * @param shortcutKey - 快捷键,数组中包含多个元素���解析为组合快捷键,将按规则排序后存入缓存
18684
+ * @param shortcutKey - 快捷键,数组中包含多个元素则解析为组合快捷键,将按规则排序后存入缓存
18577
18685
  * @param title - 快捷键标题,快捷键的友好名称
18578
18686
  * @param callbackFn - 回调函数
18579
18687
  * @returns 注册操作是否成功
package/package.json CHANGED
@@ -1 +1 @@
1
- { "name": "@jlceda/pro-api-types", "type": "module", "version": "0.2.13", "description": "嘉立创EDA & EasyEDA 专业版扩展 API 接口类型定义", "typings": "index.d.ts", "author": "JLCEDA <support@lceda.cn>", "license": "Apache-2.0", "homepage": "https://pro.lceda.cn/", "keywords": ["jlceda", "pro-api"], "scripts": { "lint": "eslint", "fix": "eslint --fix", "build": "ts-node ./build/build.ts" }, "devDependencies": { "@antfu/eslint-config": "^5.4.1", "@types/fast-text-encoding": "^1.0.3", "@types/fs-extra": "^11.0.4", "dotenv": "^16.4.7", "eslint": "^9.37.0", "fast-text-encoding": "^1.0.6", "fs-extra": "^11.3.0", "lint-staged": "^16.2.3", "simple-git-hooks": "^2.13.1", "ts-node": "^10.9.2", "typescript": "^5.7.3" }, "simple-git-hooks": { "pre-commit": "npx lint-staged" }, "lint-staged": { "*": "eslint --fix" } }
1
+ { "name": "@jlceda/pro-api-types", "type": "module", "version": "0.2.19", "description": "嘉立创EDA & EasyEDA 专业版扩展 API 接口类型定义", "typings": "index.d.ts", "author": "JLCEDA <support@lceda.cn>", "license": "Apache-2.0", "homepage": "https://pro.lceda.cn/", "keywords": ["jlceda", "pro-api"], "scripts": { "lint": "eslint", "fix": "eslint --fix", "build": "ts-node ./build/build.ts" }, "devDependencies": { "@antfu/eslint-config": "^5.4.1", "@types/fast-text-encoding": "^1.0.3", "@types/fs-extra": "^11.0.4", "dotenv": "^16.4.7", "eslint": "^9.37.0", "fast-text-encoding": "^1.0.6", "fs-extra": "^11.3.0", "lint-staged": "^16.2.3", "simple-git-hooks": "^2.13.1", "ts-node": "^10.9.2", "typescript": "^5.7.3" }, "simple-git-hooks": { "pre-commit": "npx lint-staged" }, "lint-staged": { "*": "eslint --fix" } }