@nocobase/plugin-ai 2.1.0-alpha.10 → 2.1.0-alpha.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/{server/ai-employees/built-in/data-modeling/prompt.d.ts → ai/ai-employees/cole.d.ts} +1 -3
- package/dist/{server/ai-employees/built-in/nocobase-assistant/prompt.js → ai/ai-employees/cole.js} +15 -7
- package/dist/{server/ai-employees/built-in/data-organizer/prompt.d.ts → ai/ai-employees/dara.d.ts} +1 -3
- package/dist/{server/ai-employees/built-in/data-visualization/prompt.js → ai/ai-employees/dara.js} +21 -13
- package/dist/{server/ai-employees/built-in/data-visualization/prompt.d.ts → ai/ai-employees/dex.d.ts} +1 -3
- package/dist/{server/ai-employees/built-in/data-organizer/prompt.js → ai/ai-employees/dex.js} +15 -7
- package/dist/ai/ai-employees/ellis.d.ts +10 -0
- package/dist/{server/ai-employees/built-in/email-assistant/prompt.js → ai/ai-employees/ellis.js} +19 -11
- package/dist/ai/ai-employees/lexi.d.ts +10 -0
- package/dist/{server/ai-employees/built-in/translator/prompt.js → ai/ai-employees/lexi.js} +15 -7
- package/dist/ai/ai-employees/vera.d.ts +10 -0
- package/dist/{server/ai-employees/built-in/research-analyst/prompt.js → ai/ai-employees/vera.js} +15 -7
- package/dist/ai/ai-employees/viz.d.ts +10 -0
- package/dist/{server/ai-employees/built-in/insights-analyst/prompt.js → ai/ai-employees/viz.js} +15 -7
- package/dist/ai/skills/document-search/SKILLS.md +69 -0
- package/dist/ai/tools/chartGenerator.js +14 -3
- package/dist/ai/tools/formFiller.js +13 -2
- package/dist/{server/ai-employees/built-in/ai-coding/prompt.d.ts → ai/tools/getSkill.d.ts} +1 -3
- package/dist/{server/ai-employees/built-in/data-modeling/index.js → ai/tools/getSkill.js} +39 -32
- package/dist/ai/tools/suggestions.js +13 -2
- package/dist/client/{a06081a2b06f1c14.js → 200ac94fc7f6e97b.js} +1 -1
- package/dist/client/27539a4356faebb1.js +10 -0
- package/dist/client/2db4faf814179140.js +10 -0
- package/dist/client/{521c94db45b1e031.js → 4f9117811ffc7ab3.js} +1 -1
- package/dist/client/{c49557cc10afc6b2.js → 5af11e24bcb39ac4.js} +1 -1
- package/dist/client/62bf6ed27c8de0df.js +10 -0
- package/dist/client/6dc8c9b641452067.js +10 -0
- package/dist/client/8169eb2b48edf6c7.js +10 -0
- package/dist/client/81f6436fd9322dc1.js +10 -0
- package/dist/client/{33811690df6f43ba.js → 85af3d6d85eb5b2b.js} +1 -1
- package/dist/client/87bc4d3cb55e4006.js +10 -0
- package/dist/client/9ac11803370a9625.js +10 -0
- package/dist/client/9c00efb8eb0b4d69.js +10 -0
- package/dist/client/{f74949b95f9bbb91.js → a4948d5b70172a69.js} +1 -1
- package/dist/client/ai-employees/admin/SkillSettings.d.ts +7 -5
- package/dist/{server/ai-employees/built-in/ai-coding/document/example/js-column/js_columns_for_accounts_en.d.ts → client/ai-employees/admin/ToolsSettings.d.ts} +8 -4
- package/dist/client/ai-employees/admin/mcp/MCPSettings.d.ts +10 -0
- package/dist/client/ai-employees/admin/mcp/MCPToolsList.d.ts +19 -0
- package/dist/client/ai-employees/admin/mcp/context.d.ts +15 -0
- package/dist/client/ai-employees/admin/mcp/schemas.d.ts +1286 -0
- package/dist/client/ai-employees/chatbox/utils.d.ts +3 -7
- package/dist/client/ai-employees/types.d.ts +5 -4
- package/dist/client/c83c2cae956ba914.js +10 -0
- package/dist/client/{6fcc98eb80deed47.js → d4e2ed9fa44a82b2.js} +1 -1
- package/dist/client/{5be6710cc905ec12.js → f944d487b7ff1f00.js} +1 -1
- package/dist/client/index.js +2 -2
- package/dist/client/repositories/AIConfigRepository.d.ts +8 -1
- package/dist/collections/ai-employees.js +2 -1
- package/dist/collections/ai-mcp-clients.d.ts +51 -0
- package/dist/collections/ai-mcp-clients.js +111 -0
- package/dist/externalVersion.js +14 -14
- package/dist/locale/en-US.json +65 -8
- package/dist/locale/zh-CN.json +66 -9
- package/dist/node_modules/fast-glob/package.json +1 -1
- package/dist/node_modules/flexsearch/package.json +1 -1
- package/dist/node_modules/fs-extra/package.json +1 -1
- package/dist/node_modules/nodejs-snowflake/package.json +1 -1
- package/dist/node_modules/openai/package.json +1 -1
- package/dist/node_modules/zod/package.json +1 -1
- package/dist/server/ai-employees/ai-employee.d.ts +5 -1
- package/dist/server/ai-employees/ai-employee.js +90 -13
- package/dist/server/ai-employees/middleware/index.d.ts +1 -0
- package/dist/server/ai-employees/middleware/index.js +2 -0
- package/dist/server/ai-employees/middleware/skill-tools.d.ts +12 -0
- package/dist/server/ai-employees/middleware/skill-tools.js +74 -0
- package/dist/server/ai-employees/prompts.d.ts +6 -1
- package/dist/server/ai-employees/prompts.js +9 -1
- package/dist/server/ai-employees/templates/form-assistant.d.ts +2 -2
- package/dist/server/ai-employees/templates/form-assistant.js +2 -2
- package/dist/server/ai-employees/utils.js +2 -2
- package/dist/server/{ai-employees/built-in/ai-coding/document/basic/flow-resource.d.ts → collections/ai-mcp-clients.d.ts} +1 -4
- package/dist/server/{ai-employees/built-in/ai-coding/prompt.js → collections/ai-mcp-clients.js} +12 -10
- package/dist/server/{ai-employees/built-in/ai-coding/document/example/js-column/js_columns_for_opportunities_en.d.ts → collections/ai-skills.d.ts} +1 -4
- package/dist/server/{migrations/20250923221107-setup-build-in.js → collections/ai-skills.js} +46 -13
- package/dist/server/manager/ai-coding-manager.d.ts +1 -2
- package/dist/server/manager/ai-coding-manager.js +0 -41
- package/dist/server/manager/built-in-manager.d.ts +2 -4
- package/dist/server/manager/built-in-manager.js +7 -118
- package/dist/server/migrations/20260306000001-migrate-skill-settings-tools.js +68 -0
- package/dist/server/plugin.d.ts +0 -1
- package/dist/server/plugin.js +17 -8
- package/dist/server/resource/aiEmployees.js +5 -7
- package/dist/server/{ai-employees/built-in/ai-coding/document/example/js-column/js_columns_for_contacts_en.d.ts → resource/aiMcpClients.d.ts} +3 -5
- package/dist/server/resource/aiMcpClients.js +78 -0
- package/dist/server/{ai-employees/built-in/ai-coding/document/example/js-column/index.d.ts → resource/aiSkills.d.ts} +3 -7
- package/dist/server/resource/aiSkills.js +71 -0
- package/dist/server/resource/aiTools.js +4 -6
- package/dist/server/tools/docs.js +2 -2
- package/dist/server/tools/workflow-caller.js +1 -0
- package/package.json +2 -2
- package/dist/client/16dbe01d9077bb74.js +0 -10
- package/dist/client/180c8b1051a4f36e.js +0 -10
- package/dist/client/41229e007006e7f6.js +0 -10
- package/dist/client/41950da4c64caf73.js +0 -10
- package/dist/client/585ba360c7c57caf.js +0 -10
- package/dist/client/9f62a4c5136dfe8b.js +0 -10
- package/dist/client/b7f721f8dabb54e5.js +0 -10
- package/dist/client/bc471dd60174458c.js +0 -10
- package/dist/client/c40ed1a900aefb67.js +0 -10
- package/dist/server/ai-employees/built-in/ai-coding/document/basic/flow-resource.js +0 -256
- package/dist/server/ai-employees/built-in/ai-coding/document/example/js-column/index.js +0 -48
- package/dist/server/ai-employees/built-in/ai-coding/document/example/js-column/js_columns_for_accounts_en.js +0 -452
- package/dist/server/ai-employees/built-in/ai-coding/document/example/js-column/js_columns_for_contacts_en.js +0 -363
- package/dist/server/ai-employees/built-in/ai-coding/document/example/js-column/js_columns_for_opportunities_en.js +0 -270
- package/dist/server/ai-employees/built-in/ai-coding/document/example/js-column/js_columns_for_quotations_en.d.ts +0 -13
- package/dist/server/ai-employees/built-in/ai-coding/document/example/js-column/js_columns_for_quotations_en.js +0 -219
- package/dist/server/ai-employees/built-in/ai-coding/document/example/js-column/js_columns_for_tickets_en.d.ts +0 -13
- package/dist/server/ai-employees/built-in/ai-coding/document/example/js-column/js_columns_for_tickets_en.js +0 -409
- package/dist/server/ai-employees/built-in/ai-coding/document/example/js-filter/accounts_filter_ant_style.d.ts +0 -13
- package/dist/server/ai-employees/built-in/ai-coding/document/example/js-filter/accounts_filter_ant_style.js +0 -324
- package/dist/server/ai-employees/built-in/ai-coding/document/example/js-filter/contacts_filter_ant_style.d.ts +0 -13
- package/dist/server/ai-employees/built-in/ai-coding/document/example/js-filter/contacts_filter_ant_style.js +0 -309
- package/dist/server/ai-employees/built-in/ai-coding/document/example/js-filter/index.d.ts +0 -15
- package/dist/server/ai-employees/built-in/ai-coding/document/example/js-filter/index.js +0 -50
- package/dist/server/ai-employees/built-in/ai-coding/document/example/js-filter/leads_filter_ant_style.d.ts +0 -13
- package/dist/server/ai-employees/built-in/ai-coding/document/example/js-filter/leads_filter_ant_style.js +0 -345
- package/dist/server/ai-employees/built-in/ai-coding/document/example/js-filter/opportunities_filter_ant_style.d.ts +0 -13
- package/dist/server/ai-employees/built-in/ai-coding/document/example/js-filter/opportunities_filter_ant_style.js +0 -381
- package/dist/server/ai-employees/built-in/ai-coding/document/example/js-filter/product_categories_ant_style.d.ts +0 -13
- package/dist/server/ai-employees/built-in/ai-coding/document/example/js-filter/product_categories_ant_style.js +0 -545
- package/dist/server/ai-employees/built-in/ai-coding/document/example/js-filter/tickets_filter_ant_style.d.ts +0 -13
- package/dist/server/ai-employees/built-in/ai-coding/document/example/js-filter/tickets_filter_ant_style.js +0 -346
- package/dist/server/ai-employees/built-in/ai-coding/document/js-action.d.ts +0 -13
- package/dist/server/ai-employees/built-in/ai-coding/document/js-action.js +0 -102
- package/dist/server/ai-employees/built-in/ai-coding/document/js-block.d.ts +0 -13
- package/dist/server/ai-employees/built-in/ai-coding/document/js-block.js +0 -314
- package/dist/server/ai-employees/built-in/ai-coding/document/js-column.d.ts +0 -13
- package/dist/server/ai-employees/built-in/ai-coding/document/js-column.js +0 -113
- package/dist/server/ai-employees/built-in/ai-coding/document/js-field.d.ts +0 -13
- package/dist/server/ai-employees/built-in/ai-coding/document/js-field.js +0 -498
- package/dist/server/ai-employees/built-in/ai-coding/document/js-item.d.ts +0 -13
- package/dist/server/ai-employees/built-in/ai-coding/document/js-item.js +0 -184
- package/dist/server/ai-employees/built-in/ai-coding/index.d.ts +0 -37
- package/dist/server/ai-employees/built-in/ai-coding/index.js +0 -99
- package/dist/server/ai-employees/built-in/ai-coding/profile.d.ts +0 -27
- package/dist/server/ai-employees/built-in/ai-coding/profile.js +0 -60
- package/dist/server/ai-employees/built-in/ai-coding/prompt_en.md +0 -110
- package/dist/server/ai-employees/built-in/data-modeling/index.d.ts +0 -37
- package/dist/server/ai-employees/built-in/data-modeling/profile.d.ts +0 -27
- package/dist/server/ai-employees/built-in/data-modeling/profile.js +0 -60
- package/dist/server/ai-employees/built-in/data-modeling/prompt.js +0 -283
- package/dist/server/ai-employees/built-in/data-organizer/index.d.ts +0 -37
- package/dist/server/ai-employees/built-in/data-organizer/index.js +0 -63
- package/dist/server/ai-employees/built-in/data-organizer/profile.d.ts +0 -27
- package/dist/server/ai-employees/built-in/data-organizer/profile.js +0 -60
- package/dist/server/ai-employees/built-in/data-visualization/index.d.ts +0 -37
- package/dist/server/ai-employees/built-in/data-visualization/index.js +0 -58
- package/dist/server/ai-employees/built-in/data-visualization/profile.d.ts +0 -27
- package/dist/server/ai-employees/built-in/data-visualization/profile.js +0 -60
- package/dist/server/ai-employees/built-in/email-assistant/index.d.ts +0 -34
- package/dist/server/ai-employees/built-in/email-assistant/index.js +0 -50
- package/dist/server/ai-employees/built-in/email-assistant/profile.d.ts +0 -27
- package/dist/server/ai-employees/built-in/email-assistant/profile.js +0 -60
- package/dist/server/ai-employees/built-in/email-assistant/prompt.d.ts +0 -12
- package/dist/server/ai-employees/built-in/insights-analyst/index.d.ts +0 -37
- package/dist/server/ai-employees/built-in/insights-analyst/index.js +0 -63
- package/dist/server/ai-employees/built-in/insights-analyst/profile.d.ts +0 -27
- package/dist/server/ai-employees/built-in/insights-analyst/profile.js +0 -60
- package/dist/server/ai-employees/built-in/insights-analyst/prompt.d.ts +0 -12
- package/dist/server/ai-employees/built-in/nocobase-assistant/index.d.ts +0 -34
- package/dist/server/ai-employees/built-in/nocobase-assistant/index.js +0 -50
- package/dist/server/ai-employees/built-in/nocobase-assistant/profile.d.ts +0 -27
- package/dist/server/ai-employees/built-in/nocobase-assistant/profile.js +0 -60
- package/dist/server/ai-employees/built-in/nocobase-assistant/prompt.d.ts +0 -12
- package/dist/server/ai-employees/built-in/research-analyst/index.d.ts +0 -37
- package/dist/server/ai-employees/built-in/research-analyst/index.js +0 -63
- package/dist/server/ai-employees/built-in/research-analyst/profile.d.ts +0 -27
- package/dist/server/ai-employees/built-in/research-analyst/profile.js +0 -60
- package/dist/server/ai-employees/built-in/research-analyst/prompt.d.ts +0 -12
- package/dist/server/ai-employees/built-in/translator/index.d.ts +0 -37
- package/dist/server/ai-employees/built-in/translator/index.js +0 -67
- package/dist/server/ai-employees/built-in/translator/profile.d.ts +0 -27
- package/dist/server/ai-employees/built-in/translator/profile.js +0 -60
- package/dist/server/ai-employees/built-in/translator/prompt.d.ts +0 -12
- /package/dist/server/migrations/{20250923221107-setup-build-in.d.ts → 20260306000001-migrate-skill-settings-tools.d.ts} +0 -0
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file is part of the NocoBase (R) project.
|
|
3
|
-
* Copyright (c) 2020-2024 NocoBase Co., Ltd.
|
|
4
|
-
* Authors: NocoBase Team.
|
|
5
|
-
*
|
|
6
|
-
* This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
|
|
7
|
-
* For more information, please refer to: https://www.nocobase.com/agreement.
|
|
8
|
-
*/
|
|
9
|
-
|
|
10
|
-
"use strict";(self.webpackChunk_nocobase_plugin_ai=self.webpackChunk_nocobase_plugin_ai||[]).push([["467"],{8598:function(e,t,r){r.r(t),r.d(t,{StructuredOutput:function(){return a},StructuredOutputSettings:function(){return i}});var o=r(3342),n=r(9155),c=r.n(n),p=r(219),u=r(1990),a=function(){var e=(0,p.kj)();return c().createElement(o.SchemaComponent,{components:{WorkflowVariableJSON:u.WorkflowVariableJSON},schema:{type:"void",properties:{structuredOutput:{type:"object",properties:{schema:{title:"JSON Schema",type:"string",description:c().createElement(c().Fragment,null,e("Syntax references"),":"," ",c().createElement("a",{href:"https://json-schema.org",target:"_blank",rel:"noreferrer"},"JSON Schema")),"x-decorator":"FormItem","x-component":"WorkflowVariableJSON","x-component-props":{json5:!0,autoSize:{minRows:10}}},name:{title:e("Name"),type:"string","x-decorator":"FormItem","x-component":"Input"},description:{title:e("Description"),type:"string","x-decorator":"FormItem","x-component":"Input.TextArea"},strict:{title:"Strict",type:"boolean","x-decorator":"FormItem","x-component":"Checkbox"}}}}}})},i=function(){return c().createElement(o.SchemaComponent,{components:{StructuredOutput:a},schema:{type:"void",properties:{structuredOutput:{type:"void","x-component":"StructuredOutput"}}}})}}}]);
|
|
@@ -1,256 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file is part of the NocoBase (R) project.
|
|
3
|
-
* Copyright (c) 2020-2024 NocoBase Co., Ltd.
|
|
4
|
-
* Authors: NocoBase Team.
|
|
5
|
-
*
|
|
6
|
-
* This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
|
|
7
|
-
* For more information, please refer to: https://www.nocobase.com/agreement.
|
|
8
|
-
*/
|
|
9
|
-
|
|
10
|
-
var __defProp = Object.defineProperty;
|
|
11
|
-
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
12
|
-
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
13
|
-
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
14
|
-
var __export = (target, all) => {
|
|
15
|
-
for (var name in all)
|
|
16
|
-
__defProp(target, name, { get: all[name], enumerable: true });
|
|
17
|
-
};
|
|
18
|
-
var __copyProps = (to, from, except, desc) => {
|
|
19
|
-
if (from && typeof from === "object" || typeof from === "function") {
|
|
20
|
-
for (let key of __getOwnPropNames(from))
|
|
21
|
-
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
22
|
-
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
23
|
-
}
|
|
24
|
-
return to;
|
|
25
|
-
};
|
|
26
|
-
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
27
|
-
var flow_resource_exports = {};
|
|
28
|
-
__export(flow_resource_exports, {
|
|
29
|
-
default: () => flow_resource_default
|
|
30
|
-
});
|
|
31
|
-
module.exports = __toCommonJS(flow_resource_exports);
|
|
32
|
-
var flow_resource_default = {
|
|
33
|
-
name: "flow-resource",
|
|
34
|
-
content: String.raw`# FlowResource 及资源体系
|
|
35
|
-
|
|
36
|
-
\`FlowResource\` 及其子类用于在流程引擎中管理和操作数据资源。它们封装了数据的获取、设置、同步等常用操作,支持与 API 交互。
|
|
37
|
-
|
|
38
|
-
## 资源类结构
|
|
39
|
-
|
|
40
|
-
资源体系的核心类及继承关系如下:
|
|
41
|
-
|
|
42
|
-
- \`FlowResource\`:基础资源类,提供数据的基本存取能力。
|
|
43
|
-
- \`APIResource\`:增加了 API 交互能力。
|
|
44
|
-
- \`BaseRecordResource\`:为记录资源提供基础功能,是单条和多条记录资源的基类。
|
|
45
|
-
- \`SingleRecordResource\`:用于管理单个对象(如一条记录)。
|
|
46
|
-
- \`MultiRecordResource\`:用于管理对象数组(如列表、分页数据)。
|
|
47
|
-
|
|
48
|
-
## 1. FlowResource
|
|
49
|
-
|
|
50
|
-
基础资源类,提供数据和元信息的响应式存取能力。
|
|
51
|
-
|
|
52
|
-
### 主要属性
|
|
53
|
-
|
|
54
|
-
- \`_data\`: 使用 \`observable.ref\` 包装的资源数据,存储当前资源的所有字段信息。
|
|
55
|
-
- \`_meta\`: 使用 \`observable.ref\` 包装的元信息对象,存储如分页、统计等附加信息。
|
|
56
|
-
|
|
57
|
-
### 主要方法
|
|
58
|
-
|
|
59
|
-
- \`getData()\`: 获取当前数据,返回 \`_data.value\`。
|
|
60
|
-
- \`setData(value)\`: 设置当前数据,参数为对象,支持链式调用。
|
|
61
|
-
- \`getMeta(metaKey?)\`: 获取元信息,传入 \`metaKey\` 时返回对应值,否则返回全部元信息对象。
|
|
62
|
-
- \`setMeta(meta)\`: 合并设置元信息,支持链式调用。
|
|
63
|
-
|
|
64
|
-
### 示例
|
|
65
|
-
|
|
66
|
-
\`\`\`typescript
|
|
67
|
-
const resource = new FlowResource<{ name: string }>();
|
|
68
|
-
resource.setData({ name: '张三' });
|
|
69
|
-
console.log(resource.getData()); // { name: '张三' }
|
|
70
|
-
|
|
71
|
-
resource.setMeta({ page: 1, count: 100 });
|
|
72
|
-
console.log(resource.getMeta('page')); // 1
|
|
73
|
-
console.log(resource.getMeta()); // { page: 1, count: 100 }
|
|
74
|
-
\`\`\`
|
|
75
|
-
|
|
76
|
-
### 设计说明
|
|
77
|
-
|
|
78
|
-
- \`FlowResource\` 只负责本地数据和元信息的响应式存取,不涉及 API 通信。
|
|
79
|
-
- 作为基类,通常被其他资源类继承扩展。
|
|
80
|
-
|
|
81
|
-
---
|
|
82
|
-
|
|
83
|
-
## 2. APIResource
|
|
84
|
-
|
|
85
|
-
继承自 \`FlowResource\`,为资源增加了 API 通信能力,支持配置 URL、参数、headers,并通过 APIClient 拉取数据。
|
|
86
|
-
|
|
87
|
-
### 主要属性
|
|
88
|
-
|
|
89
|
-
- \`request.url\`: 资源的 API 地址,字符串或 null。
|
|
90
|
-
- \`request.method\`: 请求方法(如 'get', 'post' 等),默认为 'get'。
|
|
91
|
-
- \`request.params\`: 请求参数对象。
|
|
92
|
-
- \`request.headers\`: 请求头对象。
|
|
93
|
-
- \`request.data\`: 请求体(可选)。
|
|
94
|
-
- \`api\`: APIClient 实例,用于发起 HTTP 请求。
|
|
95
|
-
|
|
96
|
-
### 主要方法
|
|
97
|
-
|
|
98
|
-
- \`setAPIClient(api: APIClient)\`: 设置 API 客户端实例。
|
|
99
|
-
- \`getURL()\`: 获取当前 API 地址。
|
|
100
|
-
- \`setURL(value: string)\`: 设置 API 地址。
|
|
101
|
-
- \`setRequestMethod(method: string)\`: 设置请求方法。
|
|
102
|
-
- \`addRequestHeader(key: string, value: string)\`: 添加请求头。
|
|
103
|
-
- \`addRequestParameter(key: string, value: any)\`: 添加请求参数。
|
|
104
|
-
- \`setRequestBody(data: any)\`: 设置请求体。
|
|
105
|
-
- \`setRequestOptions(key: string, value: any)\`: 设置 request 对象的任意属性。
|
|
106
|
-
- \`async refresh()\`: 通过 APIClient 拉取数据并更新本地数据(GET 请求)。
|
|
107
|
-
- \`getRefreshRequestOptions(filterByTk?)\`: 获取 refresh 请求的参数和 headers,支持主键过滤。
|
|
108
|
-
|
|
109
|
-
### 示例
|
|
110
|
-
|
|
111
|
-
\`\`\`typescript
|
|
112
|
-
const apiResource = new APIResource<{ name: string }>();
|
|
113
|
-
apiResource.setAPIClient(apiClientInstance);
|
|
114
|
-
apiResource.setURL('/users/1');
|
|
115
|
-
apiResource.setRequestMethod('get');
|
|
116
|
-
apiResource.addRequestHeader('Authorization', 'Bearer token');
|
|
117
|
-
await apiResource.refresh();
|
|
118
|
-
console.log(apiResource.getData());
|
|
119
|
-
\`\`\`
|
|
120
|
-
|
|
121
|
-
### 设计说明
|
|
122
|
-
|
|
123
|
-
- \`APIResource\` 负责与后端 API 通信,自动管理数据的获取和本地同步。
|
|
124
|
-
- 通过组合 APIClient,可灵活适配不同的 API 请求方式和参数。
|
|
125
|
-
- 仅实现了 GET(refresh),如需扩展可在子类中实现更多操作(如 POST、PUT、DELETE)。
|
|
126
|
-
|
|
127
|
-
---
|
|
128
|
-
|
|
129
|
-
## 3. BaseRecordResource
|
|
130
|
-
|
|
131
|
-
继承自 \`APIResource\`,为记录资源提供通用的基础功能,是 \`SingleRecordResource\` 和 \`MultiRecordResource\` 的基类。
|
|
132
|
-
|
|
133
|
-
### 主要属性
|
|
134
|
-
|
|
135
|
-
- \`resourceName\`: 资源名称(如 \`users\`、\`users.profile\` 等)。
|
|
136
|
-
- \`sourceId\`: 源对象 ID,用于关联资源(如主对象的主键)。
|
|
137
|
-
- \`request\`: 请求配置对象,包含 \`url\`、\`method\`、\`params\`、\`headers\` 等,\`params\` 支持过滤、排序、字段选择、白名单、黑名单等常用 API 参数。
|
|
138
|
-
|
|
139
|
-
### 主要方法
|
|
140
|
-
|
|
141
|
-
- \`buildURL(action?)\`: 构建请求 URL,支持关联资源和自定义操作。
|
|
142
|
-
- \`async runAction(action, options)\`: 执行指定操作(如自定义 action),通常为 POST 请求。
|
|
143
|
-
- \`setResourceName(resourceName) / getResourceName()\`: 设置/获取资源名称。
|
|
144
|
-
- \`setSourceId(sourceId) / getSourceId()\`: 设置/获取源对象 ID。
|
|
145
|
-
- \`setDataSourceKey(dataSourceKey) / getDataSourceKey()\`: 设置/获取数据源标识(通过 header)。
|
|
146
|
-
- \`setFilter(filter) / getFilter()\`: 设置/获取过滤条件。
|
|
147
|
-
- \`addFilterGroup(key, filter) / removeFilterGroup(key)\`: 设置/移除条件组。
|
|
148
|
-
- \`setAppends(appends) / getAppends()\`: 设置/获取附加字段。
|
|
149
|
-
- \`addAppends(appends) / removeAppends(appends)\`: 添加/移除附加字段。
|
|
150
|
-
- \`setFilterByTk(filterByTk) / getFilterByTk()\`: 设置/获取主键过滤条件。
|
|
151
|
-
- \`setFields(fields) / getFields()\`: 设置/获取字段列表。
|
|
152
|
-
- \`setSort(sort) / getSort()\`: 设置/获取排序字段。
|
|
153
|
-
- \`setExcept(except) / getExcept()\`: 设置/获取排除字段。
|
|
154
|
-
- \`setWhitelist(whitelist) / getWhitelist()\`: 设置/获取白名单字段。
|
|
155
|
-
- \`setBlacklist(blacklist) / getBlacklist()\`: 设置/获取黑名单字段。
|
|
156
|
-
- \`abstract refresh()\`: 抽象方法,需子类实现,用于拉取数据。
|
|
157
|
-
|
|
158
|
-
### 设计说明
|
|
159
|
-
|
|
160
|
-
- \`BaseRecordResource\` 统一封装了常见的 API 参数和资源操作,便于子类扩展。
|
|
161
|
-
- 支持链式调用和灵活的参数设置,适配多种业务场景。
|
|
162
|
-
- 通过 \`buildURL\` 和 \`runAction\` 支持 RESTful 及自定义 action 的请求。
|
|
163
|
-
|
|
164
|
-
### 示例
|
|
165
|
-
|
|
166
|
-
\`\`\`typescript
|
|
167
|
-
const resource = new SomeRecordResource();
|
|
168
|
-
resource.setResourceName('users');
|
|
169
|
-
resource.setSourceId(1);
|
|
170
|
-
resource.setFilter({ status: 'active' });
|
|
171
|
-
resource.setFields(['id', 'name']);
|
|
172
|
-
await resource.refresh();
|
|
173
|
-
console.log(resource.getData());
|
|
174
|
-
\`\`\`
|
|
175
|
-
|
|
176
|
-
---
|
|
177
|
-
|
|
178
|
-
## 4. SingleRecordResource
|
|
179
|
-
|
|
180
|
-
继承自 \`BaseRecordResource\`,用于管理单个对象(如一条记录),适合详情页、单条数据的增删改查等场景。
|
|
181
|
-
|
|
182
|
-
### 主要方法
|
|
183
|
-
|
|
184
|
-
- \`setFilterByTk(filterByTk: string | number)\`: 设置主键过滤条件(仅接受单个值),用于指定当前操作的对象。
|
|
185
|
-
- \`async save(data: TData)\`: 保存当前对象。若已设置主键(\`filterByTk\`),则为更新操作,否则为创建操作。保存后自动刷新数据。
|
|
186
|
-
- \`async destroy()\`: 删除当前对象(根据主键),删除后本地数据设为 null。
|
|
187
|
-
- \`async refresh()\`: 拉取单条记录数据并更新本地数据和元信息。
|
|
188
|
-
|
|
189
|
-
### 设计说明
|
|
190
|
-
|
|
191
|
-
- 适用于详情页、单条数据的增删改查等场景。
|
|
192
|
-
- 通过 \`filterByTk\` 精确定位单条记录。
|
|
193
|
-
- 所有操作均自动同步本地数据和元信息。
|
|
194
|
-
|
|
195
|
-
### 示例
|
|
196
|
-
|
|
197
|
-
\`\`\`typescript
|
|
198
|
-
const userResource = new SingleRecordResource<{ id: number; name: string }>();
|
|
199
|
-
userResource.setResourceName('users');
|
|
200
|
-
userResource.setFilterByTk(1);
|
|
201
|
-
await userResource.refresh();
|
|
202
|
-
console.log(userResource.getData());
|
|
203
|
-
|
|
204
|
-
await userResource.save({ name: '新名字' });
|
|
205
|
-
await userResource.destroy();
|
|
206
|
-
\`\`\`
|
|
207
|
-
|
|
208
|
-
---
|
|
209
|
-
|
|
210
|
-
## 5. MultiRecordResource
|
|
211
|
-
|
|
212
|
-
继承自 \`BaseRecordResource\`,用于管理对象数组(如列表、分页数据),适合表格、列表页等场景。
|
|
213
|
-
|
|
214
|
-
### 主要属性
|
|
215
|
-
|
|
216
|
-
- \`_data\`: 响应式存储的数据数组,默认为空数组。
|
|
217
|
-
- \`request.params.page\`: 当前页码,默认为 1。
|
|
218
|
-
- \`request.params.pageSize\`: 每页条数,默认为 20。
|
|
219
|
-
|
|
220
|
-
### 主要方法
|
|
221
|
-
|
|
222
|
-
- \`async next()\`: 加载下一页数据。
|
|
223
|
-
- \`async previous()\`: 加载上一页数据(页码大于 1 时)。
|
|
224
|
-
- \`async goto(page: number)\`: 跳转到指定页码。
|
|
225
|
-
- \`async create(data: TDataItem)\`: 创建新对象,成功后自动刷新数据。
|
|
226
|
-
- \`async update(filterByTk, data)\`: 更新指定对象,成功后自动刷新数据。
|
|
227
|
-
- \`async destroy(filterByTk)\`: 删除指定对象(支持单个或多个主键),成功后自动刷新数据。
|
|
228
|
-
- \`setPage(page: number) / getPage()\`: 设置/获取当前页码。
|
|
229
|
-
- \`setPageSize(pageSize: number) / getPageSize()\`: 设置/获取每页条数。
|
|
230
|
-
- \`async refresh()\`: 拉取列表数据并更新本地数据和元信息。
|
|
231
|
-
|
|
232
|
-
### 设计说明
|
|
233
|
-
|
|
234
|
-
- 适用于列表、分页、批量操作等场景。
|
|
235
|
-
- 所有数据变更操作(增删改)均自动刷新本地数据和元信息。
|
|
236
|
-
- 支持链式调用设置分页参数。
|
|
237
|
-
|
|
238
|
-
### 示例
|
|
239
|
-
|
|
240
|
-
\`\`\`typescript
|
|
241
|
-
const listResource = new MultiRecordResource<{ id: number; name: string }>();
|
|
242
|
-
listResource.setResourceName('users');
|
|
243
|
-
await listResource.refresh();
|
|
244
|
-
console.log('列表数据', listResource.getData());
|
|
245
|
-
console.log('当前页码', listResource.getMeta('page'));
|
|
246
|
-
console.log('每页记录数', listResource.getMeta('pageSize'));
|
|
247
|
-
console.log('总记录数', listResource.getMeta('count'));
|
|
248
|
-
console.log('总页数', listResource.getMeta('totalPage'));
|
|
249
|
-
|
|
250
|
-
await listResource.create({ name: '新用户' });
|
|
251
|
-
await listResource.update(1, { name: '更新名' });
|
|
252
|
-
await listResource.destroy([1, 2, 3]);
|
|
253
|
-
await listResource.next();
|
|
254
|
-
await listResource.setPageSize(50).refresh();
|
|
255
|
-
\`\`\``
|
|
256
|
-
};
|
|
@@ -1,48 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* This file is part of the NocoBase (R) project.
|
|
3
|
-
* Copyright (c) 2020-2024 NocoBase Co., Ltd.
|
|
4
|
-
* Authors: NocoBase Team.
|
|
5
|
-
*
|
|
6
|
-
* This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
|
|
7
|
-
* For more information, please refer to: https://www.nocobase.com/agreement.
|
|
8
|
-
*/
|
|
9
|
-
|
|
10
|
-
var __create = Object.create;
|
|
11
|
-
var __defProp = Object.defineProperty;
|
|
12
|
-
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
13
|
-
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
14
|
-
var __getProtoOf = Object.getPrototypeOf;
|
|
15
|
-
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
16
|
-
var __export = (target, all) => {
|
|
17
|
-
for (var name in all)
|
|
18
|
-
__defProp(target, name, { get: all[name], enumerable: true });
|
|
19
|
-
};
|
|
20
|
-
var __copyProps = (to, from, except, desc) => {
|
|
21
|
-
if (from && typeof from === "object" || typeof from === "function") {
|
|
22
|
-
for (let key of __getOwnPropNames(from))
|
|
23
|
-
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
24
|
-
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
25
|
-
}
|
|
26
|
-
return to;
|
|
27
|
-
};
|
|
28
|
-
var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
|
|
29
|
-
// If the importer is in node compatibility mode or this is not an ESM
|
|
30
|
-
// file that has been converted to a CommonJS file using a Babel-
|
|
31
|
-
// compatible transform (i.e. "__esModule" has not been set), then set
|
|
32
|
-
// "default" to the CommonJS "module.exports" for node compatibility.
|
|
33
|
-
isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
|
|
34
|
-
mod
|
|
35
|
-
));
|
|
36
|
-
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
37
|
-
var js_column_exports = {};
|
|
38
|
-
__export(js_column_exports, {
|
|
39
|
-
default: () => js_column_default
|
|
40
|
-
});
|
|
41
|
-
module.exports = __toCommonJS(js_column_exports);
|
|
42
|
-
var import_js_columns_for_accounts_en = __toESM(require("./js_columns_for_accounts_en"));
|
|
43
|
-
var import_js_columns_for_contacts_en = __toESM(require("./js_columns_for_contacts_en"));
|
|
44
|
-
var import_js_columns_for_opportunities_en = __toESM(require("./js_columns_for_opportunities_en"));
|
|
45
|
-
var import_js_columns_for_tickets_en = __toESM(require("./js_columns_for_tickets_en"));
|
|
46
|
-
var js_column_default = {
|
|
47
|
-
"en-US": [import_js_columns_for_accounts_en.default, import_js_columns_for_contacts_en.default, import_js_columns_for_opportunities_en.default, import_js_columns_for_tickets_en.default]
|
|
48
|
-
};
|