@nocobase/flow-engine 2.0.0-alpha.4 → 2.0.0-alpha.41

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 (466) hide show
  1. package/lib/BlockScopedFlowEngine.d.ts +23 -0
  2. package/lib/BlockScopedFlowEngine.js +90 -0
  3. package/lib/FlowContextProvider.d.ts +2 -2
  4. package/lib/FlowContextProvider.js +3 -3
  5. package/lib/FlowDefinition.d.ts +4 -2
  6. package/lib/JSRunner.js +3 -0
  7. package/lib/ViewScopedFlowEngine.d.ts +1 -1
  8. package/lib/ViewScopedFlowEngine.js +12 -0
  9. package/lib/acl/Acl.d.ts +1 -0
  10. package/lib/acl/Acl.js +11 -0
  11. package/lib/components/FieldModelRenderer.js +14 -6
  12. package/lib/components/FieldSkeleton.d.ts +10 -0
  13. package/lib/components/FieldSkeleton.js +64 -0
  14. package/lib/components/FlowContextSelector.js +7 -2
  15. package/lib/components/FlowModelRenderer.d.ts +3 -6
  16. package/lib/components/FlowModelRenderer.js +16 -47
  17. package/lib/components/FormItem.js +5 -1
  18. package/lib/components/MobilePopup.d.ts +20 -0
  19. package/lib/components/MobilePopup.js +102 -0
  20. package/lib/components/MobilePopup.style.d.ts +17 -0
  21. package/lib/components/MobilePopup.style.js +186 -0
  22. package/lib/components/index.d.ts +1 -0
  23. package/lib/components/index.js +3 -1
  24. package/lib/components/settings/independents/dropdown/FlowsDropdownButton.js +2 -2
  25. package/lib/components/settings/wrappers/contextual/DefaultSettingsIcon.js +17 -5
  26. package/lib/components/settings/wrappers/contextual/FlowsContextMenu.js +2 -2
  27. package/lib/components/settings/wrappers/contextual/FlowsFloatContextMenu.d.ts +2 -2
  28. package/lib/components/settings/wrappers/contextual/FlowsFloatContextMenu.js +35 -6
  29. package/lib/components/settings/wrappers/contextual/StepSettingsDialog.js +7 -1
  30. package/lib/components/variables/VariableInput.js +19 -5
  31. package/lib/components/variables/VariableTag.js +43 -2
  32. package/lib/components/variables/types.d.ts +2 -0
  33. package/lib/data-source/index.d.ts +15 -4
  34. package/lib/data-source/index.js +42 -13
  35. package/lib/data-source/sortCollectionsByInherits.d.ts +10 -0
  36. package/lib/data-source/sortCollectionsByInherits.js +71 -0
  37. package/lib/emitter.d.ts +6 -0
  38. package/lib/emitter.js +12 -0
  39. package/lib/executor/FlowExecutor.d.ts +4 -5
  40. package/lib/executor/FlowExecutor.js +168 -99
  41. package/lib/flow-registry/GlobalFlowRegistry.d.ts +1 -0
  42. package/lib/flow-registry/GlobalFlowRegistry.js +3 -0
  43. package/lib/flow-registry/InstanceFlowRegistry.d.ts +1 -0
  44. package/lib/flow-registry/InstanceFlowRegistry.js +3 -0
  45. package/lib/flowContext.d.ts +37 -5
  46. package/lib/flowContext.js +224 -87
  47. package/lib/flowEngine.d.ts +24 -1
  48. package/lib/flowEngine.js +81 -8
  49. package/lib/flowSettings.d.ts +2 -1
  50. package/lib/flowSettings.js +16 -8
  51. package/lib/hooks/useApplyAutoFlows.js +2 -1
  52. package/lib/index.d.ts +7 -1
  53. package/lib/index.js +32 -3
  54. package/lib/locale/en-US.json +4 -2
  55. package/lib/locale/index.d.ts +4 -0
  56. package/lib/locale/zh-CN.json +4 -2
  57. package/lib/models/CollectionFieldModel.d.ts +3 -0
  58. package/lib/models/CollectionFieldModel.js +52 -6
  59. package/lib/models/flowModel.d.ts +30 -29
  60. package/lib/models/flowModel.js +153 -100
  61. package/lib/models/forkFlowModel.d.ts +8 -4
  62. package/lib/models/forkFlowModel.js +38 -8
  63. package/lib/provider.d.ts +3 -1
  64. package/lib/provider.js +7 -5
  65. package/lib/resources/multiRecordResource.js +25 -1
  66. package/lib/resources/singleRecordResource.js +19 -1
  67. package/lib/resources/sqlResource.d.ts +1 -0
  68. package/lib/resources/sqlResource.js +20 -24
  69. package/lib/runjs-context/contexts/FormJSFieldItemRunJSContext.d.ts +1 -6
  70. package/lib/runjs-context/contexts/FormJSFieldItemRunJSContext.js +27 -20
  71. package/lib/runjs-context/contexts/JSBlockRunJSContext.d.ts +1 -6
  72. package/lib/runjs-context/contexts/JSBlockRunJSContext.js +46 -33
  73. package/lib/runjs-context/contexts/JSCollectionActionRunJSContext.d.ts +1 -2
  74. package/lib/runjs-context/contexts/JSCollectionActionRunJSContext.js +14 -15
  75. package/lib/runjs-context/contexts/{LinkageRunJSContext.d.ts → JSColumnRunJSContext.d.ts} +6 -3
  76. package/lib/runjs-context/contexts/JSColumnRunJSContext.js +78 -0
  77. package/lib/runjs-context/contexts/JSFieldRunJSContext.d.ts +1 -6
  78. package/lib/runjs-context/contexts/JSFieldRunJSContext.js +28 -24
  79. package/lib/runjs-context/contexts/JSItemRunJSContext.d.ts +1 -6
  80. package/lib/runjs-context/contexts/JSItemRunJSContext.js +24 -20
  81. package/lib/runjs-context/contexts/JSRecordActionRunJSContext.d.ts +1 -2
  82. package/lib/runjs-context/contexts/JSRecordActionRunJSContext.js +16 -17
  83. package/lib/runjs-context/contexts/base.d.ts +9 -0
  84. package/lib/runjs-context/contexts/base.js +205 -0
  85. package/lib/runjs-context/helpers.d.ts +5 -2
  86. package/lib/runjs-context/helpers.js +36 -27
  87. package/lib/runjs-context/registry.d.ts +7 -4
  88. package/lib/runjs-context/registry.js +10 -42
  89. package/lib/runjs-context/setup.d.ts +9 -0
  90. package/lib/runjs-context/setup.js +82 -0
  91. package/lib/runjs-context/snippets/global/{copy-record-json.snippet.js → api-request.snippet.js} +25 -10
  92. package/lib/runjs-context/snippets/global/clipboard-copy-text.snippet.js +61 -0
  93. package/lib/runjs-context/snippets/global/{view-navigation-push.snippet.js → import-esm.snippet.js} +26 -12
  94. package/lib/runjs-context/snippets/global/message-error.snippet.js +6 -0
  95. package/lib/runjs-context/snippets/global/message-success.snippet.js +6 -0
  96. package/lib/runjs-context/snippets/global/notification-open.snippet.d.ts +3 -8
  97. package/lib/runjs-context/snippets/global/notification-open.snippet.js +8 -1
  98. package/lib/runjs-context/snippets/global/open-view-dialog.snippet.js +10 -3
  99. package/lib/runjs-context/snippets/global/open-view-drawer.snippet.js +10 -3
  100. package/lib/runjs-context/snippets/global/query-selector.snippet.js +53 -0
  101. package/lib/runjs-context/snippets/global/require-amd.snippet.d.ts +11 -0
  102. package/lib/runjs-context/snippets/global/{requireAsync.snippet.js → require-amd.snippet.js} +16 -13
  103. package/lib/runjs-context/snippets/global/window-open.snippet.d.ts +3 -8
  104. package/lib/runjs-context/snippets/global/window-open.snippet.js +8 -1
  105. package/lib/runjs-context/snippets/index.d.ts +14 -3
  106. package/lib/runjs-context/snippets/index.js +162 -40
  107. package/lib/runjs-context/snippets/scene/block/add-event-listener.snippet.d.ts +11 -0
  108. package/lib/runjs-context/snippets/scene/{jsblock → block}/add-event-listener.snippet.js +11 -2
  109. package/lib/runjs-context/snippets/scene/block/api-fetch-render-list.snippet.d.ts +11 -0
  110. package/lib/runjs-context/snippets/scene/block/api-fetch-render-list.snippet.js +64 -0
  111. package/lib/runjs-context/snippets/scene/block/chartjs-bar.snippet.d.ts +11 -0
  112. package/lib/runjs-context/snippets/scene/block/chartjs-bar.snippet.js +99 -0
  113. package/lib/runjs-context/snippets/{libs → scene/block}/echarts-init.snippet.js +24 -7
  114. package/lib/runjs-context/snippets/scene/block/render-antd-icons.snippet.d.ts +11 -0
  115. package/lib/runjs-context/snippets/scene/block/render-antd-icons.snippet.js +65 -0
  116. package/lib/runjs-context/snippets/scene/block/render-button-handler.snippet.d.ts +11 -0
  117. package/lib/runjs-context/snippets/scene/{jsblock → block}/render-button-handler.snippet.js +17 -9
  118. package/lib/runjs-context/snippets/scene/block/render-iframe.snippet.d.ts +11 -0
  119. package/lib/runjs-context/snippets/scene/block/render-iframe.snippet.js +57 -0
  120. package/lib/runjs-context/snippets/scene/block/render-info-card.snippet.d.ts +11 -0
  121. package/lib/runjs-context/snippets/scene/block/render-info-card.snippet.js +71 -0
  122. package/lib/runjs-context/snippets/scene/block/render-react-jsx.snippet.d.ts +11 -0
  123. package/lib/runjs-context/snippets/scene/{jsblock/render-card.snippet.js → block/render-react-jsx.snippet.js} +26 -13
  124. package/lib/runjs-context/snippets/scene/block/render-react.snippet.d.ts +11 -0
  125. package/lib/runjs-context/snippets/scene/{jsblock → block}/render-react.snippet.js +18 -17
  126. package/lib/runjs-context/snippets/scene/block/render-statistics.snippet.d.ts +11 -0
  127. package/lib/runjs-context/snippets/scene/block/render-statistics.snippet.js +95 -0
  128. package/lib/runjs-context/snippets/scene/block/render-timeline.snippet.d.ts +11 -0
  129. package/lib/runjs-context/snippets/scene/block/render-timeline.snippet.js +84 -0
  130. package/lib/runjs-context/snippets/scene/block/resource-example.snippet.d.ts +11 -0
  131. package/lib/runjs-context/snippets/scene/block/resource-example.snippet.js +60 -0
  132. package/lib/runjs-context/snippets/scene/block/three-users-orbit.snippet.d.ts +11 -0
  133. package/lib/runjs-context/snippets/scene/block/three-users-orbit.snippet.js +283 -0
  134. package/lib/runjs-context/snippets/scene/block/vue-component.snippet.d.ts +11 -0
  135. package/lib/runjs-context/snippets/scene/block/vue-component.snippet.js +124 -0
  136. package/lib/runjs-context/snippets/scene/detail/color-by-value.snippet.d.ts +11 -0
  137. package/lib/runjs-context/snippets/scene/{jsfield → detail}/color-by-value.snippet.js +13 -3
  138. package/lib/runjs-context/snippets/scene/detail/copy-to-clipboard.snippet.d.ts +11 -0
  139. package/lib/runjs-context/snippets/{global → scene/detail}/copy-to-clipboard.snippet.js +28 -6
  140. package/lib/runjs-context/snippets/scene/detail/format-number.snippet.d.ts +11 -0
  141. package/lib/runjs-context/snippets/scene/{jsfield → detail}/format-number.snippet.js +13 -3
  142. package/lib/runjs-context/snippets/scene/detail/innerHTML-value.snippet.d.ts +11 -0
  143. package/lib/runjs-context/snippets/scene/{jsfield → detail}/innerHTML-value.snippet.js +13 -3
  144. package/lib/runjs-context/snippets/scene/detail/percentage-bar.snippet.d.ts +11 -0
  145. package/lib/runjs-context/snippets/scene/detail/percentage-bar.snippet.js +82 -0
  146. package/lib/runjs-context/snippets/scene/detail/relative-time.snippet.d.ts +11 -0
  147. package/lib/runjs-context/snippets/scene/detail/relative-time.snippet.js +80 -0
  148. package/lib/runjs-context/snippets/scene/detail/status-tag.snippet.d.ts +11 -0
  149. package/lib/runjs-context/snippets/scene/detail/status-tag.snippet.js +74 -0
  150. package/lib/runjs-context/snippets/scene/form/calculate-total.snippet.d.ts +11 -0
  151. package/lib/runjs-context/snippets/scene/form/calculate-total.snippet.js +63 -0
  152. package/lib/runjs-context/snippets/scene/form/cascade-select.snippet.d.ts +11 -0
  153. package/lib/runjs-context/snippets/scene/form/cascade-select.snippet.js +81 -0
  154. package/lib/runjs-context/snippets/scene/form/conditional-required.snippet.d.ts +11 -0
  155. package/lib/runjs-context/snippets/scene/form/conditional-required.snippet.js +64 -0
  156. package/lib/runjs-context/snippets/scene/form/copy-field-values.snippet.d.ts +11 -0
  157. package/lib/runjs-context/snippets/scene/form/copy-field-values.snippet.js +74 -0
  158. package/lib/runjs-context/snippets/scene/form/render-basic.snippet.d.ts +11 -0
  159. package/lib/runjs-context/snippets/scene/{jsitem → form}/render-basic.snippet.js +11 -2
  160. package/lib/runjs-context/snippets/scene/form/set-disabled.snippet.d.ts +11 -0
  161. package/lib/runjs-context/snippets/scene/{linkage → form}/set-disabled.snippet.js +12 -3
  162. package/lib/runjs-context/snippets/scene/form/set-field-value.snippet.d.ts +11 -0
  163. package/lib/runjs-context/snippets/scene/{linkage → form}/set-field-value.snippet.js +12 -3
  164. package/lib/runjs-context/snippets/scene/form/set-required.snippet.d.ts +11 -0
  165. package/lib/runjs-context/snippets/scene/{linkage → form}/set-required.snippet.js +12 -3
  166. package/lib/runjs-context/snippets/scene/form/toggle-multiple-fields.snippet.d.ts +11 -0
  167. package/lib/runjs-context/snippets/scene/form/toggle-multiple-fields.snippet.js +67 -0
  168. package/lib/runjs-context/snippets/scene/form/toggle-visible.snippet.d.ts +11 -0
  169. package/lib/runjs-context/snippets/scene/{linkage → form}/toggle-visible.snippet.js +12 -3
  170. package/lib/runjs-context/snippets/scene/table/cell-open-dialog.snippet.d.ts +11 -0
  171. package/lib/runjs-context/snippets/scene/table/cell-open-dialog.snippet.js +64 -0
  172. package/lib/runjs-context/snippets/scene/table/collection-selected-count.snippet.d.ts +11 -0
  173. package/lib/runjs-context/snippets/scene/{actions → table}/collection-selected-count.snippet.js +11 -2
  174. package/lib/runjs-context/snippets/scene/table/concat-fields.snippet.d.ts +11 -0
  175. package/lib/runjs-context/snippets/scene/table/concat-fields.snippet.js +79 -0
  176. package/lib/runjs-context/snippets/scene/table/destroy-selected.snippet.d.ts +11 -0
  177. package/lib/runjs-context/snippets/{global/log-json-record.snippet.js → scene/table/destroy-selected.snippet.js} +24 -11
  178. package/lib/runjs-context/snippets/scene/table/export-selected-json.snippet.d.ts +11 -0
  179. package/lib/runjs-context/snippets/scene/table/export-selected-json.snippet.js +64 -0
  180. package/lib/runjs-context/snippets/scene/table/iterate-selected-rows.snippet.d.ts +11 -0
  181. package/lib/runjs-context/snippets/scene/{actions → table}/iterate-selected-rows.snippet.js +11 -2
  182. package/lib/runjs-context/snippets/types.d.ts +9 -1
  183. package/lib/scheduler/ModelOperationScheduler.d.ts +51 -0
  184. package/lib/scheduler/ModelOperationScheduler.js +262 -0
  185. package/lib/types.d.ts +28 -3
  186. package/lib/types.js +4 -3
  187. package/lib/utils/associationObjectVariable.d.ts +32 -0
  188. package/lib/utils/associationObjectVariable.js +157 -0
  189. package/lib/utils/buildSettingsViewInputArgs.d.ts +19 -0
  190. package/lib/utils/buildSettingsViewInputArgs.js +75 -0
  191. package/lib/utils/createEphemeralContext.d.ts +13 -0
  192. package/lib/utils/createEphemeralContext.js +140 -0
  193. package/lib/utils/flows.d.ts +10 -0
  194. package/lib/{runjs-context/snippets/global/api-request-post.snippet.js → utils/flows.js} +21 -15
  195. package/lib/utils/index.d.ts +7 -2
  196. package/lib/utils/index.js +21 -2
  197. package/lib/utils/jsxTransform.d.ts +15 -0
  198. package/lib/utils/jsxTransform.js +68 -0
  199. package/lib/utils/params-resolvers.js +3 -3
  200. package/lib/utils/parsePathnameToViewParams.d.ts +1 -1
  201. package/lib/utils/parsePathnameToViewParams.js +41 -5
  202. package/lib/utils/pruneFilter.d.ts +21 -0
  203. package/lib/{runjs-context/snippets/global/try-catch-async.snippet.js → utils/pruneFilter.js} +24 -16
  204. package/lib/utils/safeGlobals.d.ts +5 -3
  205. package/lib/utils/safeGlobals.js +40 -0
  206. package/lib/utils/schema-utils.js +2 -2
  207. package/lib/utils/serverContextParams.d.ts +1 -0
  208. package/lib/utils/translation.d.ts +4 -1
  209. package/lib/utils/translation.js +6 -2
  210. package/lib/utils/variablesParams.d.ts +22 -5
  211. package/lib/utils/variablesParams.js +132 -36
  212. package/lib/views/DrawerComponent.js +21 -2
  213. package/lib/views/PageComponent.js +2 -1
  214. package/lib/views/ViewNavigation.d.ts +3 -9
  215. package/lib/views/ViewNavigation.js +16 -2
  216. package/lib/views/createViewMeta.d.ts +29 -1
  217. package/lib/views/createViewMeta.js +338 -72
  218. package/lib/views/index.d.ts +1 -0
  219. package/lib/views/index.js +3 -0
  220. package/lib/views/useDialog.d.ts +9 -8
  221. package/lib/views/useDialog.js +19 -14
  222. package/lib/views/useDrawer.d.ts +9 -8
  223. package/lib/views/useDrawer.js +54 -35
  224. package/lib/views/usePage.d.ts +9 -8
  225. package/lib/views/usePage.js +20 -14
  226. package/package.json +6 -3
  227. package/src/BlockScopedFlowEngine.ts +86 -0
  228. package/src/FlowContextProvider.tsx +4 -2
  229. package/src/JSRunner.ts +3 -0
  230. package/src/ViewScopedFlowEngine.ts +15 -1
  231. package/src/__tests__/JSRunner.test.ts +62 -53
  232. package/src/__tests__/blockScopedFlowEngine.test.ts +154 -0
  233. package/src/__tests__/createViewMeta.popup.test.ts +132 -0
  234. package/src/__tests__/flow-engine.test.ts +3 -0
  235. package/src/__tests__/flowContext.test.ts +52 -0
  236. package/src/__tests__/flowContextCreateJSRunner.test.ts +163 -0
  237. package/src/__tests__/flowEngine.saveModel.test.ts +4 -0
  238. package/src/__tests__/flowRunJSContextDefine.test.ts +508 -0
  239. package/src/__tests__/flowSettings.open.test.tsx +2 -0
  240. package/src/__tests__/flowSettings.test.ts +2 -0
  241. package/src/__tests__/globalFlowRegistry.test.ts +1 -1
  242. package/src/__tests__/modelOperationScheduler.test.ts +346 -0
  243. package/src/__tests__/objectVariable.test.ts +464 -0
  244. package/src/__tests__/runjsContext.test.ts +216 -35
  245. package/src/__tests__/runjsContextImplementations.test.ts +217 -0
  246. package/src/__tests__/runjsContextRuntime.test.ts +269 -0
  247. package/src/__tests__/runjsEdgeCases.test.ts +281 -0
  248. package/src/__tests__/runjsLocales.test.ts +36 -0
  249. package/src/__tests__/runjsRuntimeFeatures.test.ts +461 -0
  250. package/src/__tests__/runjsSnippets.test.ts +140 -0
  251. package/src/__tests__/viewScopedFlowEngine.test.ts +3 -3
  252. package/src/acl/Acl.tsx +14 -0
  253. package/src/acl/__tests__/Acl.test.tsx +43 -0
  254. package/src/components/DynamicFlowsEditor.tsx +3 -4
  255. package/src/components/FieldModelRenderer.tsx +20 -7
  256. package/src/components/FieldSkeleton.tsx +27 -0
  257. package/src/components/FlowContextSelector.tsx +6 -2
  258. package/src/components/FlowModelRenderer.tsx +33 -81
  259. package/src/components/FormItem.tsx +8 -1
  260. package/src/components/MobilePopup.style.ts +220 -0
  261. package/src/components/MobilePopup.tsx +86 -0
  262. package/src/components/__tests__/flow-model-render-error-fallback.test.tsx +6 -6
  263. package/src/components/index.ts +1 -0
  264. package/src/components/settings/independents/dropdown/FlowsDropdownButton.tsx +1 -1
  265. package/src/components/settings/wrappers/contextual/DefaultSettingsIcon.tsx +17 -4
  266. package/src/components/settings/wrappers/contextual/FlowsContextMenu.tsx +1 -1
  267. package/src/components/settings/wrappers/contextual/FlowsFloatContextMenu.tsx +39 -10
  268. package/src/components/settings/wrappers/contextual/StepSettingsDialog.tsx +14 -1
  269. package/src/components/settings/wrappers/contextual/__tests__/DefaultSettingsIcon.test.tsx +425 -0
  270. package/src/components/subModel/__tests__/AddSubModelButton.test.tsx +5 -7
  271. package/src/components/variables/VariableInput.tsx +25 -5
  272. package/src/components/variables/VariableTag.tsx +54 -2
  273. package/src/components/variables/types.ts +2 -0
  274. package/src/data-source/__tests__/sortCollectionsByInherits.test.ts +125 -0
  275. package/src/data-source/index.ts +42 -11
  276. package/src/data-source/sortCollectionsByInherits.ts +61 -0
  277. package/src/emitter.ts +14 -0
  278. package/src/executor/FlowExecutor.ts +213 -119
  279. package/src/executor/__tests__/ctx-defs-injection.test.ts +197 -0
  280. package/src/executor/__tests__/flowExecutor.test.ts +151 -5
  281. package/src/flow-registry/GlobalFlowRegistry.ts +1 -0
  282. package/src/flow-registry/InstanceFlowRegistry.ts +1 -0
  283. package/src/flow-registry/__tests__/globalFlowRegistry.test.ts +54 -0
  284. package/src/flowContext.ts +303 -104
  285. package/src/flowEngine.ts +96 -6
  286. package/src/flowSettings.ts +12 -4
  287. package/src/hooks/useApplyAutoFlows.ts +3 -1
  288. package/src/index.ts +12 -1
  289. package/src/locale/en-US.json +4 -2
  290. package/src/locale/zh-CN.json +4 -2
  291. package/src/models/CollectionFieldModel.tsx +60 -8
  292. package/src/models/__tests__/dispatchEvent.behavior.test.ts +169 -0
  293. package/src/models/__tests__/flowModel.getFlows.sort.test.ts +33 -9
  294. package/src/models/__tests__/flowModel.scheduleModelOperation.test.tsx +129 -0
  295. package/src/models/__tests__/flowModel.test.ts +234 -111
  296. package/src/models/__tests__/forkFlowModel.test.ts +40 -7
  297. package/src/models/flowModel.tsx +197 -132
  298. package/src/models/forkFlowModel.ts +48 -8
  299. package/src/provider.tsx +10 -7
  300. package/src/resources/multiRecordResource.ts +28 -1
  301. package/src/resources/singleRecordResource.ts +19 -1
  302. package/src/resources/sqlResource.ts +20 -25
  303. package/src/runjs-context/contexts/FormJSFieldItemRunJSContext.ts +28 -21
  304. package/src/runjs-context/contexts/JSBlockRunJSContext.ts +46 -34
  305. package/src/runjs-context/contexts/JSCollectionActionRunJSContext.ts +15 -16
  306. package/src/runjs-context/contexts/JSColumnRunJSContext.ts +58 -0
  307. package/src/runjs-context/contexts/JSFieldRunJSContext.ts +30 -25
  308. package/src/runjs-context/contexts/JSItemRunJSContext.ts +25 -21
  309. package/src/runjs-context/contexts/JSRecordActionRunJSContext.ts +17 -18
  310. package/src/runjs-context/contexts/base.ts +196 -0
  311. package/src/runjs-context/helpers.ts +32 -30
  312. package/src/runjs-context/registry.ts +16 -47
  313. package/src/runjs-context/setup.ts +51 -0
  314. package/src/runjs-context/snippets/global/api-request.snippet.ts +38 -0
  315. package/src/runjs-context/snippets/global/clipboard-copy-text.snippet.ts +42 -0
  316. package/src/runjs-context/snippets/global/import-esm.snippet.ts +39 -0
  317. package/src/runjs-context/snippets/global/message-error.snippet.ts +6 -0
  318. package/src/runjs-context/snippets/global/message-success.snippet.ts +6 -0
  319. package/src/runjs-context/snippets/global/notification-open.snippet.ts +11 -1
  320. package/src/runjs-context/snippets/global/open-view-dialog.snippet.ts +10 -3
  321. package/src/runjs-context/snippets/global/open-view-drawer.snippet.ts +10 -3
  322. package/src/runjs-context/snippets/global/query-selector.snippet.ts +34 -0
  323. package/src/runjs-context/snippets/global/require-amd.snippet.ts +30 -0
  324. package/src/runjs-context/snippets/global/window-open.snippet.ts +11 -1
  325. package/src/runjs-context/snippets/index.ts +178 -39
  326. package/src/runjs-context/snippets/scene/{jsblock → block}/add-event-listener.snippet.ts +14 -2
  327. package/src/runjs-context/snippets/scene/block/api-fetch-render-list.snippet.ts +45 -0
  328. package/src/runjs-context/snippets/scene/block/chartjs-bar.snippet.ts +80 -0
  329. package/src/runjs-context/snippets/scene/block/echarts-init.snippet.ts +44 -0
  330. package/src/runjs-context/snippets/scene/block/render-antd-icons.snippet.ts +46 -0
  331. package/src/runjs-context/snippets/scene/block/render-button-handler.snippet.ts +35 -0
  332. package/src/runjs-context/snippets/scene/block/render-iframe.snippet.ts +38 -0
  333. package/src/runjs-context/snippets/scene/block/render-info-card.snippet.ts +52 -0
  334. package/src/runjs-context/snippets/scene/block/render-react-jsx.snippet.ts +39 -0
  335. package/src/runjs-context/snippets/scene/block/render-react.snippet.ts +38 -0
  336. package/src/runjs-context/snippets/scene/block/render-statistics.snippet.ts +76 -0
  337. package/src/runjs-context/snippets/scene/block/render-timeline.snippet.ts +65 -0
  338. package/src/runjs-context/snippets/scene/block/resource-example.snippet.ts +46 -0
  339. package/src/runjs-context/snippets/scene/block/three-users-orbit.snippet.ts +264 -0
  340. package/src/runjs-context/snippets/scene/block/vue-component.snippet.ts +105 -0
  341. package/src/runjs-context/snippets/scene/detail/color-by-value.snippet.ts +33 -0
  342. package/src/runjs-context/snippets/scene/detail/copy-to-clipboard.snippet.ts +45 -0
  343. package/src/runjs-context/snippets/scene/detail/format-number.snippet.ts +32 -0
  344. package/src/runjs-context/snippets/scene/detail/innerHTML-value.snippet.ts +31 -0
  345. package/src/runjs-context/snippets/scene/detail/percentage-bar.snippet.ts +63 -0
  346. package/src/runjs-context/snippets/scene/detail/relative-time.snippet.ts +61 -0
  347. package/src/runjs-context/snippets/scene/detail/status-tag.snippet.ts +55 -0
  348. package/src/runjs-context/snippets/scene/form/calculate-total.snippet.ts +44 -0
  349. package/src/runjs-context/snippets/scene/form/cascade-select.snippet.ts +62 -0
  350. package/src/runjs-context/snippets/scene/form/conditional-required.snippet.ts +45 -0
  351. package/src/runjs-context/snippets/scene/form/copy-field-values.snippet.ts +55 -0
  352. package/src/runjs-context/snippets/scene/{jsitem → form}/render-basic.snippet.ts +14 -2
  353. package/src/runjs-context/snippets/scene/{linkage → form}/set-disabled.snippet.ts +15 -3
  354. package/src/runjs-context/snippets/scene/{linkage → form}/set-field-value.snippet.ts +15 -3
  355. package/src/runjs-context/snippets/scene/{linkage → form}/set-required.snippet.ts +15 -3
  356. package/src/runjs-context/snippets/scene/form/toggle-multiple-fields.snippet.ts +48 -0
  357. package/src/runjs-context/snippets/scene/{linkage → form}/toggle-visible.snippet.ts +15 -3
  358. package/src/runjs-context/snippets/scene/table/cell-open-dialog.snippet.ts +45 -0
  359. package/src/runjs-context/snippets/scene/{actions → table}/collection-selected-count.snippet.ts +14 -2
  360. package/src/runjs-context/snippets/scene/table/concat-fields.snippet.ts +60 -0
  361. package/src/runjs-context/snippets/scene/table/destroy-selected.snippet.ts +36 -0
  362. package/src/runjs-context/snippets/scene/table/export-selected-json.snippet.ts +45 -0
  363. package/src/runjs-context/snippets/scene/{actions → table}/iterate-selected-rows.snippet.ts +14 -2
  364. package/src/runjs-context/snippets/types.ts +5 -1
  365. package/src/scheduler/ModelOperationScheduler.ts +304 -0
  366. package/src/types.ts +34 -0
  367. package/src/utils/__tests__/flows.test.ts +65 -0
  368. package/src/utils/__tests__/jsxTransform.test.ts +38 -0
  369. package/src/utils/__tests__/parsePathnameToViewParams.test.ts +25 -0
  370. package/src/utils/__tests__/pruneFilter.test.ts +38 -0
  371. package/src/utils/__tests__/safeGlobals.test.ts +22 -1
  372. package/src/utils/__tests__/variablesParams.test.ts +63 -0
  373. package/src/utils/associationObjectVariable.ts +180 -0
  374. package/src/utils/buildSettingsViewInputArgs.ts +72 -0
  375. package/src/utils/createEphemeralContext.ts +142 -0
  376. package/src/utils/flows.ts +23 -0
  377. package/src/utils/index.ts +11 -2
  378. package/src/utils/jsxTransform.ts +39 -0
  379. package/src/utils/params-resolvers.ts +2 -2
  380. package/src/utils/parsePathnameToViewParams.ts +50 -6
  381. package/src/utils/pruneFilter.ts +41 -0
  382. package/src/utils/safeGlobals.ts +49 -3
  383. package/src/utils/schema-utils.ts +1 -1
  384. package/src/utils/serverContextParams.ts +1 -0
  385. package/src/utils/translation.ts +7 -2
  386. package/src/utils/variablesParams.ts +156 -38
  387. package/src/views/DrawerComponent.tsx +21 -2
  388. package/src/views/PageComponent.tsx +1 -1
  389. package/src/views/ViewNavigation.ts +20 -12
  390. package/src/views/__tests__/ViewNavigation.test.ts +10 -0
  391. package/src/views/createViewMeta.ts +393 -70
  392. package/src/views/index.tsx +1 -0
  393. package/src/views/useDialog.tsx +24 -18
  394. package/src/views/useDrawer.tsx +74 -45
  395. package/src/views/usePage.tsx +26 -17
  396. package/lib/runjs-context/contexts/FlowRunJSContext.d.ts +0 -38
  397. package/lib/runjs-context/contexts/FlowRunJSContext.js +0 -217
  398. package/lib/runjs-context/contexts/LinkageRunJSContext.js +0 -62
  399. package/lib/runjs-context/index.d.ts +0 -19
  400. package/lib/runjs-context/index.js +0 -57
  401. package/lib/runjs-context/snippets/global/api-request-get.snippet.d.ts +0 -16
  402. package/lib/runjs-context/snippets/global/api-request-get.snippet.js +0 -42
  403. package/lib/runjs-context/snippets/global/api-request-post.snippet.d.ts +0 -16
  404. package/lib/runjs-context/snippets/global/console-log-ctx.snippet.d.ts +0 -16
  405. package/lib/runjs-context/snippets/global/console-log-ctx.snippet.js +0 -41
  406. package/lib/runjs-context/snippets/global/requireAsync.snippet.d.ts +0 -16
  407. package/lib/runjs-context/snippets/global/sleep.snippet.d.ts +0 -16
  408. package/lib/runjs-context/snippets/global/sleep.snippet.js +0 -43
  409. package/lib/runjs-context/snippets/global/try-catch-async.snippet.d.ts +0 -16
  410. package/lib/runjs-context/snippets/libs/echarts-init.snippet.d.ts +0 -15
  411. package/lib/runjs-context/snippets/scene/actions/collection-selected-count.snippet.d.ts +0 -15
  412. package/lib/runjs-context/snippets/scene/actions/iterate-selected-rows.snippet.d.ts +0 -15
  413. package/lib/runjs-context/snippets/scene/actions/record-id-message.snippet.d.ts +0 -15
  414. package/lib/runjs-context/snippets/scene/actions/record-id-message.snippet.js +0 -43
  415. package/lib/runjs-context/snippets/scene/actions/run-action-basic.snippet.d.ts +0 -15
  416. package/lib/runjs-context/snippets/scene/actions/run-action-basic.snippet.js +0 -40
  417. package/lib/runjs-context/snippets/scene/jsblock/add-event-listener.snippet.d.ts +0 -15
  418. package/lib/runjs-context/snippets/scene/jsblock/append-style.snippet.d.ts +0 -15
  419. package/lib/runjs-context/snippets/scene/jsblock/append-style.snippet.js +0 -42
  420. package/lib/runjs-context/snippets/scene/jsblock/jsx-mount.snippet.d.ts +0 -15
  421. package/lib/runjs-context/snippets/scene/jsblock/jsx-mount.snippet.js +0 -46
  422. package/lib/runjs-context/snippets/scene/jsblock/jsx-unmount.snippet.d.ts +0 -15
  423. package/lib/runjs-context/snippets/scene/jsblock/jsx-unmount.snippet.js +0 -41
  424. package/lib/runjs-context/snippets/scene/jsblock/render-basic.snippet.d.ts +0 -15
  425. package/lib/runjs-context/snippets/scene/jsblock/render-basic.snippet.js +0 -41
  426. package/lib/runjs-context/snippets/scene/jsblock/render-button-handler.snippet.d.ts +0 -15
  427. package/lib/runjs-context/snippets/scene/jsblock/render-react.snippet.d.ts +0 -15
  428. package/lib/runjs-context/snippets/scene/jsfield/color-by-value.snippet.d.ts +0 -15
  429. package/lib/runjs-context/snippets/scene/jsfield/format-number.snippet.d.ts +0 -15
  430. package/lib/runjs-context/snippets/scene/jsfield/innerHTML-value.snippet.d.ts +0 -15
  431. package/lib/runjs-context/snippets/scene/jsitem/render-basic.snippet.d.ts +0 -15
  432. package/lib/runjs-context/snippets/scene/linkage/set-disabled.snippet.d.ts +0 -15
  433. package/lib/runjs-context/snippets/scene/linkage/set-field-value.snippet.d.ts +0 -15
  434. package/lib/runjs-context/snippets/scene/linkage/set-required.snippet.d.ts +0 -15
  435. package/lib/runjs-context/snippets/scene/linkage/toggle-visible.snippet.d.ts +0 -15
  436. package/src/runjs-context/contexts/FlowRunJSContext.ts +0 -190
  437. package/src/runjs-context/contexts/LinkageRunJSContext.ts +0 -35
  438. package/src/runjs-context/index.ts +0 -20
  439. package/src/runjs-context/snippets/global/api-request-get.snippet.ts +0 -20
  440. package/src/runjs-context/snippets/global/api-request-post.snippet.ts +0 -20
  441. package/src/runjs-context/snippets/global/console-log-ctx.snippet.ts +0 -19
  442. package/src/runjs-context/snippets/global/copy-record-json.snippet.ts +0 -21
  443. package/src/runjs-context/snippets/global/copy-to-clipboard.snippet.ts +0 -21
  444. package/src/runjs-context/snippets/global/log-json-record.snippet.ts +0 -21
  445. package/src/runjs-context/snippets/global/requireAsync.snippet.ts +0 -24
  446. package/src/runjs-context/snippets/global/sleep.snippet.ts +0 -21
  447. package/src/runjs-context/snippets/global/try-catch-async.snippet.ts +0 -22
  448. package/src/runjs-context/snippets/global/view-navigation-push.snippet.ts +0 -23
  449. package/src/runjs-context/snippets/libs/echarts-init.snippet.ts +0 -24
  450. package/src/runjs-context/snippets/scene/actions/record-id-message.snippet.ts +0 -21
  451. package/src/runjs-context/snippets/scene/actions/run-action-basic.snippet.ts +0 -18
  452. package/src/runjs-context/snippets/scene/jsblock/append-style.snippet.ts +0 -20
  453. package/src/runjs-context/snippets/scene/jsblock/jsx-mount.snippet.ts +0 -24
  454. package/src/runjs-context/snippets/scene/jsblock/jsx-unmount.snippet.ts +0 -19
  455. package/src/runjs-context/snippets/scene/jsblock/render-basic.snippet.ts +0 -24
  456. package/src/runjs-context/snippets/scene/jsblock/render-button-handler.snippet.ts +0 -24
  457. package/src/runjs-context/snippets/scene/jsblock/render-card.snippet.ts +0 -30
  458. package/src/runjs-context/snippets/scene/jsblock/render-react.snippet.ts +0 -34
  459. package/src/runjs-context/snippets/scene/jsfield/color-by-value.snippet.ts +0 -20
  460. package/src/runjs-context/snippets/scene/jsfield/format-number.snippet.ts +0 -19
  461. package/src/runjs-context/snippets/scene/jsfield/innerHTML-value.snippet.ts +0 -18
  462. /package/lib/runjs-context/snippets/global/{copy-record-json.snippet.d.ts → api-request.snippet.d.ts} +0 -0
  463. /package/lib/runjs-context/snippets/global/{copy-to-clipboard.snippet.d.ts → clipboard-copy-text.snippet.d.ts} +0 -0
  464. /package/lib/runjs-context/snippets/global/{log-json-record.snippet.d.ts → import-esm.snippet.d.ts} +0 -0
  465. /package/lib/runjs-context/snippets/global/{view-navigation-push.snippet.d.ts → query-selector.snippet.d.ts} +0 -0
  466. /package/lib/runjs-context/snippets/scene/{jsblock/render-card.snippet.d.ts → block/echarts-init.snippet.d.ts} +0 -0
@@ -7,37 +7,42 @@
7
7
  * For more information, please refer to: https://www.nocobase.com/agreement.
8
8
  */
9
9
 
10
- import { FlowRunJSContext } from './FlowRunJSContext';
11
- import { createSafeDocument, createSafeWindow } from '../../utils';
10
+ import { FlowRunJSContext } from '../../flowContext';
12
11
 
13
- export class JSFieldRunJSContext extends FlowRunJSContext {
14
- static injectDefaultGlobals() {
15
- return { window: createSafeWindow(), document: createSafeDocument() };
16
- }
17
- constructor(delegate: any) {
18
- super(delegate);
19
- this.defineProperty('element', { get: () => (this as any)._delegate['element'] });
20
- this.defineProperty('value', { get: () => (this as any)._delegate['value'] });
21
- this.defineProperty('record', { get: () => (this as any)._delegate['record'] });
22
- this.defineProperty('collection', { get: () => (this as any)._delegate['collection'] });
23
- }
24
- }
12
+ export class JSFieldRunJSContext extends FlowRunJSContext {}
25
13
 
26
14
  JSFieldRunJSContext.define({
27
15
  label: 'JSField RunJS context',
28
16
  properties: {
29
- element: 'ElementProxy,字段渲染容器',
30
- value: '字段当前值(只读)',
31
- record: '当前记录(只读)',
32
- collection: '集合定义(只读)',
17
+ element: `ElementProxy instance providing a safe DOM container for field rendering.
18
+ Supports innerHTML, append, and other DOM manipulation methods.`,
19
+ value: `Current value of the field (read-only).
20
+ Contains the data value stored in this field.`,
21
+ record: `Current record data object (read-only).
22
+ Contains all field values of the parent record.`,
23
+ collection: `Collection definition metadata (read-only).
24
+ Provides schema information about the collection this field belongs to.`,
33
25
  },
34
26
  methods: {
35
- onRefReady: 'Container ready callback',
36
- },
37
- snipastes: {
38
- 'Render value': { $ref: 'scene/jsfield/innerHTML-value', prefix: 'sn-jsf-value' },
39
- 'Message success': { $ref: 'global/message-success', prefix: 'sn-msg-ok' },
40
- 'Format number': { $ref: 'scene/jsfield/format-number', prefix: 'sn-jsf-num' },
41
- 'Color by value': { $ref: 'scene/jsfield/color-by-value', prefix: 'sn-jsf-color' },
27
+ onRefReady: `Wait for field container DOM element to be ready before executing callback.
28
+ Parameters: (ref: React.RefObject, callback: (element: HTMLElement) => void, timeout?: number) => void
29
+ Example: ctx.onRefReady(ctx.ref, (el) => { el.innerHTML = ctx.value })`,
42
30
  },
43
31
  });
32
+
33
+ JSFieldRunJSContext.define(
34
+ {
35
+ label: 'JS 字段 RunJS 上下文',
36
+ properties: {
37
+ element: 'ElementProxy,字段渲染容器,支持 innerHTML/append 等 DOM 操作',
38
+ value: '字段当前值(只读)',
39
+ record: '当前记录对象(只读,包含父记录全部字段值)',
40
+ collection: '集合定义元数据(只读,描述字段所属集合的 Schema)',
41
+ },
42
+ methods: {
43
+ onRefReady:
44
+ '在字段容器 DOM 就绪后执行回调。参数:(ref, callback, timeout?);示例:ctx.onRefReady(ctx.ref, el => { el.innerHTML = ctx.value })',
45
+ },
46
+ },
47
+ { locale: 'zh-CN' },
48
+ );
@@ -7,33 +7,37 @@
7
7
  * For more information, please refer to: https://www.nocobase.com/agreement.
8
8
  */
9
9
 
10
- import { FlowRunJSContext } from './FlowRunJSContext';
11
- import { createSafeDocument, createSafeWindow } from '../../utils';
10
+ import { FlowRunJSContext } from '../../flowContext';
12
11
 
13
- export class JSItemRunJSContext extends FlowRunJSContext {
14
- static injectDefaultGlobals() {
15
- return { window: createSafeWindow(), document: createSafeDocument() };
16
- }
17
- constructor(delegate: any) {
18
- super(delegate);
19
- this.defineProperty('element', { get: () => (this as any)._delegate['element'] });
20
- this.defineProperty('record', { get: () => (this as any)._delegate['record'] });
21
- this.defineProperty('resource', { get: () => (this as any)._delegate['resource'] });
22
- }
23
- }
12
+ export class JSItemRunJSContext extends FlowRunJSContext {}
24
13
 
25
14
  JSItemRunJSContext.define({
26
15
  label: 'JSItem RunJS context',
27
16
  properties: {
28
- element: 'ElementProxy,表单项渲染容器',
29
- resource: '当前资源(只读)',
30
- record: '当前记录(只读)',
17
+ element: `ElementProxy instance providing a safe DOM container for form item rendering.
18
+ Supports innerHTML, append, and other DOM manipulation methods.`,
19
+ resource: `Current resource instance (read-only).
20
+ Provides access to the data resource associated with the current form context.`,
21
+ record: `Current record data object (read-only).
22
+ Contains all field values of the parent record.`,
31
23
  },
32
24
  methods: {
33
- onRefReady: 'Container ready callback',
34
- requireAsync: 'Load external library',
35
- },
36
- snipastes: {
37
- 'Render form item': { $ref: 'scene/jsitem/render-basic', prefix: 'sn-jsitem-basic' },
25
+ onRefReady: `Wait for form item container DOM element to be ready before executing callback.
26
+ Parameters: (ref: React.RefObject, callback: (element: HTMLElement) => void, timeout?: number) => void`,
38
27
  },
39
28
  });
29
+
30
+ JSItemRunJSContext.define(
31
+ {
32
+ label: 'JS 表单项 RunJS 上下文',
33
+ properties: {
34
+ element: 'ElementProxy,表单项渲染容器,支持 innerHTML/append 等 DOM 操作',
35
+ resource: '当前资源(只读)',
36
+ record: '当前记录(只读)',
37
+ },
38
+ methods: {
39
+ onRefReady: '容器就绪后执行回调。参数:(ref, callback, timeout?)',
40
+ },
41
+ },
42
+ { locale: 'zh-CN' },
43
+ );
@@ -7,28 +7,27 @@
7
7
  * For more information, please refer to: https://www.nocobase.com/agreement.
8
8
  */
9
9
 
10
- import { FlowRunJSContext } from './FlowRunJSContext';
10
+ import { FlowRunJSContext } from '../../flowContext';
11
11
 
12
- export class JSRecordActionRunJSContext extends FlowRunJSContext {
13
- constructor(delegate: any) {
14
- super(delegate);
15
- this.defineProperty('record', { get: () => (this as any)._delegate['record'] });
16
- this.defineProperty('filterByTk', { get: () => (this as any)._delegate['filterByTk'] });
17
- }
18
- }
12
+ export class JSRecordActionRunJSContext extends FlowRunJSContext {}
19
13
 
20
14
  JSRecordActionRunJSContext.define({
21
15
  label: 'JSRecordAction RunJS context',
22
16
  properties: {
23
- record: '当前记录(只读)',
24
- filterByTk: '主键/过滤键(只读)',
25
- },
26
- methods: {
27
- runAction: 'Run action: `await ctx.runAction(name, params)`',
28
- message: 'Message API',
29
- },
30
- snipastes: {
31
- 'Show record id': { $ref: 'scene/actions/record-id-message', prefix: 'sn-act-record-id' },
32
- 'Run action': { $ref: 'scene/actions/run-action-basic', prefix: 'sn-act-run' },
17
+ record: `Current record data object (read-only).
18
+ Contains all field values of the record associated with this action.`,
19
+ filterByTk: `Primary key or filter key of the current record (read-only).
20
+ Used to identify the specific record in database operations.`,
33
21
  },
34
22
  });
23
+
24
+ JSRecordActionRunJSContext.define(
25
+ {
26
+ label: 'JS 记录动作 RunJS 上下文',
27
+ properties: {
28
+ record: '当前记录(只读)',
29
+ filterByTk: '主键/过滤键(只读)',
30
+ },
31
+ },
32
+ { locale: 'zh-CN' },
33
+ );
@@ -0,0 +1,196 @@
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 { FlowRunJSContext } from '../../flowContext';
11
+
12
+ export function defineBaseContextMeta() {
13
+ FlowRunJSContext.define({
14
+ label: 'RunJS base',
15
+ properties: {
16
+ logger: 'Pino logger instance for structured logging. Example: `ctx.logger.info({ foo: 1 }, "message")`',
17
+ message:
18
+ 'Ant Design global message API for displaying temporary messages. Example: `ctx.message.success("Operation completed")`',
19
+ notification:
20
+ 'Ant Design notification API for displaying notification boxes. Example: `ctx.notification.open({ message: "Title", description: "Content" })`',
21
+ resource: 'Data resource accessible based on current user permissions',
22
+ urlSearchParams: 'URLSearchParams object containing query parameters from the current URL',
23
+ token: 'API authentication token for the current session',
24
+ role: 'Current user role information',
25
+ auth: 'Authentication context containing locale, role, user, and token information',
26
+ api: {
27
+ description: 'APIClient instance for making HTTP requests.',
28
+ detail: 'APIClient',
29
+ properties: {
30
+ request: {
31
+ description:
32
+ 'Make an HTTP request using the APIClient instance. Parameters: (options: RequestOptions) => Promise<any>.',
33
+ detail: 'Promise<any>',
34
+ completion: {
35
+ insertText: `await ctx.api.request({ url: '', method: 'get', params: {} })`,
36
+ },
37
+ },
38
+ },
39
+ },
40
+ i18n: {
41
+ description: 'An instance of i18next for managing internationalization.',
42
+ detail: 'i18next',
43
+ properties: {
44
+ language: 'Current active language code.',
45
+ },
46
+ },
47
+ React:
48
+ 'React namespace providing React library functions and hooks (available in RunJS environment). Recommended access path: `ctx.libs.React`.',
49
+ ReactDOM:
50
+ 'ReactDOM client API including createRoot for rendering React components. Also available via `ctx.libs.ReactDOM`.',
51
+ antd: 'Ant Design component library. Recommended access path: `ctx.libs.antd`.',
52
+ libs: {
53
+ description: 'Namespace for third-party and shared libraries. Includes React, ReactDOM, Ant Design, and dayjs.',
54
+ detail: 'Libraries namespace',
55
+ properties: {
56
+ React: 'React namespace (same as ctx.React).',
57
+ ReactDOM: 'ReactDOM client API (same as ctx.ReactDOM).',
58
+ antd: 'Ant Design component library (same as ctx.antd).',
59
+ dayjs: 'dayjs date-time utility library.',
60
+ antdIcons: 'Ant Design icons library. Example: `ctx.libs.antdIcons.PlusOutlined`.',
61
+ },
62
+ },
63
+ },
64
+ methods: {
65
+ t: 'Internationalization function for translating text. Parameters: (key: string, variables?: object) => string. Example: `ctx.t("Hello {name}", { name: "World" })`',
66
+ render: {
67
+ description:
68
+ 'Render into container. Accepts ReactElement, DOM Node/Fragment, or HTML string. Parameters: (vnode: ReactElement | Node | DocumentFragment | string, container?: HTMLElement|ElementProxy) => Root|null. Example: `ctx.render(<div>Hello</div>)` or `ctx.render("<b>hi</b>")`',
69
+ detail: 'ReactDOM Root',
70
+ completion: {
71
+ insertText: `ctx.render(<div />)`,
72
+ },
73
+ },
74
+ requireAsync:
75
+ 'Asynchronously load external libraries from URL. Parameters: (url: string) => Promise<any>. Example: `const lodash = await ctx.requireAsync("https://cdn.jsdelivr.net/npm/lodash")`',
76
+ importAsync:
77
+ 'Dynamically import ESM module by URL. Parameters: (url: string) => Promise<Module>. Example: `const mod = await ctx.importAsync("https://cdn.jsdelivr.net/npm/lit-html@2/+esm")`',
78
+ resolveJsonTemplate:
79
+ 'Resolve JSON templates containing variable expressions with {{ }} syntax. Parameters: (template: any, context?: object) => any',
80
+ runAction: {
81
+ description:
82
+ 'Execute a data action on the current resource. Parameters: (actionName: string, params: object) => Promise<any>. Example: `await ctx.runAction("create", { values: { name: "test" } })`',
83
+ detail: 'Promise<any>',
84
+ completion: {
85
+ insertText: `await ctx.runAction('create', { values: {} })`,
86
+ },
87
+ },
88
+ openView: {
89
+ description: `Open a view component (page, modal, or drawer) by its unique identifier.
90
+ Parameters: (viewId: string, options?: OpenViewOptions) => Promise<void>
91
+ Options:
92
+ - params: Record<string, any> - Parameters passed to the view component
93
+ - mode: "page" | "modal" | "drawer" - Display mode (default: "drawer")
94
+ - title: string - Modal/drawer title
95
+ - width: number | string - Modal/drawer width
96
+ - navigation: boolean - Whether to use route navigation
97
+ - preventClose: boolean - Prevent closing the view
98
+ - viewUid: string - Custom view UID for routing
99
+ - isMobileLayout: boolean - Use mobile layout (displays as embed)
100
+ Examples:
101
+ - Modal with params: await ctx.openView("user-detail", { params: { id: 123 }, mode: "modal", title: "User Details", width: 800 })
102
+ - Drawer (default): await ctx.openView("settings-page")
103
+ - Page navigation: await ctx.openView("dashboard", { mode: "page" })`,
104
+ detail: 'Promise<void>',
105
+ completion: {
106
+ insertText: `await ctx.openView('view-id', { mode: 'drawer', params: {} })`,
107
+ },
108
+ },
109
+ },
110
+ });
111
+
112
+ FlowRunJSContext.define(
113
+ {
114
+ label: 'RunJS 基础',
115
+ properties: {
116
+ logger: 'Pino 日志实例(结构化日志)。示例:`ctx.logger.info({ foo: 1 }, "message")`',
117
+ message: 'Ant Design 全局消息 API,用于显示临时提示。示例:`ctx.message.success("操作成功")`',
118
+ notification:
119
+ 'Ant Design 通知 API,用于显示通知框。示例:`ctx.notification.open({ message: "标题", description: "内容" })`',
120
+ resource: '基于当前用户权限可访问的数据资源',
121
+ urlSearchParams: '当前 URL 的查询参数(URLSearchParams 对象)',
122
+ token: '当前会话的 API 认证 token',
123
+ role: '当前用户角色信息',
124
+ auth: '认证上下文,包含 locale、role、user、token 等信息',
125
+ api: {
126
+ description: '用于发起 HTTP 请求的 APIClient 实例',
127
+ detail: 'APIClient',
128
+ properties: {
129
+ request: {
130
+ description: '通过 ctx.api.request 发起 HTTP 请求,入参为 RequestOptions,返回 Promise。',
131
+ detail: 'Promise<any>',
132
+ completion: {
133
+ insertText: `await ctx.api.request({ url: '', method: 'get', params: {} })`,
134
+ },
135
+ },
136
+ },
137
+ },
138
+ i18n: {
139
+ description: 'i18next 实例,可用于管理国际化',
140
+ detail: 'i18next',
141
+ properties: {
142
+ language: '当前激活的语言代码',
143
+ },
144
+ },
145
+ React: 'React 命名空间,提供 React 函数与 hooks(RunJS 环境中可用)。推荐使用 `ctx.libs.React` 访问。',
146
+ ReactDOM: 'ReactDOM 客户端 API,含 createRoot 等渲染方法。推荐通过 `ctx.libs.ReactDOM` 访问。',
147
+ antd: 'Ant Design 组件库(RunJS 环境中可用)。推荐使用 `ctx.libs.antd` 访问。',
148
+ libs: {
149
+ description:
150
+ '第三方/通用库的统一命名空间,包含 React、ReactDOM、Ant Design、dayjs 等。后续新增库会优先挂在此处。',
151
+ detail: '通用库命名空间',
152
+ properties: {
153
+ React: 'React 命名空间(等价于 ctx.React)。',
154
+ ReactDOM: 'ReactDOM 客户端 API(等价于 ctx.ReactDOM)。',
155
+ antd: 'Ant Design 组件库(等价于 ctx.antd)。',
156
+ dayjs: 'dayjs 日期时间工具库。',
157
+ antdIcons: 'Ant Design 图标库。 例如:`ctx.libs.antdIcons.PlusOutlined`。',
158
+ },
159
+ },
160
+ },
161
+ methods: {
162
+ t: '国际化函数,用于翻译文案。参数:(key: string, variables?: object) => string。示例:`ctx.t("你好 {name}", { name: "世界" })`',
163
+ render: {
164
+ description:
165
+ '渲染到容器。vnode 支持 ReactElement、DOM 节点/片段、或 HTML 字符串。参数:(vnode: ReactElement | Node | DocumentFragment | string, container?: HTMLElement|ElementProxy) => Root|null。示例:`ctx.render(<div />)` 或 `ctx.render("<b>hi</b>")`',
166
+ detail: 'ReactDOM Root',
167
+ completion: {
168
+ insertText: `ctx.render(<div />)`,
169
+ },
170
+ },
171
+ requireAsync:
172
+ '按 URL 异步加载外部库。参数:(url: string) => Promise<any>。示例:`const lodash = await ctx.requireAsync("https://cdn.jsdelivr.net/npm/lodash")`',
173
+ importAsync:
174
+ '按 URL 动态导入 ESM 模块(开发/生产均可用)。参数:(url: string) => Promise<Module>。示例:`const mod = await ctx.importAsync("https://cdn.jsdelivr.net/npm/lit-html@2/+esm")`',
175
+ resolveJsonTemplate: '解析含 {{ }} 变量表达式的 JSON 模板。参数:(template: any, context?: object) => any',
176
+ runAction: {
177
+ description:
178
+ '对当前资源执行数据动作。参数:(actionName: string, params: object) => Promise<any>。示例:`await ctx.runAction("create", { values: { name: "test" } })`',
179
+ detail: 'Promise<any>',
180
+ completion: {
181
+ insertText: `await ctx.runAction('create', { values: {} })`,
182
+ },
183
+ },
184
+ openView: {
185
+ description:
186
+ '根据唯一标识打开视图(页面/弹窗/抽屉)。参数:(viewId: string, options?: OpenViewOptions) => Promise<void>`,常用选项:params、mode、title、width、navigation、preventClose、viewUid、isMobileLayout。',
187
+ detail: 'Promise<void>',
188
+ completion: {
189
+ insertText: `await ctx.openView('view-id', { mode: 'drawer', params: {} })`,
190
+ },
191
+ },
192
+ },
193
+ },
194
+ { locale: 'zh-CN' },
195
+ );
196
+ }
@@ -10,47 +10,49 @@
10
10
  import type { FlowContext } from '../flowContext';
11
11
  import { JSRunner } from '../JSRunner';
12
12
  import type { JSRunnerOptions } from '../JSRunner';
13
- import { FlowRunJSContext, RunJSVersion } from './contexts/FlowRunJSContext';
14
- import { RunJSContextRegistry, getModelClassName } from './registry';
15
- import { JSBlockRunJSContext } from './contexts/JSBlockRunJSContext';
16
- import { JSFieldRunJSContext } from './contexts/JSFieldRunJSContext';
17
- import { JSItemRunJSContext } from './contexts/JSItemRunJSContext';
18
- import { FormJSFieldItemRunJSContext } from './contexts/FormJSFieldItemRunJSContext';
19
- import { JSRecordActionRunJSContext } from './contexts/JSRecordActionRunJSContext';
20
- import { JSCollectionActionRunJSContext } from './contexts/JSCollectionActionRunJSContext';
21
- import { LinkageRunJSContext } from './contexts/LinkageRunJSContext';
13
+ import { RunJSContextRegistry, getModelClassName, type RunJSVersion } from './registry';
14
+
15
+ function getLocale(ctx: any): string | undefined {
16
+ return ctx?.api?.auth?.locale || ctx?.i18n?.language || ctx?.locale;
17
+ }
22
18
 
23
19
  export function getRunJSDocFor(ctx: FlowContext, { version = 'v1' as RunJSVersion } = {}) {
24
20
  const modelClass = getModelClassName(ctx);
25
- const ctor =
26
- RunJSContextRegistry.resolve(version, modelClass) ||
27
- RunJSContextRegistry.resolve('latest' as RunJSVersion, modelClass) ||
28
- FlowRunJSContext;
29
- return (ctor as any).getDoc?.() || {};
21
+ const ctor = RunJSContextRegistry.resolve(version, modelClass) || RunJSContextRegistry.resolve(version, '*');
22
+ const locale = getLocale(ctx);
23
+ if ((ctor as any)?.getDoc?.length) {
24
+ // prefer getDoc(locale)
25
+ return (ctor as any).getDoc(locale) || {};
26
+ }
27
+ return (ctor as any)?.getDoc?.() || {};
30
28
  }
31
29
 
32
30
  export function createJSRunnerWithVersion(this: FlowContext, options?: JSRunnerOptions) {
33
31
  const version = (options?.version as RunJSVersion) || ('v1' as RunJSVersion);
34
32
  const modelClass = getModelClassName(this);
35
- const Ctor =
36
- RunJSContextRegistry.resolve(version, modelClass) ||
37
- RunJSContextRegistry.resolve('latest' as RunJSVersion, modelClass) ||
38
- FlowRunJSContext;
39
- const runCtx = new Ctor((this as any).createProxy ? (this as any).createProxy() : (this as any));
40
- const def = (Ctor as any).injectDefaultGlobals?.() || {};
41
- const globals = { ctx: runCtx, ...def, ...(options?.globals || {}) };
33
+ const ensureFlowContext = (obj: any): FlowContext => obj as FlowContext;
34
+ const Ctor = RunJSContextRegistry.resolve(version, modelClass) || RunJSContextRegistry.resolve(version, '*');
35
+ if (!Ctor) {
36
+ throw new Error('[RunJS] No RunJSContext registered for version/model.');
37
+ }
38
+ const runCtx = new (Ctor as any)(ensureFlowContext(this));
39
+ const globals: Record<string, any> = { ctx: runCtx, ...(options?.globals || {}) };
40
+ // 对字段/区块类上下文,默认注入 window/document 以支持在沙箱中访问 DOM API
41
+ if (modelClass === 'JSFieldModel' || modelClass === 'JSBlockModel') {
42
+ if (typeof window !== 'undefined') globals.window = window as any;
43
+ if (typeof document !== 'undefined') globals.document = document as any;
44
+ }
42
45
  // 透传 JSRunnerOptions 其余配置(如 timeoutMs)
43
46
  const { timeoutMs } = options || {};
44
47
  return new JSRunner({ globals, timeoutMs });
45
48
  }
46
49
 
47
- export function registerDefaultMappings() {
48
- const v: RunJSVersion = 'v1';
49
- RunJSContextRegistry.register(v, 'JSBlockModel', JSBlockRunJSContext);
50
- RunJSContextRegistry.register(v, 'JSFieldModel', JSFieldRunJSContext);
51
- RunJSContextRegistry.register(v, 'JSItemModel', JSItemRunJSContext);
52
- RunJSContextRegistry.register(v, 'FormJSFieldItemModel', FormJSFieldItemRunJSContext);
53
- RunJSContextRegistry.register(v, 'JSRecordActionModel', JSRecordActionRunJSContext);
54
- RunJSContextRegistry.register(v, 'JSCollectionActionModel', JSCollectionActionRunJSContext);
55
- RunJSContextRegistry.register(v, '*', FlowRunJSContext);
50
+ export function getRunJSScenesForModel(modelClass: string, version: RunJSVersion = 'v1'): string[] {
51
+ const meta = RunJSContextRegistry.getMeta(version, modelClass);
52
+ return Array.isArray(meta?.scenes) ? [...meta!.scenes!] : [];
53
+ }
54
+
55
+ export function getRunJSScenesForContext(ctx: FlowContext, { version = 'v1' as RunJSVersion } = {}): string[] {
56
+ const modelClass = getModelClassName(ctx);
57
+ return getRunJSScenesForModel(modelClass, version);
56
58
  }
@@ -7,59 +7,28 @@
7
7
  * For more information, please refer to: https://www.nocobase.com/agreement.
8
8
  */
9
9
 
10
- import type { RunJSVersion, RunJSContextCtor } from './contexts/FlowRunJSContext';
11
- import { FlowRunJSContext } from './contexts/FlowRunJSContext';
12
- import { JSBlockRunJSContext } from './contexts/JSBlockRunJSContext';
13
- import { JSFieldRunJSContext } from './contexts/JSFieldRunJSContext';
14
- import { JSItemRunJSContext } from './contexts/JSItemRunJSContext';
15
- import { FormJSFieldItemRunJSContext } from './contexts/FormJSFieldItemRunJSContext';
16
- import { JSRecordActionRunJSContext } from './contexts/JSRecordActionRunJSContext';
17
- import { JSCollectionActionRunJSContext } from './contexts/JSCollectionActionRunJSContext';
10
+ // 为避免在模块初始化阶段引入 FlowContext(从而触发循环依赖),不要在顶层导入各类 RunJSContext。
11
+ // 在需要默认映射时(首次 resolve)再使用 createRequire 同步加载对应模块。
12
+
13
+ export type RunJSVersion = 'v1' | (string & {});
14
+ export type RunJSContextCtor = new (delegate: any) => any;
15
+ export type RunJSContextMeta = {
16
+ scenes?: string[];
17
+ };
18
18
 
19
19
  export class RunJSContextRegistry {
20
- private static map = new Map<string, RunJSContextCtor>();
21
- private static defaultsRegistered = false;
22
- private static ensureDefaults() {
23
- if (this.defaultsRegistered) return;
24
- // v1 默认映射(延迟注册:首次访问时再注册)
25
- const v = 'v1' as RunJSVersion;
26
- try {
27
- const ensure = (model: string, ctor: RunJSContextCtor) => {
28
- const key = `${v}:${model}`;
29
- if (!this.map.has(key)) this.map.set(key, ctor);
30
- };
31
- ensure('JSBlockModel', JSBlockRunJSContext as any);
32
- ensure('JSFieldModel', JSFieldRunJSContext as any);
33
- ensure('JSItemModel', JSItemRunJSContext as any);
34
- ensure('FormJSFieldItemModel', FormJSFieldItemRunJSContext as any);
35
- ensure('JSRecordActionModel', JSRecordActionRunJSContext as any);
36
- ensure('JSCollectionActionModel', JSCollectionActionRunJSContext as any);
37
- ensure('*', FlowRunJSContext as any);
38
- } finally {
39
- this.defaultsRegistered = true;
40
- }
41
- }
42
- static register(version: RunJSVersion, modelClass: string, ctor: RunJSContextCtor) {
43
- this.map.set(`${version}:${modelClass}`, ctor);
20
+ private static map = new Map<string, { ctor: RunJSContextCtor; meta?: RunJSContextMeta }>();
21
+ static register(version: RunJSVersion, modelClass: string, ctor: RunJSContextCtor, meta?: RunJSContextMeta) {
22
+ this.map.set(`${version}:${modelClass}`, { ctor, meta });
44
23
  }
45
24
  static resolve(version: RunJSVersion, modelClass: string) {
46
- this.ensureDefaults();
47
- return this.map.get(`${version}:${modelClass}`) || this.map.get(`${version}:*`);
25
+ return this.map.get(`${version}:${modelClass}`)?.ctor || this.map.get(`${version}:*`)?.ctor;
26
+ }
27
+ static getMeta(version: RunJSVersion, modelClass: string): RunJSContextMeta | undefined {
28
+ return this.map.get(`${version}:${modelClass}`)?.meta || this.map.get(`${version}:*`)?.meta;
48
29
  }
49
30
  }
50
31
 
51
32
  export function getModelClassName(ctx: any): string {
52
- const model = ctx?.model;
53
- if (!model) return '*';
54
- // 1) 优先使用类 meta 中声明的 createModelOptions.use(构建后稳定,不受构造函数名压缩影响)
55
- try {
56
- const Ctor = model.constructor as any;
57
- const use = Ctor?.meta?.createModelOptions?.use;
58
- if (typeof use === 'string' && use) return use;
59
- } catch (_) {
60
- // ignore
61
- }
62
- // 2) 回退到构造函数名(开发模式可靠,生产模式可能被压缩)
63
- const byName = model?.constructor?.name;
64
- return byName || '*';
33
+ return ctx?.model?.constructor?.name || '*';
65
34
  }
@@ -0,0 +1,51 @@
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
+ /**
11
+ * RunJS context registration entry. No side-effects by default.
12
+ */
13
+ import { RunJSContextRegistry } from './registry';
14
+ import { FlowRunJSContext } from '../flowContext';
15
+ import { defineBaseContextMeta } from './contexts/base';
16
+
17
+ let done = false;
18
+ export async function setupRunJSContexts() {
19
+ if (done) return;
20
+ defineBaseContextMeta();
21
+
22
+ // Lazy import to avoid circular dependencies during module initialization
23
+ const [
24
+ { JSBlockRunJSContext },
25
+ { JSFieldRunJSContext },
26
+ { JSItemRunJSContext },
27
+ { JSColumnRunJSContext },
28
+ { FormJSFieldItemRunJSContext },
29
+ { JSRecordActionRunJSContext },
30
+ { JSCollectionActionRunJSContext },
31
+ ] = await Promise.all([
32
+ import('./contexts/JSBlockRunJSContext'),
33
+ import('./contexts/JSFieldRunJSContext'),
34
+ import('./contexts/JSItemRunJSContext'),
35
+ import('./contexts/JSColumnRunJSContext'),
36
+ import('./contexts/FormJSFieldItemRunJSContext'),
37
+ import('./contexts/JSRecordActionRunJSContext'),
38
+ import('./contexts/JSCollectionActionRunJSContext'),
39
+ ]);
40
+
41
+ const v1 = 'v1';
42
+ RunJSContextRegistry.register(v1, '*', FlowRunJSContext);
43
+ RunJSContextRegistry.register(v1, 'JSBlockModel', JSBlockRunJSContext, { scenes: ['block'] });
44
+ RunJSContextRegistry.register(v1, 'JSFieldModel', JSFieldRunJSContext, { scenes: ['detail'] });
45
+ RunJSContextRegistry.register(v1, 'JSItemModel', JSItemRunJSContext, { scenes: ['form'] });
46
+ RunJSContextRegistry.register(v1, 'JSColumnModel', JSColumnRunJSContext, { scenes: ['table'] });
47
+ RunJSContextRegistry.register(v1, 'FormJSFieldItemModel', FormJSFieldItemRunJSContext, { scenes: ['form'] });
48
+ RunJSContextRegistry.register(v1, 'JSRecordActionModel', JSRecordActionRunJSContext, { scenes: ['table'] });
49
+ RunJSContextRegistry.register(v1, 'JSCollectionActionModel', JSCollectionActionRunJSContext, { scenes: ['table'] });
50
+ done = true;
51
+ }
@@ -0,0 +1,38 @@
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 type { SnippetModule } from '../types';
11
+
12
+ const snippet: SnippetModule = {
13
+ contexts: ['*'],
14
+ prefix: 'sn-api-request',
15
+ label: 'API request template',
16
+ description: 'Basic template to send HTTP requests via ctx.api.request',
17
+ locales: {
18
+ 'zh-CN': {
19
+ label: 'API 请求模板',
20
+ description: '使用 ctx.api.request 发送 HTTP 请求的基础模板',
21
+ },
22
+ },
23
+ content: `
24
+ // Replace url/method/params/data as needed
25
+ const response = await ctx.api.request({
26
+ url: 'users:list',
27
+ method: 'get',
28
+ params: {
29
+ pageSize: 10,
30
+ },
31
+ });
32
+
33
+ ctx.message.success(ctx.t('Request finished'));
34
+ console.log(ctx.t('Response data:'), response?.data);
35
+ `,
36
+ };
37
+
38
+ export default snippet;