@nocobase/plugin-ai 2.2.0-alpha.7 → 2.2.0-beta.10

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.
Files changed (393) hide show
  1. package/client-v2.d.ts +0 -1
  2. package/dist/ai/docs/nocobase/workflow/development/api.md +77 -259
  3. package/dist/ai/docs/nocobase/workflow/development/index.md +1 -2
  4. package/dist/ai/docs/nocobase/workflow/development/node.md +51 -84
  5. package/dist/ai/docs/nocobase/workflow/development/trigger.md +20 -122
  6. package/dist/ai/tools/subAgentWebSearch.js +15 -20
  7. package/dist/client/119.c6bf8c6433167d81.js +10 -0
  8. package/dist/client/170.d98eacdc00d9d527.js +10 -0
  9. package/dist/client/228.b4b709f93b86b6b9.js +10 -0
  10. package/dist/client/280.003b9e9788599244.js +10 -0
  11. package/dist/client/290.0f7f441d8a94f03c.js +10 -0
  12. package/dist/client/331.d547c95410476a69.js +10 -0
  13. package/dist/client/406.15c09d98faa2ccf1.js +10 -0
  14. package/dist/client/428.5eb4f53ddbb6a3b8.js +10 -0
  15. package/dist/client/462.d172d0fe91519e35.js +10 -0
  16. package/dist/client/486.dcac8f3fcec19c33.js +10 -0
  17. package/dist/client/502.2b4a51e0a8122e52.js +10 -0
  18. package/dist/client/525.33a9c8ec28be4ec4.js +10 -0
  19. package/dist/client/559.959c46d0056ccdc8.js +10 -0
  20. package/dist/client/561.7ec804ef39ec7dcd.js +10 -0
  21. package/dist/client/580.35ba54ff91b7fe6d.js +10 -0
  22. package/dist/client/597.b0d64948d74cf6cb.js +10 -0
  23. package/dist/client/604.89c674f35b52b4ef.js +10 -0
  24. package/dist/client/614.aa766080f6b99aab.js +10 -0
  25. package/dist/client/646.2e395a514c511084.js +10 -0
  26. package/dist/client/687.224e569a99cae4bb.js +10 -0
  27. package/dist/client/699.57c0a1acb723202a.js +10 -0
  28. package/dist/client/711.92cd94681fde7e05.js +10 -0
  29. package/dist/client/758.a9741e81911e53c3.js +10 -0
  30. package/dist/client/768.5177bff46ae71a5b.js +10 -0
  31. package/dist/client/792.abb57765453bcbcc.js +10 -0
  32. package/dist/client/820.f72ef2462b61d812.js +10 -0
  33. package/dist/client/832.0cf69e3f43c320b2.js +10 -0
  34. package/dist/client/927.d95c74ebb8fd51c9.js +10 -0
  35. package/dist/client/admin-settings/AdminSettings.d.ts +10 -0
  36. package/dist/client/ai-employees/1.x/selector/AIContextCollector.d.ts +4 -1
  37. package/dist/client/ai-employees/1.x/selector/AISelectorProvider.d.ts +33 -0
  38. package/dist/client/ai-employees/1.x/selector/BlockSelector.d.ts +14 -0
  39. package/dist/{client-v2/ai-employees/tools/ChartGeneratorCard.d.ts → client/ai-employees/1.x/selector/withAISelectable.d.ts} +4 -5
  40. package/dist/client/ai-employees/AIEmployeeListItem.d.ts +14 -0
  41. package/dist/client/ai-employees/AIEmployeesProvider.d.ts +12 -0
  42. package/dist/client/ai-employees/AISettingsProvider.d.ts +18 -0
  43. package/dist/{client-v2 → client}/ai-employees/AddContextButton.d.ts +1 -1
  44. package/dist/client/ai-employees/ContextAwareTooltip.d.ts +10 -0
  45. package/dist/client/ai-employees/ProfileCard.d.ts +15 -0
  46. package/dist/client/ai-employees/admin/AvatarSelect.d.ts +19 -0
  47. package/dist/client/ai-employees/admin/ChatSettings.d.ts +10 -0
  48. package/dist/client/ai-employees/admin/DataSourceSettings.d.ts +10 -0
  49. package/dist/client/ai-employees/admin/Employees.d.ts +10 -0
  50. package/dist/client/ai-employees/admin/EnableSwitch.d.ts +10 -0
  51. package/dist/client/ai-employees/admin/InputsFormSettings.d.ts +10 -0
  52. package/dist/client/ai-employees/admin/KnowledgeBaseSettings.d.ts +10 -0
  53. package/dist/client/ai-employees/admin/ModelSettings.d.ts +10 -0
  54. package/dist/client/ai-employees/admin/ProfileSettings.d.ts +12 -0
  55. package/dist/client/ai-employees/admin/SkillSettings.d.ts +19 -0
  56. package/dist/client/ai-employees/admin/SystemPrompt.d.ts +10 -0
  57. package/dist/client/ai-employees/admin/Templates.d.ts +10 -0
  58. package/dist/client/ai-employees/admin/ToolsSettings.d.ts +17 -0
  59. package/dist/{client-v2/ai-employees/chatbox/components/MessageContent.d.ts → client/ai-employees/admin/datasource/components/DatasourceSettingDetail.d.ts} +4 -3
  60. package/dist/client/ai-employees/admin/datasource/components/DatasourceSettingForm.d.ts +10 -0
  61. package/dist/client/ai-employees/admin/datasource/components/DatasourceSettingGrid.d.ts +10 -0
  62. package/dist/client/ai-employees/admin/datasource/components/basic/CollectionCascader.d.ts +14 -0
  63. package/dist/{client-v2/workflow/nodes/employee/components/SkillSettings.d.ts → client/ai-employees/admin/datasource/components/basic/FieldsTransfer.d.ts} +6 -6
  64. package/dist/client/ai-employees/admin/datasource/components/basic/index.d.ts +10 -0
  65. package/dist/client/ai-employees/admin/datasource/components/form-steps/CollectionSetting.d.ts +17 -0
  66. package/dist/client/ai-employees/admin/datasource/components/form-steps/FieldsSetting.d.ts +15 -0
  67. package/dist/client/ai-employees/admin/datasource/components/form-steps/FilterSetting.d.ts +17 -0
  68. package/dist/client/ai-employees/admin/datasource/components/form-steps/Preview.d.ts +13 -0
  69. package/dist/client/ai-employees/admin/datasource/components/form-steps/SortSetting.d.ts +15 -0
  70. package/dist/client/ai-employees/admin/datasource/components/form-steps/index.d.ts +13 -0
  71. package/dist/client/ai-employees/admin/datasource/components/index.d.ts +9 -0
  72. package/dist/client/ai-employees/admin/datasource/context.d.ts +17 -0
  73. package/dist/client/ai-employees/admin/datasource/flow-models/DatasourceSettingModel.d.ts +15 -0
  74. package/dist/client/ai-employees/admin/datasource/flow-models/index.d.ts +9 -0
  75. package/dist/client/ai-employees/admin/datasource/index.d.ts +10 -0
  76. package/dist/client/ai-employees/admin/hooks.d.ts +39 -0
  77. package/dist/client/ai-employees/admin/mcp/MCPSettings.d.ts +10 -0
  78. package/dist/client/ai-employees/admin/mcp/MCPToolsList.d.ts +19 -0
  79. package/dist/client/ai-employees/admin/mcp/context.d.ts +15 -0
  80. package/dist/client/ai-employees/admin/mcp/schemas.d.ts +1314 -0
  81. package/dist/{client-v2 → client}/ai-employees/ai-coding/AICodingButton.d.ts +1 -2
  82. package/dist/client/ai-employees/ai-coding/CodeHistory.d.ts +10 -0
  83. package/dist/client/ai-employees/ai-coding/markdown/Code.d.ts +16 -0
  84. package/dist/{client-v2/ai-employees/tools/ai-coding.d.ts → client/ai-employees/ai-coding/tools/context-tools.d.ts} +1 -3
  85. package/dist/client/ai-employees/ai-coding/tools/index.d.ts +11 -0
  86. package/dist/{client-v2/ai-employees/tools → client/ai-employees/ai-coding/ui}/CodeToolCard.d.ts +1 -1
  87. package/dist/client/ai-employees/avatars.d.ts +9 -0
  88. package/dist/client/ai-employees/built-in/utils.d.ts +15 -0
  89. package/dist/client/ai-employees/business-report/tools/index.d.ts +10 -0
  90. package/dist/{client-v2/ai-employees/tools → client/ai-employees/business-report/ui}/BusinessReportCard.d.ts +2 -2
  91. package/dist/{client-v2/ai-employees/tools → client/ai-employees/business-report/ui}/BusinessReportModal.d.ts +2 -2
  92. package/dist/client/ai-employees/business-report/ui/report-utils.d.ts +38 -0
  93. package/dist/client/ai-employees/chart-generator/tools/index.d.ts +10 -0
  94. package/dist/client/ai-employees/chart-generator/ui/ECharts.d.ts +13 -0
  95. package/dist/{client-v2/ai-employees/chatbox/components/ChatBox.d.ts → client/ai-employees/chatbox/AIThinking.d.ts} +2 -2
  96. package/dist/{client-v2/ai-employees/chatbox/components → client/ai-employees/chatbox}/Actions.d.ts +4 -2
  97. package/dist/{client-v2/ai-employees/chatbox/components → client/ai-employees/chatbox}/AddLLMModal.d.ts +4 -2
  98. package/dist/client/ai-employees/chatbox/Attachment.d.ts +14 -0
  99. package/dist/client/ai-employees/chatbox/AttachmentsHeader.d.ts +10 -0
  100. package/dist/client/ai-employees/chatbox/ChatBox.d.ts +12 -0
  101. package/dist/{client-v2/ai-employees/chatbox/components → client/ai-employees/chatbox}/ChatBoxLayout.d.ts +1 -1
  102. package/dist/{client-v2/ai-employees/chatbox/components → client/ai-employees/chatbox}/ContextItem.d.ts +1 -1
  103. package/dist/client/ai-employees/chatbox/ContextItemsHeader.d.ts +10 -0
  104. package/dist/client/ai-employees/chatbox/DebugPanel.d.ts +16 -0
  105. package/dist/client/ai-employees/chatbox/EditMessageHeader.d.ts +10 -0
  106. package/dist/client/ai-employees/chatbox/HintMessageHeader.d.ts +10 -0
  107. package/dist/client/ai-employees/chatbox/MessageRenderer.d.ts +33 -0
  108. package/dist/client/ai-employees/chatbox/SenderFooter.d.ts +13 -0
  109. package/dist/client/ai-employees/chatbox/SenderHeader.d.ts +10 -0
  110. package/dist/client/ai-employees/chatbox/SenderPrefix.d.ts +10 -0
  111. package/dist/client/ai-employees/chatbox/Upload.d.ts +12 -0
  112. package/dist/client/ai-employees/chatbox/VirtualList.d.ts +28 -0
  113. package/dist/client/ai-employees/chatbox/conversations/ConversationsList.d.ts +13 -0
  114. package/dist/client/ai-employees/chatbox/conversations/WorkflowTasksList.d.ts +13 -0
  115. package/dist/{client-v2/ai-employees/chatbox/stores/workflow-tasks.d.ts → client/ai-employees/chatbox/conversations/common.d.ts} +4 -21
  116. package/dist/client/ai-employees/chatbox/conversations/index.d.ts +9 -0
  117. package/dist/{client-v2/ai-employees/chatbox/components/ToolCard.d.ts → client/ai-employees/chatbox/generative-ui/DefaultToolCard.d.ts} +6 -7
  118. package/dist/client/ai-employees/chatbox/generative-ui/ToolCard.d.ts +15 -0
  119. package/dist/{client-v2 → client}/ai-employees/chatbox/hooks/useChat.d.ts +22 -21
  120. package/dist/client/ai-employees/chatbox/hooks/useChatBoxActions.d.ts +18 -0
  121. package/dist/{client-v2 → client}/ai-employees/chatbox/hooks/useChatConversationActions.d.ts +2 -2
  122. package/dist/{client-v2 → client}/ai-employees/chatbox/hooks/useChatMessageActions.d.ts +4 -8
  123. package/dist/{client-v2 → client}/ai-employees/chatbox/hooks/useToolCallActions.d.ts +1 -1
  124. package/dist/client/ai-employees/chatbox/hooks/useUploadFiles.d.ts +12 -0
  125. package/dist/{client-v2 → client}/ai-employees/chatbox/hooks/useWorkflowTasks.d.ts +1 -1
  126. package/dist/client/ai-employees/chatbox/markdown/Code.d.ts +18 -0
  127. package/dist/client/ai-employees/chatbox/markdown/ECharts.d.ts +10 -0
  128. package/dist/client/ai-employees/chatbox/markdown/Form.d.ts +10 -0
  129. package/dist/{client-v2/ai-employees/chatbox/components/DebugPanel.d.ts → client/ai-employees/chatbox/markdown/Generating.d.ts} +1 -1
  130. package/dist/client/ai-employees/chatbox/markdown/Markdown.d.ts +13 -0
  131. package/dist/{client-v2 → client}/ai-employees/chatbox/model.d.ts +2 -9
  132. package/dist/client/ai-employees/chatbox/roles.d.ts +32 -0
  133. package/dist/client/ai-employees/chatbox/stores/chat-box.d.ts +9 -0
  134. package/dist/client/ai-employees/chatbox/stores/chat-conversations.d.ts +9 -0
  135. package/dist/client/ai-employees/chatbox/stores/chat-messages.d.ts +9 -0
  136. package/dist/{client-v2 → client}/ai-employees/chatbox/stores/chat-tool-call.d.ts +15 -1
  137. package/dist/client/ai-employees/chatbox/stores/chat-tools.d.ts +51 -0
  138. package/dist/{client-v2/ai-employees/data-modeling/setup.d.ts → client/ai-employees/chatbox/stores/create-selectors.d.ts} +8 -5
  139. package/dist/client/ai-employees/chatbox/stores/workflow-tasks.d.ts +45 -0
  140. package/dist/{client-v2 → client}/ai-employees/chatbox/utils.d.ts +6 -21
  141. package/dist/{client-v2/workflow/nodes/employee/components/AIEmployeeSelect.d.ts → client/ai-employees/common/CodeHighlight.d.ts} +6 -5
  142. package/dist/client/ai-employees/context/classic-pages.d.ts +10 -0
  143. package/dist/{client-v2 → client}/ai-employees/context/code-editor.d.ts +1 -1
  144. package/dist/{client-v2 → client}/ai-employees/context/datasource.d.ts +1 -1
  145. package/dist/{client-v2 → client}/ai-employees/context/flow-models.d.ts +1 -1
  146. package/dist/client/ai-employees/data-modeling/Table.d.ts +12 -0
  147. package/dist/client/ai-employees/data-modeling/setup.d.ts +10 -0
  148. package/dist/client/ai-employees/data-modeling/tools/index.d.ts +10 -0
  149. package/dist/{client-v2/ai-employees/tools → client/ai-employees}/data-modeling/types.d.ts +4 -27
  150. package/dist/client/ai-employees/data-modeling/ui/CollectionNode.d.ts +12 -0
  151. package/dist/{client-v2/ai-employees/tools → client/ai-employees/data-modeling/ui}/DataModelingCard.d.ts +5 -3
  152. package/dist/{client-v2/ai-employees/tools → client/ai-employees/data-modeling/ui}/DataModelingModal.d.ts +6 -4
  153. package/dist/{client-v2/ai-employees/tools/data-modeling → client/ai-employees/data-modeling/ui}/Diagram.d.ts +1 -1
  154. package/dist/{client-v2/ai-employees/tools/data-modeling → client/ai-employees/data-modeling/ui}/Table.d.ts +2 -2
  155. package/dist/client/ai-employees/data-modeling/ui/useFieldInterfaceOptions.d.ts +14 -0
  156. package/dist/{client-v2/ai-employees/context/chart-config.d.ts → client/ai-employees/data-visualization/context.d.ts} +1 -1
  157. package/dist/{client-v2/ai-employees/tools/data-visualization.d.ts → client/ai-employees/data-visualization/tools/index.d.ts} +1 -1
  158. package/dist/client/ai-employees/datasource/DatasourceList.d.ts +17 -0
  159. package/dist/{client-v2 → client}/ai-employees/datasource/DatasourceSelector.d.ts +2 -6
  160. package/dist/client/ai-employees/datasource/index.d.ts +9 -0
  161. package/dist/client/ai-employees/flow/events/index.d.ts +9 -0
  162. package/dist/client/ai-employees/flow/index.d.ts +36 -0
  163. package/dist/client/ai-employees/flow/models/AIEmployeeActionModel.d.ts +18 -0
  164. package/dist/client/ai-employees/flow/models/AIEmployeeShortcutModel.d.ts +30 -0
  165. package/dist/{client-v2 → client}/ai-employees/form-filler/tools/index.d.ts +1 -1
  166. package/dist/client/ai-employees/permissions/Permissions.d.ts +12 -0
  167. package/dist/client/ai-employees/permissions/PermissionsTab.d.ts +5 -21
  168. package/dist/client/ai-employees/shortcuts/ShortcutList.d.ts +10 -0
  169. package/dist/client/ai-employees/shortcuts/useShortcuts.d.ts +13 -0
  170. package/dist/{client-v2 → client}/ai-employees/stores/ai-selection.d.ts +4 -4
  171. package/dist/client/ai-employees/stores/context-aware.d.ts +19 -0
  172. package/dist/{client-v2 → client}/ai-employees/stores/dialog-controller.d.ts +4 -4
  173. package/dist/client/ai-employees/sub-agents/tools/index.d.ts +10 -0
  174. package/dist/{client-v2/ai-employees/tools → client/ai-employees/sub-agents/ui}/SubAgentDispatchCard.d.ts +9 -4
  175. package/dist/client/ai-employees/suggestions/tools/index.d.ts +10 -0
  176. package/dist/client/ai-employees/suggestions/ui/SuggestionsOptions.d.ts +13 -0
  177. package/dist/client/ai-employees/types.d.ts +259 -0
  178. package/dist/client/ai-employees/workflow-tasks/tools/index.d.ts +10 -0
  179. package/dist/client/ai-employees/workflow-tasks/ui/WorkflowTaskOutputCard.d.ts +11 -0
  180. package/dist/{client-v2/workflow/nodes/llm/components → client/chat-settings}/Messages.d.ts +2 -2
  181. package/dist/{client-v2/workflow/nodes/employee/components → client/chat-settings}/StructuredOutput.d.ts +2 -2
  182. package/dist/{client-v2/workflow/components/WorkflowListCollapse.d.ts → client/components/ListCollapse.d.ts} +4 -4
  183. package/dist/client/components/skill-settings.d.ts +22 -0
  184. package/dist/{client-v2 → client}/debug-logger.d.ts +2 -2
  185. package/dist/client/features/components.d.ts +9 -0
  186. package/dist/client/features/feature-manager.d.ts +9 -0
  187. package/dist/client/features/index.d.ts +9 -0
  188. package/dist/client/features/vector-database-provider.d.ts +9 -0
  189. package/dist/client/features/vector-store-provider.d.ts +9 -0
  190. package/dist/client/index.d.ts +20 -15
  191. package/dist/client/index.js +8 -8
  192. package/dist/client/llm-providers/anthropic/ModelSettings.d.ts +10 -0
  193. package/dist/client/llm-providers/anthropic/ProviderSettings.d.ts +10 -0
  194. package/dist/client/llm-providers/anthropic/index.d.ts +10 -0
  195. package/dist/client/llm-providers/components/Chat.d.ts +10 -0
  196. package/dist/client/llm-providers/components/ModelSelect.d.ts +10 -0
  197. package/dist/client/llm-providers/dashscope/ModelSettings.d.ts +10 -0
  198. package/dist/client/llm-providers/dashscope/ProviderSettings.d.ts +10 -0
  199. package/dist/client/llm-providers/dashscope/index.d.ts +10 -0
  200. package/dist/client/llm-providers/deepseek/ModelSettings.d.ts +10 -0
  201. package/dist/client/llm-providers/deepseek/index.d.ts +10 -0
  202. package/dist/client/llm-providers/google-genai/MessageRenderer.d.ts +13 -0
  203. package/dist/client/llm-providers/google-genai/ModelSettings.d.ts +10 -0
  204. package/dist/client/llm-providers/google-genai/ProviderSettings.d.ts +10 -0
  205. package/dist/client/llm-providers/google-genai/index.d.ts +10 -0
  206. package/dist/client/llm-providers/kimi/ModelSettings.d.ts +10 -0
  207. package/dist/client/llm-providers/kimi/index.d.ts +10 -0
  208. package/dist/client/llm-providers/mimo/ModelSettings.d.ts +10 -0
  209. package/dist/client/llm-providers/mimo/index.d.ts +10 -0
  210. package/dist/client/llm-providers/mistral/ModelSettings.d.ts +10 -0
  211. package/dist/{client-v2/workflow/nodes/employee/components/AIEmployeeFieldset.d.ts → client/llm-providers/mistral/index.d.ts} +2 -3
  212. package/dist/client/llm-providers/ollama/ModelSettings.d.ts +10 -0
  213. package/dist/client/llm-providers/ollama/ProviderSettings.d.ts +10 -0
  214. package/dist/client/llm-providers/ollama/index.d.ts +10 -0
  215. package/dist/client/llm-providers/openai/completions/ModelSettings.d.ts +10 -0
  216. package/dist/client/llm-providers/openai/completions/index.d.ts +10 -0
  217. package/dist/client/llm-providers/openai/components/ProviderSettings.d.ts +10 -0
  218. package/dist/client/llm-providers/openai/responses/ModelSettings.d.ts +10 -0
  219. package/dist/client/llm-providers/openai/responses/index.d.ts +10 -0
  220. package/dist/client/llm-providers/orcarouter/ModelSettings.d.ts +10 -0
  221. package/dist/client/llm-providers/orcarouter/ProviderSettings.d.ts +10 -0
  222. package/dist/client/llm-providers/orcarouter/index.d.ts +10 -0
  223. package/dist/client/llm-providers/tongyi/ModelSettings.d.ts +10 -0
  224. package/dist/client/llm-providers/tongyi/ProviderSettings.d.ts +10 -0
  225. package/dist/client/llm-providers/tongyi/index.d.ts +10 -0
  226. package/dist/client/llm-providers/xai/ModelSettings.d.ts +10 -0
  227. package/dist/client/llm-providers/xai/index.d.ts +10 -0
  228. package/dist/client/llm-services/LLMServices.d.ts +13 -0
  229. package/dist/client/llm-services/component/DefaultModelSelect.d.ts +10 -0
  230. package/dist/client/llm-services/component/EnabledModelsSelect.d.ts +23 -0
  231. package/dist/client/llm-services/component/LLMTestFlight.d.ts +10 -0
  232. package/dist/client/llm-services/component/ModelOptionsSettings.d.ts +10 -0
  233. package/dist/client/llm-services/component/UnifiedModelSettings.d.ts +10 -0
  234. package/dist/client/llm-services/hooks/useLLMServiceCatalog.d.ts +18 -0
  235. package/dist/client/llm-services/llm-providers.d.ts +27 -0
  236. package/dist/client/llm-services/utils.d.ts +35 -0
  237. package/dist/client/manager/ai-feature-manager.d.ts +9 -0
  238. package/dist/{client-v2 → client}/manager/ai-manager.d.ts +5 -4
  239. package/dist/client/repositories/AIConfigRepository.d.ts +60 -0
  240. package/dist/client/repositories/hooks/useAIConfigRepository.d.ts +10 -0
  241. package/dist/client/schemas/llms.d.ts +347 -0
  242. package/dist/client/workflow/nodes/employee/components/AIEmployeeSelect.d.ts +10 -0
  243. package/dist/client/workflow/nodes/employee/components/assigness.d.ts +11 -0
  244. package/dist/client/workflow/nodes/employee/components/file-inputs.d.ts +10 -0
  245. package/dist/client/workflow/nodes/employee/components/message-inputs.d.ts +12 -0
  246. package/dist/client/workflow/nodes/employee/components/model-options.d.ts +10 -0
  247. package/dist/client/workflow/nodes/employee/components/structured-output.d.ts +10 -0
  248. package/dist/client/workflow/nodes/employee/components/users-select.d.ts +15 -0
  249. package/dist/client/workflow/nodes/employee/components/web-search-options.d.ts +10 -0
  250. package/dist/client/workflow/nodes/employee/configuration.d.ts +12 -0
  251. package/dist/client/workflow/nodes/employee/flow-models/feedback.d.ts +14 -0
  252. package/dist/client/workflow/nodes/employee/flow-models/task.d.ts +13 -0
  253. package/dist/client/workflow/nodes/employee/index.d.ts +23 -2
  254. package/dist/client/workflow/nodes/llm/ModelSettings.d.ts +11 -0
  255. package/dist/client/workflow/nodes/llm/index.d.ts +52 -2
  256. package/dist/{client-v2 → client}/workflow/triggers/ai-employee/Parameters.d.ts +4 -2
  257. package/dist/client/workflow/triggers/ai-employee/index.d.ts +83 -2
  258. package/dist/client-v2/ai-employees/AIEmployeeShortcut.d.ts +2 -9
  259. package/dist/client-v2/ai-employees/chatbox/hooks/useChatBoxActions.d.ts +2 -3
  260. package/dist/client-v2/ai-employees/chatbox/stores/chat-box.d.ts +49 -1
  261. package/dist/client-v2/ai-employees/chatbox/stores/chat-conversations.d.ts +19 -2
  262. package/dist/client-v2/ai-employees/chatbox/stores/chat-messages.d.ts +46 -1
  263. package/dist/client-v2/ai-employees/chatbox/stores/create-selectors.d.ts +3 -31
  264. package/dist/client-v2/ai-employees/types.d.ts +7 -101
  265. package/dist/client-v2/index.d.ts +8 -9
  266. package/dist/client-v2/index.js +1 -37
  267. package/dist/client-v2/repositories/AIConfigRepository.d.ts +23 -3
  268. package/dist/externalVersion.js +25 -20
  269. package/dist/locale/en-US.json +1 -42
  270. package/dist/locale/zh-CN.json +1 -42
  271. package/dist/node_modules/@langchain/mistralai/package.json +1 -1
  272. package/dist/node_modules/@langchain/xai/package.json +1 -1
  273. package/dist/node_modules/fs-extra/package.json +1 -1
  274. package/dist/node_modules/jsonrepair/package.json +1 -1
  275. package/dist/node_modules/just-bash/package.json +1 -1
  276. package/dist/node_modules/nodejs-snowflake/package.json +1 -1
  277. package/dist/node_modules/openai/package.json +1 -1
  278. package/dist/node_modules/zod/package.json +1 -1
  279. package/dist/server/ai-employees/ai-employee.js +1 -7
  280. package/dist/server/ai-employees/prompts.d.ts +1 -2
  281. package/dist/server/ai-employees/prompts.js +2 -8
  282. package/dist/server/llm-providers/dashscope.d.ts +1 -2
  283. package/dist/server/llm-providers/dashscope.js +1 -16
  284. package/dist/server/llm-providers/deepseek.d.ts +1 -2
  285. package/dist/server/llm-providers/deepseek.js +2 -33
  286. package/dist/server/llm-providers/kimi/provider.d.ts +1 -2
  287. package/dist/server/llm-providers/kimi/provider.js +2 -22
  288. package/dist/server/llm-providers/mistral.d.ts +2 -36
  289. package/dist/server/llm-providers/mistral.js +2 -62
  290. package/dist/server/llm-providers/openai/completions.d.ts +1 -2
  291. package/dist/server/llm-providers/openai/completions.js +1 -17
  292. package/dist/server/llm-providers/openai/responses.d.ts +1 -2
  293. package/dist/server/llm-providers/openai/responses.js +1 -17
  294. package/dist/server/llm-providers/provider.d.ts +0 -7
  295. package/dist/server/llm-providers/provider.js +1 -7
  296. package/dist/server/manager/ai-manager.d.ts +1 -2
  297. package/dist/server/manager/ai-manager.js +1 -4
  298. package/package.json +5 -5
  299. package/dist/ai/docs/nocobase/interface-builder/blocks/data-blocks/comment.md +0 -107
  300. package/dist/ai/docs/nocobase/plugins/@nocobase/plugin-block-comment/index.md +0 -14
  301. package/dist/ai/docs/nocobase/workflow/development/migration.md +0 -319
  302. package/dist/client/23.65ea8c37cd4b884b.js +0 -10
  303. package/dist/client/264.cc98933ef65608b6.js +0 -10
  304. package/dist/client/336.7a8a8853196ad779.js +0 -11
  305. package/dist/client/372.da38fe350bf841f4.js +0 -10
  306. package/dist/client/416.92b74ca47e4099c4.js +0 -10
  307. package/dist/client/446.d63c38d0309fe250.js +0 -10
  308. package/dist/client/525.203778500aca5d05.js +0 -10
  309. package/dist/client/663.680bcf6272a8504d.js +0 -10
  310. package/dist/client/681.399948c18d753667.js +0 -10
  311. package/dist/client/705.380279da896021fb.js +0 -10
  312. package/dist/client-v2/23.1bcb6986b40723d8.js +0 -10
  313. package/dist/client-v2/264.be92ff6a4d2612f1.js +0 -10
  314. package/dist/client-v2/336.e406470429e0670e.js +0 -11
  315. package/dist/client-v2/372.d76ea1ceed2be2a4.js +0 -10
  316. package/dist/client-v2/406.341be51205c674e0.js +0 -10
  317. package/dist/client-v2/416.0e1c2d9cde43b83d.js +0 -10
  318. package/dist/client-v2/446.073d450882db29fd.js +0 -10
  319. package/dist/client-v2/457.d72febb89e88fc00.js +0 -10
  320. package/dist/client-v2/663.342341f0b2b412d8.js +0 -10
  321. package/dist/client-v2/681.082f4f1c7b841983.js +0 -10
  322. package/dist/client-v2/705.1d10027ff8cfdf79.js +0 -10
  323. package/dist/client-v2/ai-employees/AIEmployeeDropdown.d.ts +0 -18
  324. package/dist/client-v2/ai-employees/chatbox/components/Attachments.d.ts +0 -27
  325. package/dist/client-v2/ai-employees/chatbox/components/Markdown.d.ts +0 -25
  326. package/dist/client-v2/ai-employees/chatbox/components/MessageRenderers.d.ts +0 -39
  327. package/dist/client-v2/ai-employees/chatbox/components/index.d.ts +0 -13
  328. package/dist/client-v2/ai-employees/chatbox/hooks/useUploadFiles.d.ts +0 -46
  329. package/dist/client-v2/ai-employees/chatbox/roles.d.ts +0 -162
  330. package/dist/client-v2/ai-employees/chatbox/stores/chat-tools.d.ts +0 -30
  331. package/dist/client-v2/ai-employees/flow/index.d.ts +0 -13
  332. package/dist/client-v2/ai-employees/tools/SuggestionsOptionsCard.d.ts +0 -16
  333. package/dist/client-v2/ai-employees/tools/WorkflowTaskOutputCard.d.ts +0 -16
  334. package/dist/client-v2/ai-employees/tools/business-report-utils.d.ts +0 -45
  335. package/dist/client-v2/ai-employees/tools/data-modeling/CollectionNode.d.ts +0 -11
  336. package/dist/client-v2/ai-employees/tools/data-modeling/legacy-template.d.ts +0 -13
  337. package/dist/client-v2/ai-employees/tools/data-modeling/runtime.d.ts +0 -15
  338. package/dist/client-v2/ai-employees/tools/data-modeling/useFieldInterfaceOptions.d.ts +0 -151
  339. package/dist/client-v2/ai-employees/tools/index.d.ts +0 -32
  340. package/dist/client-v2/components/RemoteSelect.d.ts +0 -43
  341. package/dist/client-v2/f0053e745af0ad03.svg +0 -50
  342. package/dist/client-v2/llm-providers/forms.d.ts +0 -44
  343. package/dist/client-v2/llm-providers/index.d.ts +0 -24
  344. package/dist/client-v2/llm-services/utils.d.ts +0 -13
  345. package/dist/client-v2/locale.d.ts +0 -14
  346. package/dist/client-v2/models/ai-employees/AIEmployeeActionModel.d.ts +0 -33
  347. package/dist/client-v2/models/ai-employees/AIEmployeeShortcutModel.d.ts +0 -44
  348. package/dist/client-v2/pages/AdminSettingsPage.d.ts +0 -24
  349. package/dist/client-v2/pages/DatasourceSettingsPage.d.ts +0 -62
  350. package/dist/client-v2/pages/EmployeesPage.d.ts +0 -53
  351. package/dist/client-v2/pages/LLMServicesPage.d.ts +0 -75
  352. package/dist/client-v2/pages/MCPSettingsPage.d.ts +0 -73
  353. package/dist/client-v2/pages/drawerWidth.d.ts +0 -10
  354. package/dist/client-v2/pages/permissions/Permissions.d.ts +0 -67
  355. package/dist/client-v2/pages/permissions/PermissionsTab.d.ts +0 -12
  356. package/dist/client-v2/pages/useUnsavedChangesBeforeClose.d.ts +0 -29
  357. package/dist/client-v2/plugin.d.ts +0 -32
  358. package/dist/client-v2/workflow/components/FormValueRegistry.d.ts +0 -12
  359. package/dist/client-v2/workflow/constants.d.ts +0 -26
  360. package/dist/client-v2/workflow/nodes/employee/components/Assignees.d.ts +0 -11
  361. package/dist/client-v2/workflow/nodes/employee/components/FeedbackSettings.d.ts +0 -17
  362. package/dist/client-v2/workflow/nodes/employee/components/FileInputs.d.ts +0 -11
  363. package/dist/client-v2/workflow/nodes/employee/components/MessageInputs.d.ts +0 -11
  364. package/dist/client-v2/workflow/nodes/employee/components/ModelOptions.d.ts +0 -17
  365. package/dist/client-v2/workflow/nodes/employee/components/UserInput.d.ts +0 -18
  366. package/dist/client-v2/workflow/nodes/employee/components/WebSearchOptions.d.ts +0 -16
  367. package/dist/client-v2/workflow/nodes/employee/index.d.ts +0 -23
  368. package/dist/client-v2/workflow/nodes/llm/components/LLMFieldset.d.ts +0 -12
  369. package/dist/client-v2/workflow/nodes/llm/components/StructuredOutput.d.ts +0 -11
  370. package/dist/client-v2/workflow/nodes/llm/index.d.ts +0 -30
  371. package/dist/client-v2/workflow/register.d.ts +0 -10
  372. package/dist/client-v2/workflow/triggers/ai-employee/AIEmployeeTriggerConfig.d.ts +0 -11
  373. package/dist/client-v2/workflow/triggers/ai-employee/index.d.ts +0 -25
  374. package/dist/client-v2/workflow/types.d.ts +0 -128
  375. /package/dist/{client-v2 → client}/ai-employees/AISelection.d.ts +0 -0
  376. /package/dist/{client-v2 → client}/ai-employees/AISelectionControl.d.ts +0 -0
  377. /package/dist/{client-v2 → client}/ai-employees/ai-coding/prompts.d.ts +0 -0
  378. /package/dist/{client-v2 → client}/ai-employees/ai-coding/setup.d.ts +0 -0
  379. /package/dist/{client-v2/ai-employees/chatbox/components/AIEmployeeSwitcher.d.ts → client/ai-employees/chatbox/AIEmployeeSwitch.d.ts} +0 -0
  380. /package/dist/{client-v2/ai-employees/chatbox/components → client/ai-employees/chatbox}/ChatButton.d.ts +0 -0
  381. /package/dist/{client-v2/ai-employees/chatbox/components → client/ai-employees/chatbox}/Messages.d.ts +0 -0
  382. /package/dist/{client-v2/ai-employees/chatbox/components → client/ai-employees/chatbox}/ModelSwitcher.d.ts +0 -0
  383. /package/dist/{client-v2/ai-employees/chatbox/components → client/ai-employees/chatbox}/SearchSwitch.d.ts +0 -0
  384. /package/dist/{client-v2/ai-employees/chatbox/components → client/ai-employees/chatbox}/Sender.d.ts +0 -0
  385. /package/dist/{client-v2/ai-employees/chatbox/components → client/ai-employees/chatbox}/UserPrompt.d.ts +0 -0
  386. /package/dist/{client-v2/ai-employees/chatbox/components → client/ai-employees/chatbox/conversations}/Conversations.d.ts +0 -0
  387. /package/dist/{client-v2/ai-employees/chatbox/components → client/ai-employees/chatbox/generative-ui}/ToolModal.d.ts +0 -0
  388. /package/dist/{client-v2 → client}/ai-employees/chatbox/hooks/useChatBoxEffect.d.ts +0 -0
  389. /package/dist/{client-v2 → client}/ai-employees/chatbox/hooks/useLoadMoreObserver.d.ts +0 -0
  390. /package/dist/{client-v2/workflow/components/index.d.ts → client/ai-employees/flow/events/ai-context-selection.d.ts} +0 -0
  391. /package/dist/{client-v2/models/ai-employees → client/ai-employees/flow/models}/AIEmployeeShortcutListModel.d.ts +0 -0
  392. /package/dist/{client-v2/models/ai-employees → client/ai-employees/flow/models}/index.d.ts +0 -0
  393. /package/dist/client-v2/ai-employees/{stores → chatbox/stores}/global-store.d.ts +0 -0
package/client-v2.d.ts CHANGED
@@ -1,2 +1 @@
1
1
  export * from './dist/client-v2';
2
- export { default } from './dist/client-v2';
@@ -1,9 +1,3 @@
1
- ---
2
- title: "API Reference"
3
- description: "Workflow extension API reference: Workflow Model, node execution context, trigger API, variable passing."
4
- keywords: "workflow,API reference,Workflow Model,node context,trigger API,NocoBase"
5
- ---
6
-
7
1
  # API Reference
8
2
 
9
3
  ## Server-side
@@ -35,9 +29,9 @@ Extends and registers a new trigger type.
35
29
 
36
30
  **Parameters**
37
31
 
38
- | Parameter | Type | Description |
39
- | --------- | --------------------------- | ------------------------ |
40
- | `type` | `string` | Trigger type identifier |
32
+ | Parameter | Type | Description |
33
+ | --------- | --------------------------- | ---------------- |
34
+ | `type` | `string` | Trigger type identifier |
41
35
  | `trigger` | `typeof Trigger \| Trigger` | Trigger type or instance |
42
36
 
43
37
  **Example**
@@ -90,9 +84,9 @@ Extends and registers a new node type.
90
84
 
91
85
  **Parameters**
92
86
 
93
- | Parameter | Type | Description |
94
- | ------------- | ----------------------------------- | -------------------------- |
95
- | `type` | `string` | Instruction type identifier |
87
+ | Parameter | Type | Description |
88
+ | ------------- | ----------------------------------- | -------------- |
89
+ | `type` | `string` | Instruction type identifier |
96
90
  | `instruction` | `typeof Instruction \| Instruction` | Instruction type or instance |
97
91
 
98
92
  **Example**
@@ -134,7 +128,7 @@ Triggers a specific workflow. Mainly used in custom triggers to trigger the corr
134
128
  | `workflow` | `WorkflowModel` | The workflow object to be triggered |
135
129
  | `context` | `object` | Context data provided at trigger time |
136
130
 
137
- :::info{title=Note}
131
+ :::info{title=Tip}
138
132
  `context` is currently a required item. If not provided, the workflow will not be triggered.
139
133
  :::
140
134
 
@@ -169,11 +163,11 @@ Resumes a waiting workflow with a specific node job.
169
163
 
170
164
  **Parameters**
171
165
 
172
- | Parameter | Type | Description |
173
- | --------- | ---------- | ---------------------- |
174
- | `job` | `JobModel` | The updated job object |
166
+ | Parameter | Type | Description |
167
+ | ----- | ---------- | ---------------- |
168
+ | `job` | `JobModel` | The updated job object |
175
169
 
176
- :::info{title=Note}
170
+ :::info{title=Tip}
177
171
  The passed job object is generally an updated object, and its `status` is usually updated to a value other than `JOB_STATUS.PENDING`, otherwise it will continue to wait.
178
172
  :::
179
173
 
@@ -185,15 +179,11 @@ See [source code](https://github.com/nocobase/nocobase/blob/main/packages/plugin
185
179
 
186
180
  The base class for triggers, used to extend custom trigger types.
187
181
 
188
- ```ts
189
- import { Trigger } from '@nocobase/plugin-workflow';
190
- ```
191
-
192
- | Parameter | Type | Description |
193
- | ------------- | ----------------------------------------------------------- | ---------------------------------------- |
194
- | `constructor` | `(public readonly workflow: PluginWorkflowServer): Trigger` | Constructor |
195
- | `on?` | `(workflow: WorkflowModel): void` | Event handler after enabling a workflow |
196
- | `off?` | `(workflow: WorkflowModel): void` | Event handler after disabling a workflow |
182
+ | Parameter | Type | Description |
183
+ | ------------- | ----------------------------------------------------------- | ---------------------- |
184
+ | `constructor` | `(public readonly workflow: PluginWorkflowServer): Trigger` | Constructor |
185
+ | `on?` | `(workflow: WorkflowModel): void` | Event handler after enabling a workflow |
186
+ | `off?` | `(workflow: WorkflowModel): void` | Event handler after disabling a workflow |
197
187
 
198
188
  `on`/`off` are used to register/unregister event listeners when a workflow is enabled/disabled. The passed parameter is the workflow instance corresponding to the trigger, which can be processed according to the configuration. Some trigger types that already have globally listened events may not need to implement these two methods. For example, in a scheduled trigger, you can register a timer in `on` and unregister it in `off`.
199
189
 
@@ -201,16 +191,12 @@ import { Trigger } from '@nocobase/plugin-workflow';
201
191
 
202
192
  The base class for instruction types, used to extend custom instruction types.
203
193
 
204
- ```ts
205
- import { Instruction } from '@nocobase/plugin-workflow';
206
- ```
207
-
208
- | Parameter | Type | Description |
209
- | ------------- | --------------------------------------------------------------- | ------------------------------------------------------------------------------ |
210
- | `constructor` | `(public readonly workflow: PluginWorkflowServer): Instruction` | Constructor |
211
- | `run` | `Runner` | Execution logic for the first entry into the node |
212
- | `resume?` | `Runner` | Execution logic for entering the node after resuming from an interruption |
213
- | `getScope?` | `(node: FlowNodeModel, data: any, processor: Processor): any` | Provides the local variable content for the branch generated by the corresponding node |
194
+ | Parameter | Type | Description |
195
+ | ------------- | --------------------------------------------------------------- | ---------------------------------- |
196
+ | `constructor` | `(public readonly workflow: PluginWorkflowServer): Instruction` | Constructor |
197
+ | `run` | `Runner` | Execution logic for the first entry into the node |
198
+ | `resume?` | `Runner` | Execution logic for entering the node after resuming from an interruption |
199
+ | `getScope?` | `(node: FlowNodeModel, data: any, processor: Processor): any` | Provides the local variable content for the branch generated by the corresponding node |
214
200
 
215
201
  **Related Types**
216
202
 
@@ -244,20 +230,16 @@ For `getScope`, you can refer to the [implementation of the loop node](https://g
244
230
 
245
231
  A constant table for workflow execution plan statuses, used to identify the current status of the corresponding execution plan.
246
232
 
247
- ```ts
248
- import { EXECUTION_STATUS } from '@nocobase/plugin-workflow';
249
- ```
250
-
251
- | Constant Name | Meaning |
252
- | ------------------------------- | --------------------------------------- |
253
- | `EXECUTION_STATUS.QUEUEING` | Queueing |
254
- | `EXECUTION_STATUS.STARTED` | Started |
255
- | `EXECUTION_STATUS.RESOLVED` | Resolved |
256
- | `EXECUTION_STATUS.FAILED` | Failed |
257
- | `EXECUTION_STATUS.ERROR` | Error |
258
- | `EXECUTION_STATUS.ABORTED` | Aborted |
259
- | `EXECUTION_STATUS.CANCELED` | Canceled |
260
- | `EXECUTION_STATUS.REJECTED` | Rejected |
233
+ | Constant Name | Meaning |
234
+ | ------------------------------- | -------------------- |
235
+ | `EXECUTION_STATUS.QUEUEING` | Queueing |
236
+ | `EXECUTION_STATUS.STARTED` | Started |
237
+ | `EXECUTION_STATUS.RESOLVED` | Resolved |
238
+ | `EXECUTION_STATUS.FAILED` | Failed |
239
+ | `EXECUTION_STATUS.ERROR` | Error |
240
+ | `EXECUTION_STATUS.ABORTED` | Aborted |
241
+ | `EXECUTION_STATUS.CANCELED` | Canceled |
242
+ | `EXECUTION_STATUS.REJECTED` | Rejected |
261
243
  | `EXECUTION_STATUS.RETRY_NEEDED` | Not successfully executed, retry needed |
262
244
 
263
245
  Except for the first three, all others represent a failed state, but can be used to describe different reasons for failure.
@@ -266,39 +248,33 @@ Except for the first three, all others represent a failed state, but can be used
266
248
 
267
249
  A constant table for workflow node job statuses, used to identify the current status of the corresponding node job. The status generated by the node also affects the status of the entire execution plan.
268
250
 
269
- ```ts
270
- import { JOB_STATUS } from '@nocobase/plugin-workflow';
271
- ```
272
-
273
- | Constant Name | Meaning |
274
- | -------------------------- | ------------------------------------------------------------------------------------------------ |
275
- | `JOB_STATUS.PENDING` | Pending: Execution has reached this node, but the instruction requires it to suspend and wait |
276
- | `JOB_STATUS.RESOLVED` | Resolved |
277
- | `JOB_STATUS.FAILED` | Failed: The execution of this node failed to meet the configured conditions |
278
- | `JOB_STATUS.ERROR` | Error: An unhandled error occurred during the execution of this node |
279
- | `JOB_STATUS.ABORTED` | Aborted: The execution of this node was terminated by other logic after being in a pending state |
280
- | `JOB_STATUS.CANCELED` | Canceled: The execution of this node was manually canceled after being in a pending state |
281
- | `JOB_STATUS.REJECTED` | Rejected: The continuation of this node was manually rejected after being in a pending state |
282
- | `JOB_STATUS.RETRY_NEEDED` | Not successfully executed, retry needed |
251
+ | Constant Name | Meaning |
252
+ | ------------------------- | ---------------------------------------- |
253
+ | `JOB_STATUS.PENDING` | Pending: Execution has reached this node, but the instruction requires it to suspend and wait |
254
+ | `JOB_STATUS.RESOLVED` | Resolved |
255
+ | `JOB_STATUS.FAILED` | Failed: The execution of this node failed to meet the configured conditions |
256
+ | `JOB_STATUS.ERROR` | Error: An unhandled error occurred during the execution of this node |
257
+ | `JOB_STATUS.ABORTED` | Aborted: The execution of this node was terminated by other logic after being in a pending state |
258
+ | `JOB_STATUS.CANCELED` | Canceled: The execution of this node was manually canceled after being in a pending state |
259
+ | `JOB_STATUS.REJECTED` | Rejected: The continuation of this node was manually rejected after being in a pending state |
260
+ | `JOB_STATUS.RETRY_NEEDED` | Not successfully executed, retry needed |
283
261
 
284
262
  ## Client-side
285
263
 
286
264
  The APIs available in the client-side package structure are shown in the following code:
287
265
 
288
266
  ```ts
289
- import PluginWorkflowClientV2, {
267
+ import PluginWorkflowClient, {
290
268
  Trigger,
291
269
  Instruction,
292
- } from '@nocobase/plugin-workflow/client-v2';
270
+ } from '@nocobase/plugin-workflow/client';
293
271
  ```
294
272
 
295
- ### `PluginWorkflowClientV2`
296
-
297
- Workflow client plugin class. Usually obtained via `this.app.pm.get('workflow')`.
273
+ ### `PluginWorkflowClient`
298
274
 
299
275
  #### `registerTrigger()`
300
276
 
301
- Registers the configuration panel for a trigger type.
277
+ Registers the configuration panel for the trigger type.
302
278
 
303
279
  **Signature**
304
280
 
@@ -307,13 +283,13 @@ Registers the configuration panel for a trigger type.
307
283
  **Parameters**
308
284
 
309
285
  | Parameter | Type | Description |
310
- | --- | --- | --- |
311
- | `type` | `string` | Trigger type identifier, consistent with the server-side registered identifier |
286
+ | --------- | --------------------------- | ------------------------------------ |
287
+ | `type` | `string` | Trigger type identifier, consistent with the identifier used for registration |
312
288
  | `trigger` | `typeof Trigger \| Trigger` | Trigger type or instance |
313
289
 
314
290
  #### `registerInstruction()`
315
291
 
316
- Registers the configuration panel for a node type.
292
+ Registers the configuration panel for the node type.
317
293
 
318
294
  **Signature**
319
295
 
@@ -322,8 +298,8 @@ Registers the configuration panel for a node type.
322
298
  **Parameters**
323
299
 
324
300
  | Parameter | Type | Description |
325
- | --- | --- | --- |
326
- | `type` | `string` | Node type identifier, consistent with the server-side registered identifier |
301
+ | ------------- | ----------------------------------- | ---------------------------------- |
302
+ | `type` | `string` | Node type identifier, consistent with the identifier used for registration |
327
303
  | `instruction` | `typeof Instruction \| Instruction` | Node type or instance |
328
304
 
329
305
  #### `registerInstructionGroup()`
@@ -344,221 +320,63 @@ If you need to extend other groups, you can use this method to register them.
344
320
  **Parameters**
345
321
 
346
322
  | Parameter | Type | Description |
347
- | --- | --- | --- |
348
- | `type` | `string` | Node group identifier |
323
+ | --------- | ----------------- | ----------------------------- |
324
+ | `type` | `string` | Node group identifier, consistent with the identifier used for registration |
349
325
  | `group` | `{ label: string }` | Group information, currently only includes the title |
350
326
 
351
327
  **Example**
352
328
 
353
- ```ts
354
- import { Plugin } from '@nocobase/client-v2';
355
-
329
+ ```js
356
330
  export default class YourPluginClient extends Plugin {
357
- async load() {
358
- const pluginWorkflow = this.app.pm.get('workflow');
331
+ load() {
332
+ const pluginWorkflow = this.app.pm.get(PluginWorkflowClient);
333
+
359
334
  pluginWorkflow.registerInstructionGroup('ai', { label: `{{t("AI", { ns: "${NAMESPACE}" })}}` });
360
335
  }
361
336
  }
362
337
  ```
363
338
 
364
- #### `isWorkflowSync()`
365
-
366
- Determines whether a workflow is in synchronous mode.
367
-
368
- **Signature**
369
-
370
- `isWorkflowSync(workflow: object): boolean`
371
-
372
339
  ### `Trigger`
373
340
 
374
341
  The base class for triggers, used to extend custom trigger types.
375
342
 
376
343
  | Parameter | Type | Description |
377
- | --- | --- | --- |
344
+ | --------------- | ---------------------------------------------------------------- | ---------------------------------- |
378
345
  | `title` | `string` | Trigger type name |
379
- | `description?` | `string` | Trigger type description |
380
- | `PresetFieldsetLoader?` | `LoaderOf` | Preset configuration form on creation (lazy-loaded) |
381
- | `FieldsetLoader?` | `LoaderOf` | Full trigger configuration form (lazy-loaded) |
382
- | `TriggerFieldsetLoader?` | `LoaderOf` | Input form for manual execution (lazy-loaded) |
383
- | `validate` | `(config: Record<string, unknown>) => boolean` | Configuration validation; returns `true` if the configuration is valid |
384
- | `createDefaultConfig?` | `() => Record<string, unknown>` | Provides default configuration values |
385
- | `useVariables?` | `(config, options?: UseVariableOptions) => VariableOption[] \| null` | Variable options for trigger context data |
386
- | `getCreateModelMenuItem?` | `(args) => SubModelItem \| SubModelItem[] \| null` | Menu items for creating sub-models on the canvas |
387
- | `useTempAssociationSource?` | `(config, workflow?) => TriggerTempAssociationSource \| null` | Provides a temporary association data source |
346
+ | `fieldset` | `{ [key: string]: ISchema }` | Collection of trigger configuration items |
347
+ | `scope?` | `{ [key: string]: any }` | Collection of objects that may be used in the configuration item Schema |
348
+ | `components?` | `{ [key: string]: React.FC }` | Collection of components that may be used in the configuration item Schema |
349
+ | `useVariables?` | `(config: any, options: UseVariableOptions ) => VariableOptions` | Value accessor for trigger context data |
388
350
 
389
- **Related Types**
390
-
391
- ```ts
392
- export type LoaderOf<P = {}> = () => Promise<{ default: ComponentType<P> }>;
393
- ```
394
-
395
- - If `useVariables` is not set, it means that this trigger type does not provide a value retrieval function, and the trigger's context data cannot be selected in the workflow nodes.
351
+ - If `useVariables` is not set, it means that this type of trigger does not provide a value retrieval function, and the trigger's context data cannot be selected in the workflow nodes.
396
352
 
397
353
  ### `Instruction`
398
354
 
399
355
  The base class for instructions, used to extend custom node types.
400
356
 
401
357
  | Parameter | Type | Description |
402
- | --- | --- | --- |
403
- | `title` | `string` | Node type name |
404
- | `type` | `string` | Node type identifier |
405
- | `group` | `string` | Node type group identifier, options: `'control'`/`'collection'`/`'manual'`/`'extended'` |
406
- | `description?` | `string` | Node type description |
407
- | `icon?` | `JSX.Element` | Node icon |
408
- | `FieldsetLoader?` | `LoaderOf` | Node configuration drawer form (lazy-loaded) |
409
- | `PresetFieldsetLoader?` | `LoaderOf` | Preset configuration form on creation (lazy-loaded) |
410
- | `ComponentLoader?` | `LoaderOf<{ data: any }>` | Custom node rendering on the canvas (lazy-loaded), used for branch nodes and other cases requiring special rendering |
411
- | `branching?` | `boolean \| object \| ((config) => boolean \| object)` | Declares whether the node is a branch node |
412
- | `end?` | `boolean \| ((node) => boolean)` | Declares whether the node is a terminal node |
413
- | `testable?` | `boolean` | Declares whether the node supports test runs |
414
- | `createDefaultConfig?` | `() => object` | Provides default configuration values |
415
- | `useVariables?` | `(node, options?: UseVariableOptions) => VariableOption` | Method for the node to provide variable options |
416
- | `useScopeVariables?` | `(node, options?) => VariableOption[] \| MetaTreeNode[]` | Method for the node to provide branch-scoped variable options |
417
- | `isAvailable?` | `(ctx: NodeAvailableContext) => boolean` | Method to determine whether the node is available |
418
- | `getCreateModelMenuItem?` | `({ node, workflow }) => SubModelItem \| null` | Menu items for creating sub-models on the canvas |
419
- | `useTempAssociationSource?` | `(node) => TempAssociationSource \| null` | Provides a temporary association data source |
358
+ | -------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------ |
359
+ | `group` | `string` | Node type group identifier, currently available options: `'control'`/`'collection'`/`'manual'`/`'extended'` |
360
+ | `fieldset` | `Record<string, ISchema>` | Collection of node configuration items |
361
+ | `scope?` | `Record<string, Function>` | Collection of objects that may be used in the configuration item Schema |
362
+ | `components?` | `Record<string, React.FC>` | Collection of components that may be used in the configuration item Schema |
363
+ | `Component?` | `React.FC` | Custom rendering component for the node |
364
+ | `useVariables?` | `(node, options: UseVariableOptions) => VariableOption` | Method for the node to provide node variable options |
365
+ | `useScopeVariables?` | `(node, options?) => VariableOptions` | Method for the node to provide branch local variable options |
366
+ | `useInitializers?` | `(node) => SchemaInitializerItemType` | Method for the node to provide initializer options |
367
+ | `isAvailable?` | `(ctx: NodeAvailableContext) => boolean` | Method to determine if the node is available |
420
368
 
421
369
  **Related Types**
422
370
 
423
371
  ```ts
424
372
  export type NodeAvailableContext = {
425
- engine: WorkflowPlugin;
426
373
  workflow: object;
427
374
  upstream: object;
428
375
  branchIndex: number;
429
376
  };
430
377
  ```
431
378
 
432
- - If `useVariables` is not set, it means that this node type does not provide a value retrieval function, and the result data of this type of node cannot be selected in the workflow nodes. If the result value is singular (not selectable), you can return static content that expresses the corresponding information (see: [calculation node source code](https://github.com/nocobase/nocobase/blob/develop/packages/plugins/%40nocobase/plugin-workflow/src/client-v2/nodes/calculation.tsx)). If it needs to be selectable (e.g., a property of an Object), you can customize the corresponding selection component output (see: [query data node source code](https://github.com/nocobase/nocobase/blob/develop/packages/plugins/%40nocobase/plugin-workflow/src/client-v2/nodes/query.tsx)).
433
- - `ComponentLoader` is a custom rendering component for the node. When the default node rendering is not sufficient, it can be completely overridden for custom node view rendering. For example, to provide additional branch rendering for branch-type nodes (see: [condition node source code](https://github.com/nocobase/nocobase/blob/develop/packages/plugins/%40nocobase/plugin-workflow/src/client-v2/nodes/condition.tsx)).
434
- - `isAvailable` is mainly used to determine whether a node can be used (added) in the current environment. The current environment includes the workflow plugin instance, the current workflow, upstream nodes, and the current branch index.
435
-
436
- ### Variable Input Components
437
-
438
- The workflow provides a set of variable input components for letting users select workflow variables in node/trigger configuration forms.
439
-
440
- ```ts
441
- import {
442
- WorkflowVariableInput,
443
- WorkflowVariableTextArea,
444
- WorkflowTypedVariableInput,
445
- WorkflowVariableWrapper,
446
- } from '@nocobase/plugin-workflow/client-v2';
447
- ```
448
-
449
- #### `WorkflowVariableInput`
450
-
451
- Variable input that supports selecting a variable and continuing to type content. Suitable for single-line input scenarios that require a mix of variable references and free text.
452
-
453
- ```tsx
454
- import { WorkflowVariableInput } from '@nocobase/plugin-workflow/client-v2';
455
-
456
- <Form.Item name={['config', 'target']} label="Target">
457
- <WorkflowVariableInput />
458
- </Form.Item>
459
- ```
460
-
461
- ![WorkflowVariableInput](https://static-docs.nocobase.com/20260701160110.png)
462
-
463
- **Props**
464
-
465
- | Parameter | Type | Description |
466
- | --- | --- | --- |
467
- | `value?` | `string` | Variable path value, e.g. `{{$jobsMapByNodeKey.xxx.field}}` |
468
- | `onChange?` | `(value: string) => void` | Value change callback |
469
- | `variableOptions?` | `UseWorkflowVariableOptions` | Variable filter options (type filtering, depth, etc.) |
470
- | `disabled?` | `boolean` | Whether disabled |
471
- | `placeholder?` | `string` | Placeholder text |
472
-
473
- #### `WorkflowVariableTextArea`
474
-
475
- Multi-line text area that supports inserting variable references at any cursor position. Suitable for free text scenarios such as HTTP Body, template text, etc.
476
-
477
- ```tsx
478
- import { WorkflowVariableTextArea } from '@nocobase/plugin-workflow/client-v2';
479
-
480
- <Form.Item name={['config', 'body']} label="Body">
481
- <WorkflowVariableTextArea autoSize={{ minRows: 5 }} />
482
- </Form.Item>
483
- ```
484
-
485
- ![WorkflowVariableTextArea](https://static-docs.nocobase.com/20260701160242.png)
486
-
487
- **Props**
488
-
489
- | Parameter | Type | Description |
490
- | --- | --- | --- |
491
- | `value?` | `string` | Text value (may contain variable references) |
492
- | `onChange?` | `(value: string) => void` | Value change callback |
493
- | `variableOptions?` | `UseWorkflowVariableOptions` | Variable filter options |
494
- | `delimiters?` | `readonly [string, string]` | Variable delimiters, defaults to `['{{', '}}']` |
495
-
496
- Inherits other Props from antd `TextArea` (such as `autoSize`, `placeholder`, etc.).
497
-
498
- #### `WorkflowTypedVariableInput`
499
-
500
- Typed input that switches between "constant" and "variable reference" modes. In variable mode, you can only select a variable; you cannot continue typing after selection. In constant mode, five types are supported: `string`, `number`, `boolean`, `date`, and `object`.
501
-
502
- ```tsx
503
- import { WorkflowTypedVariableInput } from '@nocobase/plugin-workflow/client-v2';
504
-
505
- <Form.Item name={['config', 'value']} label="Value">
506
- <WorkflowTypedVariableInput />
507
- </Form.Item>
508
- ```
509
-
510
- ![WorkflowTypedVariableInput](https://static-docs.nocobase.com/20260701160608.png)
511
-
512
- **Props**
513
-
514
- | Parameter | Type | Description |
515
- | --- | --- | --- |
516
- | `variableOptions?` | `UseWorkflowVariableOptions` | Variable filter options |
517
-
518
- Inherits other Props from `TypedVariableInput` (excluding internally used `extraNodes`, `metaTree`, `namespaces`).
519
-
520
- #### `WorkflowVariableWrapper`
521
-
522
- Generic wrapper for substituting different input components in different contexts. For example, when the same field requires different input methods in the trigger node configuration and the node configuration drawer, you can use this component to wrap a native input into a variable-mode-switchable input.
523
-
524
- ```tsx
525
- import { WorkflowVariableWrapper } from '@nocobase/plugin-workflow/client-v2';
526
-
527
- <Form.Item name={['config', 'timeout']} label="Timeout">
528
- <WorkflowVariableWrapper
529
- render={({ value, onChange }) => (
530
- <InputNumber value={value} onChange={onChange} min={0} />
531
- )}
532
- />
533
- </Form.Item>
534
- ```
535
-
536
- **Props**
537
-
538
- | Parameter | Type | Description |
539
- | --- | --- | --- |
540
- | `value?` | `TValue \| string \| null` | Current value (constant value or variable path string) |
541
- | `onChange?` | `(value: TValue \| string \| null) => void` | Value change callback |
542
- | `variableOptions?` | `UseWorkflowVariableOptions` | Variable filter options |
543
- | `render` | `(props: { value?, onChange? }) => ReactNode` | Renders the native input component |
544
- | `clearValue?` | `TValue \| null` | Initial value when switching from variable mode back to constant mode, defaults to `null` |
545
-
546
- ### Collection-related Components
547
-
548
- The workflow also provides a set of collection-related helper components:
549
-
550
- ```ts
551
- import {
552
- CollectionCascader,
553
- AppendsSelect,
554
- FieldsSelect,
555
- SortFieldsInput,
556
- PaginationFields,
557
- } from '@nocobase/plugin-workflow/client-v2';
558
- ```
559
-
560
- - `CollectionCascader` — Data-source-aware collection selector (cascader)
561
- - `AppendsSelect` — Association field preloading selector (tree select)
562
- - `FieldsSelect` — Collection field multi-selector
563
- - `SortFieldsInput` — Sort field input
564
- - `PaginationFields` — Pagination parameter form items
379
+ - If `useVariables` is not set, it means that this node type does not provide a value retrieval function, and the result data of this type of node cannot be selected in the workflow nodes. If the result value is singular (not selectable), you can return static content that expresses the corresponding information (see: [calculation node source code](https://github.com/nocobase/nocobase/blob/main/packages/plugins/@nocobase/plugin-workflow/src/client/nodes/calculation.tsx#L68)). If it needs to be selectable (e.g., a property of an Object), you can customize the corresponding selection component output (see: [create data node source code](https://github.com/nocobase/nocobase/blob/main/packages/plugins/@nocobase/plugin-workflow/src/client/nodes/create.tsx#L41)).
380
+ - `Component` is a custom rendering component for the node. When the default node rendering is not sufficient, it can be completely overridden for custom node view rendering. For example, if you need to provide more action buttons or other interactions for the start node of a branch type, you would use this method (see: [parallel branch source code](https://github.com/nocobase/nocobase/blob/main/packages/plugins/@nocobase/plugin-workflow-parallel/src/client/ParallelInstruction.tsx)).
381
+ - `useInitializers` is used to provide a method for initializing blocks. For example, in a manual node, you can initialize related user blocks based on upstream nodes. If this method is provided, it will be available when initializing blocks in the manual node's interface configuration (see: [create data node source code](https://github.com/nocobase/nocobase/blob/main/packages/plugins/@nocobase/plugin-workflow/src/client/nodes/create.tsx#L71)).
382
+ - `isAvailable` is mainly used to determine whether a node can be used (added) in the current environment. The current environment includes the current workflow, upstream nodes, and the current branch index.
@@ -9,5 +9,4 @@ Extensions are mainly divided into two parts:
9
9
 
10
10
  ## Other Content
11
11
 
12
- - [API Reference](./api.md)
13
- - [v1 to v2 Client-side Migration Guide](./migration.md)
12
+ - [API Reference](./api.md)