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/350/276/271/346/240/217/346/217/222/344/273/266 /345/274/200/345/217/221/346/214/207/345/215/227//345/205/266/344/273/226/346/216/245/345/217/243.md"

@@ -0,0 +1,146 @@
+# 其他接口
+
+## getLocale
+
+获取地区设置。
+
+```typescript
+getLocale(): Promise<Locale>;
+```
+
+其中 `Local` 的类型定义如下
+
+```typescript
+type Locale = "zh-CN" | "zh-HK" | "zh-TW" | "ja-JP" | "en-US" | "ko-KR" | "pt-BR" | "tr-TR" | "th-TH" | "id-ID" | "ms-MY"
+```
+
+#### 示例
+
+```typescript
+// 注意：⚠️在ui侧调用
+const locale = await Dingdocs.base.host.getLocale();
+// 'zh-CN'
+```
+
+## getTheme
+
+获取当前主题。
+
+```typescript
+getTheme(): Promise<Theme>;
+```
+
+其中 `Theme` 类型定义如下：
+
+```typescript
+type Theme = 'light' | 'dark';
+```
+
+#### 示例
+
+```typescript
+const theme = await Dingdocs.base.host.getTheme();
+// 'light'
+```
+
+## batchUploadFiles
+
+批量上传附件
+
+```typescript
+batchUploadFiles(files: File[]): Promise<AttachmentValue[]>;
+```
+
+**返回值**
+
+[`AttachmentValue`](https://alidocs.dingtalk.com/i/nodes/GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno?iframeQuery=record%3DhERWDMS_qvGDAH2_mgIYIgGieW) - 附件对象数组，每个附件包含url、filename、type、size等属性，如果记录不存在或无附件则返回null
+
+#### 示例
+
+```typescript
+const files = await Dingdocs.base.batchUploadFiles([file]);
+```
+
+## configPermission
+
+**企业内发布插件/ISV 三方插件**，需要调用此方法进行前端jsapi鉴权，才允许使用 script api 读写 AI 表格数据
+
+```typescript
+configPermission: (
+  agentId: string,
+  corpId: string,
+  timeStamp: number,
+  nonceStr: string,
+  signature: string,
+  jsApiList: string[],
+) => Promise<void>;
+
+const JSAPI_LIST = ["DingdocsScript.base.readWriteAll"];
+```
+
+#### 示例
+
+```javascript
+initView({
+  onReady: async () => {
+    // 初始化插件鉴权
+    await Dingdocs.base.host.configPermission(
+      'your_agent_id',
+      'ai_table_corp_id',
+      'timestamp(Number)',
+      'your_nonceStr',
+      'signature',
+      ["DingdocsScript.base.readWriteAll"], // AI 表格JSAPI权限点
+    );
+  },
+});
+```
+
+鉴权参数的获取可参考文档：
+
+[如何获取configPermission的各项参数](https://open.dingtalk.com/document/dingstart/develop-webapp-frontend)
+
+发布企业内部插件的流程可参考文档：
+
+[《AI 表格插件 - 企业内插件发布指南》](https://alidocs.dingtalk.com/i/nodes/vNG4YZ7JnpyN1Mo0uEKQXpb2W2LD0oRE?utm_scene=team_space)
+
+ISV发布三方插件的流程可参考文档：
+
+[《ISV接入AI表格开放API》](https://alidocs.dingtalk.com/i/nodes/GZLxjv9VGGDA9Ro2u0eQk13vV6EDybno)
+
+## getAuthCode
+
+**企业内发布插件/ISV 三方插件**，支持通过当前API获取应用免登码。根据免登授权码 和 应用 AccessToken，调用[通过免登码获取用户信息](https://open.dingtalk.com/document/development/obtain-the-userid-of-a-user-by-using-the-log-free#)接口，获取免登用户信息，包括用户userId、用户unionId等信息。
+
+```typescript
+getAuthCode: (corpId: string) => Promise<string>;
+```
+
+#### 示例
+
+```typescript
+const getAuthCode = async () => {
+  const corpId = getCorpId();
+  const authCode = await Dingdocs.base.host.getAuthCode(corpId);
+  return authCode;
+};
+```
+
+#### 如何获取当前企业corpId
+
+用户界面地址配置：`https://example.com/ui.html?corpId=$CORPID$`，边栏插件打开时，会在 url 末尾拼上当前的 corpId
+
+```typescript
+const getSearchParams = () => {
+  const search =
+    window.location.search || window.location.hash.split("?")[1] || "";
+  const params = new URLSearchParams(search);
+  return params;
+};
+
+const getCorpId = () => {
+  const params = getSearchParams();
+  const corpId = params.get("corpId") || "";
+  return corpId;
+};
+```

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/350/276/271/346/240/217/346/217/222/344/273/266 /345/274/200/345/217/221/346/214/207/345/215/227//345/255/227/346/256/265/346/225/260/346/215/256/347/273/223/346/236/204.md"

@@ -0,0 +1,65 @@
+# 字段数据结构
+
+## 字段配置类型定义
+
+| **字段类型** | **code** | **读取** | **写入** | **备注** |
+| --- | --- | --- | --- | --- |
+| 文本 | `text` | `undefined` | `undefined` |  |
+| 数字 | `number` | ```typescript<br>interface Property {<br>  /** 数字格式 */<br>  formatter: NumberFormatter;<br>}<br>``` | ```typescript<br>interface Property {<br>  /** 数字格式，默认为 INT */<br>  formatter?: NumberFormatter;<br>}<br>``` | [NumberFormatter](https://alidocs.dingtalk.com/notable/record?dentryUuid=GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno&rowId=bmhb9tm5gl&sheetId=hERWDMS&viewId=qvGDAH2) |
+| 日期 | `date` | ```typescript<br>interface Property {<br>  /** 日期格式 */<br>  formatter: DateFormatter;<br>}<br>``` | ```typescript<br>interface Property {<br>  /** 日期格式，默认为YYYY-MM-DD */<br>  formatter?: DateFormatter;<br>}<br>``` | [DateFormatter](https://alidocs.dingtalk.com/notable/record?dentryUuid=GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno&rowId=sgmPZ03ioN&sheetId=hERWDMS&viewId=qvGDAH2) |
+| 复选框 | `checkbox` | `undefined` | `undefined` |  |
+| 单选 | `singleSelect` | ```typescript<br>interface Property {<br>  /** 选项列表 */<br>  choices: Array<{<br>    /** 选项ID(由系统生成) */<br>    id: string;<br>    /** 选项名 */<br>    name: string;<br>  }>;<br>}<br>``` | ```typescript<br>interface Property {<br>  /** 选项列表，默认为空 */<br>  choices?: Array<{<br>    /** 更新已有选项需要传入选项ID */<br>    id?: string;<br>    /** 选项名 */<br>    name: string;<br>  }>;<br>}<br>``` |  |
+| 多选 | `multiSelect` | ```typescript<br>interface Property {<br>  /** 选项列表 */<br>  choices: Array<{<br>    /** 选项ID(由系统生成) */<br>    id: string;<br>    /** 选项名 */<br>    name: string;<br>  }>;<br>}<br>``` | ```typescript<br>interface Property {<br>  /** 选项列表，默认为空 */<br>  choices?: Array<{<br>    /** 选项ID(由系统生成) */<br>    id: string;<br>    /** 选项名 */<br>    name: string;<br>  }>;<br>}<br>``` |  |
+| 评分 | `rating` | ```typescript<br>interface Property {<br>  /** 最小值 */<br>  min: number;<br>  /** 最大值 */<br>  max: number;<br>  /** 图标类型 */<br>  icon: RatingIconType;<br>}<br>``` | ```typescript<br>interface Property {<br>  /** 最小值，默认为1，可传0/1 */<br>  min?: numb0er;<br>  /** 最大值，默认为5，可传2～10 */<br>  max?: number;<br>  /** 图标类型，默认为star */<br>  icon?: RatingIconType;<br>}<br>``` | [RatingIconType](https://alidocs.dingtalk.com/notable/record?dentryUuid=GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno&rowId=bTFrjASNmd&sheetId=hERWDMS&viewId=qvGDAH2) |
+| 货币 | `currency` | ```typescript<br>interface Property {<br>  /** 货币格式 */<br>  formatter: CurrencyFormatter;<br>}<br>``` | ```typescript<br>interface Property {<br>  /** 货币格式，默认为FLOAT_2 */<br>  formatter?: CurrencyFormatter;<br>}<br>``` | [CurrencyFormatter](https://alidocs.dingtalk.com/notable/record?dentryUuid=GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno&rowId=H14AhQltuW&sheetId=hERWDMS&viewId=qvGDAH2) |
+| 进度 | `progress` | ```typescript<br>interface Property {<br>  /** 进度格式 */<br>  formatter: ProgressFormatter;<br>  /** 是否开启自定义进度条值 */<br>  customizeRange: boolean;<br>  /** 起始值 */<br>  min: number;<br>  /** 目标值 */<br>  max: number;<br>}<br>``` | ```typescript<br>interface Property {<br>  /** 进度格式，默认为PERCENT */<br>  formatter?: ProgressFormatter;<br>  /** 是否自定义进度条值，默认false */<br>  customizeRange: boolean;<br>  /** 起始值，默认0 */<br>  min: number;<br>  /** 目标值，默认1 */<br>  max: number;<br>}<br>``` | [ProgressFormatter](https://alidocs.dingtalk.com/notable/record?dentryUuid=GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno&rowId=PJ9idnGXLB&sheetId=hERWDMS&viewId=qvGDAH2)<br>:::<br>当需要自定义起始值或目标值时。请置customizeRange为开启状态。<br>::: |
+| 邮箱 | `email` | `undefined` | `undefined` |  |
+| 电话 | `telephone` | `undefined` | `undefined` |  |
+| 条码 | `barcode` | `undefined` | `undefined` |  |
+| 创建时间 | `createdTime` | ```typescript<br>interface Property {<br>  /** 日期格式 */<br>  formatter: DateFormatter;<br>}<br>``` | ```typescript<br>interface Property {<br>  /** 日期格式 */<br>  formatter: DateFormatter;<br>}<br>``` | [DateFormatter](https://alidocs.dingtalk.com/notable/record?dentryUuid=GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno&rowId=sgmPZ03ioN&sheetId=hERWDMS&viewId=qvGDAH2) |
+| 更新时间 | `updatedTime` | ```typescript<br>interface Property {<br>  /** 日期格式 */<br>  formatter: DateFormatter;<br>}<br>``` | ```typescript<br>interface Property {<br>  /** 日期格式 */<br>  formatter: DateFormatter;<br>}<br>``` | [DateFormatter](https://alidocs.dingtalk.com/notable/record?dentryUuid=GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno&rowId=sgmPZ03ioN&sheetId=hERWDMS&viewId=qvGDAH2) |
+| 附件 | `attachment` | `undefined` | `undefined` |  |
+| 链接 | `url` | `undefined` | `undefined` |  |
+| 富文本 | `richText` | `undefined` | `undefined` |  |
+| 主键文档 | `primaryDoc` | `undefined` | `undefined` |  |
+| 单向关联 | `unidirectionalLink` | ```typescript<br>interface Propterty {<br>  /** 是否支持多选 */<br>  multiple: string;<br>  /** 关联的数据表 */<br>  linkedSheetId: string;<br>}<br>``` | ```typescript<br>interface Propterty {<br>  /** 是否支持多选，默认为true */<br>  multiple?: string;<br>  /** 关联的数据表，不支持更新配置 */<br>  linkedSheetId?: string;<br>}<br>``` |  |
+| 双向关联 | `bidirectionalLink` | ```typescript<br>interface Propterty {<br>  /** 是否支持多选 */<br>  multiple: string;<br>  /** 关联的数据表 */<br>  linkedSheetId: string;<br>  /** 双向关联的另一个字段ID */<br>  linkedFieldId: string;<br>}<br>``` | ```typescript<br>interface Propterty {<br>  /** 是否支持多选，默认为true */<br>  multiple?: string;<br>  /** 关联的数据表，不支持更新配置 */<br>  linkedSheetId?: string;<br>}<br>``` |  |
+| 公式 | `formula` | ```typescript<br>interface Propterty {<br>  /** 计算结果格式 */<br>  formatter: NumberFormatter;<br>  /** 表达式 */<br>  formula: string;<br>}<br>``` | ```typescript<br>interface Propterty {<br>  /** 计算结果格式，默认为INT */<br>  formatter: NumberFormatter;<br>  /** 表达式, 默认为空 */<br>  formula?: string;<br>}<br>``` | [NumberFormatter](https://alidocs.dingtalk.com/notable/record?dentryUuid=GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno&rowId=bmhb9tm5gl&sheetId=hERWDMS&viewId=qvGDAH2) |
+| 关联引用 | `lookup` | `undefined` | `undefined` |  |
+| 查找引用 | `filterUp` | `undefined` | `undefined` |  |
+| 地理位置 | `geolocation` | `undefined` | `undefined` |  |
+| 人员 | `user` | ```typescript<br>interface Propterty {<br>  /** 是否可多选 */<br>  multiple: boolean;<br>}<br>``` | ```typescript<br>interface Propterty {<br>  /** 是否可多选，默认为true */<br>  multiple: boolean;<br>}<br>``` |  |
+| 群组 | `group` | ```typescript<br>interface Propterty {<br>  /** 是否可多选 */<br>  multiple: boolean;<br>}<br>``` | ```typescript<br>interface Propterty {<br>  /** 是否可多选，默认为true */<br>  multiple: boolean;<br>}<br>``` |  |
+| 部门 | `department` | ```typescript<br>interface Propterty {<br>  /** 是否可多选 */<br>  multiple: boolean;<br>}<br>``` | ```typescript<br>interface Propterty {<br>  /** 是否可多选，默认为false */<br>  multiple?: boolean;<br>}<br>``` |  |
+
+## 字段值类型定义
+
+| **字段类型** | **code** | **读取** | **写入** |
+| --- | --- | --- | --- |
+| 文本 | `text` | `string` | `string` |
+| 数字 | `number` | `string` | `string \| number` |
+| 日期 | `date` | `number`<br>以毫秒为单位的 Unix 时间戳 | `string \| number`<br>dayjs可识别的时间文本结构或以毫秒为单位的 Unix 时间戳数值 |
+| 复选框 | `checkbox` | `boolean` | `boolean` |
+| 单选 | `singleSelect` | ```typescript<br>type Cell = {<br>  /** 选项ID */<br>  id: string;<br>  /** 选项名 */<br>  name: string<br>};<br>``` | ```typescript<br>type Cell = string \| {<br>  /** 选项ID */<br>  id?: string;<br>  /** 选项ID */<br>  name?: string;<br>};<br>```<br>直接传入选项名或选项ID或传入选项对象。 |
+| 多选 | `multiSelect` | ```typescript<br>type Cell = Array<{<br>  /** 选项ID */<br>  id: string;<br>  /** 选项名 */<br>  name: string<br>}>;<br>``` | ```typescript<br>type Cell = Array<string \| {<br>  /** 选项ID */<br>  id?: string;<br>  /** 选项名 */<br>  name?: string<br>}>;<br>```<br>直接传入选项名或选项ID或选项对象的数组。 |
+| 评分 | `rating` | `string` | `string \| number` |
+| 货币 | `currency` | `string` | `string \| number` |
+| 进度 | `progress` | `string` | `string \| number` |
+| 邮箱 | `email` | `string` | `string` |
+| 电话 | `telephone` | `string` | `string` |
+| 条码 | `barcode` | `string` | `string` |
+| 创建时间 | `createdTime` | `number`<br>以毫秒为单位的 Unix 时间戳 | 不支持更新系统字段 |
+| 更新时间 | `updatedTime` | `number`<br>以毫秒为单位的 Unix 时间戳 | 不支持更新系统字段 |
+| 附件 | `attachment` | `AttachmentValue[]`<br>[AttachmentValue](https://alidocs.dingtalk.com/notable/record?dentryUuid=GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno&rowId=mgIYIgGieW&sheetId=hERWDMS&viewId=qvGDAH2) | `IOpenFile \| IOpenFile[] \| AttachmentValue \| AttachmentValue[]`<br>[IOpenFile](https://alidocs.dingtalk.com/notable/record?dentryUuid=GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno&rowId=0VuOwCWaVq&sheetId=hERWDMS&viewId=qvGDAH2) \| [AttachmentValue](https://alidocs.dingtalk.com/notable/record?dentryUuid=GZLxjv9VGGDA9Ro2u05KgqMnV6EDybno&rowId=mgIYIgGieW&sheetId=hERWDMS&viewId=qvGDAH2) |
+| 链接 | `url` | ```typescript<br>type Cell = {<br>  /** 链接标题 */<br>  text?: string;<br>  /** 链接文本 */<br>  link: string;<br>};<br>``` | ```typescript<br>type Cell = {<br>  /** 链接标题 */<br>  text?: string;<br>  /** 链接文本 */<br>  link: string;<br>};<br>``` |
+| 富文本 | `richText` | ```typescript<br>type Cell = {<br>  /** markdown格式的富文本 */<br>  markdown: string;<br>};<br>``` | ```typescript<br>type Cell = {<br>  /** markdown格式的富文本 */<br>  markdown: string;<br>};<br>``` |
+| 主键文档 | `primaryDoc` | `string` | `string` |
+| 单向关联 | `unidirectionalLink` | ```typescript<br>type Cell = {<br>  /** 关联的记录ID列表 */<br>  linkedRecordIds: string[];<br>}<br>``` | ```typescript<br>type Cell = {<br>  /** 关联的记录ID列表 */<br>  linkedRecordIds: string[];<br>}<br>``` |
+| 双向关联 | `bidirectionalLink` | ```typescript<br>type Cell = {<br>  /** 关联的记录ID列表 */<br>  linkedRecordIds: string[];<br>}<br>``` | ```typescript<br>type Cell = {<br>  /** 关联的记录ID列表 */<br>  linkedRecordIds: string[];<br>}<br>``` |
+| 公式 | `formula` | `string` | 不支持更新计算字段 |
+| 关联引用 | `lookup` | `string` | 不支持更新计算字段 |
+| 查找引用 | `filterUp` | `string` | 不支持更新计算字段 |
+| 地理位置 | `geolocation` | ```typescript<br>type Cell = {<br>  /** address */<br>  address: string;<br>  /** 简短地址 */<br>  name: string;<br>  /** 完整地址 */<br>  fullAddress: string;<br>  /** 经纬度 */<br>  location: [number, number];<br>};<br>``` | 不支持更新此字段 |
+| 人员 | `user` | ```typescript<br>type Cell = Array<{<br>  /** 用户unionId */<br>  unionId: string;<br>  /** 用户名 */<br>  name?: string;<br>}><br>``` | ```typescript<br>type Cell = Array<{<br>  /** 用户unionId */<br>  unionId?: string;<br>  /** 用户在文档所属组织下的userId */<br>  userId?: string;<br>  /** 用户在文档所属组织下的员工工号 */<br>  jobNumber?: string;<br>  /** 用户在文档所属组织下的外部联系人ID */<br>  extContactUserId?: string;<br>}><br>``` |
+| 群组 | `group` | ```typescript<br>type Cell = Array<{<br>  /** 群会话ID */<br>  openConversationId: string;<br>  /** 群会话名称 */<br>  name?: string;<br>}><br>``` | ```typescript<br>type Cell = Array<{<br>  /** 群会话ID */<br>  openConversationId: string;<br>}><br>``` |
+| 部门 | `department` | ```typescript<br>type Cell = Array<{<br>  /** 部门ID */<br>  deptId: string;<br>  /** 部门名称 */<br>  name?: string;<br>}><br>``` | ```typescript<br>type Cell = Array<{<br>  /** 部门ID */<br>  deptId: string;<br>}><br>``` |

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/350/276/271/346/240/217/346/217/222/344/273/266 /345/274/200/345/217/221/346/214/207/345/215/227//346/240/270/345/277/203/347/237/245/350/257/206.md"

@@ -0,0 +1,54 @@
+# 核心知识
+
+## 了解 AI 表格文档对象模型
+
+当需要通过边栏插件执行AI表格的增删改查操作时，应当首先获取到AI表格的对象模型，并调用对象上的方法。
+
+### 常用对象
+
+AI表格的数据对象模型有以下几类：
+
+![image.png](https://alidocs.oss-cn-zhangjiakou.aliyuncs.com/res/vBPlN5m0zy8wkOdG/img/d16de762-8859-4314-9378-6ff83bafca59.png)
+
+*   **Base**：AI表格。可包含多个数据表，为整个AI表格的顶级对象。在边栏插件中，通过引用变量DingdocsScript.base获取。
+    
+*   **Sheet**: 数据表。包含多个视图、字段、记录。可通过Base API获取到具体某个Sheet对象。
+    
+*   **View**: 视图。可通过Sheet API 获取到某个数据表的具体某个View对象。
+    
+*   **Field**: 字段。可通过Sheet API 获取到某个数据表的具体某个Field对象。
+    
+*   **Record**: 记录。可通过Sheet API 获取到某个数据表的具体某个Record对象。
+    
+*   ~~**Cell**~~~~: 单元格。可通过Record API或Field API获取到某条记录下某个字段的具体Cell对象。（暂不支持）~~
+    
+
+### 快速开始
+
+首先确定要操作的对象，再调该对象上的API。
+
+例如，获取当前查看的数据表，并新增一条标题为“测试用例”的记录，需要先通过Base API获取到当前激活的Sheet对象，再调用Sheet对象的insertRecordAsync API插入行数据。
+
+```typescript
+// script.ts
+async function insertRecord() {
+  // 获取当前激活的数据表
+  const sheet = DingdocsScript.base.getActiveSheet();
+  // 向这个数据表中新增一条标题为“测试用例”的记录
+  await sheet.insertRecordAsync({
+    fields: {
+      "标题": "测试用例"，
+    },
+  });
+}
+DingdocsScript.registerScript('insertRecord', insertRecord);
+
+
+// ui.tsx
+await Dingdocs.script.run('insertRecord');
+
+```
+
+### 参考文档
+
+[请至钉钉文档查看附件《AI 表格对象模型API参考文档》。](https://alidocs.dingtalk.com/i/nodes/QBnd5ExVEaQd4meXt7KKeRrpVyeZqMmz?iframeQuery=anchorId%3DX02mkgiybmrkhh3zori0um)

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/350/276/271/346/240/217/346/217/222/344/273/266 /345/274/200/345/217/221/346/214/207/345/215/227.md"

@@ -0,0 +1,192 @@
+# AI表格边栏插件 开发指南
+
+# 简介
+
+边栏插件是AI表格提供的一种开放能力，开发者可以通过构建自定义插件来扩展AI表格的功能。
+
+插件运行在AI表格的右侧边栏中，可以与表格数据进行交互，实现复杂的业务逻辑。
+
+# 架构概述
+
+边栏插件采用双页面架构：
+
+*   **脚本服务页面（Script Service）**：运行在 Web Worker 中，负责与AI表格数据模型交互
+    
+*   **UI交互页面（Sidebar UI）**：运行在边栏 iframe 中，负责用户界面展示和交互
+    
+
+# AI表格数据模型
+
+### 核心对象层次结构
+
+```plaintext
+Base (AI表格)
+├── Sheet (数据表)
+│   ├── View (视图)
+│   ├── Field (字段)
+│   └── Record (记录)
+
+```
+
+### 对象说明
+
+| 对象 | 描述 | 获取方式 |
+| --- | --- | --- |
+| **Base** | AI表格顶级对象，包含多个数据表 | `DingdocsScript.base` |
+| **Sheet** | 数据表对象，包含字段、记录、视图 | `base.getActiveSheet()` / `base.getSheet(id)` |
+| **View** | 视图对象，表示数据表的不同展示方式 | `sheet.getViews()` |
+| **Field** | 字段对象，定义数据表的列结构 | `sheet.getFields()` |
+| **Record** | 记录对象，表示数据表中的一行数据 | `sheet.getRecords()` |
+
+![image.png](https://alidocs.oss-cn-zhangjiakou.aliyuncs.com/res/vBPlN5m0zy8wkOdG/img/d16de762-8859-4314-9378-6ff83bafca59.png)
+
+# 快速开始
+
+### 环境准备
+
+#### 1. 安装依赖
+
+```bash
+# 使用npm
+npm install dingtalk-docs-cool-app@latest
+
+# 使用yarn
+yarn add dingtalk-docs-cool-app@latest
+
+# 使用pnpm
+pnpm install dingtalk-docs-cool-app@latest
+```
+
+#### 2. 项目模板
+
+推荐使用官方模板快速开始：
+
+[https://github.com/dingdocs-notable/addon-demo: https://github.com/dingdocs-notable/addon-demo](https://github.com/dingdocs-notable/addon-demo)
+
+```bash
+git clone https://github.com/dingdocs-notable/addon-demo.git
+cd addon-demo
+npm install
+npm start
+```
+
+### 开发服务页面
+
+1.  在src/scripts下新建`service.ts`，并配置以下内容
+    
+    ```typescript
+    
+    // 1.定义如何读写文档对象模型
+    function getActiveSheetName() {
+      const sheet = DingdocsScript.base.getActiveSheet();
+      return sheet?.getName();
+    }
+    
+    // 2.注册指令「getActiveSheetName」
+    DingdocsScript.registerScript('getActiveSheetName', getActiveSheetName);
+    ```
+    
+    此部分代码注册了一个文档脚本服务指令getActiveSheetName，通过这个指令可以获取到当前打开的数据表表名。
+    
+    将此文件单独打包到路径`{PUBLIC_URL}/static/js/script.code.js`。
+    
+2.  在src/entries下新建`script.tsx`，并配置以下内容
+    
+    ```typescript
+    import React, { useEffect } from 'react';
+    import ReactDOM from 'react-dom/client';
+    
+    import { initScript } from 'dingtalk-docs-cool-app';
+    
+    function App() {
+      useEffect(() => {
+        // 初始化文档模型服务
+        initScript({
+          scriptUrl: new URL(`${process.env.PUBLIC_URL}/static/js/script.code.js`, window.location.href),
+          onError: (e) => {
+            console.log(e);
+          }
+        });
+      }, []);
+      return null;
+    }
+    
+    const root = ReactDOM.createRoot(document.getElementById('script')!);
+    root.render(
+      <React.StrictMode>
+        <App/>
+      </React.StrictMode>
+    );
+    ```
+    
+    此部分代码用于初始化文档脚本服务，获取开发者定义的所有脚本服务指令。
+    
+3.  在src/entries下新建`ui.tsx`，并配置以下内容
+    
+    ```typescript
+    import React, { useEffect, useState } from 'react';
+    import ReactDOM from 'react-dom/client';
+    import { initView } from 'dingtalk-docs-cool-app';
+    
+    function App() {
+      const [currentSheetName, setCurrentSheetName] = useState<string>('');
+      useEffect(() => {
+        initView({
+          onReady: () => {
+            console.log('init ui completed!');
+          },
+          onError: (e) => {
+            console.log(e);
+          },
+        });
+      }, []);
+    
+      const getCurrentSheetName = async () => {
+        const name = await Dingdocs.script.run('getActiveSheetName');
+        setCurrentSheetName(name);
+      };
+    
+      return (
+        <div>
+          <h1>调试边栏插件</h1>
+          <p>当前打开的数据表名称为{currentSheetName}</p>
+          <button onClick={getCurrentSheetName}>点击刷新</button>
+        </div>
+      )
+    }
+    
+    const root = ReactDOM.createRoot(document.getElementById('ui')!);
+    root.render(
+      <React.StrictMode>
+        <App/>
+      </React.StrictMode>
+    );
+    ```
+    
+    此部分代码用于初始化边栏交互页面，页面中包含一个按钮，点击按钮时，会向文档模型服务发送指令getActiveSheetName，获取当前打开的数据表表名。
+    
+4.  将script.tsx和ui.tsx分别打包为两个静态页面，分别作为插件的脚本服务地址和交互页面地址。
+    
+
+## 插件调试
+
+跟随上方的示例，搭建一个边栏插件后
+
+*   新建或打开任意AI表格，点击 `插件` 展开插件面板
+    
+*   打开`插件市场` 点击 `自定义插件`，点击 `+新增插件`，在输入框内填入两个 html 的运行地址（一般情况下，服务地址是`http://localhost:3000/sidebar.html`，scriptServiceUrl 的地址是`http://localhost:3000/script.html`，具体以插件根目录的 README.md 为准）后点击 `确定` 添加并运行插件
+    
+
+![image.png](https://alidocs.oss-cn-zhangjiakou.aliyuncs.com/res/oJGq75kv4DDQ2lAK/img/d08495f1-85f7-4fdd-b861-402ec6fd11dd.png)
+
+![image.png](https://alidocs.oss-cn-zhangjiakou.aliyuncs.com/res/oJGq75kv4DDQ2lAK/img/f64a6846-f346-49e7-8b1a-ede5e6c4bf9c.png)
+
+![image.png](https://alidocs.oss-cn-zhangjiakou.aliyuncs.com/res/vBPlN5m0zy8wkOdG/img/ec8ef01a-f1c7-435f-93d3-3f25f2d20a2f.png)
+
+## 插件上架
+
+请联系 $\color{#0089FF}{@huanan(桦楠)}$  $\color{#0089FF}{@欧阳莫微(弗隐)}$ 
+
+## 附录（JSAPI 开放文档）
+
+[《读写AI 表格模型》](https://alidocs.dingtalk.com/i/nodes/7QG4Yx2JpOzXoN4PseoDkxxgV9dEq3XD?utm_scene=team_space)