aitable-workflow-cli 0.1.13-beta.1

package/templates/support-qa/profiles/aitable/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/345/255/227/346/256/265/346/250/241/347/211/210 /344/275/277/347/224/250/346/214/207/345/215/227//345/277/253/351/200/222/347/211/251/346/265/201/346/237/245/350/257/242/345/212/251/346/211/213/344/275/277/347/224/250/346/214/207/345/215/227.md"

@@ -0,0 +1 @@
+# 快递物流查询助手使用指南

package/templates/support-qa/profiles/aitable/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/345/257/271/350/261/241/346/250/241/345/236/213API/345/217/202/350/200/203/346/226/207/346/241/243/Base /346/250/241/345/235/227.md"

@@ -0,0 +1,391 @@
+# Base 模块
+
+当前AI表格格实例，AI表格格相关 API 的主入口，提供了操作AI表格基础对象的方法，支持查询权限、管理数据表以及获取选择区域等信息。
+
+```typescript
+const base = DingdocsScript.base;
+```
+```typescript
+const base = Base; // 提供了全局变量Base
+```
+> 文中未声明的类型定义，请至[请至钉钉文档查看附件《AI表格JSAPI 类型描述》。](https://alidocs.dingtalk.com/i/nodes/1OQX0akWmBejogd0TOoDmK42VGlDd3mE?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` 检查权限

package/templates/support-qa/profiles/aitable/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/345/257/271/350/261/241/346/250/241/345/236/213API/345/217/202/350/200/203/346/226/207/346/241/243/Field /346/250/241/345/235/227/AttachmentField /351/231/204/344/273/266/345/255/227/346/256/265.md"

@@ -0,0 +1,200 @@
+# AttachmentField 附件字段
+
+## 基本信息
+
+AttachmentField 类型用于存储和管理各种文件附件，如图片、文档、音频、视频等。它提供了上传、获取和管理附件的功能，支持多种文件格式。
+
+## 数据类型
+
+### [IOpenFile](https://alidocs.dingtalk.com/notable/record?dentryUuid=GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno&rowId=0VuOwCWaVq&sheetId=hERWDMS&viewId=qvGDAH2)
+
+表示要上传的文件（如果传入 base64，建议文件大小在 10MB 以下）。
+
+### [AttachmentValue](https://alidocs.dingtalk.com/notable/record?dentryUuid=GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno&rowId=mgIYIgGieW&sheetId=hERWDMS&viewId=qvGDAH2)
+
+表示已上传的附件。
+
+## 字段特有方法
+
+### getValueAsync
+
+获取指定记录在该附件字段中的所有附件。
+
+```typescript
+getValueAsync: (recordId: string) => Promise<AttachmentValue[] | null>
+
+```
+
+**参数**
+
+*   `recordId`: `string` - 记录ID
+    
+
+**返回值**
+
+*   [`AttachmentValue`](https://alidocs.dingtalk.com/i/nodes/GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno?iframeQuery=record%3DhERWDMS_qvGDAH2_mgIYIgGieW) - 附件对象数组，每个附件包含url、filename、type、size等属性，如果记录不存在或无附件则返回null
+    
+
+**示例**
+
+```typescript
+// 获取附件字段值
+const filesField = sheet.getField<AttachmentField>('附件');
+if (filesField) {
+  const attachments = await filesField.getValueAsync('rec123456');
+  if (attachments && attachments.length > 0) {
+    console.log(`共有 ${attachments.length} 个附件`);
+    attachments.forEach(file => {
+      console.log(`- ${file.filename} (${file.size} 字节, 类型: ${file.type})`);
+    });
+  } else {
+    console.log('没有附件');
+  }
+}
+
+```
+```typescript
+// 获取附件字段值
+const filesField = sheet.getField('附件');
+if (Base.isFieldOfType(filesField, 'attachment')) {
+  const attachments = await filesField.getValueAsync('rec123456');
+  if (attachments && attachments.length > 0) {
+    Output.log(`共有 ${attachments.length} 个附件`);
+    attachments.forEach(file => {
+      Output.log(`- ${file.filename} (${file.size} 字节, 类型: ${file.type})`);
+    });
+  } else {
+    Output.log('没有附件');
+  }
+}
+
+```
+
+### setValueAsync
+
+上传并设置指定记录在该附件字段的值。
+
+```typescript
+setValueAsync: (
+  recordId: string,
+  attachment: IOpenFile | IOpenFile[] | AttachmentValue | AttachmentValue[]
+) => Promise<boolean>
+
+```
+
+**参数**
+
+*   `recordId`: `string` - 记录ID
+    
+*   `attachment`: [`IOpenFile | IOpenFile[]`](https://alidocs.dingtalk.com/notable/record?dentryUuid=GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno&rowId=0VuOwCWaVq&sheetId=hERWDMS&viewId=qvGDAH2) | [`AttachmentValue | AttachmentValue[]`](https://alidocs.dingtalk.com/i/nodes/GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno?iframeQuery=record%3DhERWDMS_qvGDAH2_mgIYIgGieW)\- 单个文件对象或文件对象数组
+    
+
+**返回值**
+
+*   `Promise<boolean>`\- 操作是否成功
+    
+
+**注意**
+
+在边栏插件中，当需要在一个单元格内追加附件时，可以参考如下代码，上传附件的接口可以参考[《其他接口》](https://alidocs.dingtalk.com/i/nodes/1zknDm0WRz0NZeXQugKKDANoWBQEx5rG?utm_scene=team_space&iframeQuery=anchorId%3Duu_mdd3b880n5e7dhcb2yl)
+
+```typescript
+// service.tsx
+// 在service层实现附件追加
+function appendAttachments(sheetId: string, fieldId: string, recordId: string, appendFiles: AttachmentValue) {
+  const sheet = DingdocsScript.base.getSheet(sheetId);
+  const attachmentField = sheet.getField<AttachmentField>(fieldId);
+  const files = await attachmentField.getValueAsync(recordId);
+
+  // 调用 setValueAsync 时，要求数组中的所有文件变量的类型保持一致
+  // 由于 getValueAsync 的返回结果是 AttachmentValue，所以此处appendFiles类型要需要是AttachmentValue类型
+  await attachmentField.setValueAsync(recordId, [
+    ...files,
+    ...appendFiles,
+  ])
+}
+DingdocsScript.registerScript('appendAttachments', appendAttachments);
+
+
+// ui.tsx
+// 在ui层调用host方法，Dingdocs.base.uploadFiles([File]);
+const files: AttachmentValue[] = await Dingdocs.base.uploadFiles([File]);
+await Dingdocs.script.run('appendAttachments', files);
+```
+
+### getAttachmentUrls
+
+获取指定记录在该附件字段中所有附件的URL列表。
+
+```typescript
+getAttachmentUrls: (recordId: string) => Promise<string[]>
+```
+
+**参数**
+
+*   `recordId`: `string` - 记录ID
+    
+
+**返回值**
+
+*   `Promise<string[]>`\- 附件URL数组
+    
+
+**示例**
+
+```typescript
+// 获取附件的URL列表
+const filesField = sheet.getField<AttachmentField>('附件');
+if (filesField) {
+  const urls = await filesField.getAttachmentUrls('rec123456');
+  console.log('附件URL列表:');
+  urls.forEach((url, index) => {
+    console.log(`${index + 1}. ${url}`);
+  });
+  
+  // 在网页中显示图片附件
+  if (urls.length > 0) {
+    const imgContainer = document.getElementById('imageContainer');
+    if (imgContainer) {
+      urls.forEach(url => {
+        const img = document.createElement('img');
+        img.src = url;
+        img.style.maxWidth = '200px';
+        img.style.margin = '5px';
+        imgContainer.appendChild(img);
+      });
+    }
+  }
+}
+
+```
+```typescript
+// 获取附件的URL列表
+const filesField = sheet.getField('附件');
+if (Base.isFieldOfType(filesField, 'attachment')) {
+  const urls = await filesField.getAttachmentUrls('rec123456');
+  Output.log('附件URL列表:');
+  urls.forEach((url, index) => {
+    Output.log(`${index + 1}. ${url}`);
+  });
+}
+
+```
+
+### getAttachmentDetails
+
+获取指定记录在该附件字段中所有附件的详细信息（下载 URL、类型、文件名）。
+
+```typescript
+getAttachmentDetails: (recordId: string) => Promise<Array<{ filename: string; type: string; url: string }>>
+
+```
+
+**参数**
+
+*   `recordId`: `string` - 记录ID
+    
+
+**返回值**
+
+*   `Promise<Array<{ filename: string; type: string; url: string }>>`\- 附件详细信息列表

package/templates/support-qa/profiles/aitable/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/345/257/271/350/261/241/346/250/241/345/236/213API/345/217/202/350/200/203/346/226/207/346/241/243/Field /346/250/241/345/235/227/AutoNumberField /350/207/252/345/212/250/347/274/226/345/217/267/345/255/227/346/256/265.md"

@@ -0,0 +1,75 @@
+# AutoNumberField 自动编号字段
+
+`AutoNumberField`，继承自基础 [`Field`](https://alidocs.dingtalk.com/i/nodes/np9zOoBVBy2AdzEju0z93rx2W1DK0g6l?utm_scene=person_space) 类，专门用于处理自动编号字段数据。系统自动为每条记录生成唯一的编号，编号值以字符串形式存储。
+
+:::
+自动编号字段是系统自动生成的唯一标识，是一个只读字段，不能手动设置值。每新增一条记录，系统会自动分配一个递增的编号。
+:::
+
+## 字段特有方法
+
+### getValueAsync
+
+获取指定行记录该自动编号字段的值。
+
+```typescript
+getValueAsync: (recordId: string) => Promise<string | null>
+```
+
+**参数**
+
+*   `recordId` : `string` - 记录ID
+    
+
+**返回值**
+
+*   `Promise<string | null>` - 自动编号值，当字段值为空时返回null
+    
+
+**示例**
+
+```typescript
+// 获取自动编号字段值
+const autoNumberField = sheet.getField<AutoNumberField>('编号');
+if (autoNumberField) {
+  const autoNumber = await autoNumberField.getValueAsync('rec123456');
+  if (autoNumber !== null) {
+    console.log(`自动编号: ${autoNumber}`);
+  } else {
+    console.log('未设置自动编号');
+  }
+}
+```
+```typescript
+// 获取自动编号字段值
+const autoNumberField = sheet.getField('编号');
+if (Base.isFieldOfType(autoNumberField, 'autoNumber')) {
+  const autoNumber = await autoNumberField.getValueAsync('rec123456');
+  if (autoNumber !== null) {
+    Output.log(`自动编号: ${autoNumber}`);
+  } else {
+    Output.log('未设置自动编号');
+  }
+}
+```
+
+## 使用场景
+
+自动编号字段适用于以下场景：
+
+*   **订单编号**：为每个订单自动生成唯一编号
+    
+*   **工单编号**：为每个工单分配递增的编号
+    
+*   **客户编号**：为每个客户记录生成唯一标识
+    
+*   **任务编号**：为项目中的任务自动编号
+    
+
+## 注意事项
+
+1.  自动编号字段是只读的，无法通过 API 手动设置值
+    
+2.  删除记录后，该记录的编号不会被重新分配给新记录
+    
+3.  自动编号的格式由字段配置决定，可能包含前缀、日期等信息