@cratis/chronicle 6.59.0 → 6.60.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 (359) hide show
  1. package/ChronicleClient.ts +1 -1
  2. package/ChronicleOptions.ts +11 -0
  3. package/EventStore.ts +9 -1
  4. package/IEventStore.ts +7 -0
  5. package/README.md +1 -1
  6. package/artifacts/DefaultClientArtifactsProvider.ts +13 -1
  7. package/artifacts/IClientArtifactsProvider.ts +6 -0
  8. package/dist/ChronicleClient.js +1 -1
  9. package/dist/ChronicleClient.js.map +1 -1
  10. package/dist/ChronicleOptions.d.ts +7 -0
  11. package/dist/ChronicleOptions.d.ts.map +1 -1
  12. package/dist/ChronicleOptions.js +8 -0
  13. package/dist/ChronicleOptions.js.map +1 -1
  14. package/dist/EventStore.d.ts +3 -1
  15. package/dist/EventStore.d.ts.map +1 -1
  16. package/dist/EventStore.js +7 -1
  17. package/dist/EventStore.js.map +1 -1
  18. package/dist/IEventStore.d.ts +6 -0
  19. package/dist/IEventStore.d.ts.map +1 -1
  20. package/dist/artifacts/DefaultClientArtifactsProvider.d.ts +4 -0
  21. package/dist/artifacts/DefaultClientArtifactsProvider.d.ts.map +1 -1
  22. package/dist/artifacts/DefaultClientArtifactsProvider.js +11 -1
  23. package/dist/artifacts/DefaultClientArtifactsProvider.js.map +1 -1
  24. package/dist/artifacts/IClientArtifactsProvider.d.ts +4 -0
  25. package/dist/artifacts/IClientArtifactsProvider.d.ts.map +1 -1
  26. package/dist/projections/Projections.d.ts.map +1 -1
  27. package/dist/projections/Projections.js +3 -30
  28. package/dist/projections/Projections.js.map +1 -1
  29. package/dist/projections/for_Graphs/given/a_discovered_graph.d.ts +29 -0
  30. package/dist/projections/for_Graphs/given/a_discovered_graph.d.ts.map +1 -0
  31. package/dist/projections/for_Graphs/given/a_discovered_graph.js +19 -0
  32. package/dist/projections/for_Graphs/given/a_discovered_graph.js.map +1 -0
  33. package/dist/projections/for_Graphs/given/a_fake_connection.d.ts +24 -0
  34. package/dist/projections/for_Graphs/given/a_fake_connection.d.ts.map +1 -0
  35. package/dist/projections/for_Graphs/given/a_fake_connection.js +17 -0
  36. package/dist/projections/for_Graphs/given/a_fake_connection.js.map +1 -0
  37. package/dist/projections/for_Graphs/given/organization.d.ts +43 -0
  38. package/dist/projections/for_Graphs/given/organization.d.ts.map +1 -0
  39. package/dist/projections/for_Graphs/given/organization.js +84 -0
  40. package/dist/projections/for_Graphs/given/organization.js.map +1 -0
  41. package/dist/projections/graphs/EdgeCanHaveOnlyOneIdentifyingKey.d.ts +11 -0
  42. package/dist/projections/graphs/EdgeCanHaveOnlyOneIdentifyingKey.d.ts.map +1 -0
  43. package/dist/projections/graphs/EdgeCanHaveOnlyOneIdentifyingKey.js +16 -0
  44. package/dist/projections/graphs/EdgeCanHaveOnlyOneIdentifyingKey.js.map +1 -0
  45. package/dist/projections/graphs/EdgeMustHaveOneSourceAndOneTarget.d.ts +11 -0
  46. package/dist/projections/graphs/EdgeMustHaveOneSourceAndOneTarget.d.ts.map +1 -0
  47. package/dist/projections/graphs/EdgeMustHaveOneSourceAndOneTarget.js +16 -0
  48. package/dist/projections/graphs/EdgeMustHaveOneSourceAndOneTarget.js.map +1 -0
  49. package/dist/projections/graphs/GraphDeclaredMoreThanOnce.d.ts +11 -0
  50. package/dist/projections/graphs/GraphDeclaredMoreThanOnce.d.ts.map +1 -0
  51. package/dist/projections/graphs/GraphDeclaredMoreThanOnce.js +16 -0
  52. package/dist/projections/graphs/GraphDeclaredMoreThanOnce.js.map +1 -0
  53. package/dist/projections/graphs/GraphDefinitionBuilder.d.ts +24 -0
  54. package/dist/projections/graphs/GraphDefinitionBuilder.d.ts.map +1 -0
  55. package/dist/projections/graphs/GraphDefinitionBuilder.js +145 -0
  56. package/dist/projections/graphs/GraphDefinitionBuilder.js.map +1 -0
  57. package/dist/projections/graphs/GraphEdgeBuilder.d.ts +41 -0
  58. package/dist/projections/graphs/GraphEdgeBuilder.d.ts.map +1 -0
  59. package/dist/projections/graphs/GraphEdgeBuilder.js +94 -0
  60. package/dist/projections/graphs/GraphEdgeBuilder.js.map +1 -0
  61. package/dist/projections/graphs/GraphEdgeFromBuilder.d.ts +25 -0
  62. package/dist/projections/graphs/GraphEdgeFromBuilder.d.ts.map +1 -0
  63. package/dist/projections/graphs/GraphEdgeFromBuilder.js +37 -0
  64. package/dist/projections/graphs/GraphEdgeFromBuilder.js.map +1 -0
  65. package/dist/projections/graphs/GraphEdgeFromModel.d.ts +16 -0
  66. package/dist/projections/graphs/GraphEdgeFromModel.d.ts.map +1 -0
  67. package/dist/projections/graphs/GraphEdgeFromModel.js +4 -0
  68. package/dist/projections/graphs/GraphEdgeFromModel.js.map +1 -0
  69. package/dist/projections/graphs/GraphEdgeModel.d.ts +24 -0
  70. package/dist/projections/graphs/GraphEdgeModel.d.ts.map +1 -0
  71. package/dist/projections/graphs/GraphEdgeModel.js +4 -0
  72. package/dist/projections/graphs/GraphEdgeModel.js.map +1 -0
  73. package/dist/projections/graphs/GraphEdgeRemovedWithBuilder.d.ts +21 -0
  74. package/dist/projections/graphs/GraphEdgeRemovedWithBuilder.d.ts.map +1 -0
  75. package/dist/projections/graphs/GraphEdgeRemovedWithBuilder.js +31 -0
  76. package/dist/projections/graphs/GraphEdgeRemovedWithBuilder.js.map +1 -0
  77. package/dist/projections/graphs/GraphEdgeRemovedWithModel.d.ts +14 -0
  78. package/dist/projections/graphs/GraphEdgeRemovedWithModel.d.ts.map +1 -0
  79. package/dist/projections/graphs/GraphEdgeRemovedWithModel.js +4 -0
  80. package/dist/projections/graphs/GraphEdgeRemovedWithModel.js.map +1 -0
  81. package/dist/projections/graphs/GraphElementCannotBeReadModel.d.ts +11 -0
  82. package/dist/projections/graphs/GraphElementCannotBeReadModel.d.ts.map +1 -0
  83. package/dist/projections/graphs/GraphElementCannotBeReadModel.js +16 -0
  84. package/dist/projections/graphs/GraphElementCannotBeReadModel.js.map +1 -0
  85. package/dist/projections/graphs/GraphHasDuplicateElement.d.ts +13 -0
  86. package/dist/projections/graphs/GraphHasDuplicateElement.d.ts.map +1 -0
  87. package/dist/projections/graphs/GraphHasDuplicateElement.js +18 -0
  88. package/dist/projections/graphs/GraphHasDuplicateElement.js.map +1 -0
  89. package/dist/projections/graphs/GraphKeyPropertyNotFound.d.ts +12 -0
  90. package/dist/projections/graphs/GraphKeyPropertyNotFound.d.ts.map +1 -0
  91. package/dist/projections/graphs/GraphKeyPropertyNotFound.js +17 -0
  92. package/dist/projections/graphs/GraphKeyPropertyNotFound.js.map +1 -0
  93. package/dist/projections/graphs/GraphMappingBuilder.d.ts +32 -0
  94. package/dist/projections/graphs/GraphMappingBuilder.d.ts.map +1 -0
  95. package/dist/projections/graphs/GraphMappingBuilder.js +48 -0
  96. package/dist/projections/graphs/GraphMappingBuilder.js.map +1 -0
  97. package/dist/projections/graphs/GraphMemberMappings.d.ts +8 -0
  98. package/dist/projections/graphs/GraphMemberMappings.d.ts.map +1 -0
  99. package/dist/projections/graphs/GraphMemberMappings.js +54 -0
  100. package/dist/projections/graphs/GraphMemberMappings.js.map +1 -0
  101. package/dist/projections/graphs/GraphModel.d.ts +15 -0
  102. package/dist/projections/graphs/GraphModel.d.ts.map +1 -0
  103. package/dist/projections/graphs/GraphModel.js +4 -0
  104. package/dist/projections/graphs/GraphModel.js.map +1 -0
  105. package/dist/projections/graphs/GraphNameRequired.d.ts +11 -0
  106. package/dist/projections/graphs/GraphNameRequired.d.ts.map +1 -0
  107. package/dist/projections/graphs/GraphNameRequired.js +16 -0
  108. package/dist/projections/graphs/GraphNameRequired.js.map +1 -0
  109. package/dist/projections/graphs/GraphNodeBuilder.d.ts +34 -0
  110. package/dist/projections/graphs/GraphNodeBuilder.d.ts.map +1 -0
  111. package/dist/projections/graphs/GraphNodeBuilder.js +66 -0
  112. package/dist/projections/graphs/GraphNodeBuilder.js.map +1 -0
  113. package/dist/projections/graphs/GraphNodeFromBuilder.d.ts +21 -0
  114. package/dist/projections/graphs/GraphNodeFromBuilder.d.ts.map +1 -0
  115. package/dist/projections/graphs/GraphNodeFromBuilder.js +30 -0
  116. package/dist/projections/graphs/GraphNodeFromBuilder.js.map +1 -0
  117. package/dist/projections/graphs/GraphNodeFromModel.d.ts +14 -0
  118. package/dist/projections/graphs/GraphNodeFromModel.d.ts.map +1 -0
  119. package/dist/projections/graphs/GraphNodeFromModel.js +4 -0
  120. package/dist/projections/graphs/GraphNodeFromModel.js.map +1 -0
  121. package/dist/projections/graphs/GraphNodeModel.d.ts +18 -0
  122. package/dist/projections/graphs/GraphNodeModel.d.ts.map +1 -0
  123. package/dist/projections/graphs/GraphNodeModel.js +4 -0
  124. package/dist/projections/graphs/GraphNodeModel.js.map +1 -0
  125. package/dist/projections/graphs/GraphNodeRemovedWithBuilder.d.ts +17 -0
  126. package/dist/projections/graphs/GraphNodeRemovedWithBuilder.d.ts.map +1 -0
  127. package/dist/projections/graphs/GraphNodeRemovedWithBuilder.js +24 -0
  128. package/dist/projections/graphs/GraphNodeRemovedWithBuilder.js.map +1 -0
  129. package/dist/projections/graphs/GraphNodeRemovedWithModel.d.ts +12 -0
  130. package/dist/projections/graphs/GraphNodeRemovedWithModel.d.ts.map +1 -0
  131. package/dist/projections/graphs/GraphNodeRemovedWithModel.js +4 -0
  132. package/dist/projections/graphs/GraphNodeRemovedWithModel.js.map +1 -0
  133. package/dist/projections/graphs/GraphProjectionBuilder.d.ts +25 -0
  134. package/dist/projections/graphs/GraphProjectionBuilder.d.ts.map +1 -0
  135. package/dist/projections/graphs/GraphProjectionBuilder.js +36 -0
  136. package/dist/projections/graphs/GraphProjectionBuilder.js.map +1 -0
  137. package/dist/projections/graphs/GraphRegistration.d.ts +14 -0
  138. package/dist/projections/graphs/GraphRegistration.d.ts.map +1 -0
  139. package/dist/projections/graphs/GraphRegistration.js +4 -0
  140. package/dist/projections/graphs/GraphRegistration.js.map +1 -0
  141. package/dist/projections/graphs/GraphSchemaWriter.d.ts +28 -0
  142. package/dist/projections/graphs/GraphSchemaWriter.d.ts.map +1 -0
  143. package/dist/projections/graphs/GraphSchemaWriter.js +76 -0
  144. package/dist/projections/graphs/GraphSchemaWriter.js.map +1 -0
  145. package/dist/projections/graphs/Graphs.d.ts +39 -0
  146. package/dist/projections/graphs/Graphs.d.ts.map +1 -0
  147. package/dist/projections/graphs/Graphs.js +144 -0
  148. package/dist/projections/graphs/Graphs.js.map +1 -0
  149. package/dist/projections/graphs/IGraphEdgeBuilder.d.ts +37 -0
  150. package/dist/projections/graphs/IGraphEdgeBuilder.d.ts.map +1 -0
  151. package/dist/projections/graphs/IGraphEdgeBuilder.js +4 -0
  152. package/dist/projections/graphs/IGraphEdgeBuilder.js.map +1 -0
  153. package/dist/projections/graphs/IGraphEdgeFromBuilder.d.ts +29 -0
  154. package/dist/projections/graphs/IGraphEdgeFromBuilder.d.ts.map +1 -0
  155. package/dist/projections/graphs/IGraphEdgeFromBuilder.js +4 -0
  156. package/dist/projections/graphs/IGraphEdgeFromBuilder.js.map +1 -0
  157. package/dist/projections/graphs/IGraphEdgeRemovedWithBuilder.d.ts +27 -0
  158. package/dist/projections/graphs/IGraphEdgeRemovedWithBuilder.d.ts.map +1 -0
  159. package/dist/projections/graphs/IGraphEdgeRemovedWithBuilder.js +4 -0
  160. package/dist/projections/graphs/IGraphEdgeRemovedWithBuilder.js.map +1 -0
  161. package/dist/projections/graphs/IGraphMappingBuilder.d.ts +49 -0
  162. package/dist/projections/graphs/IGraphMappingBuilder.d.ts.map +1 -0
  163. package/dist/projections/graphs/IGraphMappingBuilder.js +4 -0
  164. package/dist/projections/graphs/IGraphMappingBuilder.js.map +1 -0
  165. package/dist/projections/graphs/IGraphNodeBuilder.d.ts +32 -0
  166. package/dist/projections/graphs/IGraphNodeBuilder.d.ts.map +1 -0
  167. package/dist/projections/graphs/IGraphNodeBuilder.js +4 -0
  168. package/dist/projections/graphs/IGraphNodeBuilder.js.map +1 -0
  169. package/dist/projections/graphs/IGraphNodeFromBuilder.d.ts +21 -0
  170. package/dist/projections/graphs/IGraphNodeFromBuilder.d.ts.map +1 -0
  171. package/dist/projections/graphs/IGraphNodeFromBuilder.js +4 -0
  172. package/dist/projections/graphs/IGraphNodeFromBuilder.js.map +1 -0
  173. package/dist/projections/graphs/IGraphNodeRemovedWithBuilder.d.ts +19 -0
  174. package/dist/projections/graphs/IGraphNodeRemovedWithBuilder.d.ts.map +1 -0
  175. package/dist/projections/graphs/IGraphNodeRemovedWithBuilder.js +4 -0
  176. package/dist/projections/graphs/IGraphNodeRemovedWithBuilder.js.map +1 -0
  177. package/dist/projections/graphs/IGraphProjection.d.ts +13 -0
  178. package/dist/projections/graphs/IGraphProjection.d.ts.map +1 -0
  179. package/dist/projections/graphs/IGraphProjection.js +4 -0
  180. package/dist/projections/graphs/IGraphProjection.js.map +1 -0
  181. package/dist/projections/graphs/IGraphProjectionBuilder.d.ts +26 -0
  182. package/dist/projections/graphs/IGraphProjectionBuilder.d.ts.map +1 -0
  183. package/dist/projections/graphs/IGraphProjectionBuilder.js +4 -0
  184. package/dist/projections/graphs/IGraphProjectionBuilder.js.map +1 -0
  185. package/dist/projections/graphs/IGraphs.d.ts +27 -0
  186. package/dist/projections/graphs/IGraphs.d.ts.map +1 -0
  187. package/dist/projections/graphs/IGraphs.js +4 -0
  188. package/dist/projections/graphs/IGraphs.js.map +1 -0
  189. package/dist/projections/graphs/ModelBoundGraphReader.d.ts +30 -0
  190. package/dist/projections/graphs/ModelBoundGraphReader.d.ts.map +1 -0
  191. package/dist/projections/graphs/ModelBoundGraphReader.js +112 -0
  192. package/dist/projections/graphs/ModelBoundGraphReader.js.map +1 -0
  193. package/dist/projections/graphs/NestedObjectInGraph.d.ts +12 -0
  194. package/dist/projections/graphs/NestedObjectInGraph.d.ts.map +1 -0
  195. package/dist/projections/graphs/NestedObjectInGraph.js +17 -0
  196. package/dist/projections/graphs/NestedObjectInGraph.js.map +1 -0
  197. package/dist/projections/graphs/NodeMustHaveExactlyOneKey.d.ts +12 -0
  198. package/dist/projections/graphs/NodeMustHaveExactlyOneKey.d.ts.map +1 -0
  199. package/dist/projections/graphs/NodeMustHaveExactlyOneKey.js +17 -0
  200. package/dist/projections/graphs/NodeMustHaveExactlyOneKey.js.map +1 -0
  201. package/dist/projections/graphs/UnknownGraphEventProperty.d.ts +13 -0
  202. package/dist/projections/graphs/UnknownGraphEventProperty.d.ts.map +1 -0
  203. package/dist/projections/graphs/UnknownGraphEventProperty.js +18 -0
  204. package/dist/projections/graphs/UnknownGraphEventProperty.js.map +1 -0
  205. package/dist/projections/graphs/UnknownGraphNode.d.ts +12 -0
  206. package/dist/projections/graphs/UnknownGraphNode.d.ts.map +1 -0
  207. package/dist/projections/graphs/UnknownGraphNode.js +17 -0
  208. package/dist/projections/graphs/UnknownGraphNode.js.map +1 -0
  209. package/dist/projections/graphs/edge.d.ts +23 -0
  210. package/dist/projections/graphs/edge.d.ts.map +1 -0
  211. package/dist/projections/graphs/edge.js +29 -0
  212. package/dist/projections/graphs/edge.js.map +1 -0
  213. package/dist/projections/graphs/edgeFrom.d.ts +31 -0
  214. package/dist/projections/graphs/edgeFrom.d.ts.map +1 -0
  215. package/dist/projections/graphs/edgeFrom.js +26 -0
  216. package/dist/projections/graphs/edgeFrom.js.map +1 -0
  217. package/dist/projections/graphs/edgeRemovedWith.d.ts +22 -0
  218. package/dist/projections/graphs/edgeRemovedWith.d.ts.map +1 -0
  219. package/dist/projections/graphs/edgeRemovedWith.js +25 -0
  220. package/dist/projections/graphs/edgeRemovedWith.js.map +1 -0
  221. package/dist/projections/graphs/edgeSource.d.ts +22 -0
  222. package/dist/projections/graphs/edgeSource.d.ts.map +1 -0
  223. package/dist/projections/graphs/edgeSource.js +30 -0
  224. package/dist/projections/graphs/edgeSource.js.map +1 -0
  225. package/dist/projections/graphs/edgeTarget.d.ts +22 -0
  226. package/dist/projections/graphs/edgeTarget.d.ts.map +1 -0
  227. package/dist/projections/graphs/edgeTarget.js +30 -0
  228. package/dist/projections/graphs/edgeTarget.js.map +1 -0
  229. package/dist/projections/graphs/graph.d.ts +16 -0
  230. package/dist/projections/graphs/graph.d.ts.map +1 -0
  231. package/dist/projections/graphs/graph.js +24 -0
  232. package/dist/projections/graphs/graph.js.map +1 -0
  233. package/dist/projections/graphs/graphKey.d.ts +16 -0
  234. package/dist/projections/graphs/graphKey.d.ts.map +1 -0
  235. package/dist/projections/graphs/graphKey.js +28 -0
  236. package/dist/projections/graphs/graphKey.js.map +1 -0
  237. package/dist/projections/graphs/graphProjection.d.ts +21 -0
  238. package/dist/projections/graphs/graphProjection.d.ts.map +1 -0
  239. package/dist/projections/graphs/graphProjection.js +28 -0
  240. package/dist/projections/graphs/graphProjection.js.map +1 -0
  241. package/dist/projections/graphs/index.d.ts +48 -0
  242. package/dist/projections/graphs/index.d.ts.map +1 -0
  243. package/dist/projections/graphs/index.js +27 -0
  244. package/dist/projections/graphs/index.js.map +1 -0
  245. package/dist/projections/graphs/isGraphElement.d.ts +7 -0
  246. package/dist/projections/graphs/isGraphElement.d.ts.map +1 -0
  247. package/dist/projections/graphs/isGraphElement.js +13 -0
  248. package/dist/projections/graphs/isGraphElement.js.map +1 -0
  249. package/dist/projections/graphs/node.d.ts +22 -0
  250. package/dist/projections/graphs/node.d.ts.map +1 -0
  251. package/dist/projections/graphs/node.js +29 -0
  252. package/dist/projections/graphs/node.js.map +1 -0
  253. package/dist/projections/graphs/nodeFrom.d.ts +31 -0
  254. package/dist/projections/graphs/nodeFrom.d.ts.map +1 -0
  255. package/dist/projections/graphs/nodeFrom.js +26 -0
  256. package/dist/projections/graphs/nodeFrom.js.map +1 -0
  257. package/dist/projections/graphs/nodeRemovedWith.d.ts +28 -0
  258. package/dist/projections/graphs/nodeRemovedWith.d.ts.map +1 -0
  259. package/dist/projections/graphs/nodeRemovedWith.js +25 -0
  260. package/dist/projections/graphs/nodeRemovedWith.js.map +1 -0
  261. package/dist/projections/graphs/propertyPathOf.d.ts +8 -0
  262. package/dist/projections/graphs/propertyPathOf.d.ts.map +1 -0
  263. package/dist/projections/graphs/propertyPathOf.js +14 -0
  264. package/dist/projections/graphs/propertyPathOf.js.map +1 -0
  265. package/dist/projections/index.d.ts +1 -0
  266. package/dist/projections/index.d.ts.map +1 -1
  267. package/dist/projections/index.js +1 -0
  268. package/dist/projections/index.js.map +1 -1
  269. package/dist/projections/registerProjectionWithRetry.d.ts +15 -0
  270. package/dist/projections/registerProjectionWithRetry.d.ts.map +1 -0
  271. package/dist/projections/registerProjectionWithRetry.js +44 -0
  272. package/dist/projections/registerProjectionWithRetry.js.map +1 -0
  273. package/dist/readModels/rootReadModelTypes.d.ts.map +1 -1
  274. package/dist/readModels/rootReadModelTypes.js +3 -1
  275. package/dist/readModels/rootReadModelTypes.js.map +1 -1
  276. package/dist/sinks/WellKnownSinks.d.ts +4 -0
  277. package/dist/sinks/WellKnownSinks.d.ts.map +1 -1
  278. package/dist/sinks/WellKnownSinks.js +5 -1
  279. package/dist/sinks/WellKnownSinks.js.map +1 -1
  280. package/dist/tsconfig.tsbuildinfo +1 -1
  281. package/dist/types/DecoratorType.d.ts +5 -1
  282. package/dist/types/DecoratorType.d.ts.map +1 -1
  283. package/dist/types/DecoratorType.js +4 -0
  284. package/dist/types/DecoratorType.js.map +1 -1
  285. package/for_ChronicleOptions/when_configuring_the_graph_sink/with_graph_sink_type.spec.ts +22 -0
  286. package/package.json +3 -3
  287. package/projections/Projections.ts +4 -29
  288. package/projections/for_Graphs/given/a_discovered_graph.ts +21 -0
  289. package/projections/for_Graphs/given/a_fake_connection.ts +19 -0
  290. package/projections/for_Graphs/given/organization.ts +96 -0
  291. package/projections/for_Graphs/when_building_a_fluent_graph.spec.ts +112 -0
  292. package/projections/for_Graphs/when_building_a_model_bound_graph.spec.ts +91 -0
  293. package/projections/for_Graphs/when_declaring_an_edge_with_an_identity.spec.ts +137 -0
  294. package/projections/for_Graphs/when_declaring_an_invalid_graph.spec.ts +199 -0
  295. package/projections/for_Graphs/when_declaring_with_standard_decorators.standard.spec.ts +92 -0
  296. package/projections/for_Graphs/when_discovering_graph_elements.spec.ts +32 -0
  297. package/projections/for_Graphs/when_mapping_properties.spec.ts +159 -0
  298. package/projections/for_Graphs/when_registering_graphs.spec.ts +56 -0
  299. package/projections/graphs/EdgeCanHaveOnlyOneIdentifyingKey.ts +16 -0
  300. package/projections/graphs/EdgeMustHaveOneSourceAndOneTarget.ts +16 -0
  301. package/projections/graphs/GraphDeclaredMoreThanOnce.ts +16 -0
  302. package/projections/graphs/GraphDefinitionBuilder.ts +166 -0
  303. package/projections/graphs/GraphEdgeBuilder.ts +107 -0
  304. package/projections/graphs/GraphEdgeFromBuilder.ts +47 -0
  305. package/projections/graphs/GraphEdgeFromModel.ts +22 -0
  306. package/projections/graphs/GraphEdgeModel.ts +34 -0
  307. package/projections/graphs/GraphEdgeRemovedWithBuilder.ts +39 -0
  308. package/projections/graphs/GraphEdgeRemovedWithModel.ts +19 -0
  309. package/projections/graphs/GraphElementCannotBeReadModel.ts +16 -0
  310. package/projections/graphs/GraphHasDuplicateElement.ts +18 -0
  311. package/projections/graphs/GraphKeyPropertyNotFound.ts +17 -0
  312. package/projections/graphs/GraphMappingBuilder.ts +65 -0
  313. package/projections/graphs/GraphMemberMappings.ts +57 -0
  314. package/projections/graphs/GraphModel.ts +20 -0
  315. package/projections/graphs/GraphNameRequired.ts +16 -0
  316. package/projections/graphs/GraphNodeBuilder.ts +76 -0
  317. package/projections/graphs/GraphNodeFromBuilder.ts +38 -0
  318. package/projections/graphs/GraphNodeFromModel.ts +19 -0
  319. package/projections/graphs/GraphNodeModel.ts +25 -0
  320. package/projections/graphs/GraphNodeRemovedWithBuilder.ts +30 -0
  321. package/projections/graphs/GraphNodeRemovedWithModel.ts +16 -0
  322. package/projections/graphs/GraphProjectionBuilder.ts +52 -0
  323. package/projections/graphs/GraphRegistration.ts +19 -0
  324. package/projections/graphs/GraphSchemaWriter.ts +80 -0
  325. package/projections/graphs/Graphs.ts +165 -0
  326. package/projections/graphs/IGraphEdgeBuilder.ts +43 -0
  327. package/projections/graphs/IGraphEdgeFromBuilder.ts +34 -0
  328. package/projections/graphs/IGraphEdgeRemovedWithBuilder.ts +32 -0
  329. package/projections/graphs/IGraphMappingBuilder.ts +57 -0
  330. package/projections/graphs/IGraphNodeBuilder.ts +37 -0
  331. package/projections/graphs/IGraphNodeFromBuilder.ts +25 -0
  332. package/projections/graphs/IGraphNodeRemovedWithBuilder.ts +23 -0
  333. package/projections/graphs/IGraphProjection.ts +16 -0
  334. package/projections/graphs/IGraphProjectionBuilder.ts +34 -0
  335. package/projections/graphs/IGraphs.ts +33 -0
  336. package/projections/graphs/ModelBoundGraphReader.ts +119 -0
  337. package/projections/graphs/NestedObjectInGraph.ts +17 -0
  338. package/projections/graphs/NodeMustHaveExactlyOneKey.ts +17 -0
  339. package/projections/graphs/UnknownGraphEventProperty.ts +18 -0
  340. package/projections/graphs/UnknownGraphNode.ts +17 -0
  341. package/projections/graphs/edge.ts +40 -0
  342. package/projections/graphs/edgeFrom.ts +48 -0
  343. package/projections/graphs/edgeRemovedWith.ts +36 -0
  344. package/projections/graphs/edgeSource.ts +39 -0
  345. package/projections/graphs/edgeTarget.ts +39 -0
  346. package/projections/graphs/graph.ts +28 -0
  347. package/projections/graphs/graphKey.ts +31 -0
  348. package/projections/graphs/graphProjection.ts +39 -0
  349. package/projections/graphs/index.ts +50 -0
  350. package/projections/graphs/isGraphElement.ts +14 -0
  351. package/projections/graphs/node.ts +40 -0
  352. package/projections/graphs/nodeFrom.ts +48 -0
  353. package/projections/graphs/nodeRemovedWith.ts +44 -0
  354. package/projections/graphs/propertyPathOf.ts +15 -0
  355. package/projections/index.ts +1 -0
  356. package/projections/registerProjectionWithRetry.ts +53 -0
  357. package/readModels/rootReadModelTypes.ts +3 -1
  358. package/sinks/WellKnownSinks.ts +7 -1
  359. package/types/DecoratorType.ts +7 -1
@@ -27,5 +27,9 @@ export var DecoratorType;
27
27
  DecoratorType["GlobalForHandler"] = "globalForHandler";
28
28
  /** Event source definition artifacts discovered through the eventSource decorator. */
29
29
  DecoratorType["EventSource"] = "eventSource";
30
+ /** Node and edge artifacts of a property graph discovered through the node and edge decorators. */
31
+ DecoratorType["GraphElement"] = "graphElement";
32
+ /** Fluent graph projection artifacts discovered through the graphProjection decorator. */
33
+ DecoratorType["GraphProjection"] = "graphProjection";
30
34
  })(DecoratorType || (DecoratorType = {}));
31
35
  //# sourceMappingURL=DecoratorType.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"DecoratorType.js","sourceRoot":"","sources":["../../types/DecoratorType.ts"],"names":[],"mappings":"AAAA,6CAA6C;AAC7C,qGAAqG;AAErG;;GAEG;AACH,MAAM,CAAN,IAAY,aAiCX;AAjCD,WAAY,aAAa;IACrB,uEAAuE;IACvE,wCAAuB,CAAA;IAEvB,uEAAuE;IACvE,wCAAuB,CAAA;IAEvB,kEAAkE;IAClE,oCAAmB,CAAA;IAEnB,kEAAkE;IAClE,oCAAmB,CAAA;IAEnB,gEAAgE;IAChE,kCAAiB,CAAA;IAEjB,wEAAwE;IACxE,0CAAyB,CAAA;IAEzB,oFAAoF;IACpF,0CAAyB,CAAA;IAEzB,kEAAkE;IAClE,oCAAmB,CAAA;IAEnB,0FAA0F;IAC1F,0DAAyC,CAAA;IAEzC,8FAA8F;IAC9F,sDAAqC,CAAA;IAErC,sFAAsF;IACtF,4CAA2B,CAAA;AAC/B,CAAC,EAjCW,aAAa,KAAb,aAAa,QAiCxB"}
1
+ {"version":3,"file":"DecoratorType.js","sourceRoot":"","sources":["../../types/DecoratorType.ts"],"names":[],"mappings":"AAAA,6CAA6C;AAC7C,qGAAqG;AAErG;;GAEG;AACH,MAAM,CAAN,IAAY,aAuCX;AAvCD,WAAY,aAAa;IACrB,uEAAuE;IACvE,wCAAuB,CAAA;IAEvB,uEAAuE;IACvE,wCAAuB,CAAA;IAEvB,kEAAkE;IAClE,oCAAmB,CAAA;IAEnB,kEAAkE;IAClE,oCAAmB,CAAA;IAEnB,gEAAgE;IAChE,kCAAiB,CAAA;IAEjB,wEAAwE;IACxE,0CAAyB,CAAA;IAEzB,oFAAoF;IACpF,0CAAyB,CAAA;IAEzB,kEAAkE;IAClE,oCAAmB,CAAA;IAEnB,0FAA0F;IAC1F,0DAAyC,CAAA;IAEzC,8FAA8F;IAC9F,sDAAqC,CAAA;IAErC,sFAAsF;IACtF,4CAA2B,CAAA;IAE3B,mGAAmG;IACnG,8CAA6B,CAAA;IAE7B,0FAA0F;IAC1F,oDAAmC,CAAA;AACvC,CAAC,EAvCW,aAAa,KAAb,aAAa,QAuCxB"}
@@ -0,0 +1,22 @@
1
+ // Copyright (c) Cratis. All rights reserved.
2
+ // Licensed under the MIT license. See LICENSE file in the project root for full license information.
3
+
4
+ import { chai, describe, it } from 'vitest';
5
+ import { ChronicleOptions } from '../../ChronicleOptions.js';
6
+ import { WellKnownSinks } from '../../sinks/index.js';
7
+
8
+ chai.should();
9
+
10
+ describe('when configuring the graph sink', () => {
11
+ it('should store graphs in Neo4j by default, and leave document read models alone', () => {
12
+ const options = ChronicleOptions.development();
13
+ options.defaultGraphSinkTypeId.should.equal(WellKnownSinks.Neo4j);
14
+ options.defaultSinkTypeId.should.equal(WellKnownSinks.MongoDB);
15
+ });
16
+
17
+ it('should use the configured sink type for graphs only', () => {
18
+ const options = ChronicleOptions.development({ defaultGraphSinkTypeId: WellKnownSinks.InMemoryGraph });
19
+ options.defaultGraphSinkTypeId.should.equal(WellKnownSinks.InMemoryGraph);
20
+ options.defaultSinkTypeId.should.equal(WellKnownSinks.MongoDB);
21
+ });
22
+ });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cratis/chronicle",
3
- "version": "6.59.0",
3
+ "version": "6.60.0",
4
4
  "description": "Event sourcing for TypeScript and Node.js — the idiomatic client for Cratis Chronicle, the open-source event-sourcing database",
5
5
  "author": "Cratis",
6
6
  "license": "MIT",
@@ -173,12 +173,12 @@
173
173
  "clean": "rm -rf dist",
174
174
  "test": "vitest run",
175
175
  "test:integration": "vitest run --config vitest.integration.config.ts",
176
- "test:standard-types": "tsc --ignoreConfig --noEmit --target es2022 --module es2022 --moduleResolution bundler --lib es2022,esnext.decorators --types node --skipLibCheck --strict schemas/decorators.standard.spec.ts projections/declarative/addChildCompatibility.standard.spec.ts projections/declarative/for_CompositeKeyBuilder/when_typing_constant_parts.standard.spec.ts projections/modelBound/decorators.standard.spec.ts events/classDecorators.standard.spec.ts reactors/decorators.standard.spec.ts readModels/standardFallbacks.standard.spec.ts readModels/registration.standard.spec.ts for_ChronicleClient/when_registering_artifacts/with_standard_property_mappings.standard.spec.ts artifacts/validateArtifactSchemas.spec.ts testing/for_EventScenario/when_appending_concept_fields/with_standard_decorators.standard.spec.ts testing/for_EventScenario/when_appending_scoped_constraints/with_standard_decorators.standard.spec.ts testing/for_EventScenario/when_appending_event_sequence_constraints/with_standard_decorators.standard.spec.ts testing/for_EventScenario/when_appending_event_sequence_constraints/other_sequence_extended_key.standard.spec.ts events/constraints/for_Constraints/when_scoping_to_event_sequences/with_standard_decorators.standard.spec.ts schemas/for_JsonSchemaGenerator/when_generating_children/with_standard_decorators.standard.spec.ts events/for_handles/when_decorating_a_method.standard.spec.ts testing/for_ReadModelScenario/when_evaluating_arithmetic/with_standard_decorators.standard.spec.ts testing/for_ReadModelScenario/when_evaluating_joins/with_standard_decorators.standard.spec.ts testing/for_EventScenario/when_appending_field_types/with_standard_decorators.standard.spec.ts eventSequences/for_EventSequence/when_appending/with_subject_annotations.standard.spec.ts projections/for_ProjectionDefinitionCompiler/when_compiling_from_all.standard.spec.ts projections/for_ProjectionDefinitionCompiler/when_compiling_tags/with_standard_decorators.standard.spec.ts telemetry/for_ChronicleTelemetry/when_exposing_names/with_convention_names.spec.ts projections/for_ProjectionDefinitionCompiler/when_compiling_from_all_events.standard.spec.ts events/for_observerFilters/when_registering/with_standard_decorators.standard.spec.ts reactors/for_Reactors/against_a_kernel/when_filtering_source_and_stream_types.integration.spec.ts testing/for_observerScenarios/when_selecting_filters/with_source_and_stream_types.spec.ts readModels/for_ReadModelWatcher/watchCompatibility.standard.spec.ts for_EventStore/when_implementing_a_legacy_event_store.spec.ts",
176
+ "test:standard-types": "tsc --ignoreConfig --noEmit --target es2022 --module es2022 --moduleResolution bundler --lib es2022,esnext.decorators --types node --skipLibCheck --strict schemas/decorators.standard.spec.ts projections/declarative/addChildCompatibility.standard.spec.ts projections/declarative/for_CompositeKeyBuilder/when_typing_constant_parts.standard.spec.ts projections/modelBound/decorators.standard.spec.ts projections/for_Graphs/when_declaring_with_standard_decorators.standard.spec.ts events/classDecorators.standard.spec.ts reactors/decorators.standard.spec.ts readModels/standardFallbacks.standard.spec.ts readModels/registration.standard.spec.ts for_ChronicleClient/when_registering_artifacts/with_standard_property_mappings.standard.spec.ts artifacts/validateArtifactSchemas.spec.ts testing/for_EventScenario/when_appending_concept_fields/with_standard_decorators.standard.spec.ts testing/for_EventScenario/when_appending_scoped_constraints/with_standard_decorators.standard.spec.ts testing/for_EventScenario/when_appending_event_sequence_constraints/with_standard_decorators.standard.spec.ts testing/for_EventScenario/when_appending_event_sequence_constraints/other_sequence_extended_key.standard.spec.ts events/constraints/for_Constraints/when_scoping_to_event_sequences/with_standard_decorators.standard.spec.ts schemas/for_JsonSchemaGenerator/when_generating_children/with_standard_decorators.standard.spec.ts events/for_handles/when_decorating_a_method.standard.spec.ts testing/for_ReadModelScenario/when_evaluating_arithmetic/with_standard_decorators.standard.spec.ts testing/for_ReadModelScenario/when_evaluating_joins/with_standard_decorators.standard.spec.ts testing/for_EventScenario/when_appending_field_types/with_standard_decorators.standard.spec.ts eventSequences/for_EventSequence/when_appending/with_subject_annotations.standard.spec.ts projections/for_ProjectionDefinitionCompiler/when_compiling_from_all.standard.spec.ts projections/for_ProjectionDefinitionCompiler/when_compiling_tags/with_standard_decorators.standard.spec.ts telemetry/for_ChronicleTelemetry/when_exposing_names/with_convention_names.spec.ts projections/for_ProjectionDefinitionCompiler/when_compiling_from_all_events.standard.spec.ts events/for_observerFilters/when_registering/with_standard_decorators.standard.spec.ts reactors/for_Reactors/against_a_kernel/when_filtering_source_and_stream_types.integration.spec.ts testing/for_observerScenarios/when_selecting_filters/with_source_and_stream_types.spec.ts readModels/for_ReadModelWatcher/watchCompatibility.standard.spec.ts for_EventStore/when_implementing_a_legacy_event_store.spec.ts",
177
177
  "test:native": "node ./scripts/check-native-esm.mjs"
178
178
  },
179
179
  "dependencies": {
180
180
  "@bufbuild/protobuf": "^2.16.0",
181
- "@cratis/chronicle.contracts": "19.125.2",
181
+ "@cratis/chronicle.contracts": "19.129.0",
182
182
  "@grpc/grpc-js": "^1.14.5",
183
183
  "@opentelemetry/api": "^1.9.1",
184
184
  "glob": "^13.0.6",
@@ -2,7 +2,7 @@
2
2
  // Licensed under the MIT license. See LICENSE file in the project root for full license information.
3
3
 
4
4
  import { createLogger } from '../logging/createLogger.js';
5
- import { ProjectionOwner, type ProjectionDefinition } from '@cratis/chronicle.contracts';
5
+ import type { ProjectionDefinition } from '@cratis/chronicle.contracts';
6
6
  import { Constructor, Guid } from '@cratis/fundamentals';
7
7
  import { IClientArtifactsProvider } from '../artifacts/index.js';
8
8
  import { ChronicleConnection } from '../connection/index.js';
@@ -24,6 +24,7 @@ import { ProjectionId } from './ProjectionId.js';
24
24
  import { ProjectionQueryResult } from './ProjectionQueryResult.js';
25
25
  import { ProjectionState } from './ProjectionState.js';
26
26
  import { ProjectionDefinitionCompiler } from './ProjectionDefinitionCompiler.js';
27
+ import { registerProjectionWithRetry } from './registerProjectionWithRetry.js';
27
28
  import type { ResolvedModelBoundMetadata } from './ResolvedModelBoundMetadata.js';
28
29
  import { UnableToQueryProjection } from './UnableToQueryProjection.js';
29
30
 
@@ -275,34 +276,8 @@ export class Projections implements IProjections {
275
276
  return EventSequenceId.eventLog.value;
276
277
  }
277
278
 
278
- private async registerWithRetry(projection: ProjectionDefinition, identifier: string, maxAttempts = 5): Promise<void> {
279
- let delay = 2000;
280
- for (let attempt = 1; attempt <= maxAttempts; attempt++) {
281
- try {
282
- this._logger.info('Registering projection', { identifier, readModel: projection.ReadModel, attempt });
283
- await this._connection.projections.register({
284
- EventStore: this._eventStore,
285
- Owner: ProjectionOwner.PROJECTION_OWNER_Client,
286
- Projections: [projection]
287
- });
288
- this._logger.info('Projection registered successfully', { identifier });
289
- return;
290
- } catch (error) {
291
- const msg = String(error);
292
- const isTransient = msg.includes('UNKNOWN') || msg.includes('UNAVAILABLE') || msg.includes('INTERNAL');
293
- if (!isTransient || attempt === maxAttempts) {
294
- throw new Error(`Failed to register projection '${identifier}' after ${attempt} attempt(s): ${msg}`);
295
- }
296
- this._logger.warn('Projection registration failed with transient error, retrying', {
297
- identifier,
298
- attempt,
299
- nextAttemptInMs: delay,
300
- error
301
- });
302
- await new Promise(resolve => setTimeout(resolve, delay));
303
- delay = Math.min(delay * 2, 15000);
304
- }
305
- }
279
+ private registerWithRetry(projection: ProjectionDefinition, identifier: string): Promise<void> {
280
+ return registerProjectionWithRetry(this._connection, this._eventStore, this._logger, projection, identifier);
306
281
  }
307
282
 
308
283
  private resolveModelBoundMetadata(type: Constructor): ResolvedModelBoundMetadata | undefined {
@@ -0,0 +1,21 @@
1
+ // Copyright (c) Cratis. All rights reserved.
2
+ // Licensed under the MIT license. See LICENSE file in the project root for full license information.
3
+
4
+ import type { Constructor } from '@cratis/fundamentals';
5
+ import { Graphs } from '../../graphs/Graphs.js';
6
+ import { aFakeConnection } from './a_fake_connection.js';
7
+ import { artifactsWith } from './organization.js';
8
+
9
+ /**
10
+ * Discovers the graphs of the given nodes, edges and fluent graph projections.
11
+ * @param graphElements - The nodes and edges.
12
+ * @param graphProjections - The fluent graph projections.
13
+ * @param sinkTypeId - The sink type of the graphs.
14
+ * @returns The graphs, once discovered, and what is needed to look at what they registered.
15
+ */
16
+ export async function discoverGraphs(graphElements: Constructor[], graphProjections: Constructor[] = [], sinkTypeId = 'Neo4j') {
17
+ const fake = aFakeConnection();
18
+ const graphs = new Graphs('the-store', fake.connection, artifactsWith(graphElements, graphProjections), sinkTypeId);
19
+ await graphs.discover();
20
+ return { graphs, ...fake };
21
+ }
@@ -0,0 +1,19 @@
1
+ // Copyright (c) Cratis. All rights reserved.
2
+ // Licensed under the MIT license. See LICENSE file in the project root for full license information.
3
+
4
+ import type { ChronicleConnection } from '../../../connection/index.js';
5
+
6
+ /**
7
+ * Creates a connection that records what is registered.
8
+ * @returns The connection and what was registered with it.
9
+ */
10
+ export function aFakeConnection() {
11
+ const readModelRequests: Array<{ EventStore: string; Owner: number; ReadModels: Array<{ Type: { Identifier: string } }>; Source: number }> = [];
12
+ const projectionRequests: Array<{ EventStore: string; Owner: number; Projections: any[] }> = [];
13
+ const connection = {
14
+ logger: undefined,
15
+ readModels: { registerMany: async (request: (typeof readModelRequests)[number]) => { readModelRequests.push(request); return {}; } },
16
+ projections: { register: async (request: (typeof projectionRequests)[number]) => { projectionRequests.push(request); return {}; } }
17
+ } as unknown as ChronicleConnection;
18
+ return { connection, readModelRequests, projectionRequests };
19
+ }
@@ -0,0 +1,96 @@
1
+ // Copyright (c) Cratis. All rights reserved.
2
+ // Licensed under the MIT license. See LICENSE file in the project root for full license information.
3
+
4
+ import 'reflect-metadata';
5
+ import { field } from '@cratis/fundamentals';
6
+ import type { IClientArtifactsProvider } from '../../../artifacts/IClientArtifactsProvider.js';
7
+ import { eventType } from '../../../events/eventTypeDecorator.js';
8
+ import { edge } from '../../graphs/edge.js';
9
+ import { edgeFrom } from '../../graphs/edgeFrom.js';
10
+ import { edgeRemovedWith } from '../../graphs/edgeRemovedWith.js';
11
+ import { edgeSource } from '../../graphs/edgeSource.js';
12
+ import { edgeTarget } from '../../graphs/edgeTarget.js';
13
+ import { graph } from '../../graphs/graph.js';
14
+ import { graphKey } from '../../graphs/graphKey.js';
15
+ import { node } from '../../graphs/node.js';
16
+ import { nodeFrom } from '../../graphs/nodeFrom.js';
17
+ import { nodeRemovedWith } from '../../graphs/nodeRemovedWith.js';
18
+ import { setFromContext } from '../../modelBound/setFromContext.js';
19
+ import type { Constructor } from '@cratis/fundamentals';
20
+
21
+ // Decorators are applied as plain function calls so the fixtures do not depend on decorator-syntax support.
22
+
23
+ export class PersonRegistered {
24
+ personId = '';
25
+ name = '';
26
+ }
27
+ eventType()(PersonRegistered);
28
+
29
+ export class PersonRemoved {
30
+ personId = '';
31
+ }
32
+ eventType()(PersonRemoved);
33
+
34
+ export class GroupCreated {
35
+ groupId = '';
36
+ name = '';
37
+ }
38
+ eventType()(GroupCreated);
39
+
40
+ export class MemberAdded {
41
+ personId = '';
42
+ groupId = '';
43
+ }
44
+ eventType()(MemberAdded);
45
+
46
+ export class MemberRemoved {
47
+ personId = '';
48
+ groupId = '';
49
+ }
50
+ eventType()(MemberRemoved);
51
+
52
+ export class Person {
53
+ personId = '';
54
+ name = '';
55
+ }
56
+ graph('Organization')(Person);
57
+ node()(Person);
58
+ graphKey()(Person.prototype, 'personId');
59
+ nodeFrom(PersonRegistered, { key: 'personId' })(Person);
60
+ nodeRemovedWith(PersonRemoved, { key: 'personId', detach: true })(Person);
61
+
62
+ export class Group {
63
+ groupId = '';
64
+ name = '';
65
+ }
66
+ graph('Organization')(Group);
67
+ node()(Group);
68
+ graphKey()(Group.prototype, 'groupId');
69
+ nodeFrom(GroupCreated, { key: 'groupId' })(Group);
70
+
71
+ export class MemberOf {
72
+ personId = '';
73
+ groupId = '';
74
+ since = new Date();
75
+ }
76
+ field(Date)(MemberOf.prototype, 'since');
77
+ graph('Organization')(MemberOf);
78
+ edge('MEMBER_OF')(MemberOf);
79
+ edgeSource(Person)(MemberOf.prototype, 'personId');
80
+ edgeTarget(Group)(MemberOf.prototype, 'groupId');
81
+ setFromContext(MemberAdded, 'occurred')(MemberOf.prototype, 'since');
82
+ edgeFrom(MemberAdded, { sourceKey: 'personId', targetKey: 'groupId' })(MemberOf);
83
+ edgeRemovedWith(MemberRemoved, { sourceKey: 'personId', targetKey: 'groupId' })(MemberOf);
84
+
85
+ /**
86
+ * Creates a provider that finds only the given graph artifacts.
87
+ * @param graphElements - The nodes and edges.
88
+ * @param graphProjections - The fluent graph projections.
89
+ * @returns The provider.
90
+ */
91
+ export function artifactsWith(graphElements: Constructor[], graphProjections: Constructor[] = []): IClientArtifactsProvider {
92
+ return {
93
+ eventTypes: [], readModels: [], reactors: [], reducers: [], seeders: [], constraints: [], projections: [],
94
+ webhooks: [], eventTypeMigrations: [], globalForHandlers: [], graphElements, graphProjections
95
+ };
96
+ }
@@ -0,0 +1,112 @@
1
+ // Copyright (c) Cratis. All rights reserved.
2
+ // Licensed under the MIT license. See LICENSE file in the project root for full license information.
3
+
4
+ import 'reflect-metadata';
5
+ import { beforeAll, chai, describe, it } from 'vitest';
6
+ import { graph } from '../graphs/graph.js';
7
+ import { graphProjection } from '../graphs/graphProjection.js';
8
+ import type { IGraphProjection } from '../graphs/IGraphProjection.js';
9
+ import type { IGraphProjectionBuilder } from '../graphs/IGraphProjectionBuilder.js';
10
+ import { discoverGraphs } from './given/a_discovered_graph.js';
11
+ import {
12
+ Group, GroupCreated, MemberAdded, MemberOf, MemberRemoved, Person, PersonRegistered, PersonRemoved
13
+ } from './given/organization.js';
14
+
15
+ chai.should();
16
+
17
+ // The nodes and edges of the fluent graph are the plain types; the fluent builder says what the decorators say elsewhere.
18
+ class PlainPerson { personId = ''; name = ''; }
19
+ class PlainGroup { groupId = ''; name = ''; }
20
+ class PlainMemberOf { times = 0; }
21
+
22
+ class OrganizationGraph implements IGraphProjection {
23
+ define(builder: IGraphProjectionBuilder): void {
24
+ builder
25
+ .node(Person, node => node
26
+ .from(PersonRegistered, from => from.usingKey(event => event.personId))
27
+ .removedWith(PersonRemoved, removed => removed.usingKey(event => event.personId).detach()))
28
+ .node(Group, node => node
29
+ .from(GroupCreated, from => from.usingKey(event => event.groupId)))
30
+ .edge(MemberOf, Person, Group, edge => edge
31
+ .from(MemberAdded, from => from
32
+ .usingSourceKey(event => event.personId)
33
+ .usingTargetKey(event => event.groupId)
34
+ .set(member => member.since).toEventContextProperty('occurred'))
35
+ .removedWith(MemberRemoved, removed => removed
36
+ .usingSourceKey(event => event.personId)
37
+ .usingTargetKey(event => event.groupId)));
38
+ }
39
+ }
40
+ graphProjection('Organization')(OrganizationGraph);
41
+
42
+ describe('when building the same graph with the fluent builder as with the decorators', () => {
43
+ let fluent: Awaited<ReturnType<typeof discoverGraphs>>;
44
+ let decorated: Awaited<ReturnType<typeof discoverGraphs>>;
45
+
46
+ beforeAll(async () => {
47
+ fluent = await discoverGraphs([], [OrganizationGraph]);
48
+ decorated = await discoverGraphs([Person, Group, MemberOf]);
49
+ });
50
+
51
+ it('should not fail', () => fluent.graphs.failures.size.should.equal(0));
52
+ it('should describe the graph with the same schema', () => {
53
+ fluent.graphs.registrations[0].readModel.Schema.should.equal(decorated.graphs.registrations[0].readModel.Schema);
54
+ });
55
+ it('should map the graph from the same events', () => {
56
+ fluent.graphs.registrations[0].projection.Graph!.should.deep.equal(decorated.graphs.registrations[0].projection.Graph!);
57
+ });
58
+ it('should be the projection that fills the read model of the graph', () => {
59
+ fluent.graphs.registrations[0].projection.ReadModel.should.equal('Organization');
60
+ fluent.graphs.registrations[0].projection.Identifier.should.equal('OrganizationGraph');
61
+ });
62
+ });
63
+
64
+ describe('when declaring a fluent graph without a name', () => {
65
+ it('should name the graph after the class', async () => {
66
+ class Anonymous implements IGraphProjection {
67
+ define(builder: IGraphProjectionBuilder): void {
68
+ builder.node(PlainPerson, node => node.identifiedBy(person => person.personId).from(PersonRegistered));
69
+ }
70
+ }
71
+ graphProjection()(Anonymous);
72
+ const result = await discoverGraphs([], [Anonymous]);
73
+ result.graphs.registrations[0].graphName.should.equal('Anonymous');
74
+ });
75
+ });
76
+
77
+ describe('when declaring a fluent graph without decorators on its nodes and edges', () => {
78
+ let projection: Awaited<ReturnType<typeof discoverGraphs>>['graphs']['registrations'][0]['projection'];
79
+
80
+ beforeAll(async () => {
81
+ class PlainGraph implements IGraphProjection {
82
+ define(builder: IGraphProjectionBuilder): void {
83
+ builder
84
+ .node(PlainPerson, node => node.identifiedBy(person => person.personId).from(PersonRegistered))
85
+ .node(PlainGroup, node => node.identifiedBy(group => group.groupId).from(GroupCreated))
86
+ .edge(PlainMemberOf, PlainPerson, PlainGroup, edge => edge
87
+ .named('MEMBER_OF')
88
+ .from(MemberAdded, from => from
89
+ .usingSourceKey(event => event.personId)
90
+ .usingTargetKey(event => event.groupId)
91
+ .increment(member => member.times)));
92
+ }
93
+ }
94
+ graph('Plain')(PlainGraph);
95
+ graphProjection('Plain')(PlainGraph);
96
+ const result = await discoverGraphs([], [PlainGraph]);
97
+ projection = result.graphs.registrations[0].projection;
98
+ });
99
+
100
+ it('should label the nodes with the name of the class and take the key from identifiedBy', () => {
101
+ Object.keys(projection.Graph!.Nodes).should.deep.equal(['PlainPerson', 'PlainGroup']);
102
+ projection.Graph!.Nodes.PlainPerson.From['PersonRegistered+1'].Key.should.equal('$eventSourceId');
103
+ });
104
+ it('should name the edge', () => {
105
+ Object.keys(projection.Graph!.Edges).should.deep.equal(['MEMBER_OF']);
106
+ });
107
+ it('should take the end node keys from the event and map the properties of the edge', () => {
108
+ projection.Graph!.Edges.MEMBER_OF.From['MemberAdded+1'].should.deep.equal({
109
+ SourceKey: 'personId', TargetKey: 'groupId', Identity: '', Properties: { times: '$increment' }
110
+ });
111
+ });
112
+ });
@@ -0,0 +1,91 @@
1
+ // Copyright (c) Cratis. All rights reserved.
2
+ // Licensed under the MIT license. See LICENSE file in the project root for full license information.
3
+
4
+ import 'reflect-metadata';
5
+ import { beforeAll, chai, describe, it } from 'vitest';
6
+ import { ReadModelObserverType } from '@cratis/chronicle.contracts';
7
+ import { discoverGraphs } from './given/a_discovered_graph.js';
8
+ import { Group, MemberOf, Person } from './given/organization.js';
9
+
10
+ chai.should();
11
+
12
+ describe('when building a graph from decorated nodes and edges', () => {
13
+ let result: Awaited<ReturnType<typeof discoverGraphs>>;
14
+ let schema: Record<string, any>;
15
+
16
+ beforeAll(async () => {
17
+ result = await discoverGraphs([Person, Group, MemberOf]);
18
+ schema = JSON.parse(result.graphs.registrations[0].readModel.Schema);
19
+ });
20
+
21
+ it('should not fail', () => result.graphs.failures.size.should.equal(0));
22
+ it('should register one graph named by the decorators', () => {
23
+ result.graphs.registrations.map(_ => _.graphName).should.deep.equal(['Organization']);
24
+ });
25
+ it('should store the graph in the graph sink as a read model of the projection', () => {
26
+ const readModel = result.graphs.registrations[0].readModel;
27
+ readModel.Type.Identifier.should.equal('Organization');
28
+ readModel.Sink.TypeId.should.equal('Neo4j');
29
+ readModel.ObserverType.should.equal(ReadModelObserverType.Projection);
30
+ readModel.ObserverIdentifier.should.equal('Organization');
31
+ });
32
+ it('should mark the schema root as a graph', () => {
33
+ schema['x-graph'].should.be.true;
34
+ schema.title.should.equal('Organization');
35
+ });
36
+ it('should annotate a node with its kind and key and describe its properties', () => {
37
+ schema.properties.Person.should.deep.equal({
38
+ type: 'object',
39
+ properties: { personId: { type: 'string' }, name: { type: 'string' } },
40
+ 'x-graph-kind': 'Node',
41
+ 'x-graph-key': 'personId'
42
+ });
43
+ });
44
+ it('should annotate an edge with its kind, end nodes and leave the keys of the end nodes out of its properties', () => {
45
+ schema.properties.MEMBER_OF.should.deep.equal({
46
+ type: 'object',
47
+ properties: { since: { type: 'string', format: 'date-time' } },
48
+ 'x-graph-kind': 'Edge',
49
+ 'x-graph-source': 'Person',
50
+ 'x-graph-target': 'Group'
51
+ });
52
+ });
53
+ it('should project the graph from the event log, rewindable, with an empty read model state', () => {
54
+ const projection = result.graphs.registrations[0].projection;
55
+ projection.EventSequenceId.should.equal('event-log');
56
+ projection.Identifier.should.equal('Organization');
57
+ projection.ReadModel.should.equal('Organization');
58
+ projection.IsActive.should.be.true;
59
+ projection.IsRewindable.should.be.true;
60
+ projection.InitialModelState.should.equal('{}');
61
+ });
62
+ it('should map a node from an event keyed by the event type id and generation', () => {
63
+ result.graphs.registrations[0].projection.Graph!.Nodes.Person.should.deep.equal({
64
+ From: { 'PersonRegistered+1': { Key: 'personId', Properties: { name: 'name' }, UpdateOnly: false } },
65
+ RemovedWith: { 'PersonRemoved+1': { Key: 'personId', Detach: true } }
66
+ });
67
+ });
68
+ it('should map the properties of a node by name and leave out the key', () => {
69
+ result.graphs.registrations[0].projection.Graph!.Nodes.Group.From['GroupCreated+1'].Properties.should.deep.equal({ name: 'name' });
70
+ });
71
+ it('should map an edge from the events that create and remove it', () => {
72
+ result.graphs.registrations[0].projection.Graph!.Edges.MEMBER_OF.should.deep.equal({
73
+ From: {
74
+ 'MemberAdded+1': {
75
+ SourceKey: 'personId',
76
+ TargetKey: 'groupId',
77
+ Identity: '',
78
+ Properties: { since: '$eventContext(Occurred)' }
79
+ }
80
+ },
81
+ RemovedWith: { 'MemberRemoved+1': { SourceKey: 'personId', TargetKey: 'groupId', Identity: '' } }
82
+ });
83
+ });
84
+ });
85
+
86
+ describe('when building a graph for a sink type', () => {
87
+ it('should use the sink type', async () => {
88
+ const result = await discoverGraphs([Person, Group, MemberOf], [], 'InMemoryGraph');
89
+ result.graphs.registrations[0].readModel.Sink.TypeId.should.equal('InMemoryGraph');
90
+ });
91
+ });
@@ -0,0 +1,137 @@
1
+ // Copyright (c) Cratis. All rights reserved.
2
+ // Licensed under the MIT license. See LICENSE file in the project root for full license information.
3
+
4
+ import 'reflect-metadata';
5
+ import { beforeAll, chai, describe, it } from 'vitest';
6
+ import { eventType } from '../../events/eventTypeDecorator.js';
7
+ import { count } from '../modelBound/count.js';
8
+ import { edge } from '../graphs/edge.js';
9
+ import { edgeFrom } from '../graphs/edgeFrom.js';
10
+ import { edgeRemovedWith } from '../graphs/edgeRemovedWith.js';
11
+ import { edgeSource } from '../graphs/edgeSource.js';
12
+ import { edgeTarget } from '../graphs/edgeTarget.js';
13
+ import { graph } from '../graphs/graph.js';
14
+ import { graphKey } from '../graphs/graphKey.js';
15
+ import { graphProjection } from '../graphs/graphProjection.js';
16
+ import type { IGraphProjection } from '../graphs/IGraphProjection.js';
17
+ import type { IGraphProjectionBuilder } from '../graphs/IGraphProjectionBuilder.js';
18
+ import { node } from '../graphs/node.js';
19
+ import { nodeFrom } from '../graphs/nodeFrom.js';
20
+ import { UnknownGraphEventProperty } from '../graphs/UnknownGraphEventProperty.js';
21
+ import { discoverGraphs } from './given/a_discovered_graph.js';
22
+
23
+ chai.should();
24
+
25
+ class PlaceVisited { personId = ''; placeId = ''; visitId = ''; }
26
+ eventType()(PlaceVisited);
27
+ class VisitCancelled { personId = ''; placeId = ''; visitId = ''; }
28
+ eventType()(VisitCancelled);
29
+ class NoteWritten { personId = ''; placeId = ''; }
30
+ eventType()(NoteWritten);
31
+
32
+ class Visitor { personId = ''; }
33
+ graph('Places')(Visitor);
34
+ node()(Visitor);
35
+ graphKey()(Visitor.prototype, 'personId');
36
+ nodeFrom(PlaceVisited, { key: 'personId' })(Visitor);
37
+
38
+ class Place { placeId = ''; }
39
+ graph('Places')(Place);
40
+ node()(Place);
41
+ graphKey()(Place.prototype, 'placeId');
42
+ nodeFrom(PlaceVisited, { key: 'placeId' })(Place);
43
+
44
+ class Visited {
45
+ personId = '';
46
+ placeId = '';
47
+ visitId = '';
48
+ times = 0;
49
+ }
50
+ graph('Places')(Visited);
51
+ edge('VISITED')(Visited);
52
+ edgeSource(Visitor)(Visited.prototype, 'personId');
53
+ edgeTarget(Place)(Visited.prototype, 'placeId');
54
+ graphKey()(Visited.prototype, 'visitId');
55
+ count(PlaceVisited)(Visited.prototype, 'times');
56
+ edgeFrom(PlaceVisited, { sourceKey: 'personId', targetKey: 'placeId', identity: 'visitId' })(Visited);
57
+ edgeRemovedWith(VisitCancelled, { sourceKey: 'personId', targetKey: 'placeId' })(Visited);
58
+
59
+ describe('when declaring an edge with an identifying key', () => {
60
+ let result: Awaited<ReturnType<typeof discoverGraphs>>;
61
+
62
+ beforeAll(async () => {
63
+ result = await discoverGraphs([Visitor, Place, Visited]);
64
+ });
65
+
66
+ it('should annotate the edge with the identifying property', () => {
67
+ JSON.parse(result.graphs.registrations[0].readModel.Schema).properties.VISITED['x-graph-identity'].should.equal('visitId');
68
+ });
69
+ it('should keep the identifying property out of the properties the events map', () => {
70
+ result.graphs.registrations[0].projection.Graph!.Edges.VISITED.From['PlaceVisited+1'].Properties.should.deep.equal({ times: '$count' });
71
+ });
72
+ it('should take the identity from the event property it names', () => {
73
+ result.graphs.registrations[0].projection.Graph!.Edges.VISITED.From['PlaceVisited+1'].Identity.should.equal('visitId');
74
+ });
75
+ it('should take the identity of a removal from the event property of the same name when none is named', () => {
76
+ result.graphs.registrations[0].projection.Graph!.Edges.VISITED.RemovedWith['VisitCancelled+1'].Identity.should.equal('visitId');
77
+ });
78
+ });
79
+
80
+ describe('when an event of an identified edge has no property for the identity', () => {
81
+ it('should fail the graph and name the property', async () => {
82
+ class NoteAuthor { personId = ''; }
83
+ graph('Notes')(NoteAuthor);
84
+ node()(NoteAuthor);
85
+ graphKey()(NoteAuthor.prototype, 'personId');
86
+ class NotePlace { placeId = ''; }
87
+ graph('Notes')(NotePlace);
88
+ node()(NotePlace);
89
+ graphKey()(NotePlace.prototype, 'placeId');
90
+ class Noted { personId = ''; placeId = ''; noteId = ''; }
91
+ graph('Notes')(Noted);
92
+ edge('NOTED')(Noted);
93
+ edgeSource(NoteAuthor)(Noted.prototype, 'personId');
94
+ edgeTarget(NotePlace)(Noted.prototype, 'placeId');
95
+ graphKey()(Noted.prototype, 'noteId');
96
+ edgeFrom(NoteWritten, { sourceKey: 'personId', targetKey: 'placeId' })(Noted);
97
+
98
+ const result = await discoverGraphs([NoteAuthor, NotePlace, Noted]);
99
+
100
+ result.graphs.registrations.length.should.equal(0);
101
+ [...result.graphs.failures.values()][0].should.be.instanceOf(UnknownGraphEventProperty).and.have.property('message').that.includes('noteId');
102
+ });
103
+ });
104
+
105
+ describe('when identifying an edge with the fluent builder', () => {
106
+ it('should identify it by the property and read the identity from the event property of the same name', async () => {
107
+ class VisitsGraph implements IGraphProjection {
108
+ define(builder: IGraphProjectionBuilder): void {
109
+ builder
110
+ .node(Visitor, node => node.from(PlaceVisited, from => from.usingKey(event => event.personId)))
111
+ .node(Place, node => node.from(PlaceVisited, from => from.usingKey(event => event.placeId)))
112
+ .edge(Visited, Visitor, Place, edge => edge
113
+ .identifiedBy(visited => visited.visitId)
114
+ .from(PlaceVisited, from => from.usingSourceKey(event => event.personId).usingTargetKey(event => event.placeId)));
115
+ }
116
+ }
117
+ graphProjection('Visits')(VisitsGraph);
118
+ const result = await discoverGraphs([], [VisitsGraph]);
119
+ result.graphs.failures.size.should.equal(0);
120
+ result.graphs.registrations[0].projection.Graph!.Edges.VISITED.From['PlaceVisited+1'].Identity.should.equal('visitId');
121
+ });
122
+
123
+ it('should fail when the event has no property to identify the edge with', async () => {
124
+ class NotesGraph implements IGraphProjection {
125
+ define(builder: IGraphProjectionBuilder): void {
126
+ builder
127
+ .node(Visitor, node => node.from(NoteWritten, from => from.usingKey(event => event.personId)))
128
+ .node(Place, node => node.from(NoteWritten, from => from.usingKey(event => event.placeId)))
129
+ .edge(Visited, Visitor, Place, edge => edge
130
+ .from(NoteWritten, from => from.usingSourceKey(event => event.personId).usingTargetKey(event => event.placeId)));
131
+ }
132
+ }
133
+ graphProjection('Notes')(NotesGraph);
134
+ const result = await discoverGraphs([], [NotesGraph]);
135
+ result.graphs.failures.get(NotesGraph)!.should.be.instanceOf(UnknownGraphEventProperty);
136
+ });
137
+ });