@cratis/chronicle 6.58.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 (384) 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 +2 -2
  6. package/artifacts/DefaultClientArtifactsProvider.ts +13 -1
  7. package/artifacts/IClientArtifactsProvider.ts +6 -0
  8. package/connection/ChronicleConnection.ts +2 -2
  9. package/connection/ChronicleConnectionString.spec.ts +21 -0
  10. package/connection/ChronicleConnectionString.ts +16 -6
  11. package/connection/LeastConnectionsLoadBalancerStrategy.ts +1 -1
  12. package/connection/LoadBalancerStrategyFactory.ts +2 -2
  13. package/connection/TokenProvider.ts +2 -1
  14. package/connection/fetchOAuthAccessToken.ts +3 -3
  15. package/connection/for_ChronicleConnection/when_warning_about_tls_validation/tls_validation_warning.spec.ts +6 -1
  16. package/dist/ChronicleClient.js +1 -1
  17. package/dist/ChronicleClient.js.map +1 -1
  18. package/dist/ChronicleOptions.d.ts +7 -0
  19. package/dist/ChronicleOptions.d.ts.map +1 -1
  20. package/dist/ChronicleOptions.js +8 -0
  21. package/dist/ChronicleOptions.js.map +1 -1
  22. package/dist/EventStore.d.ts +3 -1
  23. package/dist/EventStore.d.ts.map +1 -1
  24. package/dist/EventStore.js +7 -1
  25. package/dist/EventStore.js.map +1 -1
  26. package/dist/IEventStore.d.ts +6 -0
  27. package/dist/IEventStore.d.ts.map +1 -1
  28. package/dist/artifacts/DefaultClientArtifactsProvider.d.ts +4 -0
  29. package/dist/artifacts/DefaultClientArtifactsProvider.d.ts.map +1 -1
  30. package/dist/artifacts/DefaultClientArtifactsProvider.js +11 -1
  31. package/dist/artifacts/DefaultClientArtifactsProvider.js.map +1 -1
  32. package/dist/artifacts/IClientArtifactsProvider.d.ts +4 -0
  33. package/dist/artifacts/IClientArtifactsProvider.d.ts.map +1 -1
  34. package/dist/connection/ChronicleConnection.js +2 -2
  35. package/dist/connection/ChronicleConnection.js.map +1 -1
  36. package/dist/connection/ChronicleConnectionString.d.ts +7 -2
  37. package/dist/connection/ChronicleConnectionString.d.ts.map +1 -1
  38. package/dist/connection/ChronicleConnectionString.js +14 -6
  39. package/dist/connection/ChronicleConnectionString.js.map +1 -1
  40. package/dist/connection/LeastConnectionsLoadBalancerStrategy.d.ts +1 -1
  41. package/dist/connection/LeastConnectionsLoadBalancerStrategy.js +1 -1
  42. package/dist/connection/LoadBalancerStrategyFactory.d.ts +2 -2
  43. package/dist/connection/LoadBalancerStrategyFactory.js +2 -2
  44. package/dist/connection/TokenProvider.d.ts +2 -1
  45. package/dist/connection/TokenProvider.d.ts.map +1 -1
  46. package/dist/connection/TokenProvider.js +2 -1
  47. package/dist/connection/TokenProvider.js.map +1 -1
  48. package/dist/connection/fetchOAuthAccessToken.d.ts +1 -1
  49. package/dist/connection/fetchOAuthAccessToken.js +3 -3
  50. package/dist/connection/fetchOAuthAccessToken.js.map +1 -1
  51. package/dist/projections/Projections.d.ts.map +1 -1
  52. package/dist/projections/Projections.js +3 -30
  53. package/dist/projections/Projections.js.map +1 -1
  54. package/dist/projections/for_Graphs/given/a_discovered_graph.d.ts +29 -0
  55. package/dist/projections/for_Graphs/given/a_discovered_graph.d.ts.map +1 -0
  56. package/dist/projections/for_Graphs/given/a_discovered_graph.js +19 -0
  57. package/dist/projections/for_Graphs/given/a_discovered_graph.js.map +1 -0
  58. package/dist/projections/for_Graphs/given/a_fake_connection.d.ts +24 -0
  59. package/dist/projections/for_Graphs/given/a_fake_connection.d.ts.map +1 -0
  60. package/dist/projections/for_Graphs/given/a_fake_connection.js +17 -0
  61. package/dist/projections/for_Graphs/given/a_fake_connection.js.map +1 -0
  62. package/dist/projections/for_Graphs/given/organization.d.ts +43 -0
  63. package/dist/projections/for_Graphs/given/organization.d.ts.map +1 -0
  64. package/dist/projections/for_Graphs/given/organization.js +84 -0
  65. package/dist/projections/for_Graphs/given/organization.js.map +1 -0
  66. package/dist/projections/graphs/EdgeCanHaveOnlyOneIdentifyingKey.d.ts +11 -0
  67. package/dist/projections/graphs/EdgeCanHaveOnlyOneIdentifyingKey.d.ts.map +1 -0
  68. package/dist/projections/graphs/EdgeCanHaveOnlyOneIdentifyingKey.js +16 -0
  69. package/dist/projections/graphs/EdgeCanHaveOnlyOneIdentifyingKey.js.map +1 -0
  70. package/dist/projections/graphs/EdgeMustHaveOneSourceAndOneTarget.d.ts +11 -0
  71. package/dist/projections/graphs/EdgeMustHaveOneSourceAndOneTarget.d.ts.map +1 -0
  72. package/dist/projections/graphs/EdgeMustHaveOneSourceAndOneTarget.js +16 -0
  73. package/dist/projections/graphs/EdgeMustHaveOneSourceAndOneTarget.js.map +1 -0
  74. package/dist/projections/graphs/GraphDeclaredMoreThanOnce.d.ts +11 -0
  75. package/dist/projections/graphs/GraphDeclaredMoreThanOnce.d.ts.map +1 -0
  76. package/dist/projections/graphs/GraphDeclaredMoreThanOnce.js +16 -0
  77. package/dist/projections/graphs/GraphDeclaredMoreThanOnce.js.map +1 -0
  78. package/dist/projections/graphs/GraphDefinitionBuilder.d.ts +24 -0
  79. package/dist/projections/graphs/GraphDefinitionBuilder.d.ts.map +1 -0
  80. package/dist/projections/graphs/GraphDefinitionBuilder.js +145 -0
  81. package/dist/projections/graphs/GraphDefinitionBuilder.js.map +1 -0
  82. package/dist/projections/graphs/GraphEdgeBuilder.d.ts +41 -0
  83. package/dist/projections/graphs/GraphEdgeBuilder.d.ts.map +1 -0
  84. package/dist/projections/graphs/GraphEdgeBuilder.js +94 -0
  85. package/dist/projections/graphs/GraphEdgeBuilder.js.map +1 -0
  86. package/dist/projections/graphs/GraphEdgeFromBuilder.d.ts +25 -0
  87. package/dist/projections/graphs/GraphEdgeFromBuilder.d.ts.map +1 -0
  88. package/dist/projections/graphs/GraphEdgeFromBuilder.js +37 -0
  89. package/dist/projections/graphs/GraphEdgeFromBuilder.js.map +1 -0
  90. package/dist/projections/graphs/GraphEdgeFromModel.d.ts +16 -0
  91. package/dist/projections/graphs/GraphEdgeFromModel.d.ts.map +1 -0
  92. package/dist/projections/graphs/GraphEdgeFromModel.js +4 -0
  93. package/dist/projections/graphs/GraphEdgeFromModel.js.map +1 -0
  94. package/dist/projections/graphs/GraphEdgeModel.d.ts +24 -0
  95. package/dist/projections/graphs/GraphEdgeModel.d.ts.map +1 -0
  96. package/dist/projections/graphs/GraphEdgeModel.js +4 -0
  97. package/dist/projections/graphs/GraphEdgeModel.js.map +1 -0
  98. package/dist/projections/graphs/GraphEdgeRemovedWithBuilder.d.ts +21 -0
  99. package/dist/projections/graphs/GraphEdgeRemovedWithBuilder.d.ts.map +1 -0
  100. package/dist/projections/graphs/GraphEdgeRemovedWithBuilder.js +31 -0
  101. package/dist/projections/graphs/GraphEdgeRemovedWithBuilder.js.map +1 -0
  102. package/dist/projections/graphs/GraphEdgeRemovedWithModel.d.ts +14 -0
  103. package/dist/projections/graphs/GraphEdgeRemovedWithModel.d.ts.map +1 -0
  104. package/dist/projections/graphs/GraphEdgeRemovedWithModel.js +4 -0
  105. package/dist/projections/graphs/GraphEdgeRemovedWithModel.js.map +1 -0
  106. package/dist/projections/graphs/GraphElementCannotBeReadModel.d.ts +11 -0
  107. package/dist/projections/graphs/GraphElementCannotBeReadModel.d.ts.map +1 -0
  108. package/dist/projections/graphs/GraphElementCannotBeReadModel.js +16 -0
  109. package/dist/projections/graphs/GraphElementCannotBeReadModel.js.map +1 -0
  110. package/dist/projections/graphs/GraphHasDuplicateElement.d.ts +13 -0
  111. package/dist/projections/graphs/GraphHasDuplicateElement.d.ts.map +1 -0
  112. package/dist/projections/graphs/GraphHasDuplicateElement.js +18 -0
  113. package/dist/projections/graphs/GraphHasDuplicateElement.js.map +1 -0
  114. package/dist/projections/graphs/GraphKeyPropertyNotFound.d.ts +12 -0
  115. package/dist/projections/graphs/GraphKeyPropertyNotFound.d.ts.map +1 -0
  116. package/dist/projections/graphs/GraphKeyPropertyNotFound.js +17 -0
  117. package/dist/projections/graphs/GraphKeyPropertyNotFound.js.map +1 -0
  118. package/dist/projections/graphs/GraphMappingBuilder.d.ts +32 -0
  119. package/dist/projections/graphs/GraphMappingBuilder.d.ts.map +1 -0
  120. package/dist/projections/graphs/GraphMappingBuilder.js +48 -0
  121. package/dist/projections/graphs/GraphMappingBuilder.js.map +1 -0
  122. package/dist/projections/graphs/GraphMemberMappings.d.ts +8 -0
  123. package/dist/projections/graphs/GraphMemberMappings.d.ts.map +1 -0
  124. package/dist/projections/graphs/GraphMemberMappings.js +54 -0
  125. package/dist/projections/graphs/GraphMemberMappings.js.map +1 -0
  126. package/dist/projections/graphs/GraphModel.d.ts +15 -0
  127. package/dist/projections/graphs/GraphModel.d.ts.map +1 -0
  128. package/dist/projections/graphs/GraphModel.js +4 -0
  129. package/dist/projections/graphs/GraphModel.js.map +1 -0
  130. package/dist/projections/graphs/GraphNameRequired.d.ts +11 -0
  131. package/dist/projections/graphs/GraphNameRequired.d.ts.map +1 -0
  132. package/dist/projections/graphs/GraphNameRequired.js +16 -0
  133. package/dist/projections/graphs/GraphNameRequired.js.map +1 -0
  134. package/dist/projections/graphs/GraphNodeBuilder.d.ts +34 -0
  135. package/dist/projections/graphs/GraphNodeBuilder.d.ts.map +1 -0
  136. package/dist/projections/graphs/GraphNodeBuilder.js +66 -0
  137. package/dist/projections/graphs/GraphNodeBuilder.js.map +1 -0
  138. package/dist/projections/graphs/GraphNodeFromBuilder.d.ts +21 -0
  139. package/dist/projections/graphs/GraphNodeFromBuilder.d.ts.map +1 -0
  140. package/dist/projections/graphs/GraphNodeFromBuilder.js +30 -0
  141. package/dist/projections/graphs/GraphNodeFromBuilder.js.map +1 -0
  142. package/dist/projections/graphs/GraphNodeFromModel.d.ts +14 -0
  143. package/dist/projections/graphs/GraphNodeFromModel.d.ts.map +1 -0
  144. package/dist/projections/graphs/GraphNodeFromModel.js +4 -0
  145. package/dist/projections/graphs/GraphNodeFromModel.js.map +1 -0
  146. package/dist/projections/graphs/GraphNodeModel.d.ts +18 -0
  147. package/dist/projections/graphs/GraphNodeModel.d.ts.map +1 -0
  148. package/dist/projections/graphs/GraphNodeModel.js +4 -0
  149. package/dist/projections/graphs/GraphNodeModel.js.map +1 -0
  150. package/dist/projections/graphs/GraphNodeRemovedWithBuilder.d.ts +17 -0
  151. package/dist/projections/graphs/GraphNodeRemovedWithBuilder.d.ts.map +1 -0
  152. package/dist/projections/graphs/GraphNodeRemovedWithBuilder.js +24 -0
  153. package/dist/projections/graphs/GraphNodeRemovedWithBuilder.js.map +1 -0
  154. package/dist/projections/graphs/GraphNodeRemovedWithModel.d.ts +12 -0
  155. package/dist/projections/graphs/GraphNodeRemovedWithModel.d.ts.map +1 -0
  156. package/dist/projections/graphs/GraphNodeRemovedWithModel.js +4 -0
  157. package/dist/projections/graphs/GraphNodeRemovedWithModel.js.map +1 -0
  158. package/dist/projections/graphs/GraphProjectionBuilder.d.ts +25 -0
  159. package/dist/projections/graphs/GraphProjectionBuilder.d.ts.map +1 -0
  160. package/dist/projections/graphs/GraphProjectionBuilder.js +36 -0
  161. package/dist/projections/graphs/GraphProjectionBuilder.js.map +1 -0
  162. package/dist/projections/graphs/GraphRegistration.d.ts +14 -0
  163. package/dist/projections/graphs/GraphRegistration.d.ts.map +1 -0
  164. package/dist/projections/graphs/GraphRegistration.js +4 -0
  165. package/dist/projections/graphs/GraphRegistration.js.map +1 -0
  166. package/dist/projections/graphs/GraphSchemaWriter.d.ts +28 -0
  167. package/dist/projections/graphs/GraphSchemaWriter.d.ts.map +1 -0
  168. package/dist/projections/graphs/GraphSchemaWriter.js +76 -0
  169. package/dist/projections/graphs/GraphSchemaWriter.js.map +1 -0
  170. package/dist/projections/graphs/Graphs.d.ts +39 -0
  171. package/dist/projections/graphs/Graphs.d.ts.map +1 -0
  172. package/dist/projections/graphs/Graphs.js +144 -0
  173. package/dist/projections/graphs/Graphs.js.map +1 -0
  174. package/dist/projections/graphs/IGraphEdgeBuilder.d.ts +37 -0
  175. package/dist/projections/graphs/IGraphEdgeBuilder.d.ts.map +1 -0
  176. package/dist/projections/graphs/IGraphEdgeBuilder.js +4 -0
  177. package/dist/projections/graphs/IGraphEdgeBuilder.js.map +1 -0
  178. package/dist/projections/graphs/IGraphEdgeFromBuilder.d.ts +29 -0
  179. package/dist/projections/graphs/IGraphEdgeFromBuilder.d.ts.map +1 -0
  180. package/dist/projections/graphs/IGraphEdgeFromBuilder.js +4 -0
  181. package/dist/projections/graphs/IGraphEdgeFromBuilder.js.map +1 -0
  182. package/dist/projections/graphs/IGraphEdgeRemovedWithBuilder.d.ts +27 -0
  183. package/dist/projections/graphs/IGraphEdgeRemovedWithBuilder.d.ts.map +1 -0
  184. package/dist/projections/graphs/IGraphEdgeRemovedWithBuilder.js +4 -0
  185. package/dist/projections/graphs/IGraphEdgeRemovedWithBuilder.js.map +1 -0
  186. package/dist/projections/graphs/IGraphMappingBuilder.d.ts +49 -0
  187. package/dist/projections/graphs/IGraphMappingBuilder.d.ts.map +1 -0
  188. package/dist/projections/graphs/IGraphMappingBuilder.js +4 -0
  189. package/dist/projections/graphs/IGraphMappingBuilder.js.map +1 -0
  190. package/dist/projections/graphs/IGraphNodeBuilder.d.ts +32 -0
  191. package/dist/projections/graphs/IGraphNodeBuilder.d.ts.map +1 -0
  192. package/dist/projections/graphs/IGraphNodeBuilder.js +4 -0
  193. package/dist/projections/graphs/IGraphNodeBuilder.js.map +1 -0
  194. package/dist/projections/graphs/IGraphNodeFromBuilder.d.ts +21 -0
  195. package/dist/projections/graphs/IGraphNodeFromBuilder.d.ts.map +1 -0
  196. package/dist/projections/graphs/IGraphNodeFromBuilder.js +4 -0
  197. package/dist/projections/graphs/IGraphNodeFromBuilder.js.map +1 -0
  198. package/dist/projections/graphs/IGraphNodeRemovedWithBuilder.d.ts +19 -0
  199. package/dist/projections/graphs/IGraphNodeRemovedWithBuilder.d.ts.map +1 -0
  200. package/dist/projections/graphs/IGraphNodeRemovedWithBuilder.js +4 -0
  201. package/dist/projections/graphs/IGraphNodeRemovedWithBuilder.js.map +1 -0
  202. package/dist/projections/graphs/IGraphProjection.d.ts +13 -0
  203. package/dist/projections/graphs/IGraphProjection.d.ts.map +1 -0
  204. package/dist/projections/graphs/IGraphProjection.js +4 -0
  205. package/dist/projections/graphs/IGraphProjection.js.map +1 -0
  206. package/dist/projections/graphs/IGraphProjectionBuilder.d.ts +26 -0
  207. package/dist/projections/graphs/IGraphProjectionBuilder.d.ts.map +1 -0
  208. package/dist/projections/graphs/IGraphProjectionBuilder.js +4 -0
  209. package/dist/projections/graphs/IGraphProjectionBuilder.js.map +1 -0
  210. package/dist/projections/graphs/IGraphs.d.ts +27 -0
  211. package/dist/projections/graphs/IGraphs.d.ts.map +1 -0
  212. package/dist/projections/graphs/IGraphs.js +4 -0
  213. package/dist/projections/graphs/IGraphs.js.map +1 -0
  214. package/dist/projections/graphs/ModelBoundGraphReader.d.ts +30 -0
  215. package/dist/projections/graphs/ModelBoundGraphReader.d.ts.map +1 -0
  216. package/dist/projections/graphs/ModelBoundGraphReader.js +112 -0
  217. package/dist/projections/graphs/ModelBoundGraphReader.js.map +1 -0
  218. package/dist/projections/graphs/NestedObjectInGraph.d.ts +12 -0
  219. package/dist/projections/graphs/NestedObjectInGraph.d.ts.map +1 -0
  220. package/dist/projections/graphs/NestedObjectInGraph.js +17 -0
  221. package/dist/projections/graphs/NestedObjectInGraph.js.map +1 -0
  222. package/dist/projections/graphs/NodeMustHaveExactlyOneKey.d.ts +12 -0
  223. package/dist/projections/graphs/NodeMustHaveExactlyOneKey.d.ts.map +1 -0
  224. package/dist/projections/graphs/NodeMustHaveExactlyOneKey.js +17 -0
  225. package/dist/projections/graphs/NodeMustHaveExactlyOneKey.js.map +1 -0
  226. package/dist/projections/graphs/UnknownGraphEventProperty.d.ts +13 -0
  227. package/dist/projections/graphs/UnknownGraphEventProperty.d.ts.map +1 -0
  228. package/dist/projections/graphs/UnknownGraphEventProperty.js +18 -0
  229. package/dist/projections/graphs/UnknownGraphEventProperty.js.map +1 -0
  230. package/dist/projections/graphs/UnknownGraphNode.d.ts +12 -0
  231. package/dist/projections/graphs/UnknownGraphNode.d.ts.map +1 -0
  232. package/dist/projections/graphs/UnknownGraphNode.js +17 -0
  233. package/dist/projections/graphs/UnknownGraphNode.js.map +1 -0
  234. package/dist/projections/graphs/edge.d.ts +23 -0
  235. package/dist/projections/graphs/edge.d.ts.map +1 -0
  236. package/dist/projections/graphs/edge.js +29 -0
  237. package/dist/projections/graphs/edge.js.map +1 -0
  238. package/dist/projections/graphs/edgeFrom.d.ts +31 -0
  239. package/dist/projections/graphs/edgeFrom.d.ts.map +1 -0
  240. package/dist/projections/graphs/edgeFrom.js +26 -0
  241. package/dist/projections/graphs/edgeFrom.js.map +1 -0
  242. package/dist/projections/graphs/edgeRemovedWith.d.ts +22 -0
  243. package/dist/projections/graphs/edgeRemovedWith.d.ts.map +1 -0
  244. package/dist/projections/graphs/edgeRemovedWith.js +25 -0
  245. package/dist/projections/graphs/edgeRemovedWith.js.map +1 -0
  246. package/dist/projections/graphs/edgeSource.d.ts +22 -0
  247. package/dist/projections/graphs/edgeSource.d.ts.map +1 -0
  248. package/dist/projections/graphs/edgeSource.js +30 -0
  249. package/dist/projections/graphs/edgeSource.js.map +1 -0
  250. package/dist/projections/graphs/edgeTarget.d.ts +22 -0
  251. package/dist/projections/graphs/edgeTarget.d.ts.map +1 -0
  252. package/dist/projections/graphs/edgeTarget.js +30 -0
  253. package/dist/projections/graphs/edgeTarget.js.map +1 -0
  254. package/dist/projections/graphs/graph.d.ts +16 -0
  255. package/dist/projections/graphs/graph.d.ts.map +1 -0
  256. package/dist/projections/graphs/graph.js +24 -0
  257. package/dist/projections/graphs/graph.js.map +1 -0
  258. package/dist/projections/graphs/graphKey.d.ts +16 -0
  259. package/dist/projections/graphs/graphKey.d.ts.map +1 -0
  260. package/dist/projections/graphs/graphKey.js +28 -0
  261. package/dist/projections/graphs/graphKey.js.map +1 -0
  262. package/dist/projections/graphs/graphProjection.d.ts +21 -0
  263. package/dist/projections/graphs/graphProjection.d.ts.map +1 -0
  264. package/dist/projections/graphs/graphProjection.js +28 -0
  265. package/dist/projections/graphs/graphProjection.js.map +1 -0
  266. package/dist/projections/graphs/index.d.ts +48 -0
  267. package/dist/projections/graphs/index.d.ts.map +1 -0
  268. package/dist/projections/graphs/index.js +27 -0
  269. package/dist/projections/graphs/index.js.map +1 -0
  270. package/dist/projections/graphs/isGraphElement.d.ts +7 -0
  271. package/dist/projections/graphs/isGraphElement.d.ts.map +1 -0
  272. package/dist/projections/graphs/isGraphElement.js +13 -0
  273. package/dist/projections/graphs/isGraphElement.js.map +1 -0
  274. package/dist/projections/graphs/node.d.ts +22 -0
  275. package/dist/projections/graphs/node.d.ts.map +1 -0
  276. package/dist/projections/graphs/node.js +29 -0
  277. package/dist/projections/graphs/node.js.map +1 -0
  278. package/dist/projections/graphs/nodeFrom.d.ts +31 -0
  279. package/dist/projections/graphs/nodeFrom.d.ts.map +1 -0
  280. package/dist/projections/graphs/nodeFrom.js +26 -0
  281. package/dist/projections/graphs/nodeFrom.js.map +1 -0
  282. package/dist/projections/graphs/nodeRemovedWith.d.ts +28 -0
  283. package/dist/projections/graphs/nodeRemovedWith.d.ts.map +1 -0
  284. package/dist/projections/graphs/nodeRemovedWith.js +25 -0
  285. package/dist/projections/graphs/nodeRemovedWith.js.map +1 -0
  286. package/dist/projections/graphs/propertyPathOf.d.ts +8 -0
  287. package/dist/projections/graphs/propertyPathOf.d.ts.map +1 -0
  288. package/dist/projections/graphs/propertyPathOf.js +14 -0
  289. package/dist/projections/graphs/propertyPathOf.js.map +1 -0
  290. package/dist/projections/index.d.ts +1 -0
  291. package/dist/projections/index.d.ts.map +1 -1
  292. package/dist/projections/index.js +1 -0
  293. package/dist/projections/index.js.map +1 -1
  294. package/dist/projections/registerProjectionWithRetry.d.ts +15 -0
  295. package/dist/projections/registerProjectionWithRetry.d.ts.map +1 -0
  296. package/dist/projections/registerProjectionWithRetry.js +44 -0
  297. package/dist/projections/registerProjectionWithRetry.js.map +1 -0
  298. package/dist/readModels/rootReadModelTypes.d.ts.map +1 -1
  299. package/dist/readModels/rootReadModelTypes.js +3 -1
  300. package/dist/readModels/rootReadModelTypes.js.map +1 -1
  301. package/dist/sinks/WellKnownSinks.d.ts +4 -0
  302. package/dist/sinks/WellKnownSinks.d.ts.map +1 -1
  303. package/dist/sinks/WellKnownSinks.js +5 -1
  304. package/dist/sinks/WellKnownSinks.js.map +1 -1
  305. package/dist/tsconfig.tsbuildinfo +1 -1
  306. package/dist/types/DecoratorType.d.ts +5 -1
  307. package/dist/types/DecoratorType.d.ts.map +1 -1
  308. package/dist/types/DecoratorType.js +4 -0
  309. package/dist/types/DecoratorType.js.map +1 -1
  310. package/for_ChronicleOptions/when_configuring_the_graph_sink/with_graph_sink_type.spec.ts +22 -0
  311. package/package.json +3 -3
  312. package/projections/Projections.ts +4 -29
  313. package/projections/for_Graphs/given/a_discovered_graph.ts +21 -0
  314. package/projections/for_Graphs/given/a_fake_connection.ts +19 -0
  315. package/projections/for_Graphs/given/organization.ts +96 -0
  316. package/projections/for_Graphs/when_building_a_fluent_graph.spec.ts +112 -0
  317. package/projections/for_Graphs/when_building_a_model_bound_graph.spec.ts +91 -0
  318. package/projections/for_Graphs/when_declaring_an_edge_with_an_identity.spec.ts +137 -0
  319. package/projections/for_Graphs/when_declaring_an_invalid_graph.spec.ts +199 -0
  320. package/projections/for_Graphs/when_declaring_with_standard_decorators.standard.spec.ts +92 -0
  321. package/projections/for_Graphs/when_discovering_graph_elements.spec.ts +32 -0
  322. package/projections/for_Graphs/when_mapping_properties.spec.ts +159 -0
  323. package/projections/for_Graphs/when_registering_graphs.spec.ts +56 -0
  324. package/projections/graphs/EdgeCanHaveOnlyOneIdentifyingKey.ts +16 -0
  325. package/projections/graphs/EdgeMustHaveOneSourceAndOneTarget.ts +16 -0
  326. package/projections/graphs/GraphDeclaredMoreThanOnce.ts +16 -0
  327. package/projections/graphs/GraphDefinitionBuilder.ts +166 -0
  328. package/projections/graphs/GraphEdgeBuilder.ts +107 -0
  329. package/projections/graphs/GraphEdgeFromBuilder.ts +47 -0
  330. package/projections/graphs/GraphEdgeFromModel.ts +22 -0
  331. package/projections/graphs/GraphEdgeModel.ts +34 -0
  332. package/projections/graphs/GraphEdgeRemovedWithBuilder.ts +39 -0
  333. package/projections/graphs/GraphEdgeRemovedWithModel.ts +19 -0
  334. package/projections/graphs/GraphElementCannotBeReadModel.ts +16 -0
  335. package/projections/graphs/GraphHasDuplicateElement.ts +18 -0
  336. package/projections/graphs/GraphKeyPropertyNotFound.ts +17 -0
  337. package/projections/graphs/GraphMappingBuilder.ts +65 -0
  338. package/projections/graphs/GraphMemberMappings.ts +57 -0
  339. package/projections/graphs/GraphModel.ts +20 -0
  340. package/projections/graphs/GraphNameRequired.ts +16 -0
  341. package/projections/graphs/GraphNodeBuilder.ts +76 -0
  342. package/projections/graphs/GraphNodeFromBuilder.ts +38 -0
  343. package/projections/graphs/GraphNodeFromModel.ts +19 -0
  344. package/projections/graphs/GraphNodeModel.ts +25 -0
  345. package/projections/graphs/GraphNodeRemovedWithBuilder.ts +30 -0
  346. package/projections/graphs/GraphNodeRemovedWithModel.ts +16 -0
  347. package/projections/graphs/GraphProjectionBuilder.ts +52 -0
  348. package/projections/graphs/GraphRegistration.ts +19 -0
  349. package/projections/graphs/GraphSchemaWriter.ts +80 -0
  350. package/projections/graphs/Graphs.ts +165 -0
  351. package/projections/graphs/IGraphEdgeBuilder.ts +43 -0
  352. package/projections/graphs/IGraphEdgeFromBuilder.ts +34 -0
  353. package/projections/graphs/IGraphEdgeRemovedWithBuilder.ts +32 -0
  354. package/projections/graphs/IGraphMappingBuilder.ts +57 -0
  355. package/projections/graphs/IGraphNodeBuilder.ts +37 -0
  356. package/projections/graphs/IGraphNodeFromBuilder.ts +25 -0
  357. package/projections/graphs/IGraphNodeRemovedWithBuilder.ts +23 -0
  358. package/projections/graphs/IGraphProjection.ts +16 -0
  359. package/projections/graphs/IGraphProjectionBuilder.ts +34 -0
  360. package/projections/graphs/IGraphs.ts +33 -0
  361. package/projections/graphs/ModelBoundGraphReader.ts +119 -0
  362. package/projections/graphs/NestedObjectInGraph.ts +17 -0
  363. package/projections/graphs/NodeMustHaveExactlyOneKey.ts +17 -0
  364. package/projections/graphs/UnknownGraphEventProperty.ts +18 -0
  365. package/projections/graphs/UnknownGraphNode.ts +17 -0
  366. package/projections/graphs/edge.ts +40 -0
  367. package/projections/graphs/edgeFrom.ts +48 -0
  368. package/projections/graphs/edgeRemovedWith.ts +36 -0
  369. package/projections/graphs/edgeSource.ts +39 -0
  370. package/projections/graphs/edgeTarget.ts +39 -0
  371. package/projections/graphs/graph.ts +28 -0
  372. package/projections/graphs/graphKey.ts +31 -0
  373. package/projections/graphs/graphProjection.ts +39 -0
  374. package/projections/graphs/index.ts +50 -0
  375. package/projections/graphs/isGraphElement.ts +14 -0
  376. package/projections/graphs/node.ts +40 -0
  377. package/projections/graphs/nodeFrom.ts +48 -0
  378. package/projections/graphs/nodeRemovedWith.ts +44 -0
  379. package/projections/graphs/propertyPathOf.ts +15 -0
  380. package/projections/index.ts +1 -0
  381. package/projections/registerProjectionWithRetry.ts +53 -0
  382. package/readModels/rootReadModelTypes.ts +3 -1
  383. package/sinks/WellKnownSinks.ts +7 -1
  384. package/types/DecoratorType.ts +7 -1
@@ -0,0 +1,76 @@
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, PropertyAccessor } from '@cratis/fundamentals';
5
+ import { TypeIntrospector } from '../../types/index.js';
6
+ import { getNodeMetadata } from './node.js';
7
+ import { GraphNodeFromBuilder } from './GraphNodeFromBuilder.js';
8
+ import { GraphNodeRemovedWithBuilder } from './GraphNodeRemovedWithBuilder.js';
9
+ import type { GraphNodeFromModel } from './GraphNodeFromModel.js';
10
+ import type { GraphNodeModel } from './GraphNodeModel.js';
11
+ import type { GraphNodeRemovedWithModel } from './GraphNodeRemovedWithModel.js';
12
+ import { isGraphKey } from './graphKey.js';
13
+ import type { IGraphNodeBuilder } from './IGraphNodeBuilder.js';
14
+ import type { IGraphNodeFromBuilder } from './IGraphNodeFromBuilder.js';
15
+ import type { IGraphNodeRemovedWithBuilder } from './IGraphNodeRemovedWithBuilder.js';
16
+ import { NodeMustHaveExactlyOneKey } from './NodeMustHaveExactlyOneKey.js';
17
+ import { propertyPathOf } from './propertyPathOf.js';
18
+
19
+ /**
20
+ * Implements {@link IGraphNodeBuilder}.
21
+ * @template TNode - The type of node.
22
+ */
23
+ export class GraphNodeBuilder<TNode> implements IGraphNodeBuilder<TNode> {
24
+ private readonly _from: GraphNodeFromModel[] = [];
25
+ private readonly _removedWith: GraphNodeRemovedWithModel[] = [];
26
+ private _keyProperty?: string;
27
+
28
+ /**
29
+ * Creates a new {@link GraphNodeBuilder}.
30
+ * @param _type - The type of the node.
31
+ */
32
+ constructor(private readonly _type: Constructor<TNode>) {}
33
+
34
+ /** @inheritdoc */
35
+ identifiedBy(keyAccessor: PropertyAccessor<TNode>): IGraphNodeBuilder<TNode> {
36
+ this._keyProperty = propertyPathOf(keyAccessor);
37
+ return this;
38
+ }
39
+
40
+ /** @inheritdoc */
41
+ from<TEvent>(eventType: Constructor<TEvent>, configure?: (builder: IGraphNodeFromBuilder<TNode, TEvent>) => void): IGraphNodeBuilder<TNode> {
42
+ const builder = new GraphNodeFromBuilder<TNode, TEvent>();
43
+ configure?.(builder);
44
+ this._from.push({ eventType, key: builder.key, properties: builder.properties, updateOnly: builder.updateOnly });
45
+ return this;
46
+ }
47
+
48
+ /** @inheritdoc */
49
+ removedWith<TEvent>(eventType: Constructor<TEvent>, configure?: (builder: IGraphNodeRemovedWithBuilder<TEvent>) => void): IGraphNodeBuilder<TNode> {
50
+ const builder = new GraphNodeRemovedWithBuilder<TEvent>();
51
+ configure?.(builder);
52
+ this._removedWith.push({ eventType, key: builder.key, detach: builder.detachEdges });
53
+ return this;
54
+ }
55
+
56
+ /**
57
+ * Builds the {@link GraphNodeModel}.
58
+ * @returns The model.
59
+ * @throws {NodeMustHaveExactlyOneKey} When no key is declared and the type does not have exactly one member with the graphKey decorator.
60
+ */
61
+ build(): GraphNodeModel {
62
+ return {
63
+ type: this._type,
64
+ label: getNodeMetadata(this._type)?.label ?? this._type.name,
65
+ keyProperty: this._keyProperty ?? GraphNodeBuilder.keyOf(this._type),
66
+ from: this._from,
67
+ removedWith: this._removedWith
68
+ };
69
+ }
70
+
71
+ private static keyOf(type: Function): string {
72
+ const keys = TypeIntrospector.getTrackedProperties(type).filter(member => isGraphKey(type.prototype, member));
73
+ if (keys.length !== 1) throw new NodeMustHaveExactlyOneKey(type, keys.length);
74
+ return keys[0];
75
+ }
76
+ }
@@ -0,0 +1,38 @@
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 { PropertyAccessor } from '@cratis/fundamentals';
5
+ import { GraphMappingBuilder } from './GraphMappingBuilder.js';
6
+ import type { IGraphNodeFromBuilder } from './IGraphNodeFromBuilder.js';
7
+ import { propertyPathOf } from './propertyPathOf.js';
8
+
9
+ /**
10
+ * Implements {@link IGraphNodeFromBuilder}.
11
+ * @template TNode - The type of node.
12
+ * @template TEvent - The type of event.
13
+ */
14
+ export class GraphNodeFromBuilder<TNode, TEvent> extends GraphMappingBuilder<TNode, TEvent, IGraphNodeFromBuilder<TNode, TEvent>>
15
+ implements IGraphNodeFromBuilder<TNode, TEvent> {
16
+ /** The expression for the key of the node, or undefined for the event source id. */
17
+ key?: string;
18
+
19
+ /** Whether the event only changes a node that already exists. */
20
+ updateOnly = false;
21
+
22
+ /** @inheritdoc */
23
+ protected get self(): IGraphNodeFromBuilder<TNode, TEvent> {
24
+ return this;
25
+ }
26
+
27
+ /** @inheritdoc */
28
+ usingKey(keyAccessor: PropertyAccessor<TEvent>): IGraphNodeFromBuilder<TNode, TEvent> {
29
+ this.key = propertyPathOf(keyAccessor);
30
+ return this;
31
+ }
32
+
33
+ /** @inheritdoc */
34
+ onlyWhenExisting(): IGraphNodeFromBuilder<TNode, TEvent> {
35
+ this.updateOnly = true;
36
+ return this;
37
+ }
38
+ }
@@ -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
+ /**
5
+ * Represents how an event creates or updates a node.
6
+ */
7
+ export interface GraphNodeFromModel {
8
+ /** The event type. */
9
+ readonly eventType: Function;
10
+
11
+ /** The expression for the key of the node, or undefined for the event source id. */
12
+ readonly key?: string;
13
+
14
+ /** The property mapping expressions by node property name. */
15
+ readonly properties: Readonly<Record<string, string>>;
16
+
17
+ /** Whether the event only changes a node that already exists. */
18
+ readonly updateOnly: boolean;
19
+ }
@@ -0,0 +1,25 @@
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 { GraphNodeFromModel } from './GraphNodeFromModel.js';
5
+ import type { GraphNodeRemovedWithModel } from './GraphNodeRemovedWithModel.js';
6
+
7
+ /**
8
+ * Represents a node type with what it is projected from.
9
+ */
10
+ export interface GraphNodeModel {
11
+ /** The type of the node. */
12
+ readonly type: Function;
13
+
14
+ /** The node label. */
15
+ readonly label: string;
16
+
17
+ /** The name of the key property. */
18
+ readonly keyProperty: string;
19
+
20
+ /** The mappings that create or update nodes. */
21
+ readonly from: readonly GraphNodeFromModel[];
22
+
23
+ /** The mappings that delete nodes. */
24
+ readonly removedWith: readonly GraphNodeRemovedWithModel[];
25
+ }
@@ -0,0 +1,30 @@
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 { PropertyAccessor } from '@cratis/fundamentals';
5
+ import type { IGraphNodeRemovedWithBuilder } from './IGraphNodeRemovedWithBuilder.js';
6
+ import { propertyPathOf } from './propertyPathOf.js';
7
+
8
+ /**
9
+ * Implements {@link IGraphNodeRemovedWithBuilder}.
10
+ * @template TEvent - The type of event.
11
+ */
12
+ export class GraphNodeRemovedWithBuilder<TEvent> implements IGraphNodeRemovedWithBuilder<TEvent> {
13
+ /** The expression for the key of the node, or undefined for the event source id. */
14
+ key?: string;
15
+
16
+ /** Whether the edges attached to the node are deleted with it. */
17
+ detachEdges = false;
18
+
19
+ /** @inheritdoc */
20
+ usingKey(keyAccessor: PropertyAccessor<TEvent>): IGraphNodeRemovedWithBuilder<TEvent> {
21
+ this.key = propertyPathOf(keyAccessor);
22
+ return this;
23
+ }
24
+
25
+ /** @inheritdoc */
26
+ detach(): IGraphNodeRemovedWithBuilder<TEvent> {
27
+ this.detachEdges = true;
28
+ return this;
29
+ }
30
+ }
@@ -0,0 +1,16 @@
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
+ /**
5
+ * Represents how an event deletes a node.
6
+ */
7
+ export interface GraphNodeRemovedWithModel {
8
+ /** The event type. */
9
+ readonly eventType: Function;
10
+
11
+ /** The expression for the key of the node, or undefined for the event source id. */
12
+ readonly key?: string;
13
+
14
+ /** Whether the edges attached to the node are deleted with it. */
15
+ readonly detach: boolean;
16
+ }
@@ -0,0 +1,52 @@
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 { GraphEdgeBuilder } from './GraphEdgeBuilder.js';
6
+ import type { GraphEdgeModel } from './GraphEdgeModel.js';
7
+ import { GraphNodeBuilder } from './GraphNodeBuilder.js';
8
+ import type { GraphModel } from './GraphModel.js';
9
+ import type { GraphNodeModel } from './GraphNodeModel.js';
10
+ import type { IGraphEdgeBuilder } from './IGraphEdgeBuilder.js';
11
+ import type { IGraphNodeBuilder } from './IGraphNodeBuilder.js';
12
+ import type { IGraphProjection } from './IGraphProjection.js';
13
+ import type { IGraphProjectionBuilder } from './IGraphProjectionBuilder.js';
14
+
15
+ /**
16
+ * Implements {@link IGraphProjectionBuilder}, collecting the nodes and edges a graph projection defines.
17
+ */
18
+ export class GraphProjectionBuilder implements IGraphProjectionBuilder {
19
+ private readonly _nodes: GraphNodeModel[] = [];
20
+ private readonly _edges: GraphEdgeModel[] = [];
21
+
22
+ /** @inheritdoc */
23
+ node<TNode>(nodeType: Constructor<TNode>, configure: (builder: IGraphNodeBuilder<TNode>) => void): IGraphProjectionBuilder {
24
+ const builder = new GraphNodeBuilder<TNode>(nodeType);
25
+ configure(builder);
26
+ this._nodes.push(builder.build());
27
+ return this;
28
+ }
29
+
30
+ /** @inheritdoc */
31
+ edge<TEdge>(
32
+ edgeType: Constructor<TEdge>,
33
+ sourceType: Function,
34
+ targetType: Function,
35
+ configure: (builder: IGraphEdgeBuilder<TEdge>) => void): IGraphProjectionBuilder {
36
+ const builder = new GraphEdgeBuilder<TEdge>(edgeType, sourceType, targetType);
37
+ configure(builder);
38
+ this._edges.push(builder.build());
39
+ return this;
40
+ }
41
+
42
+ /**
43
+ * Builds the {@link GraphModel} of a graph projection.
44
+ * @param name - The name of the graph.
45
+ * @param projection - The graph projection to define the model with.
46
+ * @returns The model.
47
+ */
48
+ build(name: string, projection: IGraphProjection): GraphModel {
49
+ projection.define(this);
50
+ return { name, nodes: this._nodes, edges: this._edges };
51
+ }
52
+ }
@@ -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 { ProjectionDefinition } from '@cratis/chronicle.contracts';
5
+ import type { buildReadModelDefinition } from '../../readModels/buildReadModelDefinition.js';
6
+
7
+ /**
8
+ * Represents everything that is registered for a graph: the read model that describes it and the projection that fills it.
9
+ */
10
+ export interface GraphRegistration {
11
+ /** The name of the graph. */
12
+ readonly graphName: string;
13
+
14
+ /** The read model whose schema describes the graph. */
15
+ readonly readModel: ReturnType<typeof buildReadModelDefinition>;
16
+
17
+ /** The projection with the graph mappings. */
18
+ readonly projection: ProjectionDefinition;
19
+ }
@@ -0,0 +1,80 @@
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 { JsonSchema, JsonSchemaGenerator } from '../../schemas/index.js';
5
+ import { GraphKeyPropertyNotFound } from './GraphKeyPropertyNotFound.js';
6
+ import type { GraphModel } from './GraphModel.js';
7
+ import { NestedObjectInGraph } from './NestedObjectInGraph.js';
8
+ import { UnknownGraphNode } from './UnknownGraphNode.js';
9
+
10
+ /**
11
+ * Writes the schema form of a graph: an object schema whose properties are the node labels and edge types.
12
+ * This is the form the kernel reads a graph from. The annotations are the ones of the kernel's graph definition.
13
+ */
14
+ export class GraphSchemaWriter {
15
+ /**
16
+ * Writes the schema of a graph.
17
+ * @param model - The {@link GraphModel}.
18
+ * @returns The schema as JSON.
19
+ * @throws {NestedObjectInGraph} When a node or an edge has an object property.
20
+ * @throws {UnknownGraphNode} When an edge connects a type that is not a node of the graph.
21
+ */
22
+ write(model: GraphModel): string {
23
+ const properties: Record<string, unknown> = {};
24
+ for (const node of model.nodes) {
25
+ this.assertProperty(node.type, node.keyProperty, this.propertiesOf(node.type, []));
26
+ properties[node.label] = {
27
+ ...this.element(node.type, []),
28
+ 'x-graph-kind': 'Node',
29
+ 'x-graph-key': node.keyProperty
30
+ };
31
+ }
32
+
33
+ for (const edge of model.edges) {
34
+ const identity = edge.identifyingProperty;
35
+ if (identity !== undefined) this.assertProperty(edge.type, identity, this.propertiesOf(edge.type, edge.excludedProperties));
36
+ properties[edge.edgeType] = {
37
+ ...this.element(edge.type, edge.excludedProperties),
38
+ 'x-graph-kind': 'Edge',
39
+ 'x-graph-source': this.labelOf(model, edge.edgeType, edge.sourceNode),
40
+ 'x-graph-target': this.labelOf(model, edge.edgeType, edge.targetNode),
41
+ ...(identity === undefined ? {} : { 'x-graph-identity': identity })
42
+ };
43
+ }
44
+
45
+ return JSON.stringify({ type: 'object', title: model.name, 'x-graph': true, properties });
46
+ }
47
+
48
+ /**
49
+ * Gets the properties of a node or edge type, as they are named in the graph.
50
+ * @param type - The node or edge type.
51
+ * @param excluded - Names of members that are not properties.
52
+ * @returns The property names with their schemas.
53
+ * @throws {NestedObjectInGraph} When a property is an object.
54
+ */
55
+ propertiesOf(type: Function, excluded: readonly string[]): Record<string, JsonSchema> {
56
+ const skip = new Set(excluded.map(name => name.toLowerCase()));
57
+ const result: Record<string, JsonSchema> = {};
58
+ for (const [name, property] of Object.entries(JsonSchemaGenerator.generate(type).properties ?? {})) {
59
+ if (skip.has(name.toLowerCase())) continue;
60
+ if (property.type === 'object' || property.items?.type === 'object') throw new NestedObjectInGraph(type, name);
61
+ result[name] = property;
62
+ }
63
+
64
+ return result;
65
+ }
66
+
67
+ private element(type: Function, excluded: readonly string[]): Record<string, unknown> {
68
+ return { type: 'object', properties: this.propertiesOf(type, excluded) };
69
+ }
70
+
71
+ private assertProperty(type: Function, property: string, properties: Record<string, JsonSchema>): void {
72
+ if (!Object.hasOwn(properties, property)) throw new GraphKeyPropertyNotFound(type, property);
73
+ }
74
+
75
+ private labelOf(model: GraphModel, edgeType: string, nodeType: Function): string {
76
+ const node = model.nodes.find(candidate => candidate.type === nodeType);
77
+ if (!node) throw new UnknownGraphNode(edgeType, nodeType);
78
+ return node.label;
79
+ }
80
+ }
@@ -0,0 +1,165 @@
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 type { IClientArtifactsProvider } from '../../artifacts/index.js';
6
+ import type { ChronicleConnection } from '../../connection/index.js';
7
+ import { createLogger } from '../../logging/createLogger.js';
8
+ import { getReadModelMetadata } from '../../readModels/readModel.js';
9
+ import { hasFromEventMetadata } from '../modelBound/fromEvent.js';
10
+ import { registerProjectionWithRetry } from '../registerProjectionWithRetry.js';
11
+ import { GraphDeclaredMoreThanOnce } from './GraphDeclaredMoreThanOnce.js';
12
+ import { GraphDefinitionBuilder } from './GraphDefinitionBuilder.js';
13
+ import { GraphElementCannotBeReadModel } from './GraphElementCannotBeReadModel.js';
14
+ import type { GraphEdgeModel } from './GraphEdgeModel.js';
15
+ import type { GraphModel } from './GraphModel.js';
16
+ import type { GraphNodeModel } from './GraphNodeModel.js';
17
+ import { GraphProjectionBuilder } from './GraphProjectionBuilder.js';
18
+ import type { GraphRegistration } from './GraphRegistration.js';
19
+ import type { IGraphProjection } from './IGraphProjection.js';
20
+ import type { IGraphs } from './IGraphs.js';
21
+ import { getEdgeMetadata } from './edge.js';
22
+ import { getGraphProjectionMetadata } from './graphProjection.js';
23
+ import { getNodeMetadata } from './node.js';
24
+ import { ModelBoundGraphReader } from './ModelBoundGraphReader.js';
25
+
26
+ interface DeclaredGraph {
27
+ readonly source: Constructor;
28
+ readonly model: GraphModel;
29
+ readonly projectionId: string;
30
+ }
31
+
32
+ /**
33
+ * Implements {@link IGraphs}, discovering the graphs an application declares, with the decorators and with the fluent
34
+ * builder, and registering them with the Chronicle Kernel.
35
+ */
36
+ export class Graphs implements IGraphs {
37
+ private readonly _failures = new Map<Constructor, Error>();
38
+ private readonly _logger: ReturnType<typeof createLogger>;
39
+ private _registrations: readonly GraphRegistration[] = [];
40
+
41
+ /**
42
+ * Creates a new {@link Graphs} instance.
43
+ * @param _eventStore - The event store name.
44
+ * @param _connection - Chronicle connection.
45
+ * @param _clientArtifacts - Provider for discovered client artifact types.
46
+ * @param _graphSinkTypeId - The identifier of the sink type that stores graphs.
47
+ */
48
+ constructor(
49
+ private readonly _eventStore: string,
50
+ private readonly _connection: ChronicleConnection,
51
+ private readonly _clientArtifacts: IClientArtifactsProvider,
52
+ private readonly _graphSinkTypeId: string
53
+ ) {
54
+ this._logger = createLogger('@cratis/chronicle/graphs', _connection.logger);
55
+ }
56
+
57
+ /** @inheritdoc */
58
+ get registrations(): readonly GraphRegistration[] {
59
+ return this._registrations;
60
+ }
61
+
62
+ /** @inheritdoc */
63
+ get failures(): ReadonlyMap<Constructor, Error> {
64
+ return this._failures;
65
+ }
66
+
67
+ /** @inheritdoc */
68
+ async discover(): Promise<void> {
69
+ this._failures.clear();
70
+ const builder = new GraphDefinitionBuilder();
71
+ const registrations: GraphRegistration[] = [];
72
+ const names = new Set<string>();
73
+ for (const declared of [...this.modelBoundGraphs(), ...this.fluentGraphs()]) {
74
+ try {
75
+ if (names.has(declared.model.name)) throw new GraphDeclaredMoreThanOnce(declared.model.name);
76
+ registrations.push(builder.build(declared.model, declared.projectionId, this._graphSinkTypeId));
77
+ names.add(declared.model.name);
78
+ } catch (error) {
79
+ this.fail(declared.source, error);
80
+ }
81
+ }
82
+
83
+ this._registrations = registrations;
84
+ this._logger.debug('Graph discovery complete', { graphCount: registrations.length, failureCount: this._failures.size });
85
+ }
86
+
87
+ /** @inheritdoc */
88
+ async register(): Promise<void> {
89
+ if (this._registrations.length === 0) {
90
+ this._logger.debug('No graphs to register');
91
+ return;
92
+ }
93
+
94
+ this._logger.info('Registering graphs', { graphCount: this._registrations.length });
95
+ await this._connection.readModels.registerMany({
96
+ EventStore: this._eventStore,
97
+ Owner: 1,
98
+ ReadModels: this._registrations.map(registration => registration.readModel),
99
+ Source: 1
100
+ });
101
+
102
+ for (const registration of this._registrations) {
103
+ await registerProjectionWithRetry(
104
+ this._connection, this._eventStore, this._logger, registration.projection, registration.projection.Identifier);
105
+ }
106
+ }
107
+
108
+ private modelBoundGraphs(): DeclaredGraph[] {
109
+ const reader = new ModelBoundGraphReader();
110
+ const elements = new Map<string, { source: Constructor; nodes: GraphNodeModel[]; edges: GraphEdgeModel[] }>();
111
+ const broken = new Set<string>();
112
+ for (const type of this._clientArtifacts.graphElements ?? []) {
113
+ this.tryRead(type, () => {
114
+ const graph = ModelBoundGraphReader.graphNameOf(type);
115
+ try {
116
+ if (hasFromEventMetadata(type) || getReadModelMetadata(type) !== undefined) throw new GraphElementCannotBeReadModel(type);
117
+ const declared = elements.get(graph) ?? { source: type, nodes: [], edges: [] };
118
+ elements.set(graph, declared);
119
+ if (getNodeMetadata(type)) declared.nodes.push(reader.readNode(type));
120
+ if (getEdgeMetadata(type)) declared.edges.push(reader.readEdge(type));
121
+ } catch (error) {
122
+ // A graph without one of its nodes or edges is not what was declared. A replay would sweep away
123
+ // what the missing element left behind, so the whole graph is left unregistered.
124
+ broken.add(graph);
125
+ throw error;
126
+ }
127
+ });
128
+ }
129
+
130
+ return Array.from(elements)
131
+ .filter(([name]) => !broken.has(name))
132
+ .map(([name, declared]) => ({
133
+ source: declared.source,
134
+ model: { name, nodes: declared.nodes, edges: declared.edges },
135
+ projectionId: name
136
+ }));
137
+ }
138
+
139
+ private fluentGraphs(): DeclaredGraph[] {
140
+ const result: DeclaredGraph[] = [];
141
+ for (const type of this._clientArtifacts.graphProjections ?? []) {
142
+ this.tryRead(type, () => {
143
+ const name = getGraphProjectionMetadata(type)?.name ?? type.name;
144
+ const projection = new type() as IGraphProjection;
145
+ result.push({ source: type, model: new GraphProjectionBuilder().build(name, projection), projectionId: type.name });
146
+ });
147
+ }
148
+
149
+ return result;
150
+ }
151
+
152
+ private tryRead(type: Constructor, read: () => void): void {
153
+ try {
154
+ read();
155
+ } catch (error) {
156
+ this.fail(type, error);
157
+ }
158
+ }
159
+
160
+ private fail(type: Constructor, error: unknown): void {
161
+ const failure = error instanceof Error ? error : new Error(String(error));
162
+ this._failures.set(type, failure);
163
+ this._logger.error('Could not build a graph definition', { type: type.name, error: failure });
164
+ }
165
+ }
@@ -0,0 +1,43 @@
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, PropertyAccessor } from '@cratis/fundamentals';
5
+ import type { IGraphEdgeFromBuilder } from './IGraphEdgeFromBuilder.js';
6
+ import type { IGraphEdgeRemovedWithBuilder } from './IGraphEdgeRemovedWithBuilder.js';
7
+
8
+ /**
9
+ * Defines a builder for an edge.
10
+ * @template TEdge - The type of edge.
11
+ */
12
+ export interface IGraphEdgeBuilder<TEdge> {
13
+ /**
14
+ * Names the edge type. Not needed when the class of the edge has the edge decorator.
15
+ * @param type - The edge type, for example MEMBER_OF.
16
+ * @returns The builder for continuation.
17
+ */
18
+ named(type: string): IGraphEdgeBuilder<TEdge>;
19
+
20
+ /**
21
+ * Declares the property that identifies the edge among edges of the same type between the same two nodes.
22
+ * Not needed when the property has the graphKey decorator.
23
+ * @param identityAccessor - Accessor for the identifying property.
24
+ * @returns The builder for continuation.
25
+ */
26
+ identifiedBy(identityAccessor: PropertyAccessor<TEdge>): IGraphEdgeBuilder<TEdge>;
27
+
28
+ /**
29
+ * Creates or updates the edge when an event is observed. Both end nodes are created when they do not exist.
30
+ * @param eventType - The event constructor.
31
+ * @param configure - Callback for the keys of the end nodes and the properties.
32
+ * @returns The builder for continuation.
33
+ */
34
+ from<TEvent>(eventType: Constructor<TEvent>, configure: (builder: IGraphEdgeFromBuilder<TEdge, TEvent>) => void): IGraphEdgeBuilder<TEdge>;
35
+
36
+ /**
37
+ * Deletes the edge when an event is observed. The nodes at both ends stay.
38
+ * @param eventType - The event constructor.
39
+ * @param configure - Callback for the keys of the end nodes.
40
+ * @returns The builder for continuation.
41
+ */
42
+ removedWith<TEvent>(eventType: Constructor<TEvent>, configure: (builder: IGraphEdgeRemovedWithBuilder<TEvent>) => void): IGraphEdgeBuilder<TEdge>;
43
+ }
@@ -0,0 +1,34 @@
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 { PropertyAccessor } from '@cratis/fundamentals';
5
+ import type { IGraphMappingBuilder } from './IGraphMappingBuilder.js';
6
+
7
+ /**
8
+ * Defines the builder for how an event creates or updates an edge.
9
+ * @template TEdge - The type of edge.
10
+ * @template TEvent - The type of event.
11
+ */
12
+ export interface IGraphEdgeFromBuilder<TEdge, TEvent> extends IGraphMappingBuilder<TEdge, TEvent, IGraphEdgeFromBuilder<TEdge, TEvent>> {
13
+ /**
14
+ * Takes the key of the source node from a property on the event. By default it is the event source id.
15
+ * @param keyAccessor - Accessor for the event property.
16
+ * @returns The builder for continuation.
17
+ */
18
+ usingSourceKey(keyAccessor: PropertyAccessor<TEvent>): IGraphEdgeFromBuilder<TEdge, TEvent>;
19
+
20
+ /**
21
+ * Takes the key of the target node from a property on the event. By default it is the event source id.
22
+ * @param keyAccessor - Accessor for the event property.
23
+ * @returns The builder for continuation.
24
+ */
25
+ usingTargetKey(keyAccessor: PropertyAccessor<TEvent>): IGraphEdgeFromBuilder<TEdge, TEvent>;
26
+
27
+ /**
28
+ * Takes the identity of the edge from a property on the event, for an edge type with an identifying property.
29
+ * By default it is the event property named like the identifying property.
30
+ * @param identityAccessor - Accessor for the event property.
31
+ * @returns The builder for continuation.
32
+ */
33
+ usingIdentity(identityAccessor: PropertyAccessor<TEvent>): IGraphEdgeFromBuilder<TEdge, TEvent>;
34
+ }
@@ -0,0 +1,32 @@
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 { PropertyAccessor } from '@cratis/fundamentals';
5
+
6
+ /**
7
+ * Defines the builder for how an event deletes an edge.
8
+ * @template TEvent - The type of event.
9
+ */
10
+ export interface IGraphEdgeRemovedWithBuilder<TEvent> {
11
+ /**
12
+ * Takes the key of the source node from a property on the event. By default it is the event source id.
13
+ * @param keyAccessor - Accessor for the event property.
14
+ * @returns The builder for continuation.
15
+ */
16
+ usingSourceKey(keyAccessor: PropertyAccessor<TEvent>): IGraphEdgeRemovedWithBuilder<TEvent>;
17
+
18
+ /**
19
+ * Takes the key of the target node from a property on the event. By default it is the event source id.
20
+ * @param keyAccessor - Accessor for the event property.
21
+ * @returns The builder for continuation.
22
+ */
23
+ usingTargetKey(keyAccessor: PropertyAccessor<TEvent>): IGraphEdgeRemovedWithBuilder<TEvent>;
24
+
25
+ /**
26
+ * Takes the identity of the edge from a property on the event, for an edge type with an identifying property.
27
+ * By default it is the event property named like the identifying property.
28
+ * @param identityAccessor - Accessor for the event property.
29
+ * @returns The builder for continuation.
30
+ */
31
+ usingIdentity(identityAccessor: PropertyAccessor<TEvent>): IGraphEdgeRemovedWithBuilder<TEvent>;
32
+ }