@windypro-rourou/dsh-eda 0.1.0 → 0.1.1

package/skill/references/classes/DMT_SelectControl.md

@@ -0,0 +1,96 @@
+# DMT\_SelectControl class
+
+Document tree / selection control class
+
+## Signature
+
+```typescript
+class DMT_SelectControl
+```
+
+## Remarks
+
+Query and control of the selection focus in the document tree
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[getCurrentDocumentInfo()](./DMT_SelectControl.md)
+
+</td><td>
+
+</td><td>
+
+**_(BETA)_** Get the properties of the current document
+
+</td></tr>
+</tbody></table>
+
+---
+
+## 方法详情
+
+### getcurrentdocumentinfo
+
+# DMT\_SelectControl.getCurrentDocumentInfo() method
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+
+Get the properties of the current document
+
+## Signature
+
+```typescript
+function getCurrentDocumentInfo(): Promise<IDMT_EditorDocumentItem | undefined>;
+```
+
+## Returns
+
+Promise&lt;[IDMT\_EditorDocumentItem](../interfaces/IDMT_EditorDocumentItem.md) \| undefined&gt;
+
+An object composed of the document type, UUID, the UUID of the project it belongs to, and the UUID of the library it belongs to. If it is `undefined`<!-- -->, the retrieval failed
+
+## Remarks
+
+It will get the document type, UUID, and the UUID of the project or library it belongs to for the currently open document that has the last input focus
+
+## Example
+
+```javascript
+// 1. 创建专用测试原理图（自带图页 p1），打开该页让焦点落到测试文档上
+const schematicUuid = await eda.dmt_Schematic.createSchematic();
+await new Promise(r => setTimeout(r, 1500));
+const info = await eda.dmt_Schematic.getSchematicInfo(schematicUuid);
+const pageUuid = info.page[0].uuid;
+await eda.dmt_EditorControl.openDocument(pageUuid);
+await new Promise(r => setTimeout(r, 1000));
+
+// 2. 获取当前焦点文档的属性（documentType: 1=原理图, 3=PCB）
+const doc = await eda.dmt_SelectControl.getCurrentDocumentInfo();
+
+// 3. 输出文档类型、UUID、标签页与所属工程，确认正是刚打开的测试图页
+console.log('documentType:', doc?.documentType);
+console.log('documentUuid:', doc?.uuid);
+console.log('tabId:', doc?.tabId);
+console.log('parentProjectUuid:', doc?.parentProjectUuid);
+console.log('isFocusedPage:', doc?.uuid === pageUuid);
+
+// 4. 清理测试原理图（处于打开状态也可以直接删除）
+await new Promise(r => setTimeout(r, 1000));
+const deleted = await eda.dmt_Schematic.deleteSchematic(schematicUuid);
+console.log('deleted:', deleted);
+```

package/skill/references/classes/DMT_Team.md

@@ -0,0 +1,172 @@
+# DMT\_Team class
+
+Document tree / Team class
+
+## Signature
+
+```typescript
+class DMT_Team
+```
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[getAllInvolvedTeamInfo()](./DMT_Team.md)
+
+</td><td>
+
+</td><td>
+
+Get the detailed properties of all involved teams
+
+</td></tr>
+<tr><td>
+
+[getAllTeamsInfo()](./DMT_Team.md)
+
+</td><td>
+
+</td><td>
+
+Get the detailed properties of all direct teams
+
+</td></tr>
+<tr><td>
+
+[getCurrentTeamInfo()](./DMT_Team.md)
+
+</td><td>
+
+</td><td>
+
+Get the detailed properties of the current team
+
+</td></tr>
+</tbody></table>
+
+---
+
+## 方法详情
+
+### getallinvolvedteaminfo
+
+# DMT\_Team.getAllInvolvedTeamInfo() method
+
+Get the detailed properties of all involved teams
+
+## Signature
+
+```typescript
+function getAllInvolvedTeamInfo(): Promise<Array<IDMT_TeamItem>>;
+```
+
+## Returns
+
+Promise&lt;Array&lt;[IDMT\_TeamItem](../interfaces/IDMT_TeamItem.md)<!-- -->&gt;&gt;
+
+Detailed properties of all involved teams
+
+## Example
+
+```javascript
+// 1. 尝试获取所有参与的团队（当前版本会触发内部缺陷）
+let teams;
+try {
+	teams = await eda.dmt_Team.getAllInvolvedTeamInfo();
+}
+catch (e) {
+	console.log('说明：当前版本触发内部缺陷，改用 getAllTeamsInfo 替代：', e.message);
+
+	// 2. 替代方案：获取所有直接团队
+	teams = await eda.dmt_Team.getAllTeamsInfo();
+}
+
+// 3. 输出团队数量与每个团队的属性
+console.log('团队数量：', teams.length);
+teams.forEach((team, i) => {
+	console.log(`团队${i + 1}：`, team.name, 'uuid:', team.uuid);
+});
+```
+
+### getallteamsinfo
+
+# DMT\_Team.getAllTeamsInfo() method
+
+Get the detailed properties of all direct teams
+
+## Signature
+
+```typescript
+function getAllTeamsInfo(): Promise<Array<IDMT_TeamItem>>;
+```
+
+## Returns
+
+Promise&lt;Array&lt;[IDMT\_TeamItem](../interfaces/IDMT_TeamItem.md)<!-- -->&gt;&gt;
+
+Detailed properties of all teams
+
+## Remarks
+
+A personal space is essentially a team named \*\*Personal\*\*
+
+## Example
+
+```javascript
+// 1. 获取所有直接团队
+const teams = await eda.dmt_Team.getAllTeamsInfo();
+
+// 2. 输出团队数量与每个团队的属性（name/uuid/identity/itemType）
+console.log('团队数量：', teams.length);
+teams.forEach((team, i) => {
+	console.log(`团队${i + 1}：`, team.name, 'uuid:', team.uuid, '身份 ID：', team.identity);
+});
+```
+
+### getcurrentteaminfo
+
+# DMT\_Team.getCurrentTeamInfo() method
+
+Get the detailed properties of the current team
+
+## Signature
+
+```typescript
+function getCurrentTeamInfo(): Promise<IDMT_TeamItem | undefined>;
+```
+
+## Returns
+
+Promise&lt;[IDMT\_TeamItem](../interfaces/IDMT_TeamItem.md) \| undefined&gt;
+
+Detailed properties of the team. If it is `undefined`<!-- -->, the retrieval failed
+
+## Remarks
+
+It will get the detailed properties of the team that the project belongs to, associated with the currently open schematic, PCB, or panel that has the last input focus
+
+## Example
+
+```javascript
+// 1. 获取当前团队属性
+const team = await eda.dmt_Team.getCurrentTeamInfo();
+
+// 2. 输出当前团队属性（uuid 常用作后续 DMT_Folder/Project API 的 teamUuid 参数）
+console.log('当前团队名称：', team?.name);
+console.log('当前团队 uuid：', team?.uuid);
+console.log('当前团队身份 ID：', team?.identity);
+```

package/skill/references/classes/DMT_Workspace.md

@@ -0,0 +1,198 @@
+# DMT\_Workspace class
+
+Document tree / Workspace class
+
+## Signature
+
+```typescript
+class DMT_Workspace
+```
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[getAllWorkspacesInfo()](./DMT_Workspace.md)
+
+</td><td>
+
+</td><td>
+
+Get the detailed properties of all workspaces
+
+</td></tr>
+<tr><td>
+
+[getCurrentWorkspaceInfo()](./DMT_Workspace.md)
+
+</td><td>
+
+</td><td>
+
+Get the detailed properties of the current workspace
+
+</td></tr>
+<tr><td>
+
+[toggleToWorkspace(workspaceUuid)](./DMT_Workspace.md)
+
+</td><td>
+
+</td><td>
+
+Switch to workspace
+
+</td></tr>
+</tbody></table>
+
+---
+
+## 方法详情
+
+### getallworkspacesinfo
+
+# DMT\_Workspace.getAllWorkspacesInfo() method
+
+Get the detailed properties of all workspaces
+
+## Signature
+
+```typescript
+function getAllWorkspacesInfo(): Promise<Array<IDMT_WorkspaceItem>>;
+```
+
+## Returns
+
+Promise&lt;Array&lt;[IDMT\_WorkspaceItem](../interfaces/IDMT_WorkspaceItem.md)<!-- -->&gt;&gt;
+
+Detailed properties of all workspaces
+
+## Example
+
+```javascript
+// 1. 获取所有工作区
+const workspaces = await eda.dmt_Workspace.getAllWorkspacesInfo();
+
+// 2. 输出工作区数量与每个工作区的属性（name/uuid/itemType）
+console.log('工作区数量：', workspaces.length);
+workspaces.forEach((ws, i) => {
+	console.log(`工作区${i + 1}：`, ws.name, 'uuid:', ws.uuid);
+});
+```
+
+### getcurrentworkspaceinfo
+
+# DMT\_Workspace.getCurrentWorkspaceInfo() method
+
+Get the detailed properties of the current workspace
+
+## Signature
+
+```typescript
+function getCurrentWorkspaceInfo(): Promise<IDMT_WorkspaceItem | undefined>;
+```
+
+## Returns
+
+Promise&lt;[IDMT\_WorkspaceItem](../interfaces/IDMT_WorkspaceItem.md) \| undefined&gt;
+
+Detailed properties of the workspace. If it is `undefined`<!-- -->, the retrieval failed
+
+## Remarks
+
+It will get the detailed properties of the current workspace
+
+## Example
+
+```javascript
+// 1. 获取当前工作区属性
+const workspace = await eda.dmt_Workspace.getCurrentWorkspaceInfo();
+
+// 2. 输出当前工作区属性（uuid 可直接用作 toggleToWorkspace 的切换参数）
+console.log('当前工作区名称：', workspace?.name);
+console.log('当前工作区 uuid：', workspace?.uuid);
+```
+
+### toggletoworkspace
+
+# DMT\_Workspace.toggleToWorkspace() method
+
+Switch to workspace
+
+## Signature
+
+```typescript
+function toggleToWorkspace(workspaceUuid?: string): Promise<boolean>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+workspaceUuid
+
+</td><td>
+
+string
+
+</td><td>
+
+_(Optional)_ Workspace UUID. If not specified, it will switch to the personal workspace
+
+</td></tr>
+</tbody></table>
+
+## Returns
+
+Promise&lt;boolean&gt;
+
+Whether the switch operation was successful
+
+## Example
+
+```javascript
+// 1. 记录切换前的工作区（演示结束后切回，恢复现场）
+const before = await eda.dmt_Workspace.getCurrentWorkspaceInfo();
+
+// 2. 获取所有工作区，选一个非当前的作为切换目标；只有当前一个时切换自身
+const workspaces = await eda.dmt_Workspace.getAllWorkspacesInfo();
+const target = workspaces.find(ws => ws.uuid !== before.uuid) || before;
+
+// 3. 切换到目标工作区
+const toggled = await eda.dmt_Workspace.toggleToWorkspace(target.uuid);
+console.log('切换是否成功：', toggled);
+
+// 4. 回读当前工作区，确认已切换到目标
+const now = await eda.dmt_Workspace.getCurrentWorkspaceInfo();
+console.log('切换后工作区：', now.name, 'uuid:', now.uuid);
+
+// 5. 切回原工作区，恢复现场
+const restored = await eda.dmt_Workspace.toggleToWorkspace(before.uuid);
+console.log('切回是否成功：', restored);
+```