@cratis/chronicle 6.62.0 → 6.64.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 (448) hide show
  1. package/ChronicleClient.ts +86 -3
  2. package/artifacts/DefaultClientArtifactsProvider.ts +5 -0
  3. package/artifacts/IClientArtifactsProvider.ts +3 -0
  4. package/connection/ConnectionLifecycle.ts +42 -1
  5. package/dist/ChronicleClient.d.ts +28 -1
  6. package/dist/ChronicleClient.d.ts.map +1 -1
  7. package/dist/ChronicleClient.js +71 -3
  8. package/dist/ChronicleClient.js.map +1 -1
  9. package/dist/artifacts/DefaultClientArtifactsProvider.d.ts +2 -0
  10. package/dist/artifacts/DefaultClientArtifactsProvider.d.ts.map +1 -1
  11. package/dist/artifacts/DefaultClientArtifactsProvider.js +4 -0
  12. package/dist/artifacts/DefaultClientArtifactsProvider.js.map +1 -1
  13. package/dist/artifacts/IClientArtifactsProvider.d.ts +2 -0
  14. package/dist/artifacts/IClientArtifactsProvider.d.ts.map +1 -1
  15. package/dist/connection/ConnectionLifecycle.d.ts +24 -0
  16. package/dist/connection/ConnectionLifecycle.d.ts.map +1 -1
  17. package/dist/connection/ConnectionLifecycle.js +40 -1
  18. package/dist/connection/ConnectionLifecycle.js.map +1 -1
  19. package/dist/observation/ObservationReconnectBackoff.d.ts +64 -0
  20. package/dist/observation/ObservationReconnectBackoff.d.ts.map +1 -0
  21. package/dist/observation/ObservationReconnectBackoff.js +75 -0
  22. package/dist/observation/ObservationReconnectBackoff.js.map +1 -0
  23. package/dist/observation/ObservationStreamOutcome.d.ts +10 -0
  24. package/dist/observation/ObservationStreamOutcome.d.ts.map +1 -0
  25. package/dist/observation/ObservationStreamOutcome.js +4 -0
  26. package/dist/observation/ObservationStreamOutcome.js.map +1 -0
  27. package/dist/observation/classifyStreamError.d.ts +25 -0
  28. package/dist/observation/classifyStreamError.d.ts.map +1 -0
  29. package/dist/observation/classifyStreamError.js +55 -0
  30. package/dist/observation/classifyStreamError.js.map +1 -0
  31. package/dist/observation/for_ObservationReconnectBackoff/given/a_backoff.d.ts +13 -0
  32. package/dist/observation/for_ObservationReconnectBackoff/given/a_backoff.d.ts.map +1 -0
  33. package/dist/observation/for_ObservationReconnectBackoff/given/a_backoff.js +25 -0
  34. package/dist/observation/for_ObservationReconnectBackoff/given/a_backoff.js.map +1 -0
  35. package/dist/observation/for_ObservationReconnectBackoff/given/a_scripted_stream.d.ts +27 -0
  36. package/dist/observation/for_ObservationReconnectBackoff/given/a_scripted_stream.d.ts.map +1 -0
  37. package/dist/observation/for_ObservationReconnectBackoff/given/a_scripted_stream.js +36 -0
  38. package/dist/observation/for_ObservationReconnectBackoff/given/a_scripted_stream.js.map +1 -0
  39. package/dist/projections/for_Graphs/given/a_discovered_graph.d.ts +2 -1
  40. package/dist/projections/for_Graphs/given/a_discovered_graph.d.ts.map +1 -1
  41. package/dist/projections/for_Graphs/given/a_discovered_graph.js +3 -2
  42. package/dist/projections/for_Graphs/given/a_discovered_graph.js.map +1 -1
  43. package/dist/projections/for_Graphs/given/a_graph_with_views.d.ts +40 -0
  44. package/dist/projections/for_Graphs/given/a_graph_with_views.d.ts.map +1 -0
  45. package/dist/projections/for_Graphs/given/a_graph_with_views.js +80 -0
  46. package/dist/projections/for_Graphs/given/a_graph_with_views.js.map +1 -0
  47. package/dist/projections/for_Graphs/given/organization.d.ts +2 -1
  48. package/dist/projections/for_Graphs/given/organization.d.ts.map +1 -1
  49. package/dist/projections/for_Graphs/given/organization.js +3 -2
  50. package/dist/projections/for_Graphs/given/organization.js.map +1 -1
  51. package/dist/projections/graphs/Graphs.d.ts +5 -0
  52. package/dist/projections/graphs/Graphs.d.ts.map +1 -1
  53. package/dist/projections/graphs/Graphs.js +43 -0
  54. package/dist/projections/graphs/Graphs.js.map +1 -1
  55. package/dist/projections/graphs/IGraphs.d.ts +9 -2
  56. package/dist/projections/graphs/IGraphs.d.ts.map +1 -1
  57. package/dist/projections/graphs/index.d.ts +1 -0
  58. package/dist/projections/graphs/index.d.ts.map +1 -1
  59. package/dist/projections/graphs/index.js +1 -0
  60. package/dist/projections/graphs/index.js.map +1 -1
  61. package/dist/projections/graphs/views/AmbiguousDirection.d.ts +16 -0
  62. package/dist/projections/graphs/views/AmbiguousDirection.d.ts.map +1 -0
  63. package/dist/projections/graphs/views/AmbiguousDirection.js +21 -0
  64. package/dist/projections/graphs/views/AmbiguousDirection.js.map +1 -0
  65. package/dist/projections/graphs/views/DuplicateViewName.d.ts +16 -0
  66. package/dist/projections/graphs/views/DuplicateViewName.d.ts.map +1 -0
  67. package/dist/projections/graphs/views/DuplicateViewName.js +21 -0
  68. package/dist/projections/graphs/views/DuplicateViewName.js.map +1 -0
  69. package/dist/projections/graphs/views/EdgeNotIncidentOnRoot.d.ts +17 -0
  70. package/dist/projections/graphs/views/EdgeNotIncidentOnRoot.d.ts.map +1 -0
  71. package/dist/projections/graphs/views/EdgeNotIncidentOnRoot.js +22 -0
  72. package/dist/projections/graphs/views/EdgeNotIncidentOnRoot.js.map +1 -0
  73. package/dist/projections/graphs/views/EdgePropertyViewNotUsedAsTarget.d.ts +14 -0
  74. package/dist/projections/graphs/views/EdgePropertyViewNotUsedAsTarget.d.ts.map +1 -0
  75. package/dist/projections/graphs/views/EdgePropertyViewNotUsedAsTarget.js +19 -0
  76. package/dist/projections/graphs/views/EdgePropertyViewNotUsedAsTarget.js.map +1 -0
  77. package/dist/projections/graphs/views/EdgePropertyViewSharedAcrossEdges.d.ts +15 -0
  78. package/dist/projections/graphs/views/EdgePropertyViewSharedAcrossEdges.d.ts.map +1 -0
  79. package/dist/projections/graphs/views/EdgePropertyViewSharedAcrossEdges.js +20 -0
  80. package/dist/projections/graphs/views/EdgePropertyViewSharedAcrossEdges.js.map +1 -0
  81. package/dist/projections/graphs/views/FollowsOptions.d.ts +16 -0
  82. package/dist/projections/graphs/views/FollowsOptions.d.ts.map +1 -0
  83. package/dist/projections/graphs/views/FollowsOptions.js +4 -0
  84. package/dist/projections/graphs/views/FollowsOptions.js.map +1 -0
  85. package/dist/projections/graphs/views/GraphEdgeDirection.d.ts +10 -0
  86. package/dist/projections/graphs/views/GraphEdgeDirection.d.ts.map +1 -0
  87. package/dist/projections/graphs/views/GraphEdgeDirection.js +13 -0
  88. package/dist/projections/graphs/views/GraphEdgeDirection.js.map +1 -0
  89. package/dist/projections/graphs/views/GraphView.d.ts +13 -0
  90. package/dist/projections/graphs/views/GraphView.d.ts.map +1 -0
  91. package/dist/projections/graphs/views/GraphView.js +4 -0
  92. package/dist/projections/graphs/views/GraphView.js.map +1 -0
  93. package/dist/projections/graphs/views/GraphViewBuildResult.d.ts +15 -0
  94. package/dist/projections/graphs/views/GraphViewBuildResult.d.ts.map +1 -0
  95. package/dist/projections/graphs/views/GraphViewBuildResult.js +4 -0
  96. package/dist/projections/graphs/views/GraphViewBuildResult.js.map +1 -0
  97. package/dist/projections/graphs/views/GraphViewCardinality.d.ts +10 -0
  98. package/dist/projections/graphs/views/GraphViewCardinality.d.ts.map +1 -0
  99. package/dist/projections/graphs/views/GraphViewCardinality.js +13 -0
  100. package/dist/projections/graphs/views/GraphViewCardinality.js.map +1 -0
  101. package/dist/projections/graphs/views/GraphViewDefinition.d.ts +15 -0
  102. package/dist/projections/graphs/views/GraphViewDefinition.d.ts.map +1 -0
  103. package/dist/projections/graphs/views/GraphViewDefinition.js +4 -0
  104. package/dist/projections/graphs/views/GraphViewDefinition.js.map +1 -0
  105. package/dist/projections/graphs/views/GraphViewDefinitionBuilder.d.ts +30 -0
  106. package/dist/projections/graphs/views/GraphViewDefinitionBuilder.d.ts.map +1 -0
  107. package/dist/projections/graphs/views/GraphViewDefinitionBuilder.js +259 -0
  108. package/dist/projections/graphs/views/GraphViewDefinitionBuilder.js.map +1 -0
  109. package/dist/projections/graphs/views/GraphViewDefinitionSerializer.d.ts +21 -0
  110. package/dist/projections/graphs/views/GraphViewDefinitionSerializer.d.ts.map +1 -0
  111. package/dist/projections/graphs/views/GraphViewDefinitionSerializer.js +77 -0
  112. package/dist/projections/graphs/views/GraphViewDefinitionSerializer.js.map +1 -0
  113. package/dist/projections/graphs/views/GraphViewEdgeReference.d.ts +6 -0
  114. package/dist/projections/graphs/views/GraphViewEdgeReference.d.ts.map +1 -0
  115. package/dist/projections/graphs/views/GraphViewEdgeReference.js +4 -0
  116. package/dist/projections/graphs/views/GraphViewEdgeReference.js.map +1 -0
  117. package/dist/projections/graphs/views/GraphViewMember.d.ts +8 -0
  118. package/dist/projections/graphs/views/GraphViewMember.d.ts.map +1 -0
  119. package/dist/projections/graphs/views/GraphViewMember.js +4 -0
  120. package/dist/projections/graphs/views/GraphViewMember.js.map +1 -0
  121. package/dist/projections/graphs/views/GraphViewMemberKind.d.ts +12 -0
  122. package/dist/projections/graphs/views/GraphViewMemberKind.d.ts.map +1 -0
  123. package/dist/projections/graphs/views/GraphViewMemberKind.js +15 -0
  124. package/dist/projections/graphs/views/GraphViewMemberKind.js.map +1 -0
  125. package/dist/projections/graphs/views/GraphViewMemberMetadata.d.ts +22 -0
  126. package/dist/projections/graphs/views/GraphViewMemberMetadata.d.ts.map +1 -0
  127. package/dist/projections/graphs/views/GraphViewMemberMetadata.js +4 -0
  128. package/dist/projections/graphs/views/GraphViewMemberMetadata.js.map +1 -0
  129. package/dist/projections/graphs/views/GraphViewPropertyMember.d.ts +13 -0
  130. package/dist/projections/graphs/views/GraphViewPropertyMember.d.ts.map +1 -0
  131. package/dist/projections/graphs/views/GraphViewPropertyMember.js +4 -0
  132. package/dist/projections/graphs/views/GraphViewPropertyMember.js.map +1 -0
  133. package/dist/projections/graphs/views/GraphViewReason.d.ts +33 -0
  134. package/dist/projections/graphs/views/GraphViewReason.d.ts.map +1 -0
  135. package/dist/projections/graphs/views/GraphViewReason.js +36 -0
  136. package/dist/projections/graphs/views/GraphViewReason.js.map +1 -0
  137. package/dist/projections/graphs/views/GraphViewRelationMember.d.ts +21 -0
  138. package/dist/projections/graphs/views/GraphViewRelationMember.d.ts.map +1 -0
  139. package/dist/projections/graphs/views/GraphViewRelationMember.js +4 -0
  140. package/dist/projections/graphs/views/GraphViewRelationMember.js.map +1 -0
  141. package/dist/projections/graphs/views/GraphViewSchema.d.ts +10 -0
  142. package/dist/projections/graphs/views/GraphViewSchema.d.ts.map +1 -0
  143. package/dist/projections/graphs/views/GraphViewSchema.js +4 -0
  144. package/dist/projections/graphs/views/GraphViewSchema.js.map +1 -0
  145. package/dist/projections/graphs/views/GraphViewSchemaEdge.d.ts +14 -0
  146. package/dist/projections/graphs/views/GraphViewSchemaEdge.d.ts.map +1 -0
  147. package/dist/projections/graphs/views/GraphViewSchemaEdge.js +4 -0
  148. package/dist/projections/graphs/views/GraphViewSchemaEdge.js.map +1 -0
  149. package/dist/projections/graphs/views/GraphViewSchemaNode.d.ts +10 -0
  150. package/dist/projections/graphs/views/GraphViewSchemaNode.d.ts.map +1 -0
  151. package/dist/projections/graphs/views/GraphViewSchemaNode.js +4 -0
  152. package/dist/projections/graphs/views/GraphViewSchemaNode.js.map +1 -0
  153. package/dist/projections/graphs/views/GraphViewSerializerOptions.d.ts +9 -0
  154. package/dist/projections/graphs/views/GraphViewSerializerOptions.d.ts.map +1 -0
  155. package/dist/projections/graphs/views/GraphViewSerializerOptions.js +4 -0
  156. package/dist/projections/graphs/views/GraphViewSerializerOptions.js.map +1 -0
  157. package/dist/projections/graphs/views/RecursiveView.d.ts +15 -0
  158. package/dist/projections/graphs/views/RecursiveView.d.ts.map +1 -0
  159. package/dist/projections/graphs/views/RecursiveView.js +20 -0
  160. package/dist/projections/graphs/views/RecursiveView.js.map +1 -0
  161. package/dist/projections/graphs/views/RelationTargetNotAView.d.ts +16 -0
  162. package/dist/projections/graphs/views/RelationTargetNotAView.d.ts.map +1 -0
  163. package/dist/projections/graphs/views/RelationTargetNotAView.js +21 -0
  164. package/dist/projections/graphs/views/RelationTargetNotAView.js.map +1 -0
  165. package/dist/projections/graphs/views/TargetLabelMismatch.d.ts +18 -0
  166. package/dist/projections/graphs/views/TargetLabelMismatch.d.ts.map +1 -0
  167. package/dist/projections/graphs/views/TargetLabelMismatch.js +23 -0
  168. package/dist/projections/graphs/views/TargetLabelMismatch.js.map +1 -0
  169. package/dist/projections/graphs/views/UnknownEdge.d.ts +16 -0
  170. package/dist/projections/graphs/views/UnknownEdge.d.ts.map +1 -0
  171. package/dist/projections/graphs/views/UnknownEdge.js +21 -0
  172. package/dist/projections/graphs/views/UnknownEdge.js.map +1 -0
  173. package/dist/projections/graphs/views/UnknownEdgeProperty.d.ts +17 -0
  174. package/dist/projections/graphs/views/UnknownEdgeProperty.d.ts.map +1 -0
  175. package/dist/projections/graphs/views/UnknownEdgeProperty.js +22 -0
  176. package/dist/projections/graphs/views/UnknownEdgeProperty.js.map +1 -0
  177. package/dist/projections/graphs/views/UnknownNodeProperty.d.ts +17 -0
  178. package/dist/projections/graphs/views/UnknownNodeProperty.d.ts.map +1 -0
  179. package/dist/projections/graphs/views/UnknownNodeProperty.js +22 -0
  180. package/dist/projections/graphs/views/UnknownNodeProperty.js.map +1 -0
  181. package/dist/projections/graphs/views/ViewIsAlsoSchema.d.ts +14 -0
  182. package/dist/projections/graphs/views/ViewIsAlsoSchema.d.ts.map +1 -0
  183. package/dist/projections/graphs/views/ViewIsAlsoSchema.js +19 -0
  184. package/dist/projections/graphs/views/ViewIsAlsoSchema.js.map +1 -0
  185. package/dist/projections/graphs/views/ViewOfMetadata.d.ts +8 -0
  186. package/dist/projections/graphs/views/ViewOfMetadata.d.ts.map +1 -0
  187. package/dist/projections/graphs/views/ViewOfMetadata.js +4 -0
  188. package/dist/projections/graphs/views/ViewOfMetadata.js.map +1 -0
  189. package/dist/projections/graphs/views/ViewOfOptions.d.ts +6 -0
  190. package/dist/projections/graphs/views/ViewOfOptions.d.ts.map +1 -0
  191. package/dist/projections/graphs/views/ViewOfOptions.js +4 -0
  192. package/dist/projections/graphs/views/ViewOfOptions.js.map +1 -0
  193. package/dist/projections/graphs/views/ViewRootNotANode.d.ts +16 -0
  194. package/dist/projections/graphs/views/ViewRootNotANode.d.ts.map +1 -0
  195. package/dist/projections/graphs/views/ViewRootNotANode.js +21 -0
  196. package/dist/projections/graphs/views/ViewRootNotANode.js.map +1 -0
  197. package/dist/projections/graphs/views/declareGraphViewMember.d.ts +17 -0
  198. package/dist/projections/graphs/views/declareGraphViewMember.d.ts.map +1 -0
  199. package/dist/projections/graphs/views/declareGraphViewMember.js +31 -0
  200. package/dist/projections/graphs/views/declareGraphViewMember.js.map +1 -0
  201. package/dist/projections/graphs/views/follows.d.ts +13 -0
  202. package/dist/projections/graphs/views/follows.d.ts.map +1 -0
  203. package/dist/projections/graphs/views/follows.js +24 -0
  204. package/dist/projections/graphs/views/follows.js.map +1 -0
  205. package/dist/projections/graphs/views/fromEdge.d.ts +10 -0
  206. package/dist/projections/graphs/views/fromEdge.d.ts.map +1 -0
  207. package/dist/projections/graphs/views/fromEdge.js +15 -0
  208. package/dist/projections/graphs/views/fromEdge.js.map +1 -0
  209. package/dist/projections/graphs/views/index.d.ts +41 -0
  210. package/dist/projections/graphs/views/index.d.ts.map +1 -0
  211. package/dist/projections/graphs/views/index.js +28 -0
  212. package/dist/projections/graphs/views/index.js.map +1 -0
  213. package/dist/projections/graphs/views/viewKey.d.ts +8 -0
  214. package/dist/projections/graphs/views/viewKey.d.ts.map +1 -0
  215. package/dist/projections/graphs/views/viewKey.js +13 -0
  216. package/dist/projections/graphs/views/viewKey.js.map +1 -0
  217. package/dist/projections/graphs/views/viewOf.d.ts +22 -0
  218. package/dist/projections/graphs/views/viewOf.d.ts.map +1 -0
  219. package/dist/projections/graphs/views/viewOf.js +41 -0
  220. package/dist/projections/graphs/views/viewOf.js.map +1 -0
  221. package/dist/projections/graphs/views/viewProperty.d.ts +9 -0
  222. package/dist/projections/graphs/views/viewProperty.d.ts.map +1 -0
  223. package/dist/projections/graphs/views/viewProperty.js +14 -0
  224. package/dist/projections/graphs/views/viewProperty.js.map +1 -0
  225. package/dist/reactors/Reactors.d.ts +15 -5
  226. package/dist/reactors/Reactors.d.ts.map +1 -1
  227. package/dist/reactors/Reactors.js +95 -18
  228. package/dist/reactors/Reactors.js.map +1 -1
  229. package/dist/reactors/for_Reactors/when_reconnecting_the_observation_stream/given/a_reactor_whose_stream_ends.d.ts +26 -0
  230. package/dist/reactors/for_Reactors/when_reconnecting_the_observation_stream/given/a_reactor_whose_stream_ends.d.ts.map +1 -0
  231. package/dist/reactors/for_Reactors/when_reconnecting_the_observation_stream/given/a_reactor_whose_stream_ends.js +64 -0
  232. package/dist/reactors/for_Reactors/when_reconnecting_the_observation_stream/given/a_reactor_whose_stream_ends.js.map +1 -0
  233. package/dist/reducers/Reducers.d.ts +11 -5
  234. package/dist/reducers/Reducers.d.ts.map +1 -1
  235. package/dist/reducers/Reducers.js +93 -19
  236. package/dist/reducers/Reducers.js.map +1 -1
  237. package/dist/reducers/for_Reducers/when_reconnecting_the_observation_stream/given/a_reducer_whose_stream_ends.d.ts +25 -0
  238. package/dist/reducers/for_Reducers/when_reconnecting_the_observation_stream/given/a_reducer_whose_stream_ends.d.ts.map +1 -0
  239. package/dist/reducers/for_Reducers/when_reconnecting_the_observation_stream/given/a_reducer_whose_stream_ends.js +70 -0
  240. package/dist/reducers/for_Reducers/when_reconnecting_the_observation_stream/given/a_reducer_whose_stream_ends.js.map +1 -0
  241. package/dist/testing/InProcessAppendMetadata.d.ts +30 -0
  242. package/dist/testing/InProcessAppendMetadata.d.ts.map +1 -0
  243. package/dist/testing/InProcessAppendMetadata.js +107 -0
  244. package/dist/testing/InProcessAppendMetadata.js.map +1 -0
  245. package/dist/testing/InProcessBatchAppend.d.ts +62 -0
  246. package/dist/testing/InProcessBatchAppend.d.ts.map +1 -0
  247. package/dist/testing/InProcessBatchAppend.js +131 -0
  248. package/dist/testing/InProcessBatchAppend.js.map +1 -0
  249. package/dist/testing/InProcessEventPayload.d.ts +23 -0
  250. package/dist/testing/InProcessEventPayload.d.ts.map +1 -0
  251. package/dist/testing/InProcessEventPayload.js +94 -0
  252. package/dist/testing/InProcessEventPayload.js.map +1 -0
  253. package/dist/testing/InProcessEventReadCriteria.d.ts +9 -0
  254. package/dist/testing/InProcessEventReadCriteria.d.ts.map +1 -0
  255. package/dist/testing/InProcessEventReadCriteria.js +4 -0
  256. package/dist/testing/InProcessEventReadCriteria.js.map +1 -0
  257. package/dist/testing/InProcessEventReadFilter.d.ts +14 -0
  258. package/dist/testing/InProcessEventReadFilter.d.ts.map +1 -0
  259. package/dist/testing/InProcessEventReadFilter.js +31 -0
  260. package/dist/testing/InProcessEventReadFilter.js.map +1 -0
  261. package/dist/testing/InProcessEventSequence.d.ts +8 -5
  262. package/dist/testing/InProcessEventSequence.d.ts.map +1 -1
  263. package/dist/testing/InProcessEventSequence.js +59 -275
  264. package/dist/testing/InProcessEventSequence.js.map +1 -1
  265. package/dist/testing/InProcessEventSequenceEnvironment.d.ts +13 -0
  266. package/dist/testing/InProcessEventSequenceEnvironment.d.ts.map +1 -0
  267. package/dist/testing/InProcessEventSequenceEnvironment.js +4 -0
  268. package/dist/testing/InProcessEventSequenceEnvironment.js.map +1 -0
  269. package/dist/testing/InProcessSingleAppend.d.ts +34 -0
  270. package/dist/testing/InProcessSingleAppend.d.ts.map +1 -0
  271. package/dist/testing/InProcessSingleAppend.js +95 -0
  272. package/dist/testing/InProcessSingleAppend.js.map +1 -0
  273. package/dist/testing/projections/ProjectionCapabilities.d.ts +0 -8
  274. package/dist/testing/projections/ProjectionCapabilities.d.ts.map +1 -1
  275. package/dist/testing/projections/ProjectionCapabilities.js +21 -312
  276. package/dist/testing/projections/ProjectionCapabilities.js.map +1 -1
  277. package/dist/testing/projections/ProjectionCapabilityReject.d.ts +3 -0
  278. package/dist/testing/projections/ProjectionCapabilityReject.d.ts.map +1 -0
  279. package/dist/testing/projections/ProjectionCapabilityReject.js +4 -0
  280. package/dist/testing/projections/ProjectionCapabilityReject.js.map +1 -0
  281. package/dist/testing/projections/ProjectionCapabilityReporter.d.ts +12 -0
  282. package/dist/testing/projections/ProjectionCapabilityReporter.d.ts.map +1 -0
  283. package/dist/testing/projections/ProjectionCapabilityReporter.js +33 -0
  284. package/dist/testing/projections/ProjectionCapabilityReporter.js.map +1 -0
  285. package/dist/testing/projections/ProjectionDefinitionCapabilities.d.ts +11 -0
  286. package/dist/testing/projections/ProjectionDefinitionCapabilities.d.ts.map +1 -0
  287. package/dist/testing/projections/ProjectionDefinitionCapabilities.js +45 -0
  288. package/dist/testing/projections/ProjectionDefinitionCapabilities.js.map +1 -0
  289. package/dist/testing/projections/ProjectionEventSchemaResolver.d.ts +13 -0
  290. package/dist/testing/projections/ProjectionEventSchemaResolver.d.ts.map +1 -0
  291. package/dist/testing/projections/ProjectionEventSchemaResolver.js +22 -0
  292. package/dist/testing/projections/ProjectionEventSchemaResolver.js.map +1 -0
  293. package/dist/testing/projections/ProjectionExpressionCapabilities.d.ts +19 -0
  294. package/dist/testing/projections/ProjectionExpressionCapabilities.d.ts.map +1 -0
  295. package/dist/testing/projections/ProjectionExpressionCapabilities.js +103 -0
  296. package/dist/testing/projections/ProjectionExpressionCapabilities.js.map +1 -0
  297. package/dist/testing/projections/ProjectionInitialValueCapabilities.d.ts +16 -0
  298. package/dist/testing/projections/ProjectionInitialValueCapabilities.d.ts.map +1 -0
  299. package/dist/testing/projections/ProjectionInitialValueCapabilities.js +72 -0
  300. package/dist/testing/projections/ProjectionInitialValueCapabilities.js.map +1 -0
  301. package/dist/testing/projections/ProjectionMappingCapabilities.d.ts +21 -0
  302. package/dist/testing/projections/ProjectionMappingCapabilities.d.ts.map +1 -0
  303. package/dist/testing/projections/ProjectionMappingCapabilities.js +86 -0
  304. package/dist/testing/projections/ProjectionMappingCapabilities.js.map +1 -0
  305. package/dist/testing/projections/ProjectionMappingValidation.d.ts +9 -0
  306. package/dist/testing/projections/ProjectionMappingValidation.d.ts.map +1 -0
  307. package/dist/testing/projections/ProjectionMappingValidation.js +4 -0
  308. package/dist/testing/projections/ProjectionMappingValidation.js.map +1 -0
  309. package/dist/testing/projections/ProjectionReadModelCapabilities.d.ts +11 -0
  310. package/dist/testing/projections/ProjectionReadModelCapabilities.d.ts.map +1 -0
  311. package/dist/testing/projections/ProjectionReadModelCapabilities.js +40 -0
  312. package/dist/testing/projections/ProjectionReadModelCapabilities.js.map +1 -0
  313. package/dist/testing/projections/ProjectionRootCapabilities.d.ts +20 -0
  314. package/dist/testing/projections/ProjectionRootCapabilities.d.ts.map +1 -0
  315. package/dist/testing/projections/ProjectionRootCapabilities.js +73 -0
  316. package/dist/testing/projections/ProjectionRootCapabilities.js.map +1 -0
  317. package/dist/testing/projections/ProjectionScalarConverter.d.ts +21 -0
  318. package/dist/testing/projections/ProjectionScalarConverter.d.ts.map +1 -0
  319. package/dist/testing/projections/ProjectionScalarConverter.js +105 -0
  320. package/dist/testing/projections/ProjectionScalarConverter.js.map +1 -0
  321. package/dist/testing/projections/ProjectionSchemaCapabilities.d.ts +26 -0
  322. package/dist/testing/projections/ProjectionSchemaCapabilities.d.ts.map +1 -0
  323. package/dist/testing/projections/ProjectionSchemaCapabilities.js +109 -0
  324. package/dist/testing/projections/ProjectionSchemaCapabilities.js.map +1 -0
  325. package/dist/testing/projections/ProjectionValueConverter.d.ts +5 -0
  326. package/dist/testing/projections/ProjectionValueConverter.d.ts.map +1 -1
  327. package/dist/testing/projections/ProjectionValueConverter.js +36 -84
  328. package/dist/testing/projections/ProjectionValueConverter.js.map +1 -1
  329. package/dist/tsconfig.tsbuildinfo +1 -1
  330. package/dist/types/DecoratorType.d.ts +3 -1
  331. package/dist/types/DecoratorType.d.ts.map +1 -1
  332. package/dist/types/DecoratorType.js +2 -0
  333. package/dist/types/DecoratorType.js.map +1 -1
  334. package/for_ChronicleClient/when_reconnecting/and_an_observation_stream_lost_its_session.spec.ts +212 -0
  335. package/observation/ObservationReconnectBackoff.ts +109 -0
  336. package/observation/ObservationStreamOutcome.ts +12 -0
  337. package/observation/classifyStreamError.ts +67 -0
  338. package/observation/for_ObservationReconnectBackoff/given/a_backoff.ts +29 -0
  339. package/observation/for_ObservationReconnectBackoff/given/a_scripted_stream.ts +52 -0
  340. package/observation/for_ObservationReconnectBackoff/when_a_stream_delivered_before_it_ended.spec.ts +23 -0
  341. package/observation/for_ObservationReconnectBackoff/when_a_stream_stayed_open_before_it_ended.spec.ts +25 -0
  342. package/observation/for_ObservationReconnectBackoff/when_jittering_the_delay.spec.ts +24 -0
  343. package/observation/for_ObservationReconnectBackoff/when_streams_keep_ending_without_working.spec.ts +24 -0
  344. package/observation/for_ObservationReconnectBackoff/when_the_base_delay_is_not_positive.spec.ts +18 -0
  345. package/observation/for_ObservationReconnectBackoff/when_the_settings_are_not_finite.spec.ts +32 -0
  346. package/observation/for_ObservationReconnectBackoff/when_using_the_defaults.spec.ts +29 -0
  347. package/observation/for_classifyStreamError/when_classifying_a_stream_error.spec.ts +36 -0
  348. package/package.json +2 -2
  349. package/projections/for_Graphs/given/a_discovered_graph.ts +3 -2
  350. package/projections/for_Graphs/given/a_graph_with_views.ts +91 -0
  351. package/projections/for_Graphs/given/organization.ts +3 -2
  352. package/projections/for_Graphs/given/organization_with_views.fixture.ts +129 -0
  353. package/projections/for_Graphs/when_building_graph_views.spec.ts +218 -0
  354. package/projections/for_Graphs/when_declaring_an_invalid_graph_view.spec.ts +229 -0
  355. package/projections/for_Graphs/when_declaring_graph_views.standard.spec.ts +49 -0
  356. package/projections/for_Graphs/when_discovering_graph_views.spec.ts +58 -0
  357. package/projections/graphs/Graphs.ts +44 -0
  358. package/projections/graphs/IGraphs.ts +10 -2
  359. package/projections/graphs/index.ts +1 -0
  360. package/projections/graphs/views/AmbiguousDirection.ts +23 -0
  361. package/projections/graphs/views/DuplicateViewName.ts +23 -0
  362. package/projections/graphs/views/EdgeNotIncidentOnRoot.ts +24 -0
  363. package/projections/graphs/views/EdgePropertyViewNotUsedAsTarget.ts +21 -0
  364. package/projections/graphs/views/EdgePropertyViewSharedAcrossEdges.ts +22 -0
  365. package/projections/graphs/views/FollowsOptions.ts +20 -0
  366. package/projections/graphs/views/GraphEdgeDirection.ts +13 -0
  367. package/projections/graphs/views/GraphView.ts +18 -0
  368. package/projections/graphs/views/GraphViewBuildResult.ts +19 -0
  369. package/projections/graphs/views/GraphViewCardinality.ts +13 -0
  370. package/projections/graphs/views/GraphViewDefinition.ts +20 -0
  371. package/projections/graphs/views/GraphViewDefinitionBuilder.ts +322 -0
  372. package/projections/graphs/views/GraphViewDefinitionSerializer.ts +90 -0
  373. package/projections/graphs/views/GraphViewEdgeReference.ts +8 -0
  374. package/projections/graphs/views/GraphViewMember.ts +11 -0
  375. package/projections/graphs/views/GraphViewMemberKind.ts +16 -0
  376. package/projections/graphs/views/GraphViewMemberMetadata.ts +31 -0
  377. package/projections/graphs/views/GraphViewPropertyMember.ts +18 -0
  378. package/projections/graphs/views/GraphViewReason.ts +47 -0
  379. package/projections/graphs/views/GraphViewRelationMember.ts +29 -0
  380. package/projections/graphs/views/GraphViewSchema.ts +14 -0
  381. package/projections/graphs/views/GraphViewSchemaEdge.ts +20 -0
  382. package/projections/graphs/views/GraphViewSchemaNode.ts +14 -0
  383. package/projections/graphs/views/GraphViewSerializerOptions.ts +11 -0
  384. package/projections/graphs/views/RecursiveView.ts +22 -0
  385. package/projections/graphs/views/RelationTargetNotAView.ts +23 -0
  386. package/projections/graphs/views/TargetLabelMismatch.ts +25 -0
  387. package/projections/graphs/views/UnknownEdge.ts +23 -0
  388. package/projections/graphs/views/UnknownEdgeProperty.ts +24 -0
  389. package/projections/graphs/views/UnknownNodeProperty.ts +24 -0
  390. package/projections/graphs/views/ViewIsAlsoSchema.ts +21 -0
  391. package/projections/graphs/views/ViewOfMetadata.ts +11 -0
  392. package/projections/graphs/views/ViewOfOptions.ts +8 -0
  393. package/projections/graphs/views/ViewRootNotANode.ts +23 -0
  394. package/projections/graphs/views/declareGraphViewMember.ts +36 -0
  395. package/projections/graphs/views/follows.ts +28 -0
  396. package/projections/graphs/views/fromEdge.ts +17 -0
  397. package/projections/graphs/views/index.ts +43 -0
  398. package/projections/graphs/views/viewKey.ts +15 -0
  399. package/projections/graphs/views/viewOf.ts +50 -0
  400. package/projections/graphs/views/viewProperty.ts +16 -0
  401. package/reactors/Reactors.ts +101 -18
  402. package/reactors/for_Reactors/when_reconnecting_the_observation_stream/and_a_handler_failed_with_a_lost_session.spec.ts +32 -0
  403. package/reactors/for_Reactors/when_reconnecting_the_observation_stream/and_a_replaced_stream_fails_late.spec.ts +28 -0
  404. package/reactors/for_Reactors/when_reconnecting_the_observation_stream/and_a_stream_delivered_before_it_ended.spec.ts +24 -0
  405. package/reactors/for_Reactors/when_reconnecting_the_observation_stream/and_a_stream_stayed_open_before_it_ended.spec.ts +23 -0
  406. package/reactors/for_Reactors/when_reconnecting_the_observation_stream/and_it_is_disposed_while_waiting_to_reopen.spec.ts +27 -0
  407. package/reactors/for_Reactors/when_reconnecting_the_observation_stream/and_streams_keep_ending_without_working.spec.ts +24 -0
  408. package/reactors/for_Reactors/when_reconnecting_the_observation_stream/and_the_client_reconnected_after_streams_kept_ending.spec.ts +24 -0
  409. package/reactors/for_Reactors/when_reconnecting_the_observation_stream/and_the_client_reconnected_while_waiting_to_reopen.spec.ts +25 -0
  410. package/reactors/for_Reactors/when_reconnecting_the_observation_stream/and_the_kernel_lost_the_session.spec.ts +24 -0
  411. package/reactors/for_Reactors/when_reconnecting_the_observation_stream/given/a_reactor_whose_stream_ends.ts +69 -0
  412. package/reducers/Reducers.ts +99 -19
  413. package/reducers/for_Reducers/when_reconnecting_the_observation_stream/and_a_reducer_failed_with_a_lost_session.spec.ts +33 -0
  414. package/reducers/for_Reducers/when_reconnecting_the_observation_stream/and_a_replaced_stream_fails_late.spec.ts +28 -0
  415. package/reducers/for_Reducers/when_reconnecting_the_observation_stream/and_a_stream_delivered_before_it_ended.spec.ts +24 -0
  416. package/reducers/for_Reducers/when_reconnecting_the_observation_stream/and_a_stream_stayed_open_before_it_ended.spec.ts +23 -0
  417. package/reducers/for_Reducers/when_reconnecting_the_observation_stream/and_it_is_disposed_while_waiting_to_reopen.spec.ts +27 -0
  418. package/reducers/for_Reducers/when_reconnecting_the_observation_stream/and_streams_keep_ending_without_working.spec.ts +24 -0
  419. package/reducers/for_Reducers/when_reconnecting_the_observation_stream/and_the_client_reconnected_after_streams_kept_ending.spec.ts +24 -0
  420. package/reducers/for_Reducers/when_reconnecting_the_observation_stream/and_the_client_reconnected_while_waiting_to_reopen.spec.ts +25 -0
  421. package/reducers/for_Reducers/when_reconnecting_the_observation_stream/and_the_kernel_lost_the_session.spec.ts +24 -0
  422. package/reducers/for_Reducers/when_reconnecting_the_observation_stream/given/a_reducer_whose_stream_ends.ts +69 -0
  423. package/testing/InProcessAppendMetadata.ts +119 -0
  424. package/testing/InProcessBatchAppend.ts +142 -0
  425. package/testing/InProcessEventPayload.ts +100 -0
  426. package/testing/InProcessEventReadCriteria.ts +11 -0
  427. package/testing/InProcessEventReadFilter.ts +37 -0
  428. package/testing/InProcessEventSequence.ts +63 -257
  429. package/testing/InProcessEventSequenceEnvironment.ts +16 -0
  430. package/testing/InProcessSingleAppend.ts +99 -0
  431. package/testing/for_InProcessEventSequence/when_preserving_validation_and_commit_order.spec.ts +95 -0
  432. package/testing/projections/ProjectionCapabilities.ts +23 -279
  433. package/testing/projections/ProjectionCapabilityReject.ts +5 -0
  434. package/testing/projections/ProjectionCapabilityReporter.ts +31 -0
  435. package/testing/projections/ProjectionDefinitionCapabilities.ts +45 -0
  436. package/testing/projections/ProjectionEventSchemaResolver.ts +23 -0
  437. package/testing/projections/ProjectionExpressionCapabilities.ts +101 -0
  438. package/testing/projections/ProjectionInitialValueCapabilities.ts +73 -0
  439. package/testing/projections/ProjectionMappingCapabilities.ts +85 -0
  440. package/testing/projections/ProjectionMappingValidation.ts +12 -0
  441. package/testing/projections/ProjectionReadModelCapabilities.ts +42 -0
  442. package/testing/projections/ProjectionRootCapabilities.ts +75 -0
  443. package/testing/projections/ProjectionScalarConverter.ts +106 -0
  444. package/testing/projections/ProjectionSchemaCapabilities.ts +112 -0
  445. package/testing/projections/ProjectionValueConverter.ts +37 -76
  446. package/testing/projections/for_ProjectionCapabilities/when_reporting_the_first_unsupported_operation.spec.ts +74 -0
  447. package/testing/projections/for_ProjectionValueConverter/when_converting_structured_and_scalar_values.spec.ts +64 -0
  448. package/types/DecoratorType.ts +4 -1
@@ -0,0 +1,58 @@
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 { chai, describe, it } from 'vitest';
6
+ import { DefaultClientArtifactsProvider } from '../../artifacts/DefaultClientArtifactsProvider.js';
7
+ import { rootReadModelTypes } from '../../readModels/rootReadModelTypes.js';
8
+ import { TypeDiscoverer } from '../../types/index.js';
9
+ import { graph } from '../graphs/graph.js';
10
+ import { viewKey } from '../graphs/views/viewKey.js';
11
+ import { viewOf } from '../graphs/views/viewOf.js';
12
+ import { discoverGraphs } from './given/a_discovered_graph.js';
13
+ import { aView, anOrganization } from './given/a_graph_with_views.js';
14
+ import { GroupSummary, MemberSummary, organizationViews, Person } from './given/organization_with_views.fixture.js';
15
+
16
+ chai.should();
17
+
18
+ describe('when discovering the artifacts of an application with graph views', () => {
19
+ const provider = new DefaultClientArtifactsProvider(TypeDiscoverer.default);
20
+
21
+ it('should find the views', () => {
22
+ provider.graphViews.should.include.members(organizationViews);
23
+ });
24
+ it('should not find a view among the nodes and edges', () => {
25
+ provider.graphElements.should.not.include.members(organizationViews);
26
+ });
27
+ it('should not treat a view as a read model', () => {
28
+ provider.readModels.should.not.include.members(organizationViews);
29
+ rootReadModelTypes(provider).should.not.include.members(organizationViews);
30
+ provider.graphElements.should.include.members([Person]);
31
+ });
32
+ it('should build the definition from what it finds', async () => {
33
+ const result = await discoverGraphs(provider.graphElements, [], 'Neo4j', provider.graphViews);
34
+ result.graphs.failures.size.should.equal(0);
35
+ result.graphs.viewDefinitions.map(_ => _.graph).should.deep.equal(['Organization']);
36
+ result.graphs.viewDefinitions[0].views.map(view => view.name).should.include.members([GroupSummary.name, MemberSummary.name]);
37
+ });
38
+ });
39
+
40
+ describe('when views of different graphs have the same class name', () => {
41
+ it('should discover both', () => {
42
+ const first = anOrganization('FirstGraph');
43
+ const second = anOrganization('SecondGraph');
44
+ const one = aView(first.graphName, 'SharedName', () => first.Person, ['id', viewKey()]);
45
+ const other = aView(second.graphName, 'SharedName', () => second.Person, ['id', viewKey()]);
46
+ const found = new DefaultClientArtifactsProvider(TypeDiscoverer.default).graphViews;
47
+ found.should.include.members([one, other]);
48
+ });
49
+
50
+ it('should discover a class once however often it is decorated', () => {
51
+ const organization = anOrganization('Redecorated');
52
+ class Once { id = ''; }
53
+ graph(organization.graphName)(Once);
54
+ viewOf(() => organization.Person)(Once);
55
+ viewOf(() => organization.Person)(Once);
56
+ new DefaultClientArtifactsProvider(TypeDiscoverer.default).graphViews.filter(type => type === Once).should.have.lengthOf(1);
57
+ });
58
+ });
@@ -22,6 +22,10 @@ import { getEdgeMetadata } from './edge.js';
22
22
  import { getGraphProjectionMetadata } from './graphProjection.js';
23
23
  import { getNodeMetadata } from './node.js';
24
24
  import { ModelBoundGraphReader } from './ModelBoundGraphReader.js';
25
+ import type { GraphViewDefinition } from './views/GraphViewDefinition.js';
26
+ import { GraphViewDefinitionBuilder } from './views/GraphViewDefinitionBuilder.js';
27
+ import { getViewOfMetadata } from './views/viewOf.js';
28
+ import { ViewRootNotANode } from './views/ViewRootNotANode.js';
25
29
 
26
30
  interface DeclaredGraph {
27
31
  readonly source: Constructor;
@@ -37,6 +41,7 @@ export class Graphs implements IGraphs {
37
41
  private readonly _failures = new Map<Constructor, Error>();
38
42
  private readonly _logger: ReturnType<typeof createLogger>;
39
43
  private _registrations: readonly GraphRegistration[] = [];
44
+ private _viewDefinitions: readonly GraphViewDefinition[] = [];
40
45
 
41
46
  /**
42
47
  * Creates a new {@link Graphs} instance.
@@ -59,6 +64,11 @@ export class Graphs implements IGraphs {
59
64
  return this._registrations;
60
65
  }
61
66
 
67
+ /** @inheritdoc */
68
+ get viewDefinitions(): readonly GraphViewDefinition[] {
69
+ return this._viewDefinitions;
70
+ }
71
+
62
72
  /** @inheritdoc */
63
73
  get failures(): ReadonlyMap<Constructor, Error> {
64
74
  return this._failures;
@@ -70,17 +80,20 @@ export class Graphs implements IGraphs {
70
80
  const builder = new GraphDefinitionBuilder();
71
81
  const registrations: GraphRegistration[] = [];
72
82
  const names = new Set<string>();
83
+ const models = new Map<string, GraphModel>();
73
84
  for (const declared of [...this.modelBoundGraphs(), ...this.fluentGraphs()]) {
74
85
  try {
75
86
  if (names.has(declared.model.name)) throw new GraphDeclaredMoreThanOnce(declared.model.name);
76
87
  registrations.push(builder.build(declared.model, declared.projectionId, this._graphSinkTypeId));
77
88
  names.add(declared.model.name);
89
+ models.set(declared.model.name, declared.model);
78
90
  } catch (error) {
79
91
  this.fail(declared.source, error);
80
92
  }
81
93
  }
82
94
 
83
95
  this._registrations = registrations;
96
+ this._viewDefinitions = this.discoverViews(models);
84
97
  this._logger.debug('Graph discovery complete', { graphCount: registrations.length, failureCount: this._failures.size });
85
98
  }
86
99
 
@@ -149,6 +162,37 @@ export class Graphs implements IGraphs {
149
162
  return result;
150
163
  }
151
164
 
165
+ private discoverViews(models: ReadonlyMap<string, GraphModel>): GraphViewDefinition[] {
166
+ const byGraph = new Map<string, Constructor[]>();
167
+ for (const type of this._clientArtifacts.graphViews ?? []) {
168
+ this.tryRead(type, () => {
169
+ const graph = ModelBoundGraphReader.graphNameOf(type);
170
+ byGraph.set(graph, [...(byGraph.get(graph) ?? []), type]);
171
+ });
172
+ }
173
+
174
+ const builder = new GraphViewDefinitionBuilder();
175
+ const definitions: GraphViewDefinition[] = [];
176
+ for (const [graph, views] of byGraph) {
177
+ const model = models.get(graph);
178
+ if (model === undefined) {
179
+ // The graph is not registered, so a view has nothing to read. Why is reported for the graph itself.
180
+ for (const view of views) this.tryRead(view, () => { throw new ViewRootNotANode(view, graph, getViewOfMetadata(view)!.root()); });
181
+ continue;
182
+ }
183
+
184
+ try {
185
+ const result = builder.build(model, views);
186
+ for (const [view, failure] of result.failures) this.fail(view, failure);
187
+ if (result.definition !== undefined) definitions.push(result.definition);
188
+ } catch (error) {
189
+ for (const view of views) this.fail(view, error);
190
+ }
191
+ }
192
+
193
+ return definitions;
194
+ }
195
+
152
196
  private tryRead(type: Constructor, read: () => void): void {
153
197
  try {
154
198
  read();
@@ -3,6 +3,7 @@
3
3
 
4
4
  import type { Constructor } from '@cratis/fundamentals';
5
5
  import type { GraphRegistration } from './GraphRegistration.js';
6
+ import type { GraphViewDefinition } from './views/GraphViewDefinition.js';
6
7
 
7
8
  /**
8
9
  * Defines a system for the property graphs an application declares, with the decorators and with the fluent builder,
@@ -13,8 +14,15 @@ export interface IGraphs {
13
14
  readonly registrations: readonly GraphRegistration[];
14
15
 
15
16
  /**
16
- * Gets the declarations that could not be turned into a registration, and why. One invalid graph does not
17
- * take the rest of the graphs down with it.
17
+ * Gets the definitions of the views declared over the graphs, one per graph that has views, as found by the last
18
+ * call to {@link IGraphs.discover}. The definitions are not registered with the kernel. Optional so
19
+ * implementations written before graph views keep working.
20
+ */
21
+ readonly viewDefinitions?: readonly GraphViewDefinition[];
22
+
23
+ /**
24
+ * Gets the declarations that could not be turned into a registration, and why, including views that break
25
+ * the rules of a view. One invalid graph or view does not take the rest of the graphs down with it.
18
26
  */
19
27
  readonly failures: ReadonlyMap<Constructor, Error>;
20
28
 
@@ -49,3 +49,4 @@ export { GraphKeyPropertyNotFound } from './GraphKeyPropertyNotFound.js';
49
49
  export { GraphElementCannotBeReadModel } from './GraphElementCannotBeReadModel.js';
50
50
  export { GraphHasDuplicateElement } from './GraphHasDuplicateElement.js';
51
51
  export { GraphDeclaredMoreThanOnce } from './GraphDeclaredMoreThanOnce.js';
52
+ export * from './views/index.js';
@@ -0,0 +1,23 @@
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 { GraphViewReason } from './GraphViewReason.js';
5
+
6
+ /**
7
+ * Error raised when a relation follows an edge that starts and ends at the same label without saying in which direction.
8
+ */
9
+ export class AmbiguousDirection extends Error {
10
+ /** The stable reason code of the rule that was broken. */
11
+ readonly reason = GraphViewReason.AmbiguousDirection;
12
+
13
+ /**
14
+ * Creates a new {@link AmbiguousDirection}.
15
+ * @param view - The view type.
16
+ * @param member - The name of the member.
17
+ * @param edge - The edge type.
18
+ */
19
+ constructor(view: Function, member: string, edge: string) {
20
+ super(`The member '${member}' of the view '${view.name}' follows '${edge}', which starts and ends at the same label. State the direction.`);
21
+ this.name = 'AmbiguousDirection';
22
+ }
23
+ }
@@ -0,0 +1,23 @@
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 { GraphViewReason } from './GraphViewReason.js';
5
+
6
+ /**
7
+ * Error raised when two views of a graph have the same name.
8
+ */
9
+ export class DuplicateViewName extends Error {
10
+ /** The stable reason code of the rule that was broken. */
11
+ readonly reason = GraphViewReason.DuplicateViewName;
12
+
13
+ /**
14
+ * Creates a new {@link DuplicateViewName}.
15
+ * @param view - The view type that repeats the name.
16
+ * @param graph - The name of the graph.
17
+ * @param name - The name of the view.
18
+ */
19
+ constructor(view: Function, graph: string, name: string) {
20
+ super(`The view '${view.name}' repeats the view name '${name}' in the graph '${graph}'. Give it another name with viewOf.`);
21
+ this.name = 'DuplicateViewName';
22
+ }
23
+ }
@@ -0,0 +1,24 @@
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 { GraphViewReason } from './GraphViewReason.js';
5
+
6
+ /**
7
+ * Error raised when a relation follows an edge that does not start or end at the root of the view.
8
+ */
9
+ export class EdgeNotIncidentOnRoot extends Error {
10
+ /** The stable reason code of the rule that was broken. */
11
+ readonly reason = GraphViewReason.EdgeNotIncidentOnRoot;
12
+
13
+ /**
14
+ * Creates a new {@link EdgeNotIncidentOnRoot}.
15
+ * @param view - The view type.
16
+ * @param member - The name of the member.
17
+ * @param edge - The edge type.
18
+ * @param root - The label of the root of the view.
19
+ */
20
+ constructor(view: Function, member: string, edge: string, root: string) {
21
+ super(`The member '${member}' of the view '${view.name}' follows '${edge}' in a direction that does not start at '${root}', the root of the view.`);
22
+ this.name = 'EdgeNotIncidentOnRoot';
23
+ }
24
+ }
@@ -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 { GraphViewReason } from './GraphViewReason.js';
5
+
6
+ /**
7
+ * Error raised when a view with edge property members is not the target of any relation.
8
+ */
9
+ export class EdgePropertyViewNotUsedAsTarget extends Error {
10
+ /** The stable reason code of the rule that was broken. */
11
+ readonly reason = GraphViewReason.EdgePropertyViewNotUsedAsTarget;
12
+
13
+ /**
14
+ * Creates a new {@link EdgePropertyViewNotUsedAsTarget}.
15
+ * @param view - The view type.
16
+ */
17
+ constructor(view: Function) {
18
+ super(`The view '${view.name}' has members that read edge properties, but no relation yields it, so there is no edge to read them from.`);
19
+ this.name = 'EdgePropertyViewNotUsedAsTarget';
20
+ }
21
+ }
@@ -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 { GraphViewReason } from './GraphViewReason.js';
5
+
6
+ /**
7
+ * Error raised when a view with edge property members is the target of relations of more than one edge type.
8
+ */
9
+ export class EdgePropertyViewSharedAcrossEdges extends Error {
10
+ /** The stable reason code of the rule that was broken. */
11
+ readonly reason = GraphViewReason.EdgePropertyViewSharedAcrossEdges;
12
+
13
+ /**
14
+ * Creates a new {@link EdgePropertyViewSharedAcrossEdges}.
15
+ * @param view - The view type.
16
+ * @param edges - The edge types of the relations that yield the view.
17
+ */
18
+ constructor(view: Function, edges: readonly string[]) {
19
+ super(`The view '${view.name}' has members that read edge properties, but relations of more than one edge type yield it (${edges.join(', ')}). Use one view per edge type.`);
20
+ this.name = 'EdgePropertyViewSharedAcrossEdges';
21
+ }
22
+ }
@@ -0,0 +1,20 @@
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 { GraphEdgeDirection } from './GraphEdgeDirection.js';
5
+ import type { GraphViewCardinality } from './GraphViewCardinality.js';
6
+
7
+ /** Options of the follows decorator. */
8
+ export interface FollowsOptions {
9
+ /**
10
+ * Whether the relation yields a list or a single item. TypeScript erases generic arguments, so the type of the
11
+ * member cannot say which one it is. Defaults to {@link GraphViewCardinality.Many}.
12
+ */
13
+ readonly cardinality?: GraphViewCardinality;
14
+
15
+ /**
16
+ * The direction in which the edge is followed. It is derived from the labels of the edge, except for an edge
17
+ * that starts and ends at the same label, which needs it to be stated.
18
+ */
19
+ readonly direction?: GraphEdgeDirection;
20
+ }
@@ -0,0 +1,13 @@
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 the direction in which a relation follows an edge, seen from the root node of the view.
6
+ */
7
+ export enum GraphEdgeDirection {
8
+ /** The root node is the source of the edge. */
9
+ Outgoing = 'outgoing',
10
+
11
+ /** The root node is the target of the edge. */
12
+ Incoming = 'incoming'
13
+ }
@@ -0,0 +1,18 @@
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 { GraphViewMember } from './GraphViewMember.js';
5
+
6
+ /**
7
+ * Represents a view over a graph as it is declared: anchored at one node label, with its members in declaration order.
8
+ */
9
+ export interface GraphView {
10
+ /** The name of the view, unique in its graph. */
11
+ readonly name: string;
12
+
13
+ /** The label of the node the view is anchored at. */
14
+ readonly root: string;
15
+
16
+ /** The members of the view, in the order they are declared. */
17
+ readonly members: readonly GraphViewMember[];
18
+ }
@@ -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 { Constructor } from '@cratis/fundamentals';
5
+ import type { GraphViewDefinition } from './GraphViewDefinition.js';
6
+
7
+ /**
8
+ * Represents the outcome of building the views of one graph.
9
+ */
10
+ export interface GraphViewBuildResult {
11
+ /**
12
+ * The definition of the views. It is missing when any view of the graph is invalid: a view can be read only
13
+ * together with the views it nests, so the views of a graph are emitted together or not at all.
14
+ */
15
+ readonly definition?: GraphViewDefinition;
16
+
17
+ /** The views that are invalid, and why. The error of each carries the reason code. */
18
+ readonly failures: ReadonlyMap<Constructor, Error>;
19
+ }
@@ -0,0 +1,13 @@
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 many related items a relation of a graph view yields.
6
+ */
7
+ export enum GraphViewCardinality {
8
+ /** A list of related items. A relation without any related node yields an empty list. */
9
+ Many = 'many',
10
+
11
+ /** A single related item. A relation without any related node yields null. */
12
+ One = 'one'
13
+ }
@@ -0,0 +1,20 @@
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 { GraphView } from './GraphView.js';
5
+ import type { GraphViewSchema } from './GraphViewSchema.js';
6
+
7
+ /**
8
+ * Represents the views declared over a graph. It is the transport and conformance form of the views, shared by the
9
+ * Cratis clients: it is emitted from the declarations, never written by hand.
10
+ */
11
+ export interface GraphViewDefinition {
12
+ /** The name of the graph the views read. */
13
+ readonly graph: string;
14
+
15
+ /** The nodes and edges the views were validated against. It is written only when the serializer is asked to. */
16
+ readonly schema?: GraphViewSchema;
17
+
18
+ /** The views, sorted by name. */
19
+ readonly views: readonly GraphView[];
20
+ }