aitable-workflow-cli 0.1.15 → 0.1.16-beta.1786022310508

package/templates/aitable-handoff/wiki/faq-support/18-/345/274/200/345/217/221/350/200/205/346/214/207/345/215/227/AI/350/241/250/346/240/274/350/204/232/346/234/254/346/217/222/344/273/266 /345/274/200/345/217/221/346/214/207/345/215/227/Base /346/250/241/345/235/227.md"

@@ -1,391 +0,0 @@
-# Base 模块
-
-当前AI表格格实例，AI表格格相关 API 的主入口，提供了操作AI表格基础对象的方法，支持查询权限、管理数据表以及获取选择区域等信息。
-
-```typescript
-const base = DingdocsScript.base;
-```
-```typescript
-const base = Base; // 提供了全局变量Base
-```
-> 文中未声明的类型定义，请至[请至钉钉文档查看附件《AI表格JSAPI 类型描述》。](https://alidocs.dingtalk.com/i/nodes/LeBq413JAOyAdGBMsBo1lRd3WDOnGvpb?iframeQuery=anchorId%3DX02mk15wsqsz7clll7zlo)中进行查询
-
-### getActiveSheet
-
-获取当前激活的数据表对象。
-
-```typescript
-getActiveSheet(): Sheet | null
-```
-
-**返回值**
-
-*   [`Sheet[] | null`](https://alidocs.dingtalk.com/i/nodes/dQPGYqjpJYZnRbNYCzr9jRXw8akx1Z5N) - 当前选中的数据表对象，若未选中任何数据表则返回 null
-    
-
-**示例**
-
-```typescript
-const activeSheet = base.getActiveSheet();
-if (activeSheet) {
-  console.log(`当前选中的数据表: ${activeSheet.getName()}`);
-} else {
-  console.log('当前未选中任何数据表');
-}
-
-```
-```typescript
-const activeSheet = Base.getActiveSheet();
-if (activeSheet) {
-  Output.log(`当前选中的数据表: ${activeSheet.getName()}`);
-} else {
-  Output.log('当前未选中任何数据表');
-}
-
-```
-
-### getSheet
-
-根据数据表ID或数据表名称获取指定数据表。
-
-```typescript
-getSheet(idOrName: string): Sheet | null
-
-```
-
-**参数**
-
-*   `idOrName`: `string` - 数据表ID或数据表名称
-    
-
-**返回值**
-
-*   [`Sheet | null`](https://alidocs.dingtalk.com/i/nodes/y20BglGWOGQgpOj6uYQeAA3EWA7depqY?utm_scene=person_space) - 匹配的数据表对象，若未找到则返回 null
-    
-
-**示例**
-
-```typescript
-// 通过名称获取数据表
-const productSheet = base.getSheet('产品清单');
-if (productSheet) {
-  console.log(`成功获取数据表，字段数量: ${productSheet.getFields().length}`);
-}
-
-// 通过ID获取数据表
-const sheetById = base.getSheet('sht123456');
-
-```
-```typescript
-// 通过名称获取数据表
-const productSheet = Base.getSheet('产品清单');
-if (productSheet) {
-  Output.log(`成功获取数据表，字段数量: ${productSheet.getFields().length}`);
-}
-
-// 通过ID获取数据表
-const sheetById = Base.getSheet('sht123456');
-
-```
-
-### getSheets
-
-获取当前用户可见的所有数据表。
-
-```typescript
-getSheets(): Sheet[]
-```
-
-**返回值**
-
-*   [`Sheet[]`](https://alidocs.dingtalk.com/i/nodes/y20BglGWOGQgpOj6uYQeAA3EWA7depqY?utm_scene=person_space) - 当前用户可见的所有数据表对象数组
-    
-
-**示例**
-
-```typescript
-const allSheets = base.getSheets();
-console.log(`可见的数据表数量: ${allSheets.length}`);
-allSheets.forEach(sheet => {
-  console.log(`- ${sheet.getName()}`);
-});
-
-```
-```typescript
-const allSheets = Base.getSheets();
-Output.log(`可见的数据表数量: ${allSheets.length}`);
-allSheets.forEach(sheet => {
-  Output.log(`- ${sheet.getName()}`);
-});
-
-```
-
-### insertSheet
-
-插入一张数据表。
-
-```typescript
-insertSheet(name: string, fields?: FieldToInsert[]): Sheet
-
-```
-
-**参数**
-
-*   `name`: `string` - 数据表名称
-    
-*   `fields`: [`FieldToInsert[]`](https://alidocs.dingtalk.com/i/nodes/GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno?iframeQuery=record%3DhERWDMS_qvGDAH2_pbtVzlZUdc)  (可选) - 数据表携带的字段配置，不传时会携带默认空数据表模版的字段
-    
-
-根据字段类型不同，支持传入的字段属性结构也不同，具体可以参考[《字段数据结构》](https://alidocs.dingtalk.com/i/nodes/nYMoO1rWxmP7olkyF0kGwelwV47Z3je9?utm_scene=team_space&iframeQuery=anchorId%3Duu_mk4xf3z7pfeezmqbo5e)
-
-**返回值**
-
-*   [`Sheet`](https://alidocs.dingtalk.com/i/nodes/y20BglGWOGQgpOj6uYQeAA3EWA7depqY?utm_scene=person_space) - 新插入的数据表对象
-    
-
-**示例**
-
-```typescript
-// 创建一个仅有默认字段的数据表
-const newSheet = base.insertSheet('新数据表');
-
-// 创建一个带有自定义字段的数据表
-const customSheet = base.insertSheet('客户信息', [
-  { name: '客户名称', type: 'text' },
-  { name: '注册日期', type: 'date' }
-]);
-
-```
-```typescript
-// 创建一个仅有默认字段的数据表
-const newSheet = Base.insertSheet('新数据表');
-
-// 创建一个带有自定义字段的数据表
-const customSheet = Base.insertSheet('客户信息', [
-  { name: '客户名称', type: 'text' },
-  { name: '注册日期', type: 'date' }
-]);
-
-```
-
-### updateSheet
-
-根据数据表ID更新指定数据表。
-
-```typescript
-updateSheet(id: string, sheetConfig: SheetToUpdate): Sheet
-
-```
-
-**参数**
-
-*   `id`: `string` - 数据表ID
-    
-*   `sheetConfig`: [`SheetToUpdate`](https://alidocs.dingtalk.com/notable/record?dentryUuid=GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno&rowId=ldfKflKobM&sheetId=hERWDMS&viewId=qvGDAH2) - 需要更新的数据表名称和描述
-    
-
-**返回值**
-
-*   [`Sheet`](https://alidocs.dingtalk.com/i/nodes/y20BglGWOGQgpOj6uYQeAA3EWA7depqY?utm_scene=person_space) - 更新的数据表对象，支持链式调用
-    
-
-### deleteSheet
-
-根据数据表ID或数据表名称删除指定数据表。
-
-```typescript
-deleteSheet(idOrName: string): Base
-
-```
-
-**参数**
-
-*   `idOrName`: `string` - 数据表ID或数据表名称
-    
-
-**返回值**
-
-*   `Base` - Base对象本身，支持链式调用
-    
-
-**示例**
-
-```typescript
-// 通过名称删除数据表
-base.deleteSheet('临时数据表');
-
-// 通过ID删除数据表并链式调用
-base.deleteSheet('sht123456').getSheets();
-
-```
-
-### isFieldOfType
-
-判断字段是否为指定字段类型
-
-```typescript
-isFieldOfType: <T extends FieldType>(field: Field<FieldType>, type: T) => field is Field<T>;
-```
-
-**参数**
-
-*   `field`: [`Field`](https://alidocs.dingtalk.com/i/nodes/np9zOoBVBy2AdzEju0z93rx2W1DK0g6l?utm_scene=person_space) - 需要判断类型的字段对象
-    
-*   `field`: [`FieldType`](https://alidocs.dingtalk.com/notable/record?dentryUuid=GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno&rowId=7Gtfo83ZWU&sheetId=hERWDMS&viewId=qvGDAH2) - 指定字段类型
-    
-
-**返回值**
-
-*   `boolean` - 是否为对应类型的字段
-    
-
-**示例**
-
-```typescript
-const field = sheet.getField('数字');
-if (field && base.isFieldOfType(field, 'number')) {
-    console.log('This is a number field');
-} else {
-    console.log('This is not a number Field')
-}
-```
-```typescript
-const field = sheet.getField('数字');
-if (field && Base.isFieldOfType(field, 'number')) {
-    Output.log('This is a number field');
-} else {
-    Output.log('This is not a number Field')
-}
-```
-
-### getSelection
-
-获取当前AI表格激活区域的信息
-
-```typescript
-getSelection: () => Selection;
-
-```
-
-**返回值**
-
-*    [`Selection`](https://alidocs.dingtalk.com/i/nodes/GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno?iframeQuery=record%3DhERWDMS_qvGDAH2_IL4TFXyGoQ) - 数据表激活区域的信息
-    
-
-### getDentryUuid
-
-获取文档dentryUuid。
-
-```typescript
-getDentryUuid(): string
-```
-
-**返回值**
-
-*   `string` - 文档的dentryUuid
-    
-
-**示例**
-
-```typescript
-const uuid = base.getDentryUuid();
-console.log(`当前文档UUID: ${uuid}`);
-
-```
-```typescript
-const uuid = Base.getDentryUuid();
-Output.log(`当前文档UUID: ${uuid}`);
-
-```
-
-### getCorpId
-
-获取文档所属企业的 CorpId。
-
-> ⚠️ **仅脚本插件可用**：此 API 仅支持在脚本插件中使用，不支持在边栏插件中调用。如需在边栏插件中调用，请查看getAuthCode API实现[《其他接口》](https://alidocs.dingtalk.com/i/nodes/1zknDm0WRz0NZeXQugKKDANoWBQEx5rG?utm_scene=team_space&iframeQuery=anchorId%3Duu_metpevjdhlx2zj3ysyw)。
-
-```plaintext
-getCorpId(): string
-```
-
-**返回值**
-
-*   `string` - 文档所属企业的 CorpId
-    
-
-**示例**
-
-```typescript
-const corpId = Base.getCorpId();
-Output.log(`当前企业ID: ${corpId}`);
-```
-
-### getCurrentUser
-
-获取当前用户信息。
-
-> ⚠️ **仅脚本插件可用**：此 API 仅支持在脚本插件中使用，不支持在边栏插件中调用。如需在边栏插件中调用，请查看getAuthCode API实现[《其他接口》](https://alidocs.dingtalk.com/i/nodes/1zknDm0WRz0NZeXQugKKDANoWBQEx5rG?utm_scene=team_space&iframeQuery=anchorId%3Duu_metpevjdhlx2zj3ysyw)。
-
-```typescript
-getCurrentUser(): Promise<UserCellValue | null>
-```
-
-**返回值**
-
-*   [`Promise<UserCellValue | null>`](https://alidocs.dingtalk.com/notable/record?dentryUuid=GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno&rowId=udEx7tlPxG&sheetId=hERWDMS&viewId=qvGDAH2) - 当前用户信息，如果用户不存在则返回 null。[`UserCellValue`](https://alidocs.dingtalk.com/notable/record?dentryUuid=GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno&rowId=udEx7tlPxG&sheetId=hERWDMS&viewId=qvGDAH2) 包含当前用户的基本信息用户ID。
-    
-
-**示例**
-
-```typescript
-const currentUser = await Base.getCurrentUser();
-if (currentUser) {
-  Output.log(`当前用户: ${currentUser.name}`);
-  Output.log(`用户ID: ${currentUser.unionId}`);
-} else {
-  Output.log('无法获取当前用户信息');
-}
-```
-
-### getPermissionAsync
-
-获取文档权限。
-
-```javascript
-getPermissionAsync: (params: IGetPermission) => Promise<boolean>;
-```
-
-**参数**
-
-*    [`IGetPermission`](https://alidocs.dingtalk.com/i/nodes/GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno?iframeQuery=record%3DhERWDMS_qvGDAH2_o9sPfOWcwA) **-** 权限范围
-    
-
-**返回值**
-
-*   `Promise<boolean>` - 是否拥有权限
-    
-
-示例
-
-```typescript
-const hasPermission = await base.getPermissionAsync({
-    scope: PermissionScope.BASE,
-    permissionType: PermissionType.MANAGE,
-});
-console.log('当前', hasPermission ? '拥有' : '未拥有', 'AI 表格管理权限')
-```
-```typescript
-const hasPermission = await Base.getPermissionAsync({
-    scope: PermissionScope.BASE,
-    permissionType: PermissionType.MANAGE,
-});
-Output.log('当前', hasPermission ? '拥有' : '未拥有', 'AI 表格管理权限')
-```
-
-## 注意事项
-
-1.  在使用 `insertSheet` 方法时，确保提供的字段名称不重复，且第一个字段类型必须支持作为主字段
-    
-2.  不能删除最后一张数据表，调用 `deleteSheet` 时需注意
-    
-3.  部分操作受权限限制，在执行前可以通过 `getPermissionAsync` 检查权限