@windypro-rourou/dsh-eda 0.1.0 → 0.1.2

package/skill/references/interfaces/ILIB_ExtendLibraryClassificationIndex.md

@@ -0,0 +1,150 @@
+# ILIB\_ExtendLibraryClassificationIndex interface
+
+> Warning: This API is now obsolete.
+>
+> since EDA v3.2; dropped EDA v3.3
+
+External library classification index
+
+## Signature
+
+```typescript
+interface ILIB_ExtendLibraryClassificationIndex
+```
+
+## Remarks
+
+Supports external libraries using a name or UUID as the unique ID index of the classification
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[primaryClassificationName?](./ILIB_ExtendLibraryClassificationIndex.md)
+
+</td><td>
+
+</td><td>
+
+string
+
+</td><td>
+
+_(Optional)_ Primary classification name
+
+</td></tr>
+<tr><td>
+
+[primaryClassificationUuid?](./ILIB_ExtendLibraryClassificationIndex.md)
+
+</td><td>
+
+</td><td>
+
+string
+
+</td><td>
+
+_(Optional)_ Primary classification UUID
+
+</td></tr>
+<tr><td>
+
+[secondaryClassificationName?](./ILIB_ExtendLibraryClassificationIndex.md)
+
+</td><td>
+
+</td><td>
+
+string
+
+</td><td>
+
+_(Optional)_ Secondary classification name
+
+</td></tr>
+<tr><td>
+
+[secondaryClassificationUuid?](./ILIB_ExtendLibraryClassificationIndex.md)
+
+</td><td>
+
+</td><td>
+
+string
+
+</td><td>
+
+_(Optional)_ Secondary classification UUID
+
+</td></tr>
+</tbody></table>
+
+---
+
+## 属性详情
+
+### primaryclassificationname
+
+# ILIB\_ExtendLibraryClassificationIndex.primaryClassificationName property
+
+Primary classification name
+
+## Signature
+
+```typescript
+primaryClassificationName?: string;
+```
+
+### primaryclassificationuuid
+
+# ILIB\_ExtendLibraryClassificationIndex.primaryClassificationUuid property
+
+Primary classification UUID
+
+## Signature
+
+```typescript
+primaryClassificationUuid?: string;
+```
+
+### secondaryclassificationname
+
+# ILIB\_ExtendLibraryClassificationIndex.secondaryClassificationName property
+
+Secondary classification name
+
+## Signature
+
+```typescript
+secondaryClassificationName?: string;
+```
+
+### secondaryclassificationuuid
+
+# ILIB\_ExtendLibraryClassificationIndex.secondaryClassificationUuid property
+
+Secondary classification UUID
+
+## Signature
+
+```typescript
+secondaryClassificationUuid?: string;
+```

package/skill/references/interfaces/ILIB_ExtendLibraryDeviceFunctions.md

@@ -0,0 +1,157 @@
+# ILIB\_ExtendLibraryDeviceFunctions interface
+
+External library device functions
+
+## Signature
+
+```typescript
+interface ILIB_ExtendLibraryDeviceFunctions extends ILIB_ExtendLibraryFunctions
+```
+**Extends:** [ILIB\_ExtendLibraryFunctions](./ILIB_ExtendLibraryFunctions.md)
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[getList](./ILIB_ExtendLibraryDeviceFunctions.md)
+
+</td><td>
+
+</td><td>
+
+(props: [ILIB\_ExtendLibrarySearchProperty](./ILIB_ExtendLibrarySearchProperty.md)<!-- -->&lt;{ attributes?: undefined \| Record&lt;string, string&gt;; symbolType?: undefined \| [ELIB\_SymbolType.COMPONENT](../enums/ELIB_SymbolType.md) \| [ELIB\_SymbolType.NET\_FLAG](../enums/ELIB_SymbolType.md) \| [ELIB\_SymbolType.NET\_PORT](../enums/ELIB_SymbolType.md) \| [ELIB\_SymbolType.DRAWING](../enums/ELIB_SymbolType.md) \| [ELIB\_SymbolType.NON\_ELECTRICAL](../enums/ELIB_SymbolType.md) \| [ELIB\_SymbolType.SHORT\_CIRCUIT\_FLAG](../enums/ELIB_SymbolType.md) \| [ELIB\_SymbolType.OFF\_PAGE\_CONNECTOR](../enums/ELIB_SymbolType.md) \| [ELIB\_SymbolType.DIFFERENTIAL\_PAIRS\_FLAG](../enums/ELIB_SymbolType.md) \| [ELIB\_SymbolType.CBB\_SYMBOL](../enums/ELIB_SymbolType.md) }&gt;) =&gt; Promise&lt;[ILIB\_ExtendLibrarySearchResult](./ILIB_ExtendLibrarySearchResult.md)<!-- -->&lt;[ILIB\_ExtendLibraryItemIndex](./ILIB_ExtendLibraryItemIndex.md) &amp; { classification?: undefined \| string\[\] \| [ILIB\_ExtendLibraryClassificationIndex](./ILIB_ExtendLibraryClassificationIndex.md)<!-- -->; symbol?: undefined \| [ILIB\_ExtendLibraryItem](./ILIB_ExtendLibraryItem.md) &amp; { symbolType: [ELIB\_SymbolType](../enums/ELIB_SymbolType.md) }; footprint?: undefined \| [ILIB\_ExtendLibraryItem](./ILIB_ExtendLibraryItem.md)<!-- -->; symbols?: undefined \| ([ILIB\_ExtendLibraryItem](./ILIB_ExtendLibraryItem.md) &amp; { symbolType: [ELIB\_SymbolType](../enums/ELIB_SymbolType.md) })\[\]; footprints?: undefined \| [ILIB\_ExtendLibraryItem](./ILIB_ExtendLibraryItem.md)<!-- -->\[\]; model3d?: undefined \| [ILIB\_ExtendLibraryItemIndex](./ILIB_ExtendLibraryItemIndex.md) &amp; { adjustment?: undefined \| { size?: undefined \| { x: number; y: number; z: number }; rotation?: undefined \| { x: number; y: number; z: number }; offset?: undefined \| { x: number; y: number; z: number } } }; images?: undefined \| [ILIB\_ExtendLibraryItem](./ILIB_ExtendLibraryItem.md)<!-- -->\[\]; value?: undefined \| string; supplierPart?: undefined \| string; manufacturer?: undefined \| string; description?: undefined \| string; updateTime?: undefined \| number; createTime?: undefined \| number; attributes?: undefined \| Record&lt;string, string&gt; }&gt;&gt;
+
+</td><td>
+
+</td></tr>
+<tr><td>
+
+[getSupportedPreviewTypes](./ILIB_ExtendLibraryDeviceFunctions.md)
+
+</td><td>
+
+</td><td>
+
+() =&gt; Promise&lt;Array&lt;[ELIB\_PreviewType](../enums/ELIB_PreviewType.md)<!-- -->&gt;&gt;
+
+</td><td>
+
+获取支持的预览类型
+
+</td></tr>
+<tr><td>
+
+[getSupportedSymbolTypes](./ILIB_ExtendLibraryDeviceFunctions.md)
+
+</td><td>
+
+</td><td>
+
+() =&gt; Promise&lt;Array&lt;[ELIB\_SymbolType](../enums/ELIB_SymbolType.md)<!-- -->&gt;&gt;
+
+</td><td>
+
+获取支持的符号类型
+
+</td></tr>
+</tbody></table>
+
+---
+
+## 属性详情
+
+### getlist
+
+# ILIB\_ExtendLibraryDeviceFunctions.getList property
+
+## Signature
+
+```typescript
+getList: (
+	props: ILIB_ExtendLibrarySearchProperty<{
+		attributes?: undefined | Record<string, string>;
+		symbolType?:
+			| undefined
+			| ELIB_SymbolType.COMPONENT
+			| ELIB_SymbolType.NET_FLAG
+			| ELIB_SymbolType.NET_PORT
+			| ELIB_SymbolType.DRAWING
+			| ELIB_SymbolType.NON_ELECTRICAL
+			| ELIB_SymbolType.SHORT_CIRCUIT_FLAG
+			| ELIB_SymbolType.OFF_PAGE_CONNECTOR
+			| ELIB_SymbolType.DIFFERENTIAL_PAIRS_FLAG
+			| ELIB_SymbolType.CBB_SYMBOL;
+	}>,
+) =>
+	Promise<
+		ILIB_ExtendLibrarySearchResult<
+			ILIB_ExtendLibraryItemIndex & {
+				classification?: undefined | string[] | ILIB_ExtendLibraryClassificationIndex;
+				symbol?: undefined | (ILIB_ExtendLibraryItem & { symbolType: ELIB_SymbolType });
+				footprint?: undefined | ILIB_ExtendLibraryItem;
+				symbols?: undefined | (ILIB_ExtendLibraryItem & { symbolType: ELIB_SymbolType })[];
+				footprints?: undefined | ILIB_ExtendLibraryItem[];
+				model3d?:
+					| undefined
+					| (ILIB_ExtendLibraryItemIndex & {
+						adjustment?:
+							| undefined
+							| {
+								size?: undefined | { x: number; y: number; z: number };
+								rotation?: undefined | { x: number; y: number; z: number };
+								offset?: undefined | { x: number; y: number; z: number };
+							};
+					});
+				images?: undefined | ILIB_ExtendLibraryItem[];
+				value?: undefined | string;
+				supplierPart?: undefined | string;
+				manufacturer?: undefined | string;
+				description?: undefined | string;
+				updateTime?: undefined | number;
+				createTime?: undefined | number;
+				attributes?: undefined | Record<string, string>;
+			}
+		>
+	>;
+```
+
+### getsupportedpreviewtypes
+
+# ILIB\_ExtendLibraryDeviceFunctions.getSupportedPreviewTypes property
+
+获取支持的预览类型
+
+## Signature
+
+```typescript
+getSupportedPreviewTypes: () => Promise<Array<ELIB_PreviewType>>;
+```
+
+### getsupportedsymboltypes
+
+# ILIB\_ExtendLibraryDeviceFunctions.getSupportedSymbolTypes property
+
+获取支持的符号类型
+
+## Signature
+
+```typescript
+getSupportedSymbolTypes: () => Promise<Array<ELIB_SymbolType>>;
+```

package/skill/references/interfaces/ILIB_ExtendLibraryFootprintFunctions.md

@@ -0,0 +1,63 @@
+# ILIB\_ExtendLibraryFootprintFunctions interface
+
+External library footprint functions
+
+## Signature
+
+```typescript
+interface ILIB_ExtendLibraryFootprintFunctions extends ILIB_ExtendLibraryFunctions
+```
+**Extends:** [ILIB\_ExtendLibraryFunctions](./ILIB_ExtendLibraryFunctions.md)
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[getList](./ILIB_ExtendLibraryFootprintFunctions.md)
+
+</td><td>
+
+</td><td>
+
+(props: [ILIB\_ExtendLibrarySearchProperty](./ILIB_ExtendLibrarySearchProperty.md)<!-- -->&lt;{}&gt;) =&gt; Promise&lt;[ILIB\_ExtendLibrarySearchResult](./ILIB_ExtendLibrarySearchResult.md)<!-- -->&lt;[ILIB\_ExtendLibraryItem](./ILIB_ExtendLibraryItem.md) &amp; [ILIB\_ExtendLibrarySearchResultDataLine](./ILIB_ExtendLibrarySearchResultDataLine.md)<!-- -->&gt;&gt;
+
+</td><td>
+
+</td></tr>
+</tbody></table>
+
+---
+
+## 属性详情
+
+### getlist
+
+# ILIB\_ExtendLibraryFootprintFunctions.getList property
+
+## Signature
+
+```typescript
+getList: (props: ILIB_ExtendLibrarySearchProperty<{}>) =>
+	Promise<
+		ILIB_ExtendLibrarySearchResult<
+			ILIB_ExtendLibraryItem & ILIB_ExtendLibrarySearchResultDataLine
+		>
+	>;
+```

package/skill/references/interfaces/ILIB_ExtendLibraryFunctions.md

@@ -0,0 +1,123 @@
+# ILIB\_ExtendLibraryFunctions interface
+
+External library functions
+
+## Signature
+
+```typescript
+interface ILIB_ExtendLibraryFunctions
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[getClassificationTree](./ILIB_ExtendLibraryFunctions.md)
+
+</td><td>
+
+</td><td>
+
+() =&gt; Promise&lt;Array&lt;{ name: string; uuid?: undefined \| string; children?: undefined \| ({ name: string; uuid?: undefined \| string })\[\] }&gt;&gt;
+
+</td><td>
+
+获取分类树
+
+</td></tr>
+<tr><td>
+
+[getDetail](./ILIB_ExtendLibraryFunctions.md)
+
+</td><td>
+
+</td><td>
+
+(uuid: string) =&gt; Promise&lt;any&gt;
+
+</td><td>
+
+获取详细信息
+
+</td></tr>
+<tr><td>
+
+[getList](./ILIB_ExtendLibraryFunctions.md)
+
+</td><td>
+
+</td><td>
+
+(props: [ILIB\_ExtendLibrarySearchProperty](./ILIB_ExtendLibrarySearchProperty.md)<!-- -->&lt;any&gt;) =&gt; Promise&lt;[ILIB\_ExtendLibrarySearchResult](./ILIB_ExtendLibrarySearchResult.md)<!-- -->&lt;any&gt;&gt;
+
+</td><td>
+
+获取列表
+
+</td></tr>
+</tbody></table>
+
+---
+
+## 属性详情
+
+### getclassificationtree
+
+# ILIB\_ExtendLibraryFunctions.getClassificationTree property
+
+获取分类树
+
+## Signature
+
+```typescript
+getClassificationTree: () =>
+	Promise<
+		Array<{
+			name: string;
+			uuid?: undefined | string;
+			children?: undefined | { name: string; uuid?: undefined | string }[];
+		}>
+	>;
+```
+
+### getdetail
+
+# ILIB\_ExtendLibraryFunctions.getDetail property
+
+获取详细信息
+
+## Signature
+
+```typescript
+getDetail: (uuid: string) => Promise<any>;
+```
+
+### getlist
+
+# ILIB\_ExtendLibraryFunctions.getList property
+
+获取列表
+
+## Signature
+
+```typescript
+getList: (props: ILIB_ExtendLibrarySearchProperty<any>) =>
+	Promise<ILIB_ExtendLibrarySearchResult<any>>;
+```

package/skill/references/interfaces/ILIB_ExtendLibraryItem.md

@@ -0,0 +1,97 @@
+# ILIB\_ExtendLibraryItem interface
+
+External library item
+
+## Signature
+
+```typescript
+interface ILIB_ExtendLibraryItem extends ILIB_ExtendLibraryItemIndex
+```
+**Extends:** [ILIB\_ExtendLibraryItemIndex](./ILIB_ExtendLibraryItemIndex.md)
+
+## Remarks
+
+Here the `url` or `data` field needs to be passed. If both are passed, the data of `data` is used and the `url` field is ignored
+
+If only the `url` field is passed in, a request will be made to it to try to obtain its library file
+
+The data of `data` can be in Blob or DataURL format
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[data?](./ILIB_ExtendLibraryItem.md)
+
+</td><td>
+
+</td><td>
+
+string \| Blob
+
+</td><td>
+
+_(Optional)_ Library file data
+
+</td></tr>
+<tr><td>
+
+[url?](./ILIB_ExtendLibraryItem.md)
+
+</td><td>
+
+</td><td>
+
+string
+
+</td><td>
+
+_(Optional)_ Library file URL
+
+</td></tr>
+</tbody></table>
+
+---
+
+## 属性详情
+
+### data
+
+# ILIB\_ExtendLibraryItem.data property
+
+Library file data
+
+## Signature
+
+```typescript
+data?: string | Blob;
+```
+
+### url
+
+# ILIB\_ExtendLibraryItem.url property
+
+Library file URL
+
+## Signature
+
+```typescript
+url?: string;
+```

package/skill/references/interfaces/ILIB_ExtendLibraryItemIndex.md

@@ -0,0 +1,98 @@
+# ILIB\_ExtendLibraryItemIndex interface
+
+External library item index
+
+## Signature
+
+```typescript
+interface ILIB_ExtendLibraryItemIndex
+```
+
+## Remarks
+
+Supports external libraries using a name or UUID as the unique ID index of the item
+
+Under normal circumstances, each library is expected to have a UUID, but some systems may not have a UUID field (or a field that can serve a similar purpose) at development time
+
+When only the `name` field is passed here, `name` will be used as the unique ID, and duplicate names are not allowed
+
+If both the `uuid` and `name` fields are passed, only `uuid` cannot be duplicated
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[name](./ILIB_ExtendLibraryItemIndex.md)
+
+</td><td>
+
+</td><td>
+
+string
+
+</td><td>
+
+Library name
+
+</td></tr>
+<tr><td>
+
+[uuid?](./ILIB_ExtendLibraryItemIndex.md)
+
+</td><td>
+
+</td><td>
+
+string
+
+</td><td>
+
+_(Optional)_ Library UUID
+
+</td></tr>
+</tbody></table>
+
+---
+
+## 属性详情
+
+### name
+
+# ILIB\_ExtendLibraryItemIndex.name property
+
+Library name
+
+## Signature
+
+```typescript
+name: string;
+```
+
+### uuid
+
+# ILIB\_ExtendLibraryItemIndex.uuid property
+
+Library UUID
+
+## Signature
+
+```typescript
+uuid?: string;
+```