@quadnix/octo 0.0.29 → 0.1.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 (362) hide show
  1. package/LICENSE +661 -0
  2. package/README.md +25 -3
  3. package/dist/app.type.d.ts +143 -4
  4. package/dist/app.type.js +80 -9
  5. package/dist/app.type.js.map +1 -1
  6. package/dist/decorators/action.decorator.d.ts +10 -6
  7. package/dist/decorators/action.decorator.js +19 -6
  8. package/dist/decorators/action.decorator.js.map +1 -1
  9. package/dist/decorators/anchor.decorator.d.ts +12 -5
  10. package/dist/decorators/anchor.decorator.js +12 -5
  11. package/dist/decorators/anchor.decorator.js.map +1 -1
  12. package/dist/decorators/enable-hook.decorator.d.ts +1 -1
  13. package/dist/decorators/enable-hook.decorator.js +1 -1
  14. package/dist/decorators/factory.decorator.d.ts +18 -34
  15. package/dist/decorators/factory.decorator.js +18 -34
  16. package/dist/decorators/factory.decorator.js.map +1 -1
  17. package/dist/decorators/model.decorator.d.ts +1 -1
  18. package/dist/decorators/model.decorator.js +1 -1
  19. package/dist/decorators/module.decorator.d.ts +16 -10
  20. package/dist/decorators/module.decorator.js +16 -10
  21. package/dist/decorators/module.decorator.js.map +1 -1
  22. package/dist/decorators/on-event.decorator.d.ts +5 -0
  23. package/dist/decorators/on-event.decorator.js +5 -0
  24. package/dist/decorators/on-event.decorator.js.map +1 -1
  25. package/dist/decorators/validate.decorator.d.ts +15 -1
  26. package/dist/decorators/validate.decorator.js +15 -1
  27. package/dist/decorators/validate.decorator.js.map +1 -1
  28. package/dist/errors/container.error.d.ts +18 -0
  29. package/dist/errors/container.error.js +18 -0
  30. package/dist/errors/container.error.js.map +1 -1
  31. package/dist/errors/index.d.ts +1 -0
  32. package/dist/errors/index.js +1 -0
  33. package/dist/errors/index.js.map +1 -1
  34. package/dist/errors/module.error.d.ts +6 -0
  35. package/dist/errors/module.error.js +6 -0
  36. package/dist/errors/module.error.js.map +1 -1
  37. package/dist/errors/node.error.d.ts +56 -0
  38. package/dist/errors/node.error.js +56 -0
  39. package/dist/errors/node.error.js.map +1 -1
  40. package/dist/errors/schema.error.d.ts +6 -0
  41. package/dist/errors/schema.error.js +6 -0
  42. package/dist/errors/schema.error.js.map +1 -1
  43. package/dist/errors/terraform.error.d.ts +19 -0
  44. package/dist/errors/terraform.error.js +23 -0
  45. package/dist/errors/terraform.error.js.map +1 -0
  46. package/dist/errors/transaction.error.d.ts +77 -0
  47. package/dist/errors/transaction.error.js +83 -0
  48. package/dist/errors/transaction.error.js.map +1 -1
  49. package/dist/events/action.event.d.ts +0 -2
  50. package/dist/events/action.event.js +0 -2
  51. package/dist/events/action.event.js.map +1 -1
  52. package/dist/events/event.model.d.ts +21 -5
  53. package/dist/events/event.model.js +11 -5
  54. package/dist/events/event.model.js.map +1 -1
  55. package/dist/events/hook/commit.hook.event.d.ts +0 -6
  56. package/dist/events/hook/commit.hook.event.js +0 -6
  57. package/dist/events/hook/commit.hook.event.js.map +1 -1
  58. package/dist/events/hook/hook.event.d.ts +0 -2
  59. package/dist/events/hook/hook.event.js +0 -2
  60. package/dist/events/hook/hook.event.js.map +1 -1
  61. package/dist/events/hook/model.hook.event.d.ts +0 -6
  62. package/dist/events/hook/model.hook.event.js +0 -6
  63. package/dist/events/hook/model.hook.event.js.map +1 -1
  64. package/dist/events/hook/resource.hook.event.d.ts +0 -6
  65. package/dist/events/hook/resource.hook.event.js +0 -6
  66. package/dist/events/hook/resource.hook.event.js.map +1 -1
  67. package/dist/events/index.d.ts +3 -0
  68. package/dist/events/index.js +3 -0
  69. package/dist/events/index.js.map +1 -1
  70. package/dist/events/mode-result.event.d.ts +57 -0
  71. package/dist/events/mode-result.event.js +24 -0
  72. package/dist/events/mode-result.event.js.map +1 -0
  73. package/dist/events/mode.event.d.ts +57 -0
  74. package/dist/events/mode.event.js +32 -0
  75. package/dist/events/mode.event.js.map +1 -0
  76. package/dist/events/module.event.d.ts +0 -2
  77. package/dist/events/module.event.js +0 -2
  78. package/dist/events/module.event.js.map +1 -1
  79. package/dist/events/registration.event.d.ts +18 -14
  80. package/dist/events/registration.event.js +18 -14
  81. package/dist/events/registration.event.js.map +1 -1
  82. package/dist/events/serialization.event.d.ts +15 -12
  83. package/dist/events/serialization.event.js +15 -12
  84. package/dist/events/serialization.event.js.map +1 -1
  85. package/dist/events/terraform.event.d.ts +42 -0
  86. package/dist/events/terraform.event.js +31 -0
  87. package/dist/events/terraform.event.js.map +1 -0
  88. package/dist/events/transaction.event.d.ts +0 -37
  89. package/dist/events/transaction.event.js +0 -28
  90. package/dist/events/transaction.event.js.map +1 -1
  91. package/dist/functions/container/container.d.ts +54 -13
  92. package/dist/functions/container/container.js +63 -18
  93. package/dist/functions/container/container.js.map +1 -1
  94. package/dist/functions/container/test-container.d.ts +43 -29
  95. package/dist/functions/container/test-container.js +71 -43
  96. package/dist/functions/container/test-container.js.map +1 -1
  97. package/dist/functions/dependency/dependency.d.ts +82 -8
  98. package/dist/functions/dependency/dependency.js +80 -14
  99. package/dist/functions/dependency/dependency.js.map +1 -1
  100. package/dist/functions/diff/aggregate-resource-actions.d.ts +19 -0
  101. package/dist/functions/diff/aggregate-resource-actions.js +41 -0
  102. package/dist/functions/diff/aggregate-resource-actions.js.map +1 -0
  103. package/dist/functions/diff/diff-metadata.d.ts +21 -3
  104. package/dist/functions/diff/diff-metadata.js +18 -0
  105. package/dist/functions/diff/diff-metadata.js.map +1 -1
  106. package/dist/functions/diff/diff.d.ts +55 -1
  107. package/dist/functions/diff/diff.js +44 -3
  108. package/dist/functions/diff/diff.js.map +1 -1
  109. package/dist/functions/diff/diff.utility.d.ts +17 -2
  110. package/dist/functions/diff/diff.utility.js +53 -38
  111. package/dist/functions/diff/diff.utility.js.map +1 -1
  112. package/dist/functions/hook/commit.hook.d.ts +16 -1
  113. package/dist/functions/hook/commit.hook.js +21 -6
  114. package/dist/functions/hook/commit.hook.js.map +1 -1
  115. package/dist/functions/hook/model-action.hook.d.ts +16 -1
  116. package/dist/functions/hook/model-action.hook.js +21 -6
  117. package/dist/functions/hook/model-action.hook.js.map +1 -1
  118. package/dist/functions/hook/resource-action.hook.d.ts +16 -1
  119. package/dist/functions/hook/resource-action.hook.js +21 -6
  120. package/dist/functions/hook/resource-action.hook.js.map +1 -1
  121. package/dist/functions/node/node-action.abstract.d.ts +23 -0
  122. package/dist/functions/node/node-action.abstract.js +20 -0
  123. package/dist/functions/node/node-action.abstract.js.map +1 -1
  124. package/dist/functions/node/node.abstract.d.ts +56 -5
  125. package/dist/functions/node/node.abstract.js +85 -12
  126. package/dist/functions/node/node.abstract.js.map +1 -1
  127. package/dist/functions/node/node.interface.d.ts +1 -0
  128. package/dist/functions/schema/schema.d.ts +7 -0
  129. package/dist/functions/schema/schema.js +9 -0
  130. package/dist/functions/schema/schema.js.map +1 -1
  131. package/dist/index.d.ts +5 -1
  132. package/dist/index.js +4 -1
  133. package/dist/index.js.map +1 -1
  134. package/dist/main.d.ts +244 -14
  135. package/dist/main.js +361 -72
  136. package/dist/main.js.map +1 -1
  137. package/dist/models/account/account.model.d.ts +37 -7
  138. package/dist/models/account/account.model.js +40 -8
  139. package/dist/models/account/account.model.js.map +1 -1
  140. package/dist/models/account/account.schema.d.ts +13 -1
  141. package/dist/models/account/account.schema.js +12 -0
  142. package/dist/models/account/account.schema.js.map +1 -1
  143. package/dist/models/app/app.model.d.ts +16 -1
  144. package/dist/models/app/app.model.js +19 -4
  145. package/dist/models/app/app.model.js.map +1 -1
  146. package/dist/models/app/app.schema.d.ts +6 -0
  147. package/dist/models/app/app.schema.js +6 -0
  148. package/dist/models/app/app.schema.js.map +1 -1
  149. package/dist/models/deployment/deployment.model.d.ts +13 -1
  150. package/dist/models/deployment/deployment.model.js +16 -4
  151. package/dist/models/deployment/deployment.model.js.map +1 -1
  152. package/dist/models/deployment/deployment.schema.d.ts +2 -0
  153. package/dist/models/deployment/deployment.schema.js +2 -0
  154. package/dist/models/deployment/deployment.schema.js.map +1 -1
  155. package/dist/models/environment/environment.model.d.ts +13 -1
  156. package/dist/models/environment/environment.model.js +20 -8
  157. package/dist/models/environment/environment.model.js.map +1 -1
  158. package/dist/models/environment/environment.schema.d.ts +2 -0
  159. package/dist/models/environment/environment.schema.js +2 -0
  160. package/dist/models/environment/environment.schema.js.map +1 -1
  161. package/dist/models/execution/execution.model.d.ts +20 -2
  162. package/dist/models/execution/execution.model.js +46 -28
  163. package/dist/models/execution/execution.model.js.map +1 -1
  164. package/dist/models/execution/execution.schema.d.ts +11 -0
  165. package/dist/models/execution/execution.schema.js +11 -0
  166. package/dist/models/execution/execution.schema.js.map +1 -1
  167. package/dist/models/filesystem/filesystem.model.d.ts +27 -1
  168. package/dist/models/filesystem/filesystem.model.js +30 -4
  169. package/dist/models/filesystem/filesystem.model.js.map +1 -1
  170. package/dist/models/filesystem/filesystem.schema.d.ts +5 -0
  171. package/dist/models/filesystem/filesystem.schema.js +5 -0
  172. package/dist/models/filesystem/filesystem.schema.js.map +1 -1
  173. package/dist/models/image/image.model.d.ts +17 -4
  174. package/dist/models/image/image.model.js +20 -7
  175. package/dist/models/image/image.model.js.map +1 -1
  176. package/dist/models/image/image.schema.d.ts +8 -0
  177. package/dist/models/image/image.schema.js +8 -0
  178. package/dist/models/image/image.schema.js.map +1 -1
  179. package/dist/models/model-action.interface.d.ts +17 -4
  180. package/dist/models/model.abstract.d.ts +96 -1
  181. package/dist/models/model.abstract.js +106 -7
  182. package/dist/models/model.abstract.js.map +1 -1
  183. package/dist/models/model.interface.d.ts +3 -0
  184. package/dist/models/pipeline/pipeline.model.d.ts +13 -1
  185. package/dist/models/pipeline/pipeline.model.js +18 -6
  186. package/dist/models/pipeline/pipeline.model.js.map +1 -1
  187. package/dist/models/pipeline/pipeline.schema.d.ts +8 -0
  188. package/dist/models/pipeline/pipeline.schema.js +8 -0
  189. package/dist/models/pipeline/pipeline.schema.js.map +1 -1
  190. package/dist/models/region/region.model.d.ts +16 -1
  191. package/dist/models/region/region.model.js +19 -4
  192. package/dist/models/region/region.model.js.map +1 -1
  193. package/dist/models/region/region.schema.d.ts +6 -0
  194. package/dist/models/region/region.schema.js +6 -0
  195. package/dist/models/region/region.schema.js.map +1 -1
  196. package/dist/models/server/server.model.d.ts +13 -1
  197. package/dist/models/server/server.model.js +16 -4
  198. package/dist/models/server/server.model.js.map +1 -1
  199. package/dist/models/server/server.schema.d.ts +3 -1
  200. package/dist/models/server/server.schema.js +3 -1
  201. package/dist/models/server/server.schema.js.map +1 -1
  202. package/dist/models/service/service.model.d.ts +15 -1
  203. package/dist/models/service/service.model.js +15 -1
  204. package/dist/models/service/service.model.js.map +1 -1
  205. package/dist/models/service/service.schema.d.ts +4 -1
  206. package/dist/models/service/service.schema.js +4 -1
  207. package/dist/models/service/service.schema.js.map +1 -1
  208. package/dist/models/subnet/subnet.model.d.ts +27 -3
  209. package/dist/models/subnet/subnet.model.js +40 -16
  210. package/dist/models/subnet/subnet.model.js.map +1 -1
  211. package/dist/models/subnet/subnet.schema.d.ts +9 -0
  212. package/dist/models/subnet/subnet.schema.js +9 -0
  213. package/dist/models/subnet/subnet.schema.js.map +1 -1
  214. package/dist/modes/apply-transaction.d.ts +23 -0
  215. package/dist/modes/apply-transaction.js +25 -0
  216. package/dist/modes/apply-transaction.js.map +1 -0
  217. package/dist/modes/commit.mode.d.ts +54 -0
  218. package/dist/modes/commit.mode.js +235 -0
  219. package/dist/modes/commit.mode.js.map +1 -0
  220. package/dist/modes/generate.mode.d.ts +29 -0
  221. package/dist/modes/generate.mode.js +49 -0
  222. package/dist/modes/generate.mode.js.map +1 -0
  223. package/dist/modes/run-action.mode.d.ts +30 -0
  224. package/dist/modes/run-action.mode.js +140 -0
  225. package/dist/modes/run-action.mode.js.map +1 -0
  226. package/dist/modes/validate.mode.d.ts +162 -0
  227. package/dist/modes/validate.mode.js +480 -0
  228. package/dist/modes/validate.mode.js.map +1 -0
  229. package/dist/modules/module.abstract.d.ts +51 -0
  230. package/dist/modules/module.abstract.js +36 -0
  231. package/dist/modules/module.abstract.js.map +1 -1
  232. package/dist/modules/module.container.d.ts +36 -0
  233. package/dist/modules/module.container.js +36 -0
  234. package/dist/modules/module.container.js.map +1 -1
  235. package/dist/modules/test-module.container.d.ts +139 -24
  236. package/dist/modules/test-module.container.js +410 -163
  237. package/dist/modules/test-module.container.js.map +1 -1
  238. package/dist/overlays/anchor.abstract.d.ts +32 -1
  239. package/dist/overlays/anchor.abstract.js +42 -11
  240. package/dist/overlays/anchor.abstract.js.map +1 -1
  241. package/dist/overlays/anchor.schema.d.ts +21 -0
  242. package/dist/overlays/anchor.schema.js +21 -0
  243. package/dist/overlays/anchor.schema.js.map +1 -1
  244. package/dist/overlays/overlay-data.repository.d.ts +18 -0
  245. package/dist/overlays/overlay-data.repository.js +18 -0
  246. package/dist/overlays/overlay-data.repository.js.map +1 -1
  247. package/dist/overlays/overlay.abstract.d.ts +56 -1
  248. package/dist/overlays/overlay.abstract.js +79 -20
  249. package/dist/overlays/overlay.abstract.js.map +1 -1
  250. package/dist/overlays/overlay.schema.d.ts +20 -0
  251. package/dist/overlays/overlay.schema.js +20 -0
  252. package/dist/overlays/overlay.schema.js.map +1 -1
  253. package/dist/resources/resource-action.interface.d.ts +26 -2
  254. package/dist/resources/resource-data.repository.d.ts +63 -1
  255. package/dist/resources/resource-data.repository.js +94 -4
  256. package/dist/resources/resource-data.repository.js.map +1 -1
  257. package/dist/resources/resource.abstract.d.ts +118 -3
  258. package/dist/resources/resource.abstract.js +166 -33
  259. package/dist/resources/resource.abstract.js.map +1 -1
  260. package/dist/resources/resource.schema.d.ts +29 -1
  261. package/dist/resources/resource.schema.js +28 -0
  262. package/dist/resources/resource.schema.js.map +1 -1
  263. package/dist/resources/terraform-resource.abstract.d.ts +44 -0
  264. package/dist/resources/terraform-resource.abstract.js +45 -0
  265. package/dist/resources/terraform-resource.abstract.js.map +1 -0
  266. package/dist/services/event/event.service.d.ts +30 -3
  267. package/dist/services/event/event.service.js +58 -16
  268. package/dist/services/event/event.service.js.map +1 -1
  269. package/dist/services/input/input.service.d.ts +52 -3
  270. package/dist/services/input/input.service.js +72 -8
  271. package/dist/services/input/input.service.js.map +1 -1
  272. package/dist/services/schema-translation/schema-translation.service.d.ts +9 -0
  273. package/dist/services/schema-translation/schema-translation.service.js +9 -0
  274. package/dist/services/schema-translation/schema-translation.service.js.map +1 -1
  275. package/dist/services/serialization/model/model-serialization.service.d.ts +26 -2
  276. package/dist/services/serialization/model/model-serialization.service.js +110 -62
  277. package/dist/services/serialization/model/model-serialization.service.js.map +1 -1
  278. package/dist/services/serialization/resource/resource-serialization.service.d.ts +33 -4
  279. package/dist/services/serialization/resource/resource-serialization.service.js +64 -28
  280. package/dist/services/serialization/resource/resource-serialization.service.js.map +1 -1
  281. package/dist/services/state-management/file-app-lock.utility.d.ts +43 -0
  282. package/dist/services/state-management/file-app-lock.utility.js +124 -0
  283. package/dist/services/state-management/file-app-lock.utility.js.map +1 -0
  284. package/dist/services/state-management/local-encryption.state-provider.d.ts +53 -2
  285. package/dist/services/state-management/local-encryption.state-provider.js +75 -49
  286. package/dist/services/state-management/local-encryption.state-provider.js.map +1 -1
  287. package/dist/services/state-management/local.state-provider.d.ts +49 -2
  288. package/dist/services/state-management/local.state-provider.js +70 -49
  289. package/dist/services/state-management/local.state-provider.js.map +1 -1
  290. package/dist/services/state-management/state-management.service.d.ts +141 -6
  291. package/dist/services/state-management/state-management.service.js +149 -4
  292. package/dist/services/state-management/state-management.service.js.map +1 -1
  293. package/dist/services/state-management/state-provider.interface.d.ts +55 -1
  294. package/dist/services/state-management/terraform-state.service.d.ts +76 -0
  295. package/dist/services/state-management/terraform-state.service.js +154 -0
  296. package/dist/services/state-management/terraform-state.service.js.map +1 -0
  297. package/dist/services/state-management/test.state-provider.d.ts +38 -1
  298. package/dist/services/state-management/test.state-provider.js +52 -21
  299. package/dist/services/state-management/test.state-provider.js.map +1 -1
  300. package/dist/services/terraform/terraform.service.d.ts +426 -0
  301. package/dist/services/terraform/terraform.service.js +995 -0
  302. package/dist/services/terraform/terraform.service.js.map +1 -0
  303. package/dist/services/terraform/terraform.type.d.ts +387 -0
  304. package/dist/services/terraform/terraform.type.js +579 -0
  305. package/dist/services/terraform/terraform.type.js.map +1 -0
  306. package/dist/services/transaction/transaction.service.d.ts +86 -10
  307. package/dist/services/transaction/transaction.service.js +387 -232
  308. package/dist/services/transaction/transaction.service.js.map +1 -1
  309. package/dist/services/validation/validation.service.d.ts +13 -1
  310. package/dist/services/validation/validation.service.js +12 -0
  311. package/dist/services/validation/validation.service.js.map +1 -1
  312. package/dist/utilities/array/array.utility.d.ts +3 -0
  313. package/dist/utilities/array/array.utility.js +3 -0
  314. package/dist/utilities/array/array.utility.js.map +1 -1
  315. package/dist/utilities/file/file.utility.d.ts +15 -0
  316. package/dist/utilities/file/file.utility.js +18 -1
  317. package/dist/utilities/file/file.utility.js.map +1 -1
  318. package/dist/utilities/hcl/hcl.utility.d.ts +61 -0
  319. package/dist/utilities/hcl/hcl.utility.js +229 -0
  320. package/dist/utilities/hcl/hcl.utility.js.map +1 -0
  321. package/dist/utilities/node/node.utility.d.ts +3 -0
  322. package/dist/utilities/node/node.utility.js +3 -0
  323. package/dist/utilities/node/node.utility.js.map +1 -1
  324. package/dist/utilities/object/object.utility.d.ts +12 -0
  325. package/dist/utilities/object/object.utility.js +12 -0
  326. package/dist/utilities/object/object.utility.js.map +1 -1
  327. package/dist/utilities/project/project.utility.d.ts +28 -0
  328. package/dist/utilities/project/project.utility.js +35 -0
  329. package/dist/utilities/project/project.utility.js.map +1 -0
  330. package/dist/utilities/string/string.utility.d.ts +21 -0
  331. package/dist/utilities/string/string.utility.js +39 -0
  332. package/dist/utilities/string/string.utility.js.map +1 -0
  333. package/dist/utilities/terraform/terraform.utility.d.ts +227 -0
  334. package/dist/utilities/terraform/terraform.utility.js +434 -0
  335. package/dist/utilities/terraform/terraform.utility.js.map +1 -0
  336. package/dist/utilities/test-helpers/test-classes.d.ts +18 -31
  337. package/dist/utilities/test-helpers/test-classes.js +18 -41
  338. package/dist/utilities/test-helpers/test-classes.js.map +1 -1
  339. package/dist/utilities/test-helpers/test-models.js +12 -0
  340. package/dist/utilities/test-helpers/test-models.js.map +1 -1
  341. package/dist/utilities/test-helpers/test-modes.d.ts +315 -0
  342. package/dist/utilities/test-helpers/test-modes.js +463 -0
  343. package/dist/utilities/test-helpers/test-modes.js.map +1 -0
  344. package/dist/utilities/test-helpers/test-modules.d.ts +41 -0
  345. package/dist/utilities/test-helpers/test-modules.js +79 -0
  346. package/dist/utilities/test-helpers/test-modules.js.map +1 -0
  347. package/dist/utilities/test-helpers/test-overlays.d.ts +17 -1
  348. package/dist/utilities/test-helpers/test-overlays.js +49 -5
  349. package/dist/utilities/test-helpers/test-overlays.js.map +1 -1
  350. package/dist/utilities/test-helpers/test-resources.d.ts +19 -1
  351. package/dist/utilities/test-helpers/test-resources.js +61 -3
  352. package/dist/utilities/test-helpers/test-resources.js.map +1 -1
  353. package/dist/utilities/validation/validation.utility.d.ts +24 -0
  354. package/dist/utilities/validation/validation.utility.js +24 -0
  355. package/dist/utilities/validation/validation.utility.js.map +1 -1
  356. package/package.json +6 -5
  357. package/dist/services/capture/capture.service.d.ts +0 -19
  358. package/dist/services/capture/capture.service.js +0 -43
  359. package/dist/services/capture/capture.service.js.map +0 -1
  360. package/dist/utilities/cidr/cidr.utility.d.ts +0 -10
  361. package/dist/utilities/cidr/cidr.utility.js +0 -51
  362. package/dist/utilities/cidr/cidr.utility.js.map +0 -1
@@ -5,8 +5,6 @@ import { Event } from './event.model.js';
5
5
  * The SerializationEvent class is the superclass for all events in relation to serialization and deserialization.
6
6
  *
7
7
  * @group Events/Serialization
8
- *
9
- * @returns The Event instance.
10
8
  */
11
9
  export declare class SerializationEvent<T> extends Event<T> {
12
10
  }
@@ -14,52 +12,57 @@ export declare class SerializationEvent<T> extends Event<T> {
14
12
  * This event is emitted when models are deserialized from serialized output.
15
13
  *
16
14
  * @group Events/Serialization
17
- *
18
- * @returns The Event instance.
19
15
  */
20
16
  export declare class ModelDeserializedEvent extends SerializationEvent<ModelSerializedOutput> {
17
+ /**
18
+ * @internal
19
+ */
21
20
  static registrar(eventService: EventService, descriptor: PropertyDescriptor): void;
22
21
  }
23
22
  /**
24
23
  * This event is emitted when models are serialized to an output.
25
24
  *
26
25
  * @group Events/Serialization
27
- *
28
- * @returns The Event instance.
29
26
  */
30
27
  export declare class ModelSerializedEvent extends SerializationEvent<ModelSerializedOutput> {
28
+ /**
29
+ * @internal
30
+ */
31
31
  static registrar(eventService: EventService, descriptor: PropertyDescriptor): void;
32
32
  }
33
33
  /**
34
34
  * This event is emitted when resources are deserialized from serialized output.
35
35
  *
36
36
  * @group Events/Serialization
37
- *
38
- * @returns The Event instance.
39
37
  */
40
38
  export declare class ResourceDeserializedEvent extends SerializationEvent<{
41
39
  actual: ResourceSerializedOutput;
42
40
  old: ResourceSerializedOutput;
43
41
  }> {
42
+ /**
43
+ * @internal
44
+ */
44
45
  static registrar(eventService: EventService, descriptor: PropertyDescriptor): void;
45
46
  }
46
47
  /**
47
48
  * This event is emitted when actual resources are serialized to an output.
48
49
  *
49
50
  * @group Events/Serialization
50
- *
51
- * @returns The Event instance.
52
51
  */
53
52
  export declare class ActualResourceSerializedEvent extends SerializationEvent<ResourceSerializedOutput> {
53
+ /**
54
+ * @internal
55
+ */
54
56
  static registrar(eventService: EventService, descriptor: PropertyDescriptor): void;
55
57
  }
56
58
  /**
57
59
  * This event is emitted when new resources are serialized to an output.
58
60
  *
59
61
  * @group Events/Serialization
60
- *
61
- * @returns The Event instance.
62
62
  */
63
63
  export declare class NewResourceSerializedEvent extends SerializationEvent<ResourceSerializedOutput> {
64
+ /**
65
+ * @internal
66
+ */
64
67
  static registrar(eventService: EventService, descriptor: PropertyDescriptor): void;
65
68
  }
@@ -3,8 +3,6 @@ import { Event } from './event.model.js';
3
3
  * The SerializationEvent class is the superclass for all events in relation to serialization and deserialization.
4
4
  *
5
5
  * @group Events/Serialization
6
- *
7
- * @returns The Event instance.
8
6
  */
9
7
  export class SerializationEvent extends Event {
10
8
  }
@@ -12,10 +10,11 @@ export class SerializationEvent extends Event {
12
10
  * This event is emitted when models are deserialized from serialized output.
13
11
  *
14
12
  * @group Events/Serialization
15
- *
16
- * @returns The Event instance.
17
13
  */
18
14
  export class ModelDeserializedEvent extends SerializationEvent {
15
+ /**
16
+ * @internal
17
+ */
19
18
  static registrar(eventService, descriptor) {
20
19
  const originalMethod = descriptor.value;
21
20
  descriptor.value = async function (...args) {
@@ -29,10 +28,11 @@ export class ModelDeserializedEvent extends SerializationEvent {
29
28
  * This event is emitted when models are serialized to an output.
30
29
  *
31
30
  * @group Events/Serialization
32
- *
33
- * @returns The Event instance.
34
31
  */
35
32
  export class ModelSerializedEvent extends SerializationEvent {
33
+ /**
34
+ * @internal
35
+ */
36
36
  static registrar(eventService, descriptor) {
37
37
  const originalMethod = descriptor.value;
38
38
  descriptor.value = async function (...args) {
@@ -46,10 +46,11 @@ export class ModelSerializedEvent extends SerializationEvent {
46
46
  * This event is emitted when resources are deserialized from serialized output.
47
47
  *
48
48
  * @group Events/Serialization
49
- *
50
- * @returns The Event instance.
51
49
  */
52
50
  export class ResourceDeserializedEvent extends SerializationEvent {
51
+ /**
52
+ * @internal
53
+ */
53
54
  static registrar(eventService, descriptor) {
54
55
  const originalMethod = descriptor.value;
55
56
  descriptor.value = async function (...args) {
@@ -62,10 +63,11 @@ export class ResourceDeserializedEvent extends SerializationEvent {
62
63
  * This event is emitted when actual resources are serialized to an output.
63
64
  *
64
65
  * @group Events/Serialization
65
- *
66
- * @returns The Event instance.
67
66
  */
68
67
  export class ActualResourceSerializedEvent extends SerializationEvent {
68
+ /**
69
+ * @internal
70
+ */
69
71
  static registrar(eventService, descriptor) {
70
72
  const originalMethod = descriptor.value;
71
73
  descriptor.value = async function (...args) {
@@ -79,10 +81,11 @@ export class ActualResourceSerializedEvent extends SerializationEvent {
79
81
  * This event is emitted when new resources are serialized to an output.
80
82
  *
81
83
  * @group Events/Serialization
82
- *
83
- * @returns The Event instance.
84
84
  */
85
85
  export class NewResourceSerializedEvent extends SerializationEvent {
86
+ /**
87
+ * @internal
88
+ */
86
89
  static registrar(eventService, descriptor) {
87
90
  const originalMethod = descriptor.value;
88
91
  descriptor.value = async function (...args) {
@@ -1 +1 @@
1
- {"version":3,"file":"serialization.event.js","sourceRoot":"","sources":["../../src/events/serialization.event.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC;;;;;;GAMG;AACH,MAAM,OAAO,kBAAsB,SAAQ,KAAQ;CAAG;AAEtD;;;;;;GAMG;AACH,MAAM,OAAO,sBAAuB,SAAQ,kBAAyC;IACnF,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAEwC,UAAU,CAAC,KAAK,CAAC;QAE7E,UAAU,CAAC,KAAK,GAAG,KAAK,WACtB,GAAG,IAA0D;YAE7D,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEtD,YAAY,CAAC,IAAI,CAAC,IAAI,sBAAsB,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAElE,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;IACJ,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,OAAO,oBAAqB,SAAQ,kBAAyC;IACjF,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAEsC,UAAU,CAAC,KAAK,CAAC;QAE3E,UAAU,CAAC,KAAK,GAAG,KAAK,WACtB,GAAG,IAAwD;YAE3D,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEtD,YAAY,CAAC,IAAI,CAAC,IAAI,oBAAoB,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;YAE/D,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;IACJ,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,OAAO,yBAA0B,SAAQ,kBAG7C;IACA,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAE2C,UAAU,CAAC,KAAK,CAAC;QAEhF,UAAU,CAAC,KAAK,GAAG,KAAK,WACtB,GAAG,IAA6D;YAEhE,MAAM,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEvC,YAAY,CAAC,IAAI,CAAC,IAAI,yBAAyB,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACjG,CAAC,CAAC;IACJ,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,OAAO,6BAA8B,SAAQ,kBAA4C;IAC7F,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAEwD,UAAU,CAAC,KAAK,CAAC;QAE7F,UAAU,CAAC,KAAK,GAAG,KAAK,WACtB,GAAG,IAA0E;YAE7E,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEtD,YAAY,CAAC,IAAI,CAAC,IAAI,6BAA6B,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;YAExE,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;IACJ,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,OAAO,0BAA2B,SAAQ,kBAA4C;IAC1F,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAEqD,UAAU,CAAC,KAAK,CAAC;QAE1F,UAAU,CAAC,KAAK,GAAG,KAAK,WACtB,GAAG,IAAuE;YAE1E,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEtD,YAAY,CAAC,IAAI,CAAC,IAAI,0BAA0B,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;YAErE,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;IACJ,CAAC;CACF"}
1
+ {"version":3,"file":"serialization.event.js","sourceRoot":"","sources":["../../src/events/serialization.event.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC;;;;GAIG;AACH,MAAM,OAAO,kBAAsB,SAAQ,KAAQ;CAAG;AAEtD;;;;GAIG;AACH,MAAM,OAAO,sBAAuB,SAAQ,kBAAyC;IACnF;;OAEG;IACH,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAEwC,UAAU,CAAC,KAAK,CAAC;QAE7E,UAAU,CAAC,KAAK,GAAG,KAAK,WACtB,GAAG,IAA0D;YAE7D,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEtD,YAAY,CAAC,IAAI,CAAC,IAAI,sBAAsB,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAElE,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;IACJ,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,oBAAqB,SAAQ,kBAAyC;IACjF;;OAEG;IACH,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAEsC,UAAU,CAAC,KAAK,CAAC;QAE3E,UAAU,CAAC,KAAK,GAAG,KAAK,WACtB,GAAG,IAAwD;YAE3D,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEtD,YAAY,CAAC,IAAI,CAAC,IAAI,oBAAoB,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;YAE/D,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;IACJ,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,yBAA0B,SAAQ,kBAG7C;IACA;;OAEG;IACH,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAE2C,UAAU,CAAC,KAAK,CAAC;QAEhF,UAAU,CAAC,KAAK,GAAG,KAAK,WACtB,GAAG,IAA6D;YAEhE,MAAM,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEvC,YAAY,CAAC,IAAI,CAAC,IAAI,yBAAyB,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACjG,CAAC,CAAC;IACJ,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,6BAA8B,SAAQ,kBAA4C;IAC7F;;OAEG;IACH,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAEwD,UAAU,CAAC,KAAK,CAAC;QAE7F,UAAU,CAAC,KAAK,GAAG,KAAK,WACtB,GAAG,IAA0E;YAE7E,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEtD,YAAY,CAAC,IAAI,CAAC,IAAI,6BAA6B,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;YAExE,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;IACJ,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,0BAA2B,SAAQ,kBAA4C;IAC1F;;OAEG;IACH,MAAM,CAAU,SAAS,CAAC,YAA0B,EAAE,UAA8B;QAClF,MAAM,cAAc,GAEqD,UAAU,CAAC,KAAK,CAAC;QAE1F,UAAU,CAAC,KAAK,GAAG,KAAK,WACtB,GAAG,IAAuE;YAE1E,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAEtD,YAAY,CAAC,IAAI,CAAC,IAAI,0BAA0B,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;YAErE,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;IACJ,CAAC;CACF"}
@@ -0,0 +1,42 @@
1
+ import { Event } from './event.model.js';
2
+ /**
3
+ * The TerraformEvent class is the superclass for all events in relation to terraform and terragrunt.
4
+ *
5
+ * @group Events/Terraform
6
+ */
7
+ export declare class TerraformEvent<T = undefined> extends Event<T> {
8
+ }
9
+ /**
10
+ * This event is emitted when generate finishes writing terragrunt module folders.
11
+ * `emptied` lists folders written without resources, because their module left intent.
12
+ *
13
+ * @group Events/Terraform
14
+ */
15
+ export declare class TerraformFoldersWrittenEvent extends TerraformEvent<{
16
+ emptied: string[];
17
+ outputDir: string;
18
+ written: string[];
19
+ }> {
20
+ }
21
+ /**
22
+ * This event is emitted before a terraform/terragrunt command is invoked.
23
+ *
24
+ * @group Events/Terraform
25
+ */
26
+ export declare class TerraformCommandStartedEvent extends TerraformEvent<{
27
+ command: string;
28
+ dir: string;
29
+ }> {
30
+ }
31
+ /**
32
+ * This event is emitted after a terraform/terragrunt command returns, whatever its exit code.
33
+ *
34
+ * @group Events/Terraform
35
+ */
36
+ export declare class TerraformCommandFinishedEvent extends TerraformEvent<{
37
+ command: string;
38
+ dir: string;
39
+ durationInMs: number;
40
+ exitCode: number;
41
+ }> {
42
+ }
@@ -0,0 +1,31 @@
1
+ import { Event } from './event.model.js';
2
+ /**
3
+ * The TerraformEvent class is the superclass for all events in relation to terraform and terragrunt.
4
+ *
5
+ * @group Events/Terraform
6
+ */
7
+ export class TerraformEvent extends Event {
8
+ }
9
+ /**
10
+ * This event is emitted when generate finishes writing terragrunt module folders.
11
+ * `emptied` lists folders written without resources, because their module left intent.
12
+ *
13
+ * @group Events/Terraform
14
+ */
15
+ export class TerraformFoldersWrittenEvent extends TerraformEvent {
16
+ }
17
+ /**
18
+ * This event is emitted before a terraform/terragrunt command is invoked.
19
+ *
20
+ * @group Events/Terraform
21
+ */
22
+ export class TerraformCommandStartedEvent extends TerraformEvent {
23
+ }
24
+ /**
25
+ * This event is emitted after a terraform/terragrunt command returns, whatever its exit code.
26
+ *
27
+ * @group Events/Terraform
28
+ */
29
+ export class TerraformCommandFinishedEvent extends TerraformEvent {
30
+ }
31
+ //# sourceMappingURL=terraform.event.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"terraform.event.js","sourceRoot":"","sources":["../../src/events/terraform.event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC;;;;GAIG;AACH,MAAM,OAAO,cAA8B,SAAQ,KAAQ;CAAG;AAE9D;;;;;GAKG;AACH,MAAM,OAAO,4BAA6B,SAAQ,cAIhD;CAAG;AAEL;;;;GAIG;AACH,MAAM,OAAO,4BAA6B,SAAQ,cAAgD;CAAG;AAErG;;;;GAIG;AACH,MAAM,OAAO,6BAA8B,SAAQ,cAKjD;CAAG"}
@@ -1,13 +1,10 @@
1
1
  import type { DiffMetadata } from '../functions/diff/diff-metadata.js';
2
- import type { BaseResourceSchema } from '../resources/resource.schema.js';
3
2
  import { Event } from './event.model.js';
4
3
  /**
5
4
  * The TransactionEvent class is the superclass for all events in relation to transactions.
6
5
  * A transaction processes actions generated from model and resource diffs.
7
6
  *
8
7
  * @group Events/Transaction
9
- *
10
- * @returns The Event instance.
11
8
  */
12
9
  export declare class TransactionEvent<T> extends Event<T> {
13
10
  }
@@ -15,8 +12,6 @@ export declare class TransactionEvent<T> extends Event<T> {
15
12
  * This event is emitted when a model action in a transaction is done executing.
16
13
  *
17
14
  * @group Events/Transaction
18
- *
19
- * @returns The Event instance.
20
15
  */
21
16
  export declare class ModelActionTransactionEvent extends TransactionEvent<void> {
22
17
  }
@@ -24,8 +19,6 @@ export declare class ModelActionTransactionEvent extends TransactionEvent<void>
24
19
  * This event is emitted when transaction prepares a model diff.
25
20
 
26
21
  * @group Events/Transaction
27
- *
28
- * @returns The Event instance.
29
22
  */
30
23
  export declare class ModelDiffsTransactionEvent extends TransactionEvent<DiffMetadata[][]> {
31
24
  }
@@ -33,8 +26,6 @@ export declare class ModelDiffsTransactionEvent extends TransactionEvent<DiffMet
33
26
  * This event is emitted when transaction prepares a model transaction.
34
27
 
35
28
  * @group Events/Transaction
36
- *
37
- * @returns The Event instance.
38
29
  */
39
30
  export declare class ModelTransactionTransactionEvent extends TransactionEvent<DiffMetadata[][]> {
40
31
  }
@@ -42,35 +33,13 @@ export declare class ModelTransactionTransactionEvent extends TransactionEvent<D
42
33
  * This event is emitted when a resource action in a transaction is done executing.
43
34
  *
44
35
  * @group Events/Transaction
45
- *
46
- * @returns The Event instance.
47
36
  */
48
37
  export declare class ResourceActionCompletedTransactionEvent extends TransactionEvent<DiffMetadata> {
49
38
  }
50
- /**
51
- * This event is emitted pre-transaction to provide information for resource actions about to be executed
52
- * in the transaction.
53
- *
54
- * @group Events/Transaction
55
- *
56
- * @returns The Event instance.
57
- */
58
- export declare class ResourceActionInformationTransactionEvent extends TransactionEvent<{
59
- action: {
60
- name: string;
61
- };
62
- capture?: {
63
- response: Partial<BaseResourceSchema['response']>;
64
- };
65
- diff: DiffMetadata;
66
- }> {
67
- }
68
39
  /**
69
40
  * This event is emitted when a resource action in a transaction begins executing.
70
41
  *
71
42
  * @group Events/Transaction
72
- *
73
- * @returns The Event instance.
74
43
  */
75
44
  export declare class ResourceActionInitiatedTransactionEvent extends TransactionEvent<DiffMetadata> {
76
45
  }
@@ -79,8 +48,6 @@ export declare class ResourceActionInitiatedTransactionEvent extends Transaction
79
48
  * It emits a summary of the action.
80
49
  *
81
50
  * @group Events/Transaction
82
- *
83
- * @returns The Event instance.
84
51
  */
85
52
  export declare class ResourceActionSummaryTransactionEvent extends TransactionEvent<{
86
53
  diff: DiffMetadata;
@@ -94,8 +61,6 @@ export declare class ResourceActionSummaryTransactionEvent extends TransactionEv
94
61
  * This event is emitted when transaction prepares a resource diff.
95
62
 
96
63
  * @group Events/Transaction
97
- *
98
- * @returns The Event instance.
99
64
  */
100
65
  export declare class ResourceDiffsTransactionEvent extends TransactionEvent<[DiffMetadata[][], DiffMetadata[][]]> {
101
66
  }
@@ -103,8 +68,6 @@ export declare class ResourceDiffsTransactionEvent extends TransactionEvent<[Dif
103
68
  * This event is emitted when transaction prepares a resource transaction.
104
69
 
105
70
  * @group Events/Transaction
106
- *
107
- * @returns The Event instance.
108
71
  */
109
72
  export declare class ResourceTransactionTransactionEvent extends TransactionEvent<[DiffMetadata[][], DiffMetadata[][]]> {
110
73
  }
@@ -4,8 +4,6 @@ import { Event } from './event.model.js';
4
4
  * A transaction processes actions generated from model and resource diffs.
5
5
  *
6
6
  * @group Events/Transaction
7
- *
8
- * @returns The Event instance.
9
7
  */
10
8
  export class TransactionEvent extends Event {
11
9
  }
@@ -13,8 +11,6 @@ export class TransactionEvent extends Event {
13
11
  * This event is emitted when a model action in a transaction is done executing.
14
12
  *
15
13
  * @group Events/Transaction
16
- *
17
- * @returns The Event instance.
18
14
  */
19
15
  export class ModelActionTransactionEvent extends TransactionEvent {
20
16
  }
@@ -22,8 +18,6 @@ export class ModelActionTransactionEvent extends TransactionEvent {
22
18
  * This event is emitted when transaction prepares a model diff.
23
19
 
24
20
  * @group Events/Transaction
25
- *
26
- * @returns The Event instance.
27
21
  */
28
22
  export class ModelDiffsTransactionEvent extends TransactionEvent {
29
23
  }
@@ -31,8 +25,6 @@ export class ModelDiffsTransactionEvent extends TransactionEvent {
31
25
  * This event is emitted when transaction prepares a model transaction.
32
26
 
33
27
  * @group Events/Transaction
34
- *
35
- * @returns The Event instance.
36
28
  */
37
29
  export class ModelTransactionTransactionEvent extends TransactionEvent {
38
30
  }
@@ -40,27 +32,13 @@ export class ModelTransactionTransactionEvent extends TransactionEvent {
40
32
  * This event is emitted when a resource action in a transaction is done executing.
41
33
  *
42
34
  * @group Events/Transaction
43
- *
44
- * @returns The Event instance.
45
35
  */
46
36
  export class ResourceActionCompletedTransactionEvent extends TransactionEvent {
47
37
  }
48
- /**
49
- * This event is emitted pre-transaction to provide information for resource actions about to be executed
50
- * in the transaction.
51
- *
52
- * @group Events/Transaction
53
- *
54
- * @returns The Event instance.
55
- */
56
- export class ResourceActionInformationTransactionEvent extends TransactionEvent {
57
- }
58
38
  /**
59
39
  * This event is emitted when a resource action in a transaction begins executing.
60
40
  *
61
41
  * @group Events/Transaction
62
- *
63
- * @returns The Event instance.
64
42
  */
65
43
  export class ResourceActionInitiatedTransactionEvent extends TransactionEvent {
66
44
  }
@@ -69,8 +47,6 @@ export class ResourceActionInitiatedTransactionEvent extends TransactionEvent {
69
47
  * It emits a summary of the action.
70
48
  *
71
49
  * @group Events/Transaction
72
- *
73
- * @returns The Event instance.
74
50
  */
75
51
  export class ResourceActionSummaryTransactionEvent extends TransactionEvent {
76
52
  }
@@ -78,8 +54,6 @@ export class ResourceActionSummaryTransactionEvent extends TransactionEvent {
78
54
  * This event is emitted when transaction prepares a resource diff.
79
55
 
80
56
  * @group Events/Transaction
81
- *
82
- * @returns The Event instance.
83
57
  */
84
58
  export class ResourceDiffsTransactionEvent extends TransactionEvent {
85
59
  }
@@ -87,8 +61,6 @@ export class ResourceDiffsTransactionEvent extends TransactionEvent {
87
61
  * This event is emitted when transaction prepares a resource transaction.
88
62
 
89
63
  * @group Events/Transaction
90
- *
91
- * @returns The Event instance.
92
64
  */
93
65
  export class ResourceTransactionTransactionEvent extends TransactionEvent {
94
66
  }
@@ -1 +1 @@
1
- {"version":3,"file":"transaction.event.js","sourceRoot":"","sources":["../../src/events/transaction.event.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC;;;;;;;GAOG;AACH,MAAM,OAAO,gBAAoB,SAAQ,KAAQ;CAAG;AAEpD;;;;;;GAMG;AACH,MAAM,OAAO,2BAA4B,SAAQ,gBAAsB;CAAG;AAE1E;;;;;;GAMG;AACH,MAAM,OAAO,0BAA2B,SAAQ,gBAAkC;CAAG;AAErF;;;;;;GAMG;AACH,MAAM,OAAO,gCAAiC,SAAQ,gBAAkC;CAAG;AAE3F;;;;;;GAMG;AACH,MAAM,OAAO,uCAAwC,SAAQ,gBAA8B;CAAG;AAE9F;;;;;;;GAOG;AACH,MAAM,OAAO,yCAA0C,SAAQ,gBAI7D;CAAG;AAEL;;;;;;GAMG;AACH,MAAM,OAAO,uCAAwC,SAAQ,gBAA8B;CAAG;AAE9F;;;;;;;GAOG;AACH,MAAM,OAAO,qCAAsC,SAAQ,gBAGzD;CAAG;AAEL;;;;;;GAMG;AACH,MAAM,OAAO,6BAA8B,SAAQ,gBAAsD;CAAG;AAE5G;;;;;;GAMG;AACH,MAAM,OAAO,mCAAoC,SAAQ,gBAAsD;CAAG"}
1
+ {"version":3,"file":"transaction.event.js","sourceRoot":"","sources":["../../src/events/transaction.event.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC;;;;;GAKG;AACH,MAAM,OAAO,gBAAoB,SAAQ,KAAQ;CAAG;AAEpD;;;;GAIG;AACH,MAAM,OAAO,2BAA4B,SAAQ,gBAAsB;CAAG;AAE1E;;;;GAIG;AACH,MAAM,OAAO,0BAA2B,SAAQ,gBAAkC;CAAG;AAErF;;;;GAIG;AACH,MAAM,OAAO,gCAAiC,SAAQ,gBAAkC;CAAG;AAE3F;;;;GAIG;AACH,MAAM,OAAO,uCAAwC,SAAQ,gBAA8B;CAAG;AAE9F;;;;GAIG;AACH,MAAM,OAAO,uCAAwC,SAAQ,gBAA8B;CAAG;AAE9F;;;;;GAKG;AACH,MAAM,OAAO,qCAAsC,SAAQ,gBAGzD;CAAG;AAEL;;;;GAIG;AACH,MAAM,OAAO,6BAA8B,SAAQ,gBAAsD;CAAG;AAE5G;;;;GAIG;AACH,MAAM,OAAO,mCAAoC,SAAQ,gBAAsD;CAAG"}
@@ -21,17 +21,28 @@ type FactoryContainer<T> = {
21
21
  * @group Functions/Container
22
22
  */
23
23
  export declare class Container {
24
- private FACTORY_TIMEOUT_IN_MS;
25
- private readonly factories;
26
24
  private static instance;
25
+ private readonly factories;
26
+ private FACTORY_TIMEOUT_IN_MS;
27
27
  private readonly startupUnhandledPromises;
28
+ /**
29
+ * @internal
30
+ */
28
31
  private constructor();
32
+ /**
33
+ * The Container is a singleton - this is how you reach it.
34
+ */
35
+ static getInstance(): Container;
36
+ /**
37
+ * @internal
38
+ */
29
39
  copyFactories(): {
30
40
  [key: string]: FactoryContainer<unknown>[];
31
41
  };
32
42
  /**
33
- * `container.get()` allows to get an instance of a class using its factory.
34
- * If the factory is not yet registered, it places a blocking promise in the queue to wait for the registration.
43
+ * To get an instance of a class from its factory.
44
+ * If the factory is not registered yet, this waits for it, and times out - see
45
+ * {@link Container.setFactoryTimeout}.
35
46
  *
36
47
  * @param type The type or name of the class to get.
37
48
  * @param options Allows selection of a specific factory to use to get the instance.
@@ -45,14 +56,17 @@ export declare class Container {
45
56
  [key: string]: string;
46
57
  };
47
58
  }): Promise<T>;
48
- static getInstance(): Container;
59
+ /**
60
+ * Whether a factory is registered for the class.
61
+ */
49
62
  has<T>(type: Constructable<T> | string, options?: {
50
63
  metadata?: {
51
64
  [key: string]: string;
52
65
  };
53
66
  }): boolean;
54
67
  /**
55
- * `Container.registerFactory()` allows to register a factory for a class.
68
+ * To register a factory for a class. Prefer the {@link Factory} decorator; call this directly only
69
+ * when the factory is built at runtime.
56
70
  *
57
71
  * @param type The type or name of the class for which the factory is registered.
58
72
  * @param factory The factory class being registered.
@@ -64,37 +78,64 @@ export declare class Container {
64
78
  [key: string]: string;
65
79
  };
66
80
  }): void;
81
+ /**
82
+ * @internal
83
+ */
84
+ registerStartupUnhandledPromise<T>(promise: Promise<T>): void;
85
+ /**
86
+ * To register a ready-made instance, instead of a factory that builds one.
87
+ */
67
88
  registerValue<T>(type: Constructable<T> | string, value: T, options?: {
68
89
  metadata?: {
69
90
  [key: string]: string;
70
91
  };
71
92
  }): void;
72
- registerStartupUnhandledPromise<T>(promise: Promise<T>): void;
73
93
  /**
74
- * `Container.reset()` clears all registered factories and empties the container. This is mostly used in testing.
94
+ * To register a ready-made instance over whatever is already registered under the same type and
95
+ * metadata, rather than refusing as {@link Container.registerValue} does.
96
+ *
97
+ * Registering once is the right default - two factories for one type is usually a mistake. This is
98
+ * for the callers that legitimately register the same thing more than once: a module whose
99
+ * `onInit` runs on every `compose()`, and a test replacing a factory with a mock.
100
+ */
101
+ replaceValue<T>(type: Constructable<T> | string, value: T, options?: {
102
+ metadata?: {
103
+ [key: string]: string;
104
+ };
105
+ }): void;
106
+ /**
107
+ * To clear every registered factory and empty the container. Mostly used in testing.
75
108
  */
76
109
  reset(): void;
110
+ /**
111
+ * @internal
112
+ */
77
113
  setFactories(factories: {
78
114
  [key: string]: FactoryContainer<unknown>[];
79
115
  }): void;
80
116
  /**
81
- * The Container, by default, will wait a maximum of 5 seconds for a factory to resolve and provide an instance.
82
- * This method allows to change that timeout.
117
+ * To change how long `get()` waits for a factory to be registered.
83
118
  *
119
+ * @defaultValue `3000`
84
120
  * @param timeoutInMs The timeout in milliseconds.
121
+ *
85
122
  */
86
123
  setFactoryTimeout(timeoutInMs: number): void;
87
124
  /**
88
- * `Container.unRegisterFactory()` will unregister all factories of a class.
125
+ * To unregister a class's factories, so that your own can take their place.
89
126
  *
90
- * @param type The type or name of the class for which all factory is unregistered.
91
- * @param options
127
+ * @param type The type or name of the class whose factories are unregistered.
128
+ * @param options Pass `metadata` to unregister one specific factory. Without it, all of the
129
+ * class's factories are unregistered.
92
130
  */
93
131
  unRegisterFactory<T>(type: Constructable<T> | string, options?: {
94
132
  metadata?: {
95
133
  [key: string]: string;
96
134
  };
97
135
  }): void;
136
+ /**
137
+ * @internal
138
+ */
98
139
  waitToResolveAllFactories(): Promise<void>;
99
140
  }
100
141
  export {};