rez_core 5.0.182 → 6.5.0

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 (426) hide show
  1. package/.claude/settings.local.json +26 -0
  2. package/.idea/250218_nodejs_core.iml +8 -11
  3. package/.idea/codeStyles/Project.xml +58 -58
  4. package/.idea/codeStyles/codeStyleConfig.xml +4 -4
  5. package/.idea/copilot.data.migration.agent.xml +6 -0
  6. package/.idea/copilot.data.migration.ask.xml +6 -0
  7. package/.idea/copilot.data.migration.ask2agent.xml +6 -0
  8. package/.idea/copilot.data.migration.edit.xml +6 -0
  9. package/.idea/inspectionProfiles/Project_Default.xml +6 -0
  10. package/.idea/misc.xml +6 -0
  11. package/.idea/modules.xml +7 -7
  12. package/.idea/prettier.xml +6 -0
  13. package/.idea/vcs.xml +5 -5
  14. package/.prettierrc +3 -3
  15. package/README.md +99 -99
  16. package/dist/module/auth/guards/role.guard.js +3 -3
  17. package/dist/module/enterprise/controller/enterprise.controller.d.ts +12 -0
  18. package/dist/module/enterprise/controller/enterprise.controller.js +57 -0
  19. package/dist/module/enterprise/controller/enterprise.controller.js.map +1 -0
  20. package/dist/module/enterprise/controller/organization.controller.d.ts +11 -1
  21. package/dist/module/enterprise/controller/organization.controller.js +62 -2
  22. package/dist/module/enterprise/controller/organization.controller.js.map +1 -1
  23. package/dist/module/enterprise/enterprise.module.js +2 -1
  24. package/dist/module/enterprise/enterprise.module.js.map +1 -1
  25. package/dist/module/enterprise/entity/enterprise.entity.d.ts +1 -3
  26. package/dist/module/enterprise/entity/enterprise.entity.js +4 -12
  27. package/dist/module/enterprise/entity/enterprise.entity.js.map +1 -1
  28. package/dist/module/enterprise/entity/organization.entity.d.ts +1 -17
  29. package/dist/module/enterprise/entity/organization.entity.js +4 -72
  30. package/dist/module/enterprise/entity/organization.entity.js.map +1 -1
  31. package/dist/module/enterprise/repository/enterprise.repository.d.ts +2 -2
  32. package/dist/module/enterprise/repository/enterprise.repository.js +9 -4
  33. package/dist/module/enterprise/repository/enterprise.repository.js.map +1 -1
  34. package/dist/module/enterprise/service/enterprise.service.d.ts +2 -2
  35. package/dist/module/enterprise/service/enterprise.service.js +4 -4
  36. package/dist/module/enterprise/service/enterprise.service.js.map +1 -1
  37. package/dist/module/enterprise/service/organization.service.d.ts +2 -2
  38. package/dist/module/enterprise/service/organization.service.js +97 -20
  39. package/dist/module/enterprise/service/organization.service.js.map +1 -1
  40. package/dist/module/filter/service/filter.service.js +19 -19
  41. package/dist/module/integration/examples/usage.example.js +9 -9
  42. package/dist/module/meta/repository/attribute-master.repository.js +8 -8
  43. package/dist/module/meta/service/entity-dynamic.service.js +16 -16
  44. package/dist/module/meta/service/media-data.service.js +6 -6
  45. package/dist/module/meta/service/resolver.service.js +11 -11
  46. package/dist/module/module/repository/menu.repository.js +4 -4
  47. package/dist/module/notification/service/notification.service.js +6 -6
  48. package/dist/module/user/controller/login.controller.js +18 -18
  49. package/dist/module/workflow/repository/action.repository.js +2 -2
  50. package/dist/module/workflow/repository/stage.repository.js +8 -8
  51. package/dist/module/workflow/service/action-template-mapping.service.js +2 -2
  52. package/dist/module/workflow/service/action.service.js +5 -5
  53. package/dist/module/workflow/service/entity-modification.service.js +2 -2
  54. package/dist/module/workflow/service/task.service.js +8 -8
  55. package/dist/module/workflow-automation/service/schedule-handler.service.js +9 -9
  56. package/dist/table.config.d.ts +1 -2
  57. package/dist/tsconfig.build.tsbuildinfo +1 -1
  58. package/dist/utils/service/reflection-helper.service.js +2 -2
  59. package/docs/modules/event-driven-integration-design.md +91 -91
  60. package/docs/modules/integration.md +250 -250
  61. package/eslint.config.mjs +34 -34
  62. package/nest-cli.json +14 -14
  63. package/package.json +125 -125
  64. package/server.log +850 -0
  65. package/src/app.controller.ts +12 -12
  66. package/src/app.module.ts +68 -68
  67. package/src/app.service.ts +8 -8
  68. package/src/config/bull.config.ts +69 -69
  69. package/src/config/config.module.ts +17 -17
  70. package/src/config/database.config.ts +48 -48
  71. package/src/constant/global.constant.ts +67 -67
  72. package/src/core.module.ts +94 -94
  73. package/src/decorators/roles.decorator.ts +7 -7
  74. package/src/dtos/response.dto.ts +6 -6
  75. package/src/dtos/response.ts +5 -5
  76. package/src/index.ts +1 -1
  77. package/src/module/auth/auth.module.ts +49 -49
  78. package/src/module/auth/controller/auth.controller.ts +28 -28
  79. package/src/module/auth/guards/google-auth.guard.ts +9 -9
  80. package/src/module/auth/guards/jwt.guard.ts +22 -22
  81. package/src/module/auth/guards/role.guard.ts +68 -68
  82. package/src/module/auth/services/auth.service.ts +56 -56
  83. package/src/module/auth/services/jwt.service.ts +11 -11
  84. package/src/module/auth/strategies/google.strategy.ts +54 -54
  85. package/src/module/auth/strategies/jwt.strategy.ts +58 -58
  86. package/src/module/auth/strategies/local.strategy.ts +13 -13
  87. package/src/module/dashboard/controller/dashboard.controller.ts +38 -38
  88. package/src/module/dashboard/dashboard.module.ts +21 -21
  89. package/src/module/dashboard/entity/dashboard_page_data.entity.ts +27 -27
  90. package/src/module/dashboard/entity/widget_master.entity.ts +18 -18
  91. package/src/module/dashboard/repository/dashboard.repository.ts +49 -49
  92. package/src/module/dashboard/service/dashboard.service.ts +72 -72
  93. package/src/module/enterprise/controller/enterprise.controller.ts +40 -0
  94. package/src/module/enterprise/controller/organization.controller.ts +93 -36
  95. package/src/module/enterprise/enterprise.module.ts +46 -45
  96. package/src/module/enterprise/entity/enterprise.entity.ts +31 -37
  97. package/src/module/enterprise/entity/organization-app-mapping.entity.ts +13 -13
  98. package/src/module/enterprise/entity/organization.entity.ts +40 -92
  99. package/src/module/enterprise/repository/enterprise.repository.ts +39 -31
  100. package/src/module/enterprise/repository/organization.repository.ts +26 -26
  101. package/src/module/enterprise/repository/school.repository.ts +272 -272
  102. package/src/module/enterprise/service/brand.service.ts +5 -5
  103. package/src/module/enterprise/service/enterprise.service.ts +22 -16
  104. package/src/module/enterprise/service/organization-app-mapping.service.ts +4 -4
  105. package/src/module/enterprise/service/organization.service.ts +262 -145
  106. package/src/module/entity_json/controller/entity_json.controller.ts +47 -47
  107. package/src/module/entity_json/entity/entityJson.entity.ts +39 -39
  108. package/src/module/entity_json/entity_json.module.ts +18 -18
  109. package/src/module/entity_json/service/entityJson.repository.ts +37 -37
  110. package/src/module/entity_json/service/entity_json.service.ts +241 -241
  111. package/src/module/export/controller/export.controller.ts +83 -83
  112. package/src/module/export/export.module.ts +14 -14
  113. package/src/module/export/service/export.service.ts +105 -105
  114. package/src/module/filter/controller/filter.controller.ts +87 -87
  115. package/src/module/filter/dto/filter-request.dto.ts +39 -39
  116. package/src/module/filter/entity/saved-filter-detail.entity.ts +41 -41
  117. package/src/module/filter/entity/saved-filter-master.entity.ts +35 -35
  118. package/src/module/filter/filter.module.ts +33 -33
  119. package/src/module/filter/repository/saved-filter.repository.ts +247 -247
  120. package/src/module/filter/repository/saved.filter-detail.repository.ts +19 -19
  121. package/src/module/filter/service/filter-evaluator.service.ts +82 -82
  122. package/src/module/filter/service/filter.service.ts +1316 -1316
  123. package/src/module/filter/service/saved-filter.service.ts +164 -164
  124. package/src/module/ics/controller/ics.controller.ts +21 -21
  125. package/src/module/ics/dto/ics.dto.ts +55 -55
  126. package/src/module/ics/ics.module.ts +13 -13
  127. package/src/module/ics/service/ics.service.ts +57 -57
  128. package/src/module/integration/controller/calender-event.controller.ts +31 -31
  129. package/src/module/integration/controller/integration.controller.ts +662 -662
  130. package/src/module/integration/controller/wrapper.controller.ts +37 -37
  131. package/src/module/integration/dto/create-config.dto.ts +526 -526
  132. package/src/module/integration/entity/integration-config.entity.ts +112 -112
  133. package/src/module/integration/entity/integration-entity-mapper.entity.ts +14 -14
  134. package/src/module/integration/entity/integration-source.entity.ts +17 -17
  135. package/src/module/integration/entity/user-integration.entity.ts +71 -71
  136. package/src/module/integration/examples/usage.example.ts +338 -338
  137. package/src/module/integration/factories/base.factory.ts +7 -7
  138. package/src/module/integration/factories/email.factory.ts +49 -49
  139. package/src/module/integration/factories/integration.factory.ts +121 -121
  140. package/src/module/integration/factories/sms.factory.ts +51 -51
  141. package/src/module/integration/factories/telephone.factory.ts +41 -41
  142. package/src/module/integration/factories/whatsapp.factory.ts +56 -56
  143. package/src/module/integration/integration.module.ts +110 -110
  144. package/src/module/integration/service/calendar-event.service.ts +118 -118
  145. package/src/module/integration/service/integration-entity-mapper.service.ts +17 -17
  146. package/src/module/integration/service/integration-queue.service.ts +229 -229
  147. package/src/module/integration/service/integration.service.ts +2634 -2634
  148. package/src/module/integration/service/oauth.service.ts +224 -224
  149. package/src/module/integration/service/wrapper.service.ts +753 -753
  150. package/src/module/integration/strategies/email/gmail-api.strategy.ts +280 -280
  151. package/src/module/integration/strategies/email/outlook-api.strategy.ts +44 -44
  152. package/src/module/integration/strategies/email/outlook.strategy.ts +64 -64
  153. package/src/module/integration/strategies/email/sendgrid-api.strategy.ts +260 -260
  154. package/src/module/integration/strategies/integration.strategy.ts +97 -97
  155. package/src/module/integration/strategies/sms/gupshup-sms.strategy.ts +146 -146
  156. package/src/module/integration/strategies/sms/msg91-sms.strategy.ts +164 -164
  157. package/src/module/integration/strategies/sms/tubelight-sms.strategy.ts +163 -163
  158. package/src/module/integration/strategies/telephone/ozonetel-voice.strategy.ts +238 -238
  159. package/src/module/integration/strategies/telephone/tubelight-voice.strategy.ts +210 -210
  160. package/src/module/integration/strategies/whatsapp/gupshup-whatsapp.strategy.ts +359 -359
  161. package/src/module/integration/strategies/whatsapp/tubelight-whatsapp.strategy.ts +372 -372
  162. package/src/module/integration/strategies/whatsapp/whatsapp-cloud.strategy.ts +403 -403
  163. package/src/module/integration/strategies/whatsapp/whatsapp.strategy.ts +57 -57
  164. package/src/module/layout/controller/layout.controller.ts +47 -47
  165. package/src/module/layout/entity/header-items.entity.ts +28 -28
  166. package/src/module/layout/entity/header-section.entity.ts +19 -19
  167. package/src/module/layout/layout.module.ts +21 -21
  168. package/src/module/layout/repository/header-items.repository.ts +18 -18
  169. package/src/module/layout/repository/header-section.repository.ts +22 -22
  170. package/src/module/layout/service/header-section.service.ts +25 -25
  171. package/src/module/layout_preference/controller/layout_preference.controller.ts +76 -76
  172. package/src/module/layout_preference/entity/layout_preference.entity.ts +28 -28
  173. package/src/module/layout_preference/layout_preference.module.ts +22 -22
  174. package/src/module/layout_preference/repository/layout_preference.repository.ts +65 -65
  175. package/src/module/layout_preference/service/layout_preference.service.ts +191 -191
  176. package/src/module/lead/controller/lead.controller.ts +30 -30
  177. package/src/module/lead/lead.module.ts +14 -14
  178. package/src/module/lead/repository/lead.repository.ts +41 -41
  179. package/src/module/lead/service/lead.service.ts +54 -54
  180. package/src/module/linked_attributes/controller/linked_attributes.controller.ts +37 -37
  181. package/src/module/linked_attributes/entity/linked_attribute.entity.ts +51 -51
  182. package/src/module/linked_attributes/linked_attributes.module.ts +16 -16
  183. package/src/module/linked_attributes/repository/linked_attribute.repository.ts +12 -12
  184. package/src/module/linked_attributes/service/linked_attributes.service.ts +73 -73
  185. package/src/module/listmaster/controller/list-master.controller.ts +230 -230
  186. package/src/module/listmaster/entity/list-master-items.entity.ts +43 -43
  187. package/src/module/listmaster/entity/list-master.entity.ts +33 -33
  188. package/src/module/listmaster/listmaster.module.ts +46 -46
  189. package/src/module/listmaster/repository/list-master-items.repository.ts +173 -173
  190. package/src/module/listmaster/repository/list-master.repository.ts +56 -56
  191. package/src/module/listmaster/service/list-master-engine.ts +19 -19
  192. package/src/module/listmaster/service/list-master-extension.interface.ts +4 -4
  193. package/src/module/listmaster/service/list-master-item.service.ts +280 -280
  194. package/src/module/listmaster/service/list-master-registry.ts +15 -15
  195. package/src/module/listmaster/service/list-master.service.ts +527 -527
  196. package/src/module/mapper/controller/field-mapper.controller.ts +76 -76
  197. package/src/module/mapper/controller/mapper.controller.ts +20 -20
  198. package/src/module/mapper/dto/field-mapper.dto.ts +14 -14
  199. package/src/module/mapper/entity/field-lovs.entity.ts +19 -19
  200. package/src/module/mapper/entity/field-mapper.entity.ts +53 -53
  201. package/src/module/mapper/entity/mapper.entity.ts +16 -16
  202. package/src/module/mapper/mapper.module.ts +35 -35
  203. package/src/module/mapper/repository/field-lovs.repository.ts +35 -35
  204. package/src/module/mapper/repository/field-mapper.repository.ts +42 -42
  205. package/src/module/mapper/repository/mapper.repository.ts +32 -32
  206. package/src/module/mapper/service/field-mapper.service.ts +269 -269
  207. package/src/module/mapper/service/mapper.service.ts +80 -80
  208. package/src/module/master/controller/master.controller.ts +74 -74
  209. package/src/module/master/service/master.service.ts +484 -484
  210. package/src/module/meta/controller/app-master.controller.ts +38 -38
  211. package/src/module/meta/controller/attribute-master.controller.ts +84 -84
  212. package/src/module/meta/controller/entity-dynamic.controller.ts +125 -125
  213. package/src/module/meta/controller/entity-master.controller.ts +41 -41
  214. package/src/module/meta/controller/entity-relation.controller.ts +36 -36
  215. package/src/module/meta/controller/entity.controller.ts +308 -308
  216. package/src/module/meta/controller/entity.public.controller.ts +75 -75
  217. package/src/module/meta/controller/media.controller.ts +135 -135
  218. package/src/module/meta/controller/meta.controller.ts +101 -101
  219. package/src/module/meta/controller/view-master.controller.ts +79 -79
  220. package/src/module/meta/dto/entity-list-data.dto.ts +6 -6
  221. package/src/module/meta/dto/entity-tab.dto.ts +4 -4
  222. package/src/module/meta/dto/entity-table.dto.ts +12 -12
  223. package/src/module/meta/entity/app-master.entity.ts +37 -37
  224. package/src/module/meta/entity/attribute-master.entity.ts +92 -92
  225. package/src/module/meta/entity/base-entity.entity.ts +75 -75
  226. package/src/module/meta/entity/entity-master.entity.ts +85 -85
  227. package/src/module/meta/entity/entity-relation-data.entity.ts +29 -29
  228. package/src/module/meta/entity/entity-relation.entity.ts +23 -23
  229. package/src/module/meta/entity/entity-table-column.entity.ts +61 -61
  230. package/src/module/meta/entity/entity-table.entity.ts +50 -50
  231. package/src/module/meta/entity/media-data.entity.ts +32 -32
  232. package/src/module/meta/entity/preference.entity.ts +62 -62
  233. package/src/module/meta/entity/view-master.entity.ts +41 -41
  234. package/src/module/meta/entity.module.ts +165 -165
  235. package/src/module/meta/repository/app-master.repository.ts +20 -20
  236. package/src/module/meta/repository/attribute-master.repository.ts +164 -164
  237. package/src/module/meta/repository/entity-attribute-update.repository.ts +48 -48
  238. package/src/module/meta/repository/entity-master.repository.ts +120 -120
  239. package/src/module/meta/repository/entity-relation.repository.ts +22 -22
  240. package/src/module/meta/repository/entity-table-column.repository.ts +39 -39
  241. package/src/module/meta/repository/entity-table.repository.ts +53 -53
  242. package/src/module/meta/repository/media-data.repository.ts +50 -50
  243. package/src/module/meta/repository/preference.repository.ts +20 -20
  244. package/src/module/meta/repository/user-app-mapping.repository.ts +28 -28
  245. package/src/module/meta/repository/view-master.repository.ts +42 -42
  246. package/src/module/meta/service/app-master.service.ts +37 -37
  247. package/src/module/meta/service/attribute-master.service.ts +132 -132
  248. package/src/module/meta/service/common.service.ts +9 -9
  249. package/src/module/meta/service/entity-attribute-update.service.ts +26 -26
  250. package/src/module/meta/service/entity-dynamic.service.ts +824 -824
  251. package/src/module/meta/service/entity-master.service.ts +171 -171
  252. package/src/module/meta/service/entity-realation-data.service.ts +9 -9
  253. package/src/module/meta/service/entity-relation.service.ts +74 -74
  254. package/src/module/meta/service/entity-service-impl.service.ts +388 -388
  255. package/src/module/meta/service/entity-table-column.service.ts +26 -26
  256. package/src/module/meta/service/entity-table.service.ts +157 -157
  257. package/src/module/meta/service/entity-validation.service.ts +188 -188
  258. package/src/module/meta/service/entity.service.ts +49 -49
  259. package/src/module/meta/service/field-group.service.ts +103 -103
  260. package/src/module/meta/service/media-data.service.ts +591 -591
  261. package/src/module/meta/service/populate-meta.service.ts +222 -222
  262. package/src/module/meta/service/preference.service.ts +16 -16
  263. package/src/module/meta/service/resolver.service.ts +280 -280
  264. package/src/module/meta/service/section-master.service.ts +104 -104
  265. package/src/module/meta/service/update-form-json.service.ts +22 -22
  266. package/src/module/meta/service/user-app-mapping.service.ts +17 -17
  267. package/src/module/meta/service/view-master.service.ts +127 -127
  268. package/src/module/microservice-client/microservice-clients.module.ts +13 -13
  269. package/src/module/microservice-client/service/microservice-client-factory.ts +37 -37
  270. package/src/module/microservice-client/service/microservice-clients.ts +4 -4
  271. package/src/module/module/controller/menu.controller.ts +15 -15
  272. package/src/module/module/controller/module-access.controller.ts +133 -133
  273. package/src/module/module/entity/menu.entity.ts +43 -43
  274. package/src/module/module/entity/module-access.entity.ts +25 -25
  275. package/src/module/module/entity/module-action.entity.ts +17 -17
  276. package/src/module/module/entity/module.entity.ts +52 -52
  277. package/src/module/module/module.module.ts +42 -42
  278. package/src/module/module/repository/menu.repository.ts +186 -186
  279. package/src/module/module/repository/module-access.repository.ts +344 -344
  280. package/src/module/module/service/menu.service.ts +82 -82
  281. package/src/module/module/service/module-access.service.ts +189 -189
  282. package/src/module/notification/controller/notification.controller.ts +58 -58
  283. package/src/module/notification/controller/otp.controller.ts +117 -117
  284. package/src/module/notification/entity/notification.entity.ts +26 -26
  285. package/src/module/notification/entity/otp.entity.ts +28 -28
  286. package/src/module/notification/firebase-admin.config.ts +22 -22
  287. package/src/module/notification/notification.module.ts +69 -69
  288. package/src/module/notification/repository/otp.repository.ts +27 -27
  289. package/src/module/notification/service/email.service.ts +127 -127
  290. package/src/module/notification/service/notification.service.ts +164 -164
  291. package/src/module/notification/service/otp.service.ts +133 -133
  292. package/src/module/third-party-module/entity/third-party-api-registry.entity.ts +52 -52
  293. package/src/module/third-party-module/repository/third-party-api-registry.repository.ts +20 -20
  294. package/src/module/third-party-module/service/api-registry.service.ts +13 -13
  295. package/src/module/third-party-module/third-party.module.ts +12 -12
  296. package/src/module/user/controller/login.controller.ts +198 -198
  297. package/src/module/user/controller/user.controller.ts +40 -40
  298. package/src/module/user/dto/create-user.dto.ts +62 -62
  299. package/src/module/user/dto/update-user.dto.ts +4 -4
  300. package/src/module/user/entity/role.entity.ts +33 -33
  301. package/src/module/user/entity/user-role-mapping.entity.ts +38 -38
  302. package/src/module/user/entity/user-session.entity.ts +73 -73
  303. package/src/module/user/entity/user.entity.ts +62 -62
  304. package/src/module/user/repository/role.repository.ts +96 -96
  305. package/src/module/user/repository/user-role-mapping.repository.ts +126 -126
  306. package/src/module/user/repository/user.repository.ts +50 -50
  307. package/src/module/user/repository/userSession.repository.ts +33 -33
  308. package/src/module/user/service/login.service.ts +326 -326
  309. package/src/module/user/service/role.service.ts +197 -197
  310. package/src/module/user/service/user-role-mapping.service.ts +98 -98
  311. package/src/module/user/service/user-session.service.ts +200 -200
  312. package/src/module/user/service/user.service.ts +368 -368
  313. package/src/module/user/user.module.ts +65 -65
  314. package/src/module/workflow/controller/action-category.controller.ts +54 -54
  315. package/src/module/workflow/controller/action-resource-mapping.controller.ts +23 -23
  316. package/src/module/workflow/controller/action-template-mapping.controller.ts +35 -35
  317. package/src/module/workflow/controller/action.controller.ts +111 -111
  318. package/src/module/workflow/controller/activity-log.controller.ts +55 -55
  319. package/src/module/workflow/controller/comm-template.controller.ts +43 -43
  320. package/src/module/workflow/controller/entity-modification.controller.ts +35 -35
  321. package/src/module/workflow/controller/form-master.controller.ts +43 -43
  322. package/src/module/workflow/controller/stage-group.controller.ts +49 -49
  323. package/src/module/workflow/controller/stage.controller.ts +51 -51
  324. package/src/module/workflow/controller/task.controller.ts +77 -77
  325. package/src/module/workflow/controller/workflow-list-master.controller.ts +44 -44
  326. package/src/module/workflow/controller/workflow-meta.controller.ts +80 -80
  327. package/src/module/workflow/controller/workflow.controller.ts +67 -67
  328. package/src/module/workflow/entity/action-category.entity.ts +38 -38
  329. package/src/module/workflow/entity/action-data.entity.ts +55 -55
  330. package/src/module/workflow/entity/action-resources-mapping.entity.ts +29 -29
  331. package/src/module/workflow/entity/action-template-mapping.entity.ts +17 -17
  332. package/src/module/workflow/entity/action.entity.ts +53 -53
  333. package/src/module/workflow/entity/activity-log.entity.ts +43 -43
  334. package/src/module/workflow/entity/comm-template.entity.ts +43 -43
  335. package/src/module/workflow/entity/entity-modification.entity.ts +38 -38
  336. package/src/module/workflow/entity/form.entity.ts +25 -25
  337. package/src/module/workflow/entity/stage-action-mapping.entity.ts +17 -17
  338. package/src/module/workflow/entity/stage-group.entity.ts +23 -23
  339. package/src/module/workflow/entity/stage-movement-data.entity.ts +38 -38
  340. package/src/module/workflow/entity/stage.entity.ts +20 -20
  341. package/src/module/workflow/entity/task-data.entity.ts +88 -88
  342. package/src/module/workflow/entity/template-attach-mapper.entity.ts +30 -30
  343. package/src/module/workflow/entity/workflow-data.entity.ts +11 -11
  344. package/src/module/workflow/entity/workflow-level-mapping.entity.ts +18 -18
  345. package/src/module/workflow/entity/workflow.entity.ts +20 -20
  346. package/src/module/workflow/repository/action-category.repository.ts +79 -79
  347. package/src/module/workflow/repository/action-data.repository.ts +347 -347
  348. package/src/module/workflow/repository/action.repository.ts +339 -339
  349. package/src/module/workflow/repository/activity-log.repository.ts +148 -148
  350. package/src/module/workflow/repository/comm-template.repository.ts +157 -157
  351. package/src/module/workflow/repository/form-master.repository.ts +50 -50
  352. package/src/module/workflow/repository/stage-group.repository.ts +186 -186
  353. package/src/module/workflow/repository/stage-movement.repository.ts +217 -217
  354. package/src/module/workflow/repository/stage.repository.ts +160 -160
  355. package/src/module/workflow/repository/task.repository.ts +154 -154
  356. package/src/module/workflow/repository/workflow.repository.ts +42 -42
  357. package/src/module/workflow/service/action-category.service.ts +33 -33
  358. package/src/module/workflow/service/action-data.service.ts +62 -62
  359. package/src/module/workflow/service/action-resources-mapping.service.ts +10 -10
  360. package/src/module/workflow/service/action-template-mapping.service.ts +137 -137
  361. package/src/module/workflow/service/action.service.ts +302 -302
  362. package/src/module/workflow/service/activity-log.service.ts +107 -107
  363. package/src/module/workflow/service/comm-template.service.ts +181 -181
  364. package/src/module/workflow/service/entity-modification.service.ts +61 -61
  365. package/src/module/workflow/service/form-master.service.ts +35 -35
  366. package/src/module/workflow/service/populate-workflow.service.ts +320 -320
  367. package/src/module/workflow/service/stage-action-mapping.service.ts +5 -5
  368. package/src/module/workflow/service/stage-group.service.ts +325 -325
  369. package/src/module/workflow/service/stage.service.ts +197 -197
  370. package/src/module/workflow/service/task.service.ts +551 -551
  371. package/src/module/workflow/service/workflow-list-master.service.ts +68 -68
  372. package/src/module/workflow/service/workflow-meta.service.ts +640 -640
  373. package/src/module/workflow/service/workflow.service.ts +213 -213
  374. package/src/module/workflow/workflow.module.ts +180 -180
  375. package/src/module/workflow-automation/SCHEDULING_GUIDE.md +145 -145
  376. package/src/module/workflow-automation/controller/workflow-automation.controller.ts +43 -43
  377. package/src/module/workflow-automation/entity/workflow-automation-action.entity.ts +26 -26
  378. package/src/module/workflow-automation/entity/workflow-automation.entity.ts +40 -40
  379. package/src/module/workflow-automation/interface/action.decorator.ts +7 -7
  380. package/src/module/workflow-automation/interface/action.interface.ts +5 -5
  381. package/src/module/workflow-automation/service/action-registery.service.ts +35 -35
  382. package/src/module/workflow-automation/service/schedule-handler.service.ts +168 -168
  383. package/src/module/workflow-automation/service/workflow-automation-engine.service.ts +219 -219
  384. package/src/module/workflow-automation/service/workflow-automation.service.ts +476 -476
  385. package/src/module/workflow-automation/workflow-automation.module.ts +54 -54
  386. package/src/module/workflow-schedule/INSTALLATION.md +244 -244
  387. package/src/module/workflow-schedule/MULTI_PROJECT_GUIDE.md +196 -196
  388. package/src/module/workflow-schedule/README.md +422 -422
  389. package/src/module/workflow-schedule/constants/schedule.constants.ts +48 -48
  390. package/src/module/workflow-schedule/controller/workflow-schedule.controller.ts +253 -253
  391. package/src/module/workflow-schedule/docs/CLAUDE_CODE_GUIDE.md +510 -510
  392. package/src/module/workflow-schedule/docs/CLAUDE_CODE_PROMPT.md +362 -362
  393. package/src/module/workflow-schedule/docs/RUN_CLAUDE_CODE.sh +68 -68
  394. package/src/module/workflow-schedule/dto/create-schedule.dto.ts +147 -147
  395. package/src/module/workflow-schedule/dto/get-execution-logs.dto.ts +119 -119
  396. package/src/module/workflow-schedule/dto/update-schedule.dto.ts +96 -96
  397. package/src/module/workflow-schedule/entities/scheduled-workflow.entity.ts +148 -148
  398. package/src/module/workflow-schedule/entities/workflow-execution-log.entity.ts +154 -154
  399. package/src/module/workflow-schedule/interfaces/schedule-job-data.interface.ts +53 -53
  400. package/src/module/workflow-schedule/interfaces/workflow-schedule-options.interface.ts +12 -12
  401. package/src/module/workflow-schedule/processors/schedule.processor.ts +620 -620
  402. package/src/module/workflow-schedule/service/workflow-schedule.service.ts +597 -597
  403. package/src/module/workflow-schedule/workflow-schedule.module.ts +67 -67
  404. package/src/resources/dev.properties.yaml +31 -31
  405. package/src/resources/local.properties.yaml +27 -27
  406. package/src/resources/properties.module.ts +12 -12
  407. package/src/resources/properties.yaml.ts +11 -11
  408. package/src/resources/uat.properties.yaml +31 -31
  409. package/src/table.config.ts +133 -133
  410. package/src/utils/dto/excel-data.dto.ts +14 -14
  411. package/src/utils/dto/excelsheet-data.dto.ts +5 -5
  412. package/src/utils/service/base64util.service.ts +18 -18
  413. package/src/utils/service/clockIDGenUtil.service.ts +21 -21
  414. package/src/utils/service/codeGenerator.service.ts +22 -22
  415. package/src/utils/service/dateUtil.service.ts +17 -17
  416. package/src/utils/service/encryptUtil.service.ts +97 -97
  417. package/src/utils/service/excel-helper.service.ts +72 -72
  418. package/src/utils/service/excelUtil.service.ts +15 -15
  419. package/src/utils/service/file-util.service.ts +11 -11
  420. package/src/utils/service/json-util.service.ts +23 -23
  421. package/src/utils/service/loggingUtil.service.ts +88 -88
  422. package/src/utils/service/reflection-helper.service.ts +62 -62
  423. package/src/utils/service/wbsCodeGen.service.ts +8 -8
  424. package/src/utils/utils.module.ts +27 -27
  425. package/tsconfig.build.json +4 -4
  426. package/tsconfig.json +24 -24
@@ -1,180 +1,180 @@
1
- import { Module, Res } from '@nestjs/common';
2
- import { TypeOrmModule } from '@nestjs/typeorm';
3
- import { ListMasterModule } from '../listmaster/listmaster.module';
4
- import { EntityModule } from '../meta/entity.module';
5
- import { ActionTemplateMappingController } from './controller/action-template-mapping.controller';
6
- import { ActionController } from './controller/action.controller';
7
- import { CommTemplateController } from './controller/comm-template.controller';
8
- import { EntityModificationController } from './controller/entity-modification.controller';
9
- import { StageGroupController } from './controller/stage-group.controller';
10
- import { StageController } from './controller/stage.controller';
11
- import { WorkflowListMasterController } from './controller/workflow-list-master.controller';
12
- import { WorkflowMetaController } from './controller/workflow-meta.controller';
13
- import { WorkflowController } from './controller/workflow.controller';
14
- import { ActionCategory } from './entity/action-category.entity';
15
- import { ActionTemplateMapping } from './entity/action-template-mapping.entity';
16
- import { ActionEntity } from './entity/action.entity';
17
- import { CommTemplate } from './entity/comm-template.entity';
18
- import { EntityModification } from './entity/entity-modification.entity';
19
- import { StageActionMapping } from './entity/stage-action-mapping.entity';
20
- import { StageGroup } from './entity/stage-group.entity';
21
- import { StageMovementData } from './entity/stage-movement-data.entity';
22
- import { Stage } from './entity/stage.entity';
23
- import { TemplateAttach } from './entity/template-attach-mapper.entity';
24
- import { Workflow } from './entity/workflow.entity';
25
- import { CommTemplateRepository } from './repository/comm-template.repository';
26
- import { StageGroupRepository } from './repository/stage-group.repository';
27
- import { StageRepository } from './repository/stage.repository';
28
- import { WorkflowRepository } from './repository/workflow.repository';
29
- import { ActionCategoryService } from './service/action-category.service';
30
- import { ActionTemplateMappingService } from './service/action-template-mapping.service';
31
- import { ActionService } from './service/action.service';
32
- import { CommTemplateService } from './service/comm-template.service';
33
- import { EntityModificationService } from './service/entity-modification.service';
34
- import { PopulateWorkflowService } from './service/populate-workflow.service';
35
- import { StageActionMappingService } from './service/stage-action-mapping.service';
36
- import { StageGroupService } from './service/stage-group.service';
37
- import { StageService } from './service/stage.service';
38
- import { WorkflowListMasterService } from './service/workflow-list-master.service';
39
- import { WorkflowMetaService } from './service/workflow-meta.service';
40
- import { WorkflowService } from './service/workflow.service';
41
- import { ActionCategoryController } from './controller/action-category.controller';
42
- import { StageMovementRepository } from './repository/stage-movement.repository';
43
- import { WorkflowLevelMappingEntity } from './entity/workflow-level-mapping.entity';
44
- import { TaskDataEntity } from './entity/task-data.entity';
45
- import { ActionDataEntity } from './entity/action-data.entity';
46
- import { TaskController } from './controller/task.controller';
47
- import { TaskService } from './service/task.service';
48
- import { TaskRepository } from './repository/task.repository';
49
- import { ActionRepository } from './repository/action.repository';
50
- import { ActionDataRepository } from './repository/action-data.repository';
51
- import { ActionDataService } from './service/action-data.service';
52
- import { FormMasterController } from './controller/form-master.controller';
53
- import { FormMasterService } from './service/form-master.service';
54
- import { FormMasterRepository } from './repository/form-master.repository';
55
- import { ActionResourcesMapping } from './entity/action-resources-mapping.entity';
56
- import { ActionResourcesMappingService } from './service/action-resources-mapping.service';
57
- import { ActionResourcesMappingController } from './controller/action-resource-mapping.controller';
58
- import { ActionCategoryRepository } from './repository/action-category.repository';
59
- import { ActivityLog } from './entity/activity-log.entity';
60
- import { ActivityLogService } from './service/activity-log.service';
61
- import { ActivityLogRepository } from './repository/activity-log.repository';
62
- import { ActivityLogController } from './controller/activity-log.controller';
63
- import { NotificationModule } from '../notification/notification.module';
64
- import { MapperModule } from '../mapper/mapper.module';
65
- import { WorkflowAutomationModule } from '../workflow-automation/workflow-automation.module';
66
- import { ListMasterData } from '../listmaster/entity/list-master.entity';
67
- import { ListMasterItems } from '../listmaster/entity/list-master-items.entity';
68
-
69
- @Module({
70
- imports: [
71
- TypeOrmModule.forFeature([
72
- Workflow,
73
- ActionEntity,
74
- ActionCategory,
75
- Stage,
76
- StageGroup,
77
- CommTemplate,
78
- ActionTemplateMapping,
79
- StageActionMapping,
80
- StageMovementData,
81
- EntityModification,
82
- TemplateAttach,
83
- WorkflowLevelMappingEntity,
84
- TaskDataEntity,
85
- ActionDataEntity,
86
- ActionResourcesMapping,
87
- ActivityLog,
88
- ListMasterData,
89
- ListMasterItems
90
- ]),
91
- ListMasterModule,
92
- EntityModule,
93
- NotificationModule,
94
- MapperModule,
95
- WorkflowAutomationModule,
96
- ],
97
- providers: [
98
- { provide: 'ActionCategoryService', useClass: ActionCategoryService },
99
- { provide: 'CommTemplateService', useClass: CommTemplateService },
100
- {
101
- provide: 'StageActionMappingService',
102
- useClass: StageActionMappingService,
103
- },
104
- { provide: 'ActionService', useClass: ActionService },
105
- { provide: 'StageService', useClass: StageService },
106
- { provide: 'TaskService', useClass: TaskService },
107
- { provide: 'StageGroupService', useClass: StageGroupService },
108
- { provide: 'WorkflowService', useClass: WorkflowService },
109
- {
110
- provide: 'EntityModificationService',
111
- useClass: EntityModificationService,
112
- },
113
- { provide: 'FormMasterService', useClass: FormMasterService },
114
- {
115
- provide: 'ActionResourcesMappingService',
116
- useClass: ActionResourcesMappingService,
117
- },
118
- {
119
- provide: 'ActivityLogService',
120
- useClass: ActivityLogService,
121
- },
122
-
123
- WorkflowListMasterService,
124
- ActionTemplateMappingService,
125
- WorkflowRepository,
126
- CommTemplateService,
127
- CommTemplateRepository,
128
- StageGroupRepository,
129
- StageRepository,
130
- WorkflowService,
131
- WorkflowMetaService,
132
- PopulateWorkflowService,
133
- StageMovementRepository,
134
- TaskRepository,
135
- ActionRepository,
136
- ActionDataRepository,
137
- ActionDataService,
138
- FormMasterRepository,
139
- ActionCategoryRepository,
140
- ActivityLogRepository,
141
- ],
142
- exports: [
143
- 'ActionCategoryService',
144
- 'CommTemplateService',
145
- 'StageActionMappingService',
146
- 'ActionService',
147
- 'StageService',
148
- 'StageGroupService',
149
- 'EntityModificationService',
150
- 'FormMasterService',
151
- 'ActionResourcesMappingService',
152
- 'TaskService',
153
- 'ActivityLogService',
154
- WorkflowRepository,
155
- StageGroupRepository,
156
- StageRepository,
157
- WorkflowMetaService,
158
- PopulateWorkflowService,
159
- ActionCategoryRepository,
160
- ActivityLogRepository,
161
- ActionDataService,
162
- ],
163
- controllers: [
164
- WorkflowListMasterController,
165
- ActionTemplateMappingController,
166
- WorkflowController,
167
- CommTemplateController,
168
- StageGroupController,
169
- StageController,
170
- ActionController,
171
- WorkflowMetaController,
172
- EntityModificationController,
173
- ActionCategoryController,
174
- TaskController,
175
- FormMasterController,
176
- ActionResourcesMappingController,
177
- ActivityLogController,
178
- ],
179
- })
180
- export class WorkflowModule {}
1
+ import { Module, Res } from '@nestjs/common';
2
+ import { TypeOrmModule } from '@nestjs/typeorm';
3
+ import { ListMasterModule } from '../listmaster/listmaster.module';
4
+ import { EntityModule } from '../meta/entity.module';
5
+ import { ActionTemplateMappingController } from './controller/action-template-mapping.controller';
6
+ import { ActionController } from './controller/action.controller';
7
+ import { CommTemplateController } from './controller/comm-template.controller';
8
+ import { EntityModificationController } from './controller/entity-modification.controller';
9
+ import { StageGroupController } from './controller/stage-group.controller';
10
+ import { StageController } from './controller/stage.controller';
11
+ import { WorkflowListMasterController } from './controller/workflow-list-master.controller';
12
+ import { WorkflowMetaController } from './controller/workflow-meta.controller';
13
+ import { WorkflowController } from './controller/workflow.controller';
14
+ import { ActionCategory } from './entity/action-category.entity';
15
+ import { ActionTemplateMapping } from './entity/action-template-mapping.entity';
16
+ import { ActionEntity } from './entity/action.entity';
17
+ import { CommTemplate } from './entity/comm-template.entity';
18
+ import { EntityModification } from './entity/entity-modification.entity';
19
+ import { StageActionMapping } from './entity/stage-action-mapping.entity';
20
+ import { StageGroup } from './entity/stage-group.entity';
21
+ import { StageMovementData } from './entity/stage-movement-data.entity';
22
+ import { Stage } from './entity/stage.entity';
23
+ import { TemplateAttach } from './entity/template-attach-mapper.entity';
24
+ import { Workflow } from './entity/workflow.entity';
25
+ import { CommTemplateRepository } from './repository/comm-template.repository';
26
+ import { StageGroupRepository } from './repository/stage-group.repository';
27
+ import { StageRepository } from './repository/stage.repository';
28
+ import { WorkflowRepository } from './repository/workflow.repository';
29
+ import { ActionCategoryService } from './service/action-category.service';
30
+ import { ActionTemplateMappingService } from './service/action-template-mapping.service';
31
+ import { ActionService } from './service/action.service';
32
+ import { CommTemplateService } from './service/comm-template.service';
33
+ import { EntityModificationService } from './service/entity-modification.service';
34
+ import { PopulateWorkflowService } from './service/populate-workflow.service';
35
+ import { StageActionMappingService } from './service/stage-action-mapping.service';
36
+ import { StageGroupService } from './service/stage-group.service';
37
+ import { StageService } from './service/stage.service';
38
+ import { WorkflowListMasterService } from './service/workflow-list-master.service';
39
+ import { WorkflowMetaService } from './service/workflow-meta.service';
40
+ import { WorkflowService } from './service/workflow.service';
41
+ import { ActionCategoryController } from './controller/action-category.controller';
42
+ import { StageMovementRepository } from './repository/stage-movement.repository';
43
+ import { WorkflowLevelMappingEntity } from './entity/workflow-level-mapping.entity';
44
+ import { TaskDataEntity } from './entity/task-data.entity';
45
+ import { ActionDataEntity } from './entity/action-data.entity';
46
+ import { TaskController } from './controller/task.controller';
47
+ import { TaskService } from './service/task.service';
48
+ import { TaskRepository } from './repository/task.repository';
49
+ import { ActionRepository } from './repository/action.repository';
50
+ import { ActionDataRepository } from './repository/action-data.repository';
51
+ import { ActionDataService } from './service/action-data.service';
52
+ import { FormMasterController } from './controller/form-master.controller';
53
+ import { FormMasterService } from './service/form-master.service';
54
+ import { FormMasterRepository } from './repository/form-master.repository';
55
+ import { ActionResourcesMapping } from './entity/action-resources-mapping.entity';
56
+ import { ActionResourcesMappingService } from './service/action-resources-mapping.service';
57
+ import { ActionResourcesMappingController } from './controller/action-resource-mapping.controller';
58
+ import { ActionCategoryRepository } from './repository/action-category.repository';
59
+ import { ActivityLog } from './entity/activity-log.entity';
60
+ import { ActivityLogService } from './service/activity-log.service';
61
+ import { ActivityLogRepository } from './repository/activity-log.repository';
62
+ import { ActivityLogController } from './controller/activity-log.controller';
63
+ import { NotificationModule } from '../notification/notification.module';
64
+ import { MapperModule } from '../mapper/mapper.module';
65
+ import { WorkflowAutomationModule } from '../workflow-automation/workflow-automation.module';
66
+ import { ListMasterData } from '../listmaster/entity/list-master.entity';
67
+ import { ListMasterItems } from '../listmaster/entity/list-master-items.entity';
68
+
69
+ @Module({
70
+ imports: [
71
+ TypeOrmModule.forFeature([
72
+ Workflow,
73
+ ActionEntity,
74
+ ActionCategory,
75
+ Stage,
76
+ StageGroup,
77
+ CommTemplate,
78
+ ActionTemplateMapping,
79
+ StageActionMapping,
80
+ StageMovementData,
81
+ EntityModification,
82
+ TemplateAttach,
83
+ WorkflowLevelMappingEntity,
84
+ TaskDataEntity,
85
+ ActionDataEntity,
86
+ ActionResourcesMapping,
87
+ ActivityLog,
88
+ ListMasterData,
89
+ ListMasterItems
90
+ ]),
91
+ ListMasterModule,
92
+ EntityModule,
93
+ NotificationModule,
94
+ MapperModule,
95
+ WorkflowAutomationModule,
96
+ ],
97
+ providers: [
98
+ { provide: 'ActionCategoryService', useClass: ActionCategoryService },
99
+ { provide: 'CommTemplateService', useClass: CommTemplateService },
100
+ {
101
+ provide: 'StageActionMappingService',
102
+ useClass: StageActionMappingService,
103
+ },
104
+ { provide: 'ActionService', useClass: ActionService },
105
+ { provide: 'StageService', useClass: StageService },
106
+ { provide: 'TaskService', useClass: TaskService },
107
+ { provide: 'StageGroupService', useClass: StageGroupService },
108
+ { provide: 'WorkflowService', useClass: WorkflowService },
109
+ {
110
+ provide: 'EntityModificationService',
111
+ useClass: EntityModificationService,
112
+ },
113
+ { provide: 'FormMasterService', useClass: FormMasterService },
114
+ {
115
+ provide: 'ActionResourcesMappingService',
116
+ useClass: ActionResourcesMappingService,
117
+ },
118
+ {
119
+ provide: 'ActivityLogService',
120
+ useClass: ActivityLogService,
121
+ },
122
+
123
+ WorkflowListMasterService,
124
+ ActionTemplateMappingService,
125
+ WorkflowRepository,
126
+ CommTemplateService,
127
+ CommTemplateRepository,
128
+ StageGroupRepository,
129
+ StageRepository,
130
+ WorkflowService,
131
+ WorkflowMetaService,
132
+ PopulateWorkflowService,
133
+ StageMovementRepository,
134
+ TaskRepository,
135
+ ActionRepository,
136
+ ActionDataRepository,
137
+ ActionDataService,
138
+ FormMasterRepository,
139
+ ActionCategoryRepository,
140
+ ActivityLogRepository,
141
+ ],
142
+ exports: [
143
+ 'ActionCategoryService',
144
+ 'CommTemplateService',
145
+ 'StageActionMappingService',
146
+ 'ActionService',
147
+ 'StageService',
148
+ 'StageGroupService',
149
+ 'EntityModificationService',
150
+ 'FormMasterService',
151
+ 'ActionResourcesMappingService',
152
+ 'TaskService',
153
+ 'ActivityLogService',
154
+ WorkflowRepository,
155
+ StageGroupRepository,
156
+ StageRepository,
157
+ WorkflowMetaService,
158
+ PopulateWorkflowService,
159
+ ActionCategoryRepository,
160
+ ActivityLogRepository,
161
+ ActionDataService,
162
+ ],
163
+ controllers: [
164
+ WorkflowListMasterController,
165
+ ActionTemplateMappingController,
166
+ WorkflowController,
167
+ CommTemplateController,
168
+ StageGroupController,
169
+ StageController,
170
+ ActionController,
171
+ WorkflowMetaController,
172
+ EntityModificationController,
173
+ ActionCategoryController,
174
+ TaskController,
175
+ FormMasterController,
176
+ ActionResourcesMappingController,
177
+ ActivityLogController,
178
+ ],
179
+ })
180
+ export class WorkflowModule {}
@@ -1,145 +1,145 @@
1
- # Workflow Automation Scheduling Guide
2
-
3
- ## Overview
4
- This module integrates with `WorkflowScheduleModule` to enable creating scheduled workflow automations. You can create schedules that run automatically via cron, or create them in a disabled state for manual triggering only.
5
-
6
- ## Controlling Auto-Scheduling Behavior
7
-
8
- ### Option 1: Create Schedules WITHOUT Auto-Execution
9
- When creating a schedule, set `is_enabled: false` to prevent it from running automatically:
10
-
11
- ```typescript
12
- // Inject WorkflowScheduleService in your controller/service
13
- constructor(
14
- private readonly workflowScheduleService: WorkflowScheduleService,
15
- ) {}
16
-
17
- // Create schedule without auto-execution
18
- const schedule = await this.workflowScheduleService.createSchedule(
19
- {
20
- workflow_id: workflowId,
21
- workflow_name: 'My Workflow',
22
- name: 'My Schedule',
23
- cron_expression: '0 9 * * *', // Every day at 9 AM
24
- timezone: 'America/New_York',
25
- is_enabled: false, // 👈 This prevents auto-execution
26
- // ... other fields
27
- },
28
- loggedInUser,
29
- );
30
- ```
31
-
32
- ### Option 2: Create Schedules WITH Auto-Execution
33
- Simply set `is_enabled: true` (or omit it, as it defaults to true):
34
-
35
- ```typescript
36
- const schedule = await this.workflowScheduleService.createSchedule(
37
- {
38
- workflow_id: workflowId,
39
- workflow_name: 'My Workflow',
40
- name: 'My Schedule',
41
- cron_expression: '0 9 * * *',
42
- timezone: 'America/New_York',
43
- is_enabled: true, // 👈 Schedule will run automatically on cron
44
- // ... other fields
45
- },
46
- loggedInUser,
47
- );
48
- ```
49
-
50
- ## How It Works
51
-
52
- The scheduling logic in `WorkflowScheduleService.createSchedule()` (line 101-103) only adds jobs to the Bull queue if:
53
- 1. `is_enabled === true`
54
- 2. `schedule_status === 'ACTIVE'`
55
-
56
- If either condition is false, the schedule is saved to the database but NOT added to the queue, meaning the cron processor won't execute it.
57
-
58
- ## Manual Triggering
59
-
60
- You can manually trigger any schedule (enabled or disabled) using:
61
-
62
- ```typescript
63
- const result = await this.workflowScheduleService.triggerManualExecution(
64
- scheduleId,
65
- loggedInUser,
66
- { /* optional metadata */ },
67
- );
68
- ```
69
-
70
- ## Enabling/Disabling Schedules Later
71
-
72
- ### To Enable a Disabled Schedule:
73
- ```typescript
74
- await this.workflowScheduleService.updateSchedule(
75
- {
76
- id: scheduleId,
77
- is_enabled: true,
78
- },
79
- loggedInUser,
80
- );
81
- ```
82
-
83
- ### To Disable an Active Schedule:
84
- ```typescript
85
- await this.workflowScheduleService.updateSchedule(
86
- {
87
- id: scheduleId,
88
- is_enabled: false,
89
- },
90
- loggedInUser,
91
- );
92
- ```
93
-
94
- ### To Pause a Schedule Temporarily:
95
- ```typescript
96
- await this.workflowScheduleService.pauseSchedule(scheduleId, loggedInUser);
97
- ```
98
-
99
- ### To Resume a Paused Schedule:
100
- ```typescript
101
- await this.workflowScheduleService.resumeSchedule(scheduleId, loggedInUser);
102
- ```
103
-
104
- ## Best Practices
105
-
106
- 1. **Testing**: Create schedules with `is_enabled: false` during development and testing
107
- 2. **Staged Rollout**: Create schedules disabled, test manually, then enable when ready
108
- 3. **Monitoring**: Use `getExecutionLogs()` and `getExecutionStats()` to monitor schedule performance
109
- 4. **Cleanup**: Use `deleteSchedule()` to soft-delete schedules you no longer need
110
-
111
- ## Example: Complete Workflow
112
-
113
- ```typescript
114
- // 1. Create schedule (disabled)
115
- const schedule = await this.workflowScheduleService.createSchedule({
116
- workflow_id: 123,
117
- workflow_name: 'Send Daily Report',
118
- name: 'Daily Report Schedule',
119
- cron_expression: '0 9 * * *',
120
- is_enabled: false, // Start disabled
121
- }, loggedInUser);
122
-
123
- // 2. Test manually
124
- const testResult = await this.workflowScheduleService.triggerManualExecution(
125
- schedule.id,
126
- loggedInUser,
127
- );
128
-
129
- // 3. Check execution logs
130
- const logs = await this.workflowScheduleService.getExecutionLogs({
131
- schedule_id: schedule.id,
132
- }, loggedInUser);
133
-
134
- // 4. If tests pass, enable for auto-execution
135
- if (logs.data[0].execution_status === 'COMPLETED') {
136
- await this.workflowScheduleService.updateSchedule({
137
- id: schedule.id,
138
- is_enabled: true, // Now it will run on cron
139
- }, loggedInUser);
140
- }
141
- ```
142
-
143
- ## Environment Configuration
144
-
145
- The Bull queue (Redis) connection is configured in `src/config/bull.config.ts`. Ensure Redis is running and accessible for the scheduler to work.
1
+ # Workflow Automation Scheduling Guide
2
+
3
+ ## Overview
4
+ This module integrates with `WorkflowScheduleModule` to enable creating scheduled workflow automations. You can create schedules that run automatically via cron, or create them in a disabled state for manual triggering only.
5
+
6
+ ## Controlling Auto-Scheduling Behavior
7
+
8
+ ### Option 1: Create Schedules WITHOUT Auto-Execution
9
+ When creating a schedule, set `is_enabled: false` to prevent it from running automatically:
10
+
11
+ ```typescript
12
+ // Inject WorkflowScheduleService in your controller/service
13
+ constructor(
14
+ private readonly workflowScheduleService: WorkflowScheduleService,
15
+ ) {}
16
+
17
+ // Create schedule without auto-execution
18
+ const schedule = await this.workflowScheduleService.createSchedule(
19
+ {
20
+ workflow_id: workflowId,
21
+ workflow_name: 'My Workflow',
22
+ name: 'My Schedule',
23
+ cron_expression: '0 9 * * *', // Every day at 9 AM
24
+ timezone: 'America/New_York',
25
+ is_enabled: false, // 👈 This prevents auto-execution
26
+ // ... other fields
27
+ },
28
+ loggedInUser,
29
+ );
30
+ ```
31
+
32
+ ### Option 2: Create Schedules WITH Auto-Execution
33
+ Simply set `is_enabled: true` (or omit it, as it defaults to true):
34
+
35
+ ```typescript
36
+ const schedule = await this.workflowScheduleService.createSchedule(
37
+ {
38
+ workflow_id: workflowId,
39
+ workflow_name: 'My Workflow',
40
+ name: 'My Schedule',
41
+ cron_expression: '0 9 * * *',
42
+ timezone: 'America/New_York',
43
+ is_enabled: true, // 👈 Schedule will run automatically on cron
44
+ // ... other fields
45
+ },
46
+ loggedInUser,
47
+ );
48
+ ```
49
+
50
+ ## How It Works
51
+
52
+ The scheduling logic in `WorkflowScheduleService.createSchedule()` (line 101-103) only adds jobs to the Bull queue if:
53
+ 1. `is_enabled === true`
54
+ 2. `schedule_status === 'ACTIVE'`
55
+
56
+ If either condition is false, the schedule is saved to the database but NOT added to the queue, meaning the cron processor won't execute it.
57
+
58
+ ## Manual Triggering
59
+
60
+ You can manually trigger any schedule (enabled or disabled) using:
61
+
62
+ ```typescript
63
+ const result = await this.workflowScheduleService.triggerManualExecution(
64
+ scheduleId,
65
+ loggedInUser,
66
+ { /* optional metadata */ },
67
+ );
68
+ ```
69
+
70
+ ## Enabling/Disabling Schedules Later
71
+
72
+ ### To Enable a Disabled Schedule:
73
+ ```typescript
74
+ await this.workflowScheduleService.updateSchedule(
75
+ {
76
+ id: scheduleId,
77
+ is_enabled: true,
78
+ },
79
+ loggedInUser,
80
+ );
81
+ ```
82
+
83
+ ### To Disable an Active Schedule:
84
+ ```typescript
85
+ await this.workflowScheduleService.updateSchedule(
86
+ {
87
+ id: scheduleId,
88
+ is_enabled: false,
89
+ },
90
+ loggedInUser,
91
+ );
92
+ ```
93
+
94
+ ### To Pause a Schedule Temporarily:
95
+ ```typescript
96
+ await this.workflowScheduleService.pauseSchedule(scheduleId, loggedInUser);
97
+ ```
98
+
99
+ ### To Resume a Paused Schedule:
100
+ ```typescript
101
+ await this.workflowScheduleService.resumeSchedule(scheduleId, loggedInUser);
102
+ ```
103
+
104
+ ## Best Practices
105
+
106
+ 1. **Testing**: Create schedules with `is_enabled: false` during development and testing
107
+ 2. **Staged Rollout**: Create schedules disabled, test manually, then enable when ready
108
+ 3. **Monitoring**: Use `getExecutionLogs()` and `getExecutionStats()` to monitor schedule performance
109
+ 4. **Cleanup**: Use `deleteSchedule()` to soft-delete schedules you no longer need
110
+
111
+ ## Example: Complete Workflow
112
+
113
+ ```typescript
114
+ // 1. Create schedule (disabled)
115
+ const schedule = await this.workflowScheduleService.createSchedule({
116
+ workflow_id: 123,
117
+ workflow_name: 'Send Daily Report',
118
+ name: 'Daily Report Schedule',
119
+ cron_expression: '0 9 * * *',
120
+ is_enabled: false, // Start disabled
121
+ }, loggedInUser);
122
+
123
+ // 2. Test manually
124
+ const testResult = await this.workflowScheduleService.triggerManualExecution(
125
+ schedule.id,
126
+ loggedInUser,
127
+ );
128
+
129
+ // 3. Check execution logs
130
+ const logs = await this.workflowScheduleService.getExecutionLogs({
131
+ schedule_id: schedule.id,
132
+ }, loggedInUser);
133
+
134
+ // 4. If tests pass, enable for auto-execution
135
+ if (logs.data[0].execution_status === 'COMPLETED') {
136
+ await this.workflowScheduleService.updateSchedule({
137
+ id: schedule.id,
138
+ is_enabled: true, // Now it will run on cron
139
+ }, loggedInUser);
140
+ }
141
+ ```
142
+
143
+ ## Environment Configuration
144
+
145
+ The Bull queue (Redis) connection is configured in `src/config/bull.config.ts`. Ensure Redis is running and accessible for the scheduler to work.