@nocobase/flow-engine 2.0.0-alpha.2

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 (597) hide show
  1. package/LICENSE +661 -0
  2. package/README.md +30 -0
  3. package/lib/ContextPathProxy.d.ts +17 -0
  4. package/lib/ContextPathProxy.js +65 -0
  5. package/lib/ElementProxy.d.ts +17 -0
  6. package/lib/ElementProxy.js +93 -0
  7. package/lib/FlowContextProvider.d.ts +24 -0
  8. package/lib/FlowContextProvider.js +82 -0
  9. package/lib/FlowDefinition.d.ts +423 -0
  10. package/lib/FlowDefinition.js +257 -0
  11. package/lib/JSRunner.d.ts +32 -0
  12. package/lib/JSRunner.js +95 -0
  13. package/lib/ReactView.d.ts +20 -0
  14. package/lib/ReactView.js +120 -0
  15. package/lib/ViewScopedFlowEngine.d.ts +23 -0
  16. package/lib/ViewScopedFlowEngine.js +81 -0
  17. package/lib/acl/Acl.d.ts +31 -0
  18. package/lib/acl/Acl.js +115 -0
  19. package/lib/action-registry/BaseActionRegistry.d.ts +23 -0
  20. package/lib/action-registry/BaseActionRegistry.js +57 -0
  21. package/lib/action-registry/EngineActionRegistry.d.ts +20 -0
  22. package/lib/action-registry/EngineActionRegistry.js +47 -0
  23. package/lib/action-registry/ModelActionRegistry.d.ts +34 -0
  24. package/lib/action-registry/ModelActionRegistry.js +79 -0
  25. package/lib/components/DynamicFlowsEditor.d.ts +17 -0
  26. package/lib/components/DynamicFlowsEditor.js +49 -0
  27. package/lib/components/FieldModelRenderer.d.ts +10 -0
  28. package/lib/components/FieldModelRenderer.js +94 -0
  29. package/lib/components/FlowContextSelector.d.ts +11 -0
  30. package/lib/components/FlowContextSelector.js +221 -0
  31. package/lib/components/FlowErrorFallback.d.ts +25 -0
  32. package/lib/components/FlowErrorFallback.js +264 -0
  33. package/lib/components/FlowModelRenderer.d.ts +64 -0
  34. package/lib/components/FlowModelRenderer.js +254 -0
  35. package/lib/components/FormItem.d.ts +18 -0
  36. package/lib/components/FormItem.js +147 -0
  37. package/lib/components/common/FlowSettingsButton.d.ts +11 -0
  38. package/lib/components/common/FlowSettingsButton.js +66 -0
  39. package/lib/components/common/index.d.ts +9 -0
  40. package/lib/components/common/index.js +30 -0
  41. package/lib/components/common/withFlowDesignMode.d.ts +26 -0
  42. package/lib/components/common/withFlowDesignMode.js +61 -0
  43. package/lib/components/dnd/getMousePositionOnElement.d.ts +50 -0
  44. package/lib/components/dnd/getMousePositionOnElement.js +95 -0
  45. package/lib/components/dnd/index.d.ts +24 -0
  46. package/lib/components/dnd/index.js +164 -0
  47. package/lib/components/dnd/moveBlock.d.ts +33 -0
  48. package/lib/components/dnd/moveBlock.js +302 -0
  49. package/lib/components/index.d.ts +18 -0
  50. package/lib/components/index.js +48 -0
  51. package/lib/components/settings/independents/dropdown/FlowsDropdownButton.d.ts +46 -0
  52. package/lib/components/settings/independents/dropdown/FlowsDropdownButton.js +225 -0
  53. package/lib/components/settings/independents/dropdown/index.d.ts +9 -0
  54. package/lib/components/settings/independents/dropdown/index.js +30 -0
  55. package/lib/components/settings/independents/index.d.ts +1 -0
  56. package/lib/components/settings/independents/index.js +30 -0
  57. package/lib/components/settings/index.d.ts +10 -0
  58. package/lib/components/settings/index.js +32 -0
  59. package/lib/components/settings/wrappers/contextual/DefaultSettingsIcon.d.ts +24 -0
  60. package/lib/components/settings/wrappers/contextual/DefaultSettingsIcon.js +501 -0
  61. package/lib/components/settings/wrappers/contextual/FlowsContextMenu.d.ts +45 -0
  62. package/lib/components/settings/wrappers/contextual/FlowsContextMenu.js +231 -0
  63. package/lib/components/settings/wrappers/contextual/FlowsFloatContextMenu.d.ts +111 -0
  64. package/lib/components/settings/wrappers/contextual/FlowsFloatContextMenu.js +484 -0
  65. package/lib/components/settings/wrappers/contextual/StepRequiredSettingsDialog.d.ts +26 -0
  66. package/lib/components/settings/wrappers/contextual/StepRequiredSettingsDialog.js +342 -0
  67. package/lib/components/settings/wrappers/contextual/StepSettings.d.ts +23 -0
  68. package/lib/components/settings/wrappers/contextual/StepSettings.js +110 -0
  69. package/lib/components/settings/wrappers/contextual/StepSettingsDialog.d.ts +20 -0
  70. package/lib/components/settings/wrappers/contextual/StepSettingsDialog.js +206 -0
  71. package/lib/components/settings/wrappers/contextual/StepSettingsDrawer.d.ts +20 -0
  72. package/lib/components/settings/wrappers/contextual/StepSettingsDrawer.js +47 -0
  73. package/lib/components/settings/wrappers/contextual/index.d.ts +14 -0
  74. package/lib/components/settings/wrappers/contextual/index.js +40 -0
  75. package/lib/components/settings/wrappers/embedded/FlowSettings.d.ts +33 -0
  76. package/lib/components/settings/wrappers/embedded/FlowSettings.js +207 -0
  77. package/lib/components/settings/wrappers/embedded/FlowsSettings.d.ts +41 -0
  78. package/lib/components/settings/wrappers/embedded/FlowsSettings.js +84 -0
  79. package/lib/components/settings/wrappers/embedded/FlowsSettingsContent.d.ts +16 -0
  80. package/lib/components/settings/wrappers/embedded/FlowsSettingsContent.js +88 -0
  81. package/lib/components/settings/wrappers/embedded/index.d.ts +10 -0
  82. package/lib/components/settings/wrappers/embedded/index.js +32 -0
  83. package/lib/components/settings/wrappers/index.d.ts +2 -0
  84. package/lib/components/settings/wrappers/index.js +32 -0
  85. package/lib/components/subModel/AddSubModelButton.d.ts +62 -0
  86. package/lib/components/subModel/AddSubModelButton.js +415 -0
  87. package/lib/components/subModel/LazyDropdown.d.ts +55 -0
  88. package/lib/components/subModel/LazyDropdown.js +524 -0
  89. package/lib/components/subModel/index.d.ts +10 -0
  90. package/lib/components/subModel/index.js +32 -0
  91. package/lib/components/subModel/utils.d.ts +34 -0
  92. package/lib/components/subModel/utils.js +287 -0
  93. package/lib/components/variables/InlineVariableTag.d.ts +21 -0
  94. package/lib/components/variables/InlineVariableTag.js +123 -0
  95. package/lib/components/variables/SlateVariableEditor.d.ts +46 -0
  96. package/lib/components/variables/SlateVariableEditor.js +302 -0
  97. package/lib/components/variables/VariableInput.d.ts +11 -0
  98. package/lib/components/variables/VariableInput.js +322 -0
  99. package/lib/components/variables/VariableTag.d.ts +11 -0
  100. package/lib/components/variables/VariableTag.js +148 -0
  101. package/lib/components/variables/VariableTrigger.d.ts +20 -0
  102. package/lib/components/variables/VariableTrigger.js +136 -0
  103. package/lib/components/variables/index.d.ts +15 -0
  104. package/lib/components/variables/index.js +53 -0
  105. package/lib/components/variables/types.d.ts +93 -0
  106. package/lib/components/variables/types.js +24 -0
  107. package/lib/components/variables/useResolvedMetaTree.d.ts +19 -0
  108. package/lib/components/variables/useResolvedMetaTree.js +91 -0
  109. package/lib/components/variables/utils.d.ts +22 -0
  110. package/lib/components/variables/utils.js +177 -0
  111. package/lib/data-source/index.d.ts +180 -0
  112. package/lib/data-source/index.js +733 -0
  113. package/lib/data-source/jioToJoiSchema.d.ts +19 -0
  114. package/lib/data-source/jioToJoiSchema.js +114 -0
  115. package/lib/decorators/index.d.ts +9 -0
  116. package/lib/decorators/index.js +36 -0
  117. package/lib/decorators/largeField.d.ts +9 -0
  118. package/lib/decorators/largeField.js +42 -0
  119. package/lib/emitter.d.ts +16 -0
  120. package/lib/emitter.js +58 -0
  121. package/lib/event-registry/BaseEventRegistry.d.ts +22 -0
  122. package/lib/event-registry/BaseEventRegistry.js +57 -0
  123. package/lib/event-registry/EngineEventRegistry.d.ts +19 -0
  124. package/lib/event-registry/EngineEventRegistry.js +47 -0
  125. package/lib/event-registry/ModelEventRegistry.d.ts +33 -0
  126. package/lib/event-registry/ModelEventRegistry.js +79 -0
  127. package/lib/executor/FlowExecutor.d.ts +26 -0
  128. package/lib/executor/FlowExecutor.js +262 -0
  129. package/lib/flow-registry/BaseFlowRegistry.d.ts +46 -0
  130. package/lib/flow-registry/BaseFlowRegistry.js +86 -0
  131. package/lib/flow-registry/GlobalFlowRegistry.d.ts +22 -0
  132. package/lib/flow-registry/GlobalFlowRegistry.js +95 -0
  133. package/lib/flow-registry/InstanceFlowRegistry.d.ts +21 -0
  134. package/lib/flow-registry/InstanceFlowRegistry.js +59 -0
  135. package/lib/flow-registry/index.d.ts +11 -0
  136. package/lib/flow-registry/index.js +34 -0
  137. package/lib/flowContext.d.ts +215 -0
  138. package/lib/flowContext.js +1266 -0
  139. package/lib/flowEngine.d.ts +340 -0
  140. package/lib/flowEngine.js +781 -0
  141. package/lib/flowI18n.d.ts +46 -0
  142. package/lib/flowI18n.js +117 -0
  143. package/lib/flowSettings.d.ts +266 -0
  144. package/lib/flowSettings.js +850 -0
  145. package/lib/hooks/index.d.ts +14 -0
  146. package/lib/hooks/index.js +40 -0
  147. package/lib/hooks/useApplyAutoFlows.d.ts +21 -0
  148. package/lib/hooks/useApplyAutoFlows.js +62 -0
  149. package/lib/hooks/useFlowModel.d.ts +29 -0
  150. package/lib/hooks/useFlowModel.js +72 -0
  151. package/lib/hooks/useFlowModelById.d.ts +11 -0
  152. package/lib/hooks/useFlowModelById.js +61 -0
  153. package/lib/hooks/useFlowSettingsContext.d.ts +20 -0
  154. package/lib/hooks/useFlowSettingsContext.js +61 -0
  155. package/lib/hooks/useFlowStep.d.ts +17 -0
  156. package/lib/hooks/useFlowStep.js +56 -0
  157. package/lib/hooks/useNiceDropdownMaxHeight.d.ts +13 -0
  158. package/lib/hooks/useNiceDropdownMaxHeight.js +52 -0
  159. package/lib/index.d.ts +27 -0
  160. package/lib/index.js +73 -0
  161. package/lib/locale/en-US.json +61 -0
  162. package/lib/locale/index.d.ts +141 -0
  163. package/lib/locale/index.js +70 -0
  164. package/lib/locale/zh-CN.json +61 -0
  165. package/lib/models/CollectionFieldModel.d.ts +50 -0
  166. package/lib/models/CollectionFieldModel.js +242 -0
  167. package/lib/models/DisplayItemModel.d.ts +12 -0
  168. package/lib/models/DisplayItemModel.js +41 -0
  169. package/lib/models/EditableItemModel.d.ts +12 -0
  170. package/lib/models/EditableItemModel.js +41 -0
  171. package/lib/models/FilterableItemModel.d.ts +12 -0
  172. package/lib/models/FilterableItemModel.js +41 -0
  173. package/lib/models/flowModel.d.ts +344 -0
  174. package/lib/models/flowModel.js +1133 -0
  175. package/lib/models/forkFlowModel.d.ts +83 -0
  176. package/lib/models/forkFlowModel.js +257 -0
  177. package/lib/models/index.d.ts +14 -0
  178. package/lib/models/index.js +40 -0
  179. package/lib/provider.d.ts +22 -0
  180. package/lib/provider.js +114 -0
  181. package/lib/resources/apiResource.d.ts +34 -0
  182. package/lib/resources/apiResource.js +153 -0
  183. package/lib/resources/baseRecordResource.d.ts +61 -0
  184. package/lib/resources/baseRecordResource.js +264 -0
  185. package/lib/resources/filterItem.d.ts +33 -0
  186. package/lib/resources/filterItem.js +93 -0
  187. package/lib/resources/flowResource.d.ts +45 -0
  188. package/lib/resources/flowResource.js +146 -0
  189. package/lib/resources/index.d.ts +15 -0
  190. package/lib/resources/index.js +42 -0
  191. package/lib/resources/multiRecordResource.d.ts +53 -0
  192. package/lib/resources/multiRecordResource.js +230 -0
  193. package/lib/resources/singleRecordResource.d.ts +23 -0
  194. package/lib/resources/singleRecordResource.js +111 -0
  195. package/lib/resources/sqlResource.d.ts +73 -0
  196. package/lib/resources/sqlResource.js +294 -0
  197. package/lib/runjs-context/contexts/FlowRunJSContext.d.ts +38 -0
  198. package/lib/runjs-context/contexts/FlowRunJSContext.js +217 -0
  199. package/lib/runjs-context/contexts/FormJSFieldItemRunJSContext.d.ts +16 -0
  200. package/lib/runjs-context/contexts/FormJSFieldItemRunJSContext.js +66 -0
  201. package/lib/runjs-context/contexts/JSBlockRunJSContext.d.ts +16 -0
  202. package/lib/runjs-context/contexts/JSBlockRunJSContext.js +78 -0
  203. package/lib/runjs-context/contexts/JSCollectionActionRunJSContext.d.ts +12 -0
  204. package/lib/runjs-context/contexts/JSCollectionActionRunJSContext.js +59 -0
  205. package/lib/runjs-context/contexts/JSFieldRunJSContext.d.ts +16 -0
  206. package/lib/runjs-context/contexts/JSFieldRunJSContext.js +70 -0
  207. package/lib/runjs-context/contexts/JSItemRunJSContext.d.ts +16 -0
  208. package/lib/runjs-context/contexts/JSItemRunJSContext.js +66 -0
  209. package/lib/runjs-context/contexts/JSRecordActionRunJSContext.d.ts +12 -0
  210. package/lib/runjs-context/contexts/JSRecordActionRunJSContext.js +61 -0
  211. package/lib/runjs-context/contexts/LinkageRunJSContext.d.ts +12 -0
  212. package/lib/runjs-context/contexts/LinkageRunJSContext.js +62 -0
  213. package/lib/runjs-context/helpers.d.ts +17 -0
  214. package/lib/runjs-context/helpers.js +79 -0
  215. package/lib/runjs-context/index.d.ts +19 -0
  216. package/lib/runjs-context/index.js +57 -0
  217. package/lib/runjs-context/registry.d.ts +17 -0
  218. package/lib/runjs-context/registry.js +93 -0
  219. package/lib/runjs-context/snippets/global/api-request-get.snippet.d.ts +16 -0
  220. package/lib/runjs-context/snippets/global/api-request-get.snippet.js +42 -0
  221. package/lib/runjs-context/snippets/global/api-request-post.snippet.d.ts +16 -0
  222. package/lib/runjs-context/snippets/global/api-request-post.snippet.js +42 -0
  223. package/lib/runjs-context/snippets/global/console-log-ctx.snippet.d.ts +16 -0
  224. package/lib/runjs-context/snippets/global/console-log-ctx.snippet.js +41 -0
  225. package/lib/runjs-context/snippets/global/copy-record-json.snippet.d.ts +11 -0
  226. package/lib/runjs-context/snippets/global/copy-record-json.snippet.js +42 -0
  227. package/lib/runjs-context/snippets/global/copy-to-clipboard.snippet.d.ts +11 -0
  228. package/lib/runjs-context/snippets/global/copy-to-clipboard.snippet.js +42 -0
  229. package/lib/runjs-context/snippets/global/log-json-record.snippet.d.ts +11 -0
  230. package/lib/runjs-context/snippets/global/log-json-record.snippet.js +42 -0
  231. package/lib/runjs-context/snippets/global/message-error.snippet.d.ts +11 -0
  232. package/lib/runjs-context/snippets/global/message-error.snippet.js +41 -0
  233. package/lib/runjs-context/snippets/global/message-success.snippet.d.ts +11 -0
  234. package/lib/runjs-context/snippets/global/message-success.snippet.js +41 -0
  235. package/lib/runjs-context/snippets/global/notification-open.snippet.d.ts +16 -0
  236. package/lib/runjs-context/snippets/global/notification-open.snippet.js +43 -0
  237. package/lib/runjs-context/snippets/global/open-view-dialog.snippet.d.ts +11 -0
  238. package/lib/runjs-context/snippets/global/open-view-dialog.snippet.js +47 -0
  239. package/lib/runjs-context/snippets/global/open-view-drawer.snippet.d.ts +11 -0
  240. package/lib/runjs-context/snippets/global/open-view-drawer.snippet.js +47 -0
  241. package/lib/runjs-context/snippets/global/requireAsync.snippet.d.ts +16 -0
  242. package/lib/runjs-context/snippets/global/requireAsync.snippet.js +46 -0
  243. package/lib/runjs-context/snippets/global/sleep.snippet.d.ts +16 -0
  244. package/lib/runjs-context/snippets/global/sleep.snippet.js +43 -0
  245. package/lib/runjs-context/snippets/global/try-catch-async.snippet.d.ts +16 -0
  246. package/lib/runjs-context/snippets/global/try-catch-async.snippet.js +44 -0
  247. package/lib/runjs-context/snippets/global/view-navigation-push.snippet.d.ts +11 -0
  248. package/lib/runjs-context/snippets/global/view-navigation-push.snippet.js +44 -0
  249. package/lib/runjs-context/snippets/global/window-open.snippet.d.ts +16 -0
  250. package/lib/runjs-context/snippets/global/window-open.snippet.js +41 -0
  251. package/lib/runjs-context/snippets/index.d.ts +11 -0
  252. package/lib/runjs-context/snippets/index.js +94 -0
  253. package/lib/runjs-context/snippets/libs/echarts-init.snippet.d.ts +15 -0
  254. package/lib/runjs-context/snippets/libs/echarts-init.snippet.js +46 -0
  255. package/lib/runjs-context/snippets/scene/actions/collection-selected-count.snippet.d.ts +15 -0
  256. package/lib/runjs-context/snippets/scene/actions/collection-selected-count.snippet.js +44 -0
  257. package/lib/runjs-context/snippets/scene/actions/iterate-selected-rows.snippet.d.ts +15 -0
  258. package/lib/runjs-context/snippets/scene/actions/iterate-selected-rows.snippet.js +43 -0
  259. package/lib/runjs-context/snippets/scene/actions/record-id-message.snippet.d.ts +15 -0
  260. package/lib/runjs-context/snippets/scene/actions/record-id-message.snippet.js +43 -0
  261. package/lib/runjs-context/snippets/scene/actions/run-action-basic.snippet.d.ts +15 -0
  262. package/lib/runjs-context/snippets/scene/actions/run-action-basic.snippet.js +40 -0
  263. package/lib/runjs-context/snippets/scene/jsblock/add-event-listener.snippet.d.ts +15 -0
  264. package/lib/runjs-context/snippets/scene/jsblock/add-event-listener.snippet.js +46 -0
  265. package/lib/runjs-context/snippets/scene/jsblock/append-style.snippet.d.ts +15 -0
  266. package/lib/runjs-context/snippets/scene/jsblock/append-style.snippet.js +42 -0
  267. package/lib/runjs-context/snippets/scene/jsblock/jsx-mount.snippet.d.ts +15 -0
  268. package/lib/runjs-context/snippets/scene/jsblock/jsx-mount.snippet.js +46 -0
  269. package/lib/runjs-context/snippets/scene/jsblock/jsx-unmount.snippet.d.ts +15 -0
  270. package/lib/runjs-context/snippets/scene/jsblock/jsx-unmount.snippet.js +41 -0
  271. package/lib/runjs-context/snippets/scene/jsblock/render-basic.snippet.d.ts +15 -0
  272. package/lib/runjs-context/snippets/scene/jsblock/render-basic.snippet.js +41 -0
  273. package/lib/runjs-context/snippets/scene/jsblock/render-button-handler.snippet.d.ts +15 -0
  274. package/lib/runjs-context/snippets/scene/jsblock/render-button-handler.snippet.js +46 -0
  275. package/lib/runjs-context/snippets/scene/jsblock/render-card.snippet.d.ts +11 -0
  276. package/lib/runjs-context/snippets/scene/jsblock/render-card.snippet.js +45 -0
  277. package/lib/runjs-context/snippets/scene/jsblock/render-react.snippet.d.ts +15 -0
  278. package/lib/runjs-context/snippets/scene/jsblock/render-react.snippet.js +56 -0
  279. package/lib/runjs-context/snippets/scene/jsfield/color-by-value.snippet.d.ts +15 -0
  280. package/lib/runjs-context/snippets/scene/jsfield/color-by-value.snippet.js +42 -0
  281. package/lib/runjs-context/snippets/scene/jsfield/format-number.snippet.d.ts +15 -0
  282. package/lib/runjs-context/snippets/scene/jsfield/format-number.snippet.js +41 -0
  283. package/lib/runjs-context/snippets/scene/jsfield/innerHTML-value.snippet.d.ts +15 -0
  284. package/lib/runjs-context/snippets/scene/jsfield/innerHTML-value.snippet.js +40 -0
  285. package/lib/runjs-context/snippets/scene/jsitem/render-basic.snippet.d.ts +15 -0
  286. package/lib/runjs-context/snippets/scene/jsitem/render-basic.snippet.js +44 -0
  287. package/lib/runjs-context/snippets/scene/linkage/set-disabled.snippet.d.ts +15 -0
  288. package/lib/runjs-context/snippets/scene/linkage/set-disabled.snippet.js +60 -0
  289. package/lib/runjs-context/snippets/scene/linkage/set-field-value.snippet.d.ts +15 -0
  290. package/lib/runjs-context/snippets/scene/linkage/set-field-value.snippet.js +59 -0
  291. package/lib/runjs-context/snippets/scene/linkage/set-required.snippet.d.ts +15 -0
  292. package/lib/runjs-context/snippets/scene/linkage/set-required.snippet.js +60 -0
  293. package/lib/runjs-context/snippets/scene/linkage/toggle-visible.snippet.d.ts +15 -0
  294. package/lib/runjs-context/snippets/scene/linkage/toggle-visible.snippet.js +60 -0
  295. package/lib/runjs-context/snippets/types.d.ts +16 -0
  296. package/lib/runjs-context/snippets/types.js +24 -0
  297. package/lib/types.d.ts +398 -0
  298. package/lib/types.js +43 -0
  299. package/lib/utils/autoFlowError.d.ts +16 -0
  300. package/lib/utils/autoFlowError.js +53 -0
  301. package/lib/utils/constants.d.ts +29 -0
  302. package/lib/utils/constants.js +77 -0
  303. package/lib/utils/context.d.ts +40 -0
  304. package/lib/utils/context.js +63 -0
  305. package/lib/utils/createCollectionContextMeta.d.ts +11 -0
  306. package/lib/utils/createCollectionContextMeta.js +117 -0
  307. package/lib/utils/exceptions.d.ts +22 -0
  308. package/lib/utils/exceptions.js +62 -0
  309. package/lib/utils/flow-definitions.d.ts +11 -0
  310. package/lib/utils/flow-definitions.js +40 -0
  311. package/lib/utils/index.d.ts +22 -0
  312. package/lib/utils/index.js +117 -0
  313. package/lib/utils/inheritance.d.ts +16 -0
  314. package/lib/utils/inheritance.js +53 -0
  315. package/lib/utils/params-resolvers.d.ts +51 -0
  316. package/lib/utils/params-resolvers.js +309 -0
  317. package/lib/utils/parsePathnameToViewParams.d.ts +34 -0
  318. package/lib/utils/parsePathnameToViewParams.js +84 -0
  319. package/lib/utils/safeGlobals.d.ts +16 -0
  320. package/lib/utils/safeGlobals.js +179 -0
  321. package/lib/utils/schema-utils.d.ts +40 -0
  322. package/lib/utils/schema-utils.js +161 -0
  323. package/lib/utils/serverContextParams.d.ts +28 -0
  324. package/lib/utils/serverContextParams.js +106 -0
  325. package/lib/utils/setupRuntimeContextSteps.d.ts +19 -0
  326. package/lib/utils/setupRuntimeContextSteps.js +88 -0
  327. package/lib/utils/translation.d.ts +18 -0
  328. package/lib/utils/translation.js +58 -0
  329. package/lib/utils/variablesParams.d.ts +51 -0
  330. package/lib/utils/variablesParams.js +150 -0
  331. package/lib/views/DialogComponent.d.ts +22 -0
  332. package/lib/views/DialogComponent.js +98 -0
  333. package/lib/views/DrawerComponent.d.ts +11 -0
  334. package/lib/views/DrawerComponent.js +101 -0
  335. package/lib/views/FlowView.d.ts +76 -0
  336. package/lib/views/FlowView.js +81 -0
  337. package/lib/views/PageComponent.d.ts +10 -0
  338. package/lib/views/PageComponent.js +167 -0
  339. package/lib/views/ViewNavigation.d.ts +45 -0
  340. package/lib/views/ViewNavigation.js +97 -0
  341. package/lib/views/createViewMeta.d.ts +16 -0
  342. package/lib/views/createViewMeta.js +171 -0
  343. package/lib/views/index.d.ts +13 -0
  344. package/lib/views/index.js +48 -0
  345. package/lib/views/useDialog.d.ts +32 -0
  346. package/lib/views/useDialog.js +199 -0
  347. package/lib/views/useDrawer.d.ts +33 -0
  348. package/lib/views/useDrawer.js +206 -0
  349. package/lib/views/usePage.d.ts +32 -0
  350. package/lib/views/usePage.js +193 -0
  351. package/lib/views/usePatchElement.d.ts +10 -0
  352. package/lib/views/usePatchElement.js +54 -0
  353. package/lib/views/usePopover.d.ts +17 -0
  354. package/lib/views/usePopover.js +159 -0
  355. package/package.json +37 -0
  356. package/src/ContextPathProxy.ts +45 -0
  357. package/src/ElementProxy.ts +69 -0
  358. package/src/FlowContextProvider.tsx +40 -0
  359. package/src/FlowDefinition.ts +275 -0
  360. package/src/JSRunner.ts +84 -0
  361. package/src/ReactView.tsx +104 -0
  362. package/src/ViewScopedFlowEngine.ts +75 -0
  363. package/src/__tests__/ElementProxy.test.ts +51 -0
  364. package/src/__tests__/JSRunner.test.ts +92 -0
  365. package/src/__tests__/ReactView.test.tsx +63 -0
  366. package/src/__tests__/context-path-proxy.test.ts +35 -0
  367. package/src/__tests__/flow-engine.test.ts +189 -0
  368. package/src/__tests__/flowContext.test.ts +2012 -0
  369. package/src/__tests__/flowEngine.saveModel.test.ts +171 -0
  370. package/src/__tests__/flowI18n.test.ts +28 -0
  371. package/src/__tests__/flowModel.getFlows.test.ts +61 -0
  372. package/src/__tests__/flowModel.openView.navigation.test.ts +78 -0
  373. package/src/__tests__/flowRuntimeContext.test.ts +187 -0
  374. package/src/__tests__/flowSettings.open.test.tsx +1920 -0
  375. package/src/__tests__/flowSettings.test.ts +566 -0
  376. package/src/__tests__/globalFlowRegistry.test.ts +77 -0
  377. package/src/__tests__/isFieldInterfaceMatch.test.ts +51 -0
  378. package/src/__tests__/metaTreeNodeCache.test.ts +234 -0
  379. package/src/__tests__/path-aggregation.test.ts +85 -0
  380. package/src/__tests__/provider.test.tsx +28 -0
  381. package/src/__tests__/renderHiddenInConfig.test.tsx +91 -0
  382. package/src/__tests__/runjsContext.test.ts +60 -0
  383. package/src/__tests__/viewScopedFlowEngine.test.ts +212 -0
  384. package/src/acl/Acl.tsx +109 -0
  385. package/src/acl/__tests__/Acl.test.tsx +72 -0
  386. package/src/action-registry/BaseActionRegistry.ts +46 -0
  387. package/src/action-registry/EngineActionRegistry.ts +32 -0
  388. package/src/action-registry/ModelActionRegistry.ts +75 -0
  389. package/src/action-registry/__tests__/engineActionRegistry.test.ts +43 -0
  390. package/src/action-registry/__tests__/modelActionRegistry.test.ts +107 -0
  391. package/src/components/DynamicFlowsEditor.tsx +318 -0
  392. package/src/components/FieldModelRenderer.tsx +62 -0
  393. package/src/components/FlowContextSelector.tsx +255 -0
  394. package/src/components/FlowErrorFallback.tsx +316 -0
  395. package/src/components/FlowModelRenderer.tsx +428 -0
  396. package/src/components/FormItem.tsx +130 -0
  397. package/src/components/__tests__/flow-model-render-error-fallback.test.tsx +226 -0
  398. package/src/components/common/FlowSettingsButton.tsx +30 -0
  399. package/src/components/common/index.ts +10 -0
  400. package/src/components/common/withFlowDesignMode.tsx +49 -0
  401. package/src/components/dnd/getMousePositionOnElement.ts +115 -0
  402. package/src/components/dnd/index.tsx +128 -0
  403. package/src/components/dnd/moveBlock.ts +379 -0
  404. package/src/components/index.ts +20 -0
  405. package/src/components/settings/independents/dropdown/FlowsDropdownButton.tsx +279 -0
  406. package/src/components/settings/independents/dropdown/index.ts +10 -0
  407. package/src/components/settings/independents/index.ts +2 -0
  408. package/src/components/settings/index.ts +11 -0
  409. package/src/components/settings/wrappers/contextual/DefaultSettingsIcon.tsx +617 -0
  410. package/src/components/settings/wrappers/contextual/FlowsContextMenu.tsx +292 -0
  411. package/src/components/settings/wrappers/contextual/FlowsFloatContextMenu.tsx +655 -0
  412. package/src/components/settings/wrappers/contextual/StepRequiredSettingsDialog.tsx +446 -0
  413. package/src/components/settings/wrappers/contextual/StepSettings.tsx +109 -0
  414. package/src/components/settings/wrappers/contextual/StepSettingsDialog.tsx +217 -0
  415. package/src/components/settings/wrappers/contextual/StepSettingsDrawer.tsx +32 -0
  416. package/src/components/settings/wrappers/contextual/index.ts +15 -0
  417. package/src/components/settings/wrappers/embedded/FlowSettings.tsx +258 -0
  418. package/src/components/settings/wrappers/embedded/FlowsSettings.tsx +111 -0
  419. package/src/components/settings/wrappers/embedded/FlowsSettingsContent.tsx +96 -0
  420. package/src/components/settings/wrappers/embedded/index.ts +11 -0
  421. package/src/components/settings/wrappers/index.ts +5 -0
  422. package/src/components/subModel/AddSubModelButton.tsx +575 -0
  423. package/src/components/subModel/LazyDropdown.tsx +714 -0
  424. package/src/components/subModel/__tests__/AddSubModelButton.test.tsx +1185 -0
  425. package/src/components/subModel/__tests__/buildWrapperFieldChildren.test.ts +192 -0
  426. package/src/components/subModel/__tests__/utils.test.ts +425 -0
  427. package/src/components/subModel/index.ts +12 -0
  428. package/src/components/subModel/utils.ts +278 -0
  429. package/src/components/variables/InlineVariableTag.tsx +97 -0
  430. package/src/components/variables/SlateVariableEditor.tsx +384 -0
  431. package/src/components/variables/VariableInput.tsx +342 -0
  432. package/src/components/variables/VariableTag.tsx +123 -0
  433. package/src/components/variables/VariableTrigger.tsx +116 -0
  434. package/src/components/variables/__tests__/FlowContextSelector.test.tsx +553 -0
  435. package/src/components/variables/__tests__/VariableInput.test.tsx +550 -0
  436. package/src/components/variables/__tests__/VariableTag.test.tsx +347 -0
  437. package/src/components/variables/__tests__/test-utils.tsx +62 -0
  438. package/src/components/variables/__tests__/utils.test.ts +310 -0
  439. package/src/components/variables/index.ts +16 -0
  440. package/src/components/variables/types.ts +100 -0
  441. package/src/components/variables/useResolvedMetaTree.ts +76 -0
  442. package/src/components/variables/utils.ts +192 -0
  443. package/src/data-source/__tests__/collection.test.ts +58 -0
  444. package/src/data-source/__tests__/index.test.ts +82 -0
  445. package/src/data-source/__tests__/jioToJoiSchema.test.ts +56 -0
  446. package/src/data-source/index.ts +812 -0
  447. package/src/data-source/jioToJoiSchema.ts +103 -0
  448. package/src/decorators/index.ts +10 -0
  449. package/src/decorators/largeField.ts +14 -0
  450. package/src/emitter.ts +33 -0
  451. package/src/event-registry/BaseEventRegistry.ts +40 -0
  452. package/src/event-registry/EngineEventRegistry.ts +26 -0
  453. package/src/event-registry/ModelEventRegistry.ts +69 -0
  454. package/src/event-registry/__tests__/engineEventRegistry.test.ts +48 -0
  455. package/src/executor/FlowExecutor.ts +256 -0
  456. package/src/executor/__tests__/eventStep.test.ts +157 -0
  457. package/src/executor/__tests__/flowExecutor.test.ts +163 -0
  458. package/src/flow-registry/BaseFlowRegistry.ts +91 -0
  459. package/src/flow-registry/GlobalFlowRegistry.ts +82 -0
  460. package/src/flow-registry/InstanceFlowRegistry.ts +39 -0
  461. package/src/flow-registry/__tests__/globalFlowRegistry.test.ts +141 -0
  462. package/src/flow-registry/__tests__/instance-and-global-registry.test.ts +67 -0
  463. package/src/flow-registry/__tests__/instanceFlowRegistry.test.ts +83 -0
  464. package/src/flow-registry/index.ts +12 -0
  465. package/src/flowContext.ts +1639 -0
  466. package/src/flowEngine.ts +905 -0
  467. package/src/flowI18n.ts +96 -0
  468. package/src/flowSettings.ts +1045 -0
  469. package/src/hooks/index.ts +15 -0
  470. package/src/hooks/useApplyAutoFlows.ts +51 -0
  471. package/src/hooks/useFlowModel.tsx +59 -0
  472. package/src/hooks/useFlowModelById.ts +37 -0
  473. package/src/hooks/useFlowSettingsContext.tsx +37 -0
  474. package/src/hooks/useFlowStep.tsx +19 -0
  475. package/src/hooks/useNiceDropdownMaxHeight.ts +34 -0
  476. package/src/index.ts +38 -0
  477. package/src/locale/en-US.json +61 -0
  478. package/src/locale/index.ts +38 -0
  479. package/src/locale/zh-CN.json +61 -0
  480. package/src/models/CollectionFieldModel.tsx +269 -0
  481. package/src/models/DisplayItemModel.tsx +13 -0
  482. package/src/models/EditableItemModel.tsx +13 -0
  483. package/src/models/FilterableItemModel.tsx +13 -0
  484. package/src/models/__tests__/CollectionFieldModel.test.ts +122 -0
  485. package/src/models/__tests__/defaultParams-on-create.test.ts +83 -0
  486. package/src/models/__tests__/flow-model-oninit.test.ts +44 -0
  487. package/src/models/__tests__/flowModel.actions.integration.test.ts +100 -0
  488. package/src/models/__tests__/flowModel.getFlows.sort.test.ts +100 -0
  489. package/src/models/__tests__/flowModel.test.ts +2746 -0
  490. package/src/models/__tests__/flowRegistry.test.ts +512 -0
  491. package/src/models/__tests__/forkFlowModel.test.ts +1047 -0
  492. package/src/models/__tests__/model-actions.test.ts +70 -0
  493. package/src/models/__tests__/model-events.test.ts +69 -0
  494. package/src/models/flowModel.tsx +1398 -0
  495. package/src/models/forkFlowModel.ts +287 -0
  496. package/src/models/index.ts +17 -0
  497. package/src/provider.tsx +101 -0
  498. package/src/resources/__tests__/apiResource.test.ts +201 -0
  499. package/src/resources/__tests__/baseRecordResource.test.ts +262 -0
  500. package/src/resources/__tests__/filterItem.test.ts +260 -0
  501. package/src/resources/__tests__/flowResource.test.ts +127 -0
  502. package/src/resources/apiResource.ts +148 -0
  503. package/src/resources/baseRecordResource.ts +279 -0
  504. package/src/resources/filterItem.ts +74 -0
  505. package/src/resources/flowResource.ts +143 -0
  506. package/src/resources/index.ts +17 -0
  507. package/src/resources/multiRecordResource.ts +219 -0
  508. package/src/resources/singleRecordResource.ts +83 -0
  509. package/src/resources/sqlResource.ts +299 -0
  510. package/src/runjs-context/contexts/FlowRunJSContext.ts +190 -0
  511. package/src/runjs-context/contexts/FormJSFieldItemRunJSContext.ts +39 -0
  512. package/src/runjs-context/contexts/JSBlockRunJSContext.ts +52 -0
  513. package/src/runjs-context/contexts/JSCollectionActionRunJSContext.ts +32 -0
  514. package/src/runjs-context/contexts/JSFieldRunJSContext.ts +43 -0
  515. package/src/runjs-context/contexts/JSItemRunJSContext.ts +39 -0
  516. package/src/runjs-context/contexts/JSRecordActionRunJSContext.ts +34 -0
  517. package/src/runjs-context/contexts/LinkageRunJSContext.ts +35 -0
  518. package/src/runjs-context/helpers.ts +56 -0
  519. package/src/runjs-context/index.ts +20 -0
  520. package/src/runjs-context/registry.ts +65 -0
  521. package/src/runjs-context/snippets/global/api-request-get.snippet.ts +20 -0
  522. package/src/runjs-context/snippets/global/api-request-post.snippet.ts +20 -0
  523. package/src/runjs-context/snippets/global/console-log-ctx.snippet.ts +19 -0
  524. package/src/runjs-context/snippets/global/copy-record-json.snippet.ts +21 -0
  525. package/src/runjs-context/snippets/global/copy-to-clipboard.snippet.ts +21 -0
  526. package/src/runjs-context/snippets/global/log-json-record.snippet.ts +21 -0
  527. package/src/runjs-context/snippets/global/message-error.snippet.ts +20 -0
  528. package/src/runjs-context/snippets/global/message-success.snippet.ts +20 -0
  529. package/src/runjs-context/snippets/global/notification-open.snippet.ts +21 -0
  530. package/src/runjs-context/snippets/global/open-view-dialog.snippet.ts +26 -0
  531. package/src/runjs-context/snippets/global/open-view-drawer.snippet.ts +26 -0
  532. package/src/runjs-context/snippets/global/requireAsync.snippet.ts +24 -0
  533. package/src/runjs-context/snippets/global/sleep.snippet.ts +21 -0
  534. package/src/runjs-context/snippets/global/try-catch-async.snippet.ts +22 -0
  535. package/src/runjs-context/snippets/global/view-navigation-push.snippet.ts +23 -0
  536. package/src/runjs-context/snippets/global/window-open.snippet.ts +19 -0
  537. package/src/runjs-context/snippets/index.ts +59 -0
  538. package/src/runjs-context/snippets/libs/echarts-init.snippet.ts +24 -0
  539. package/src/runjs-context/snippets/scene/actions/collection-selected-count.snippet.ts +22 -0
  540. package/src/runjs-context/snippets/scene/actions/iterate-selected-rows.snippet.ts +21 -0
  541. package/src/runjs-context/snippets/scene/actions/record-id-message.snippet.ts +21 -0
  542. package/src/runjs-context/snippets/scene/actions/run-action-basic.snippet.ts +18 -0
  543. package/src/runjs-context/snippets/scene/jsblock/add-event-listener.snippet.ts +29 -0
  544. package/src/runjs-context/snippets/scene/jsblock/append-style.snippet.ts +20 -0
  545. package/src/runjs-context/snippets/scene/jsblock/jsx-mount.snippet.ts +24 -0
  546. package/src/runjs-context/snippets/scene/jsblock/jsx-unmount.snippet.ts +19 -0
  547. package/src/runjs-context/snippets/scene/jsblock/render-basic.snippet.ts +24 -0
  548. package/src/runjs-context/snippets/scene/jsblock/render-button-handler.snippet.ts +24 -0
  549. package/src/runjs-context/snippets/scene/jsblock/render-card.snippet.ts +30 -0
  550. package/src/runjs-context/snippets/scene/jsblock/render-react.snippet.ts +34 -0
  551. package/src/runjs-context/snippets/scene/jsfield/color-by-value.snippet.ts +20 -0
  552. package/src/runjs-context/snippets/scene/jsfield/format-number.snippet.ts +19 -0
  553. package/src/runjs-context/snippets/scene/jsfield/innerHTML-value.snippet.ts +18 -0
  554. package/src/runjs-context/snippets/scene/jsitem/render-basic.snippet.ts +27 -0
  555. package/src/runjs-context/snippets/scene/linkage/set-disabled.snippet.ts +38 -0
  556. package/src/runjs-context/snippets/scene/linkage/set-field-value.snippet.ts +37 -0
  557. package/src/runjs-context/snippets/scene/linkage/set-required.snippet.ts +38 -0
  558. package/src/runjs-context/snippets/scene/linkage/toggle-visible.snippet.ts +38 -0
  559. package/src/runjs-context/snippets/types.ts +17 -0
  560. package/src/types.ts +474 -0
  561. package/src/utils/__tests__/context.test.ts +93 -0
  562. package/src/utils/__tests__/params-resolvers.test.ts +652 -0
  563. package/src/utils/__tests__/parsePathnameToViewParams.test.ts +104 -0
  564. package/src/utils/__tests__/safeGlobals.test.ts +29 -0
  565. package/src/utils/__tests__/utils.test.ts +1021 -0
  566. package/src/utils/__tests__/variablesParams.test.ts +52 -0
  567. package/src/utils/autoFlowError.ts +29 -0
  568. package/src/utils/constants.ts +60 -0
  569. package/src/utils/context.ts +70 -0
  570. package/src/utils/createCollectionContextMeta.ts +122 -0
  571. package/src/utils/exceptions.ts +36 -0
  572. package/src/utils/flow-definitions.ts +16 -0
  573. package/src/utils/index.ts +63 -0
  574. package/src/utils/inheritance.ts +39 -0
  575. package/src/utils/params-resolvers.ts +482 -0
  576. package/src/utils/parsePathnameToViewParams.ts +103 -0
  577. package/src/utils/safeGlobals.ts +188 -0
  578. package/src/utils/schema-utils.ts +201 -0
  579. package/src/utils/serverContextParams.ts +111 -0
  580. package/src/utils/setupRuntimeContextSteps.ts +89 -0
  581. package/src/utils/translation.ts +37 -0
  582. package/src/utils/variablesParams.ts +175 -0
  583. package/src/views/DialogComponent.tsx +79 -0
  584. package/src/views/DrawerComponent.tsx +72 -0
  585. package/src/views/FlowView.tsx +103 -0
  586. package/src/views/PageComponent.tsx +150 -0
  587. package/src/views/ViewNavigation.ts +122 -0
  588. package/src/views/__tests__/FlowView.test.ts +31 -0
  589. package/src/views/__tests__/ViewNavigation.test.ts +191 -0
  590. package/src/views/__tests__/usePatchElement.test.tsx +28 -0
  591. package/src/views/createViewMeta.ts +157 -0
  592. package/src/views/index.tsx +14 -0
  593. package/src/views/useDialog.tsx +192 -0
  594. package/src/views/useDrawer.tsx +205 -0
  595. package/src/views/usePage.tsx +182 -0
  596. package/src/views/usePatchElement.tsx +27 -0
  597. package/src/views/usePopover.tsx +131 -0
@@ -0,0 +1,157 @@
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
+ import { beforeEach, describe, expect, it, vi } from 'vitest';
11
+ import { FlowEngine } from '../../flowEngine';
12
+ import { FlowModel } from '../../models';
13
+ import type { FlowDefinitionOptions, FlowModelOptions } from '../../types';
14
+
15
+ describe('FlowExecutor - event step integration', () => {
16
+ let engine: FlowEngine;
17
+
18
+ beforeEach(() => {
19
+ engine = new FlowEngine();
20
+ vi.restoreAllMocks();
21
+ vi.clearAllMocks();
22
+ });
23
+
24
+ function createModelWithFlows(uid: string, flows: Record<string, Omit<FlowDefinitionOptions, 'key'>>) {
25
+ const model = new FlowModel({
26
+ uid,
27
+ flowEngine: engine,
28
+ stepParams: {},
29
+ subModels: {},
30
+ flowRegistry: flows,
31
+ } as FlowModelOptions);
32
+ return model;
33
+ }
34
+
35
+ it('executes event step first and can exit subsequent steps', async () => {
36
+ // Register an event with a handler that exits when allow=false
37
+ const eventHandler = vi.fn().mockImplementation((ctx, params: any) => {
38
+ if (params?.allow === false) ctx.exit();
39
+ });
40
+ engine.registerEvents({
41
+ click: {
42
+ name: 'click',
43
+ title: 'Click',
44
+ handler: eventHandler,
45
+ },
46
+ });
47
+
48
+ const nextStepHandler = vi.fn();
49
+
50
+ const flows = {
51
+ blocked: {
52
+ on: { eventName: 'click', defaultParams: { allow: false } },
53
+ steps: {
54
+ next: { handler: nextStepHandler },
55
+ },
56
+ },
57
+ allowed: {
58
+ on: { eventName: 'click', defaultParams: { allow: true } },
59
+ steps: {
60
+ next: { handler: nextStepHandler },
61
+ },
62
+ },
63
+ } satisfies Record<string, Omit<FlowDefinitionOptions, 'key'>>;
64
+
65
+ const model = createModelWithFlows('m-events', flows);
66
+
67
+ // When allow=false, event step exits and subsequent steps should not run
68
+ await engine.executor.dispatchEvent(model, 'click');
69
+ expect(eventHandler).toHaveBeenCalled();
70
+ // Both flows fire, but only the second one should run next step
71
+ // nextStepHandler should be called exactly once for the 'allowed' flow
72
+ expect(nextStepHandler).toHaveBeenCalledTimes(1);
73
+ });
74
+
75
+ it('merges on.defaultParams with event defaultParams (event takes precedence on conflicts)', async () => {
76
+ const receivedParams: any[] = [];
77
+ const eventHandler = vi.fn().mockImplementation((_ctx, params) => {
78
+ receivedParams.push(params);
79
+ });
80
+ engine.registerEvents({
81
+ click: {
82
+ name: 'click',
83
+ title: 'Click',
84
+ defaultParams: { a: 1, b: 2 },
85
+ handler: eventHandler,
86
+ },
87
+ });
88
+
89
+ const flows = {
90
+ f1: {
91
+ on: { eventName: 'click', defaultParams: { b: 99, c: 3 } },
92
+ steps: {
93
+ after: { handler: vi.fn() },
94
+ },
95
+ },
96
+ } satisfies Record<string, Omit<FlowDefinitionOptions, 'key'>>;
97
+
98
+ const model = createModelWithFlows('m-merge', flows);
99
+ await engine.executor.runFlow(model, 'f1');
100
+
101
+ expect(eventHandler).toHaveBeenCalledTimes(1);
102
+ // event defaultParams override flow.on.defaultParams on same keys
103
+ expect(receivedParams[0]).toEqual({ a: 1, b: 2, c: 3 });
104
+ });
105
+
106
+ it('event step runs before ordinary steps', async () => {
107
+ const calls: string[] = [];
108
+ const eventHandler = vi.fn().mockImplementation(() => {
109
+ calls.push('event');
110
+ });
111
+ const nextHandler = vi.fn().mockImplementation(() => {
112
+ calls.push('next');
113
+ });
114
+
115
+ engine.registerEvents({
116
+ click: { name: 'click', title: 'Click', handler: eventHandler },
117
+ });
118
+
119
+ const flows = {
120
+ f: {
121
+ on: { eventName: 'click' },
122
+ steps: {
123
+ next: { handler: nextHandler },
124
+ },
125
+ },
126
+ } satisfies Record<string, Omit<FlowDefinitionOptions, 'key'>>;
127
+
128
+ const model = createModelWithFlows('m-order', flows);
129
+ await engine.executor.runFlow(model, 'f');
130
+
131
+ expect(eventHandler).toHaveBeenCalledTimes(1);
132
+ expect(nextHandler).toHaveBeenCalledTimes(1);
133
+ expect(calls).toEqual(['event', 'next']);
134
+ });
135
+
136
+ it('dispatchEvent triggers only flows that match event name', async () => {
137
+ const clickHandler = vi.fn();
138
+ const submitHandler = vi.fn();
139
+
140
+ engine.registerEvents({
141
+ click: { name: 'click', title: 'Click', handler: clickHandler },
142
+ submit: { name: 'submit', title: 'Submit', handler: submitHandler },
143
+ });
144
+
145
+ const flows = {
146
+ onClick: { on: { eventName: 'click' }, steps: { s: { handler: vi.fn() } } },
147
+ onSubmit: { on: { eventName: 'submit' }, steps: { s: { handler: vi.fn() } } },
148
+ } satisfies Record<string, Omit<FlowDefinitionOptions, 'key'>>;
149
+
150
+ const model = createModelWithFlows('m-dispatch', flows);
151
+
152
+ await engine.executor.dispatchEvent(model, 'click');
153
+
154
+ expect(clickHandler).toHaveBeenCalledTimes(1);
155
+ expect(submitHandler).not.toHaveBeenCalled();
156
+ });
157
+ });
@@ -0,0 +1,163 @@
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
+ import { beforeEach, describe, expect, it, vi } from 'vitest';
11
+ import { FlowEngine } from '../../flowEngine';
12
+ import { FlowModel } from '../../models';
13
+ import type { FlowDefinitionOptions, FlowModelOptions } from '../../types';
14
+
15
+ describe('FlowExecutor', () => {
16
+ let engine: FlowEngine;
17
+
18
+ beforeEach(() => {
19
+ engine = new FlowEngine();
20
+ vi.restoreAllMocks();
21
+ vi.clearAllMocks();
22
+ });
23
+
24
+ function createModelWithFlows(uid: string, flows: Record<string, Omit<FlowDefinitionOptions, 'key'>>) {
25
+ const model = new FlowModel({
26
+ uid,
27
+ flowEngine: engine,
28
+ stepParams: {},
29
+ subModels: {},
30
+ flowRegistry: flows,
31
+ } as FlowModelOptions);
32
+ return model;
33
+ }
34
+
35
+ it('runFlow executes steps and merges params from action/step/model', async () => {
36
+ const actionHandler = vi.fn((_ctx, params) => params);
37
+ engine.registerActions({
38
+ testAction: {
39
+ name: 'testAction',
40
+ handler: actionHandler,
41
+ defaultParams: { a: 1, b: 2 },
42
+ },
43
+ });
44
+
45
+ const step2Handler = vi.fn().mockResolvedValue('step2-ok');
46
+
47
+ const flows = {
48
+ testFlow: {
49
+ title: 'Test Flow',
50
+ steps: {
51
+ step1: {
52
+ use: 'testAction',
53
+ defaultParams: { b: 22, c: 3 },
54
+ },
55
+ step2: {
56
+ handler: step2Handler,
57
+ },
58
+ },
59
+ },
60
+ } satisfies Record<string, Omit<FlowDefinitionOptions, 'key'>>;
61
+
62
+ const model = new FlowModel({
63
+ uid: 'm-runFlow',
64
+ flowEngine: engine,
65
+ stepParams: { testFlow: { step1: { b: 99, d: 4 } } },
66
+ subModels: {},
67
+ flowRegistry: flows,
68
+ } as FlowModelOptions);
69
+
70
+ const result = await engine.executor.runFlow(model, 'testFlow');
71
+
72
+ // step1 received merged params: action(a=1,b=2) + step(b=22,c=3) + model(b=99,d=4)
73
+ expect(actionHandler).toHaveBeenCalledTimes(1);
74
+ const [, receivedParams] = actionHandler.mock.calls[0];
75
+ expect(receivedParams).toEqual({ a: 1, b: 99, c: 3, d: 4 });
76
+
77
+ expect(step2Handler).toHaveBeenCalledTimes(1);
78
+
79
+ // result is stepResults map
80
+ expect(result).toBeDefined();
81
+ expect(result.step2).toBe('step2-ok');
82
+ });
83
+
84
+ it('runAutoFlows executes only auto flows in sort order and caches result', async () => {
85
+ const calls: string[] = [];
86
+ const mkFlow = (key: string, sort: number) => ({
87
+ sort,
88
+ steps: {
89
+ only: {
90
+ handler: vi.fn().mockImplementation(async () => {
91
+ calls.push(key);
92
+ return key;
93
+ }),
94
+ },
95
+ },
96
+ });
97
+
98
+ const flows = {
99
+ f2: mkFlow('f2', 2),
100
+ f1: mkFlow('f1', 1),
101
+ ignoredManual: { manual: true, steps: { s: { handler: vi.fn() } } },
102
+ ignoredOn: { on: 'click', steps: { s: { handler: vi.fn() } } },
103
+ } satisfies Record<string, Omit<FlowDefinitionOptions, 'key'>>;
104
+
105
+ const model = createModelWithFlows('m-auto', flows);
106
+
107
+ const r1 = await engine.executor.runAutoFlows(model);
108
+ expect(r1).toHaveLength(2);
109
+ // sort order: f1 then f2
110
+ expect(calls).toEqual(['f1', 'f2']);
111
+
112
+ // second run should hit cache and not execute handlers again
113
+ const prevCount = calls.length;
114
+ const r2 = await engine.executor.runAutoFlows(model);
115
+ expect(r2).toEqual(r1);
116
+ expect(calls.length).toBe(prevCount);
117
+ });
118
+
119
+ it('dispatchEvent triggers only flows matching event name', async () => {
120
+ const clickHandler = vi.fn().mockResolvedValue('ok-click');
121
+ const submitHandler = vi.fn().mockResolvedValue('ok-submit');
122
+
123
+ const flows = {
124
+ clickFlow: { on: { eventName: 'click' }, steps: { s: { handler: clickHandler } } },
125
+ submitFlow: { on: { eventName: 'submit' }, steps: { s: { handler: submitHandler } } },
126
+ } satisfies Record<string, Omit<FlowDefinitionOptions, 'key'>>;
127
+
128
+ const model = createModelWithFlows('m-dispatch', flows);
129
+
130
+ await engine.executor.dispatchEvent(model, 'click');
131
+
132
+ expect(clickHandler).toHaveBeenCalledTimes(1);
133
+ expect(submitHandler).not.toHaveBeenCalled();
134
+ });
135
+
136
+ it('instance flow overrides global flow with same key', async () => {
137
+ class MyModel extends FlowModel {}
138
+
139
+ // register a global flow on MyModel
140
+ MyModel.registerFlow('sameKey', {
141
+ title: 'Global Flow',
142
+ steps: {
143
+ s: { handler: vi.fn().mockResolvedValue('global') },
144
+ },
145
+ });
146
+
147
+ // create instance with same key overriding
148
+ const instanceHandler = vi.fn().mockResolvedValue('instance');
149
+ const model = new MyModel({
150
+ uid: 'm-combined',
151
+ flowEngine: engine,
152
+ flowRegistry: {
153
+ sameKey: { steps: { s: { handler: instanceHandler } } },
154
+ },
155
+ stepParams: {},
156
+ subModels: {},
157
+ } as FlowModelOptions);
158
+
159
+ const result = await engine.executor.runFlow(model, 'sameKey');
160
+ expect(instanceHandler).toHaveBeenCalledTimes(1);
161
+ expect(result.s).toBe('instance');
162
+ });
163
+ });
@@ -0,0 +1,91 @@
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
+ import { FlowDefinitionOptions } from '../types';
11
+ import { FlowDefinition } from '../FlowDefinition';
12
+ import { observable } from '@formily/reactive';
13
+
14
+ type FlowKey = string;
15
+
16
+ export interface IFlowRepository {
17
+ addFlows(flowDefs: Record<string, Omit<FlowDefinitionOptions, 'key'>>): void;
18
+ addFlow(flowKey: string, flowOptions: Omit<FlowDefinitionOptions, 'key'>): FlowDefinition | void;
19
+ removeFlow(flowKey: string): void;
20
+ getFlows(): Map<string, FlowDefinition>;
21
+ mapFlows<T = any>(callback: (flow: FlowDefinition) => T): T[];
22
+ hasFlow(flowKey: string): boolean;
23
+ getFlow(flowKey: string): FlowDefinition | undefined;
24
+ saveFlow(flow: FlowDefinition): Promise<any> | void;
25
+ destroyFlow(flowKey: string): Promise<any> | void;
26
+ moveStep(flowKey: string, sourceStepKey: string, targetStepKey: string): Promise<any> | void;
27
+ }
28
+
29
+ /**
30
+ * 抽象基类,封装通用的 Flow Registry 逻辑
31
+ * 子类只需实现持久化相关的方法
32
+ */
33
+ export abstract class BaseFlowRegistry implements IFlowRepository {
34
+ protected flows: Map<FlowKey, FlowDefinition>;
35
+
36
+ constructor() {
37
+ this.flows = observable.shallow(new Map());
38
+ }
39
+
40
+ addFlows(flows: Record<FlowKey, Omit<FlowDefinitionOptions, 'key'> & { key?: string }>): void {
41
+ for (const [flowKey, flowOptions] of Object.entries(flows || {})) {
42
+ this.addFlow(flowKey, flowOptions);
43
+ }
44
+ }
45
+
46
+ addFlow(flowKey: FlowKey, flowOptions: Omit<FlowDefinitionOptions, 'key'> & { key?: string }): FlowDefinition {
47
+ const flow = new FlowDefinition(
48
+ {
49
+ ...flowOptions,
50
+ key: flowKey,
51
+ },
52
+ this,
53
+ );
54
+ this.flows.set(flowKey, flow);
55
+ return flow;
56
+ }
57
+
58
+ hasFlow(flowKey: FlowKey): boolean {
59
+ const flow = this.flows.get(flowKey);
60
+ return !!flow;
61
+ }
62
+
63
+ getFlow(flowKey: FlowKey): FlowDefinition | undefined {
64
+ return this.flows.get(flowKey);
65
+ }
66
+
67
+ getFlows(): Map<FlowKey, FlowDefinition> {
68
+ return this.flows;
69
+ }
70
+
71
+ removeFlow(flowKey: FlowKey): void {
72
+ this.flows.delete(flowKey);
73
+ }
74
+
75
+ mapFlows<T = any>(callback: (flow: FlowDefinition) => T): T[] {
76
+ const flows = this.getFlows();
77
+ return [...flows.values()].map((flow) => callback(flow));
78
+ }
79
+
80
+ moveStep(flowKey: FlowKey, sourceStepKey: string, targetStepKey: string): void {
81
+ const flow = this.getFlow(flowKey);
82
+ if (!flow) {
83
+ throw new Error(`Flow '${flowKey}' not found`);
84
+ }
85
+ flow.moveStep(sourceStepKey, targetStepKey);
86
+ }
87
+
88
+ // 抽象方法 - 子类必须实现持久化逻辑
89
+ abstract saveFlow(flow: FlowDefinition): Promise<any> | void;
90
+ abstract destroyFlow(flowKey: string): Promise<any> | void;
91
+ }
@@ -0,0 +1,82 @@
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
+ import { FlowDefinitionOptions, ModelConstructor } from '../types';
11
+ import { FlowModel } from '../models';
12
+ import { FlowDefinition } from '../FlowDefinition';
13
+ import { BaseFlowRegistry } from './BaseFlowRegistry';
14
+
15
+ type FlowKey = string;
16
+
17
+ export class GlobalFlowRegistry extends BaseFlowRegistry {
18
+ constructor(protected target: ModelConstructor) {
19
+ super();
20
+ }
21
+
22
+ removeFlow(flowKey: FlowKey): void {
23
+ // Not supported yet for static flows; warn and noop
24
+ console.warn(`GlobalFlowRegistry.removeFlow: removing static flow '${flowKey}' is not supported.`);
25
+ }
26
+
27
+ getFlow(flowKey: FlowKey): FlowDefinition | undefined {
28
+ if (this.flows.has(flowKey)) {
29
+ return this.flows.get(flowKey);
30
+ }
31
+ const proto: typeof FlowModel | null = Object.getPrototypeOf(this.target);
32
+ if (proto !== Function.prototype && proto !== Object.prototype && proto?.globalFlowRegistry) {
33
+ return proto.globalFlowRegistry.getFlow(flowKey);
34
+ }
35
+ return undefined;
36
+ }
37
+
38
+ getFlows(): Map<FlowKey, FlowDefinition> {
39
+ const flows = new Map<FlowKey, FlowDefinition>(this.flows);
40
+ const proto: typeof FlowModel | null = Object.getPrototypeOf(this.target);
41
+ if (proto !== Function.prototype && proto !== Object.prototype && proto?.globalFlowRegistry) {
42
+ for (const [key, def] of proto.globalFlowRegistry.getFlows().entries()) {
43
+ if (!flows.has(key)) {
44
+ flows.set(key, def);
45
+ }
46
+ }
47
+ }
48
+
49
+ // 对静态流进行排序:按 sort 升序;sort 相同的情况下,父类静态流先于子类静态流
50
+ const getClassDepth = (klass: any): number => {
51
+ let depth = 0;
52
+ let cur = klass;
53
+ while (cur && cur !== FlowModel && cur !== Function.prototype && cur !== Object.prototype) {
54
+ cur = Object.getPrototypeOf(cur);
55
+ depth += 1;
56
+ }
57
+ return depth;
58
+ };
59
+
60
+ const sortedEntries = Array.from(flows.entries()).sort(([, a], [, b]) => {
61
+ const sa = a.sort ?? 0;
62
+ const sb = b.sort ?? 0;
63
+ if (sa !== sb) return sa - sb;
64
+ const ra = a['flowRegistry'];
65
+ const rb = b['flowRegistry'];
66
+ const da = getClassDepth(ra['target']);
67
+ const db = getClassDepth(rb['target']);
68
+ if (da !== db) return da - db; // 父类(深度更小)在前
69
+ return 0;
70
+ });
71
+
72
+ return new Map(sortedEntries);
73
+ }
74
+
75
+ saveFlow(flow: FlowDefinition): void {
76
+ // No-op for static flows
77
+ }
78
+
79
+ destroyFlow(flowKey: string): void {
80
+ // Static flows are class-level; no persistence. No-op.
81
+ }
82
+ }
@@ -0,0 +1,39 @@
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
+ import { FlowDefinition } from '../FlowDefinition';
11
+ import { FlowModel } from '../models';
12
+ import { BaseFlowRegistry } from './BaseFlowRegistry';
13
+
14
+ type FlowKey = string;
15
+
16
+ export class InstanceFlowRegistry extends BaseFlowRegistry {
17
+ constructor(protected model: FlowModel) {
18
+ super();
19
+ }
20
+
21
+ async save() {
22
+ await this.model.saveStepParams();
23
+ }
24
+
25
+ async saveFlow(flow: FlowDefinition): Promise<void> {
26
+ await this.model.saveStepParams();
27
+ }
28
+
29
+ async destroyFlow(flowKey: FlowKey): Promise<void> {
30
+ this.removeFlow(flowKey);
31
+ // TODO
32
+ await this.model.saveStepParams();
33
+ }
34
+
35
+ async moveStep(flowKey: FlowKey, sourceStepKey: string, targetStepKey: string): Promise<void> {
36
+ super.moveStep(flowKey, sourceStepKey, targetStepKey);
37
+ await this.model.saveStepParams();
38
+ }
39
+ }
@@ -0,0 +1,141 @@
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
+ import { describe, expect, test, vi } from 'vitest';
11
+ import { FlowEngine } from '../../flowEngine';
12
+ import { FlowModel } from '../../models/flowModel';
13
+ import type { FlowDefinitionOptions } from '../../types';
14
+
15
+ describe('GlobalFlowRegistry', () => {
16
+ test('registerFlow stores static flow on model class', () => {
17
+ class ParentModel extends FlowModel {}
18
+
19
+ const parentFlow: FlowDefinitionOptions = {
20
+ key: 'parentFlow',
21
+ title: 'Parent Flow',
22
+ steps: {
23
+ stepA: { title: 'A' } as any,
24
+ },
25
+ };
26
+
27
+ ParentModel.registerFlow(parentFlow);
28
+
29
+ const flow = ParentModel.globalFlowRegistry.getFlow('parentFlow');
30
+ expect(flow).toBeDefined();
31
+ expect(flow?.key).toBe('parentFlow');
32
+ expect(flow?.title).toBe('Parent Flow');
33
+ expect(flow?.getStep('stepA')?.serialize()).toEqual({ key: 'stepA', flowKey: 'parentFlow', title: 'A', sort: 1 });
34
+ });
35
+
36
+ test('saveFlow/destroyFlow on global registry are no-ops', () => {
37
+ class X extends FlowModel {}
38
+ X.registerFlow({ key: 'f', steps: {} });
39
+ const reg = X.globalFlowRegistry;
40
+
41
+ const flowForSave = reg.getFlow('f');
42
+ expect(() => reg.saveFlow(flowForSave!)).not.toThrow();
43
+ expect(() => reg.destroyFlow('f')).not.toThrow();
44
+ });
45
+
46
+ test("removeFlow warns and doesn't remove static flows", () => {
47
+ class X extends FlowModel {}
48
+ X.registerFlow({ key: 'f', steps: {} });
49
+
50
+ const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
51
+
52
+ try {
53
+ X.globalFlowRegistry.removeFlow('f');
54
+ expect(warnSpy).toHaveBeenCalled();
55
+ // Flow still present
56
+ expect(X.globalFlowRegistry.getFlow('f')).toBeDefined();
57
+ } finally {
58
+ warnSpy.mockRestore();
59
+ }
60
+ });
61
+
62
+ test('child class inherits flows from parent registry', () => {
63
+ class ParentModel extends FlowModel {}
64
+ class ChildModel extends ParentModel {}
65
+
66
+ ParentModel.registerFlow({ key: 'inherited', title: 'From Parent', steps: {} });
67
+
68
+ // Child should see parent flow via global registry
69
+ const childReg = ChildModel.globalFlowRegistry;
70
+ const inherited = childReg.getFlow('inherited');
71
+ expect(inherited).toBeDefined();
72
+ expect(inherited?.title).toBe('From Parent');
73
+ });
74
+
75
+ test('child flow overrides parent flow with same key', () => {
76
+ class ParentModel extends FlowModel {}
77
+ class ChildModel extends ParentModel {}
78
+
79
+ ParentModel.registerFlow({ key: 'shared', title: 'Parent Title', steps: {} });
80
+ ChildModel.registerFlow({ key: 'shared', title: 'Child Title', steps: {} });
81
+
82
+ const childReg = ChildModel.globalFlowRegistry;
83
+ const flow = childReg.getFlow('shared');
84
+ expect(flow).toBeDefined();
85
+ expect(flow?.title).toBe('Child Title');
86
+ });
87
+
88
+ test('FlowModel instance merges instance and static flows with instance precedence', () => {
89
+ const engine = new FlowEngine();
90
+
91
+ class MyModel extends FlowModel {}
92
+ engine.registerModels({ MyModel });
93
+
94
+ // Static flows
95
+ MyModel.registerFlow({ key: 'static1', title: 'S1', steps: {} });
96
+ MyModel.registerFlow({ key: 'dup', title: 'Static DUP', steps: {} });
97
+
98
+ const model = engine.createModel({ use: 'MyModel' });
99
+
100
+ // Instance flows
101
+ model.flowRegistry.addFlow('inst1', { title: 'I1', steps: {} });
102
+ model.flowRegistry.addFlow('dup', { title: 'Instance DUP', steps: {} });
103
+
104
+ const all = model.getFlows();
105
+ // Contains both static and instance keys
106
+ expect(Array.from(all.keys()).sort()).toEqual(['dup', 'inst1', 'static1']);
107
+
108
+ // Instance takes precedence for duplicate key
109
+ expect(all.get('dup')?.title).toBe('Instance DUP');
110
+ expect(all.get('static1')?.title).toBe('S1');
111
+ });
112
+
113
+ test('dispatchEvent triggers both static and instance event flows', async () => {
114
+ const engine = new FlowEngine();
115
+ class MyModel extends FlowModel {}
116
+ engine.registerModels({ MyModel });
117
+
118
+ const staticHandler = vi.fn().mockResolvedValue('static-called');
119
+ const instanceHandler = vi.fn().mockResolvedValue('instance-called');
120
+
121
+ // Static event flow
122
+ MyModel.registerFlow({
123
+ key: 'staticEvent',
124
+ on: { eventName: 'click' },
125
+ steps: { s: { handler: staticHandler } },
126
+ });
127
+
128
+ const model = engine.createModel({ use: 'MyModel' });
129
+ // Instance event flow
130
+ model.flowRegistry.addFlow('instEvent', {
131
+ on: { eventName: 'click' },
132
+ steps: { i: { handler: instanceHandler } },
133
+ });
134
+
135
+ model.dispatchEvent('click', { foo: 'bar' });
136
+ await new Promise((resolve) => setTimeout(resolve, 0));
137
+
138
+ expect(staticHandler).toHaveBeenCalled();
139
+ expect(instanceHandler).toHaveBeenCalled();
140
+ });
141
+ });