@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.
- package/ChronicleClient.ts +86 -3
- package/artifacts/DefaultClientArtifactsProvider.ts +5 -0
- package/artifacts/IClientArtifactsProvider.ts +3 -0
- package/connection/ConnectionLifecycle.ts +42 -1
- package/dist/ChronicleClient.d.ts +28 -1
- package/dist/ChronicleClient.d.ts.map +1 -1
- package/dist/ChronicleClient.js +71 -3
- package/dist/ChronicleClient.js.map +1 -1
- package/dist/artifacts/DefaultClientArtifactsProvider.d.ts +2 -0
- package/dist/artifacts/DefaultClientArtifactsProvider.d.ts.map +1 -1
- package/dist/artifacts/DefaultClientArtifactsProvider.js +4 -0
- package/dist/artifacts/DefaultClientArtifactsProvider.js.map +1 -1
- package/dist/artifacts/IClientArtifactsProvider.d.ts +2 -0
- package/dist/artifacts/IClientArtifactsProvider.d.ts.map +1 -1
- package/dist/connection/ConnectionLifecycle.d.ts +24 -0
- package/dist/connection/ConnectionLifecycle.d.ts.map +1 -1
- package/dist/connection/ConnectionLifecycle.js +40 -1
- package/dist/connection/ConnectionLifecycle.js.map +1 -1
- package/dist/observation/ObservationReconnectBackoff.d.ts +64 -0
- package/dist/observation/ObservationReconnectBackoff.d.ts.map +1 -0
- package/dist/observation/ObservationReconnectBackoff.js +75 -0
- package/dist/observation/ObservationReconnectBackoff.js.map +1 -0
- package/dist/observation/ObservationStreamOutcome.d.ts +10 -0
- package/dist/observation/ObservationStreamOutcome.d.ts.map +1 -0
- package/dist/observation/ObservationStreamOutcome.js +4 -0
- package/dist/observation/ObservationStreamOutcome.js.map +1 -0
- package/dist/observation/classifyStreamError.d.ts +25 -0
- package/dist/observation/classifyStreamError.d.ts.map +1 -0
- package/dist/observation/classifyStreamError.js +55 -0
- package/dist/observation/classifyStreamError.js.map +1 -0
- package/dist/observation/for_ObservationReconnectBackoff/given/a_backoff.d.ts +13 -0
- package/dist/observation/for_ObservationReconnectBackoff/given/a_backoff.d.ts.map +1 -0
- package/dist/observation/for_ObservationReconnectBackoff/given/a_backoff.js +25 -0
- package/dist/observation/for_ObservationReconnectBackoff/given/a_backoff.js.map +1 -0
- package/dist/observation/for_ObservationReconnectBackoff/given/a_scripted_stream.d.ts +27 -0
- package/dist/observation/for_ObservationReconnectBackoff/given/a_scripted_stream.d.ts.map +1 -0
- package/dist/observation/for_ObservationReconnectBackoff/given/a_scripted_stream.js +36 -0
- package/dist/observation/for_ObservationReconnectBackoff/given/a_scripted_stream.js.map +1 -0
- package/dist/projections/for_Graphs/given/a_discovered_graph.d.ts +2 -1
- package/dist/projections/for_Graphs/given/a_discovered_graph.d.ts.map +1 -1
- package/dist/projections/for_Graphs/given/a_discovered_graph.js +3 -2
- package/dist/projections/for_Graphs/given/a_discovered_graph.js.map +1 -1
- package/dist/projections/for_Graphs/given/a_graph_with_views.d.ts +40 -0
- package/dist/projections/for_Graphs/given/a_graph_with_views.d.ts.map +1 -0
- package/dist/projections/for_Graphs/given/a_graph_with_views.js +80 -0
- package/dist/projections/for_Graphs/given/a_graph_with_views.js.map +1 -0
- package/dist/projections/for_Graphs/given/organization.d.ts +2 -1
- package/dist/projections/for_Graphs/given/organization.d.ts.map +1 -1
- package/dist/projections/for_Graphs/given/organization.js +3 -2
- package/dist/projections/for_Graphs/given/organization.js.map +1 -1
- package/dist/projections/graphs/Graphs.d.ts +5 -0
- package/dist/projections/graphs/Graphs.d.ts.map +1 -1
- package/dist/projections/graphs/Graphs.js +43 -0
- package/dist/projections/graphs/Graphs.js.map +1 -1
- package/dist/projections/graphs/IGraphs.d.ts +9 -2
- package/dist/projections/graphs/IGraphs.d.ts.map +1 -1
- package/dist/projections/graphs/index.d.ts +1 -0
- package/dist/projections/graphs/index.d.ts.map +1 -1
- package/dist/projections/graphs/index.js +1 -0
- package/dist/projections/graphs/index.js.map +1 -1
- package/dist/projections/graphs/views/AmbiguousDirection.d.ts +16 -0
- package/dist/projections/graphs/views/AmbiguousDirection.d.ts.map +1 -0
- package/dist/projections/graphs/views/AmbiguousDirection.js +21 -0
- package/dist/projections/graphs/views/AmbiguousDirection.js.map +1 -0
- package/dist/projections/graphs/views/DuplicateViewName.d.ts +16 -0
- package/dist/projections/graphs/views/DuplicateViewName.d.ts.map +1 -0
- package/dist/projections/graphs/views/DuplicateViewName.js +21 -0
- package/dist/projections/graphs/views/DuplicateViewName.js.map +1 -0
- package/dist/projections/graphs/views/EdgeNotIncidentOnRoot.d.ts +17 -0
- package/dist/projections/graphs/views/EdgeNotIncidentOnRoot.d.ts.map +1 -0
- package/dist/projections/graphs/views/EdgeNotIncidentOnRoot.js +22 -0
- package/dist/projections/graphs/views/EdgeNotIncidentOnRoot.js.map +1 -0
- package/dist/projections/graphs/views/EdgePropertyViewNotUsedAsTarget.d.ts +14 -0
- package/dist/projections/graphs/views/EdgePropertyViewNotUsedAsTarget.d.ts.map +1 -0
- package/dist/projections/graphs/views/EdgePropertyViewNotUsedAsTarget.js +19 -0
- package/dist/projections/graphs/views/EdgePropertyViewNotUsedAsTarget.js.map +1 -0
- package/dist/projections/graphs/views/EdgePropertyViewSharedAcrossEdges.d.ts +15 -0
- package/dist/projections/graphs/views/EdgePropertyViewSharedAcrossEdges.d.ts.map +1 -0
- package/dist/projections/graphs/views/EdgePropertyViewSharedAcrossEdges.js +20 -0
- package/dist/projections/graphs/views/EdgePropertyViewSharedAcrossEdges.js.map +1 -0
- package/dist/projections/graphs/views/FollowsOptions.d.ts +16 -0
- package/dist/projections/graphs/views/FollowsOptions.d.ts.map +1 -0
- package/dist/projections/graphs/views/FollowsOptions.js +4 -0
- package/dist/projections/graphs/views/FollowsOptions.js.map +1 -0
- package/dist/projections/graphs/views/GraphEdgeDirection.d.ts +10 -0
- package/dist/projections/graphs/views/GraphEdgeDirection.d.ts.map +1 -0
- package/dist/projections/graphs/views/GraphEdgeDirection.js +13 -0
- package/dist/projections/graphs/views/GraphEdgeDirection.js.map +1 -0
- package/dist/projections/graphs/views/GraphView.d.ts +13 -0
- package/dist/projections/graphs/views/GraphView.d.ts.map +1 -0
- package/dist/projections/graphs/views/GraphView.js +4 -0
- package/dist/projections/graphs/views/GraphView.js.map +1 -0
- package/dist/projections/graphs/views/GraphViewBuildResult.d.ts +15 -0
- package/dist/projections/graphs/views/GraphViewBuildResult.d.ts.map +1 -0
- package/dist/projections/graphs/views/GraphViewBuildResult.js +4 -0
- package/dist/projections/graphs/views/GraphViewBuildResult.js.map +1 -0
- package/dist/projections/graphs/views/GraphViewCardinality.d.ts +10 -0
- package/dist/projections/graphs/views/GraphViewCardinality.d.ts.map +1 -0
- package/dist/projections/graphs/views/GraphViewCardinality.js +13 -0
- package/dist/projections/graphs/views/GraphViewCardinality.js.map +1 -0
- package/dist/projections/graphs/views/GraphViewDefinition.d.ts +15 -0
- package/dist/projections/graphs/views/GraphViewDefinition.d.ts.map +1 -0
- package/dist/projections/graphs/views/GraphViewDefinition.js +4 -0
- package/dist/projections/graphs/views/GraphViewDefinition.js.map +1 -0
- package/dist/projections/graphs/views/GraphViewDefinitionBuilder.d.ts +30 -0
- package/dist/projections/graphs/views/GraphViewDefinitionBuilder.d.ts.map +1 -0
- package/dist/projections/graphs/views/GraphViewDefinitionBuilder.js +259 -0
- package/dist/projections/graphs/views/GraphViewDefinitionBuilder.js.map +1 -0
- package/dist/projections/graphs/views/GraphViewDefinitionSerializer.d.ts +21 -0
- package/dist/projections/graphs/views/GraphViewDefinitionSerializer.d.ts.map +1 -0
- package/dist/projections/graphs/views/GraphViewDefinitionSerializer.js +77 -0
- package/dist/projections/graphs/views/GraphViewDefinitionSerializer.js.map +1 -0
- package/dist/projections/graphs/views/GraphViewEdgeReference.d.ts +6 -0
- package/dist/projections/graphs/views/GraphViewEdgeReference.d.ts.map +1 -0
- package/dist/projections/graphs/views/GraphViewEdgeReference.js +4 -0
- package/dist/projections/graphs/views/GraphViewEdgeReference.js.map +1 -0
- package/dist/projections/graphs/views/GraphViewMember.d.ts +8 -0
- package/dist/projections/graphs/views/GraphViewMember.d.ts.map +1 -0
- package/dist/projections/graphs/views/GraphViewMember.js +4 -0
- package/dist/projections/graphs/views/GraphViewMember.js.map +1 -0
- package/dist/projections/graphs/views/GraphViewMemberKind.d.ts +12 -0
- package/dist/projections/graphs/views/GraphViewMemberKind.d.ts.map +1 -0
- package/dist/projections/graphs/views/GraphViewMemberKind.js +15 -0
- package/dist/projections/graphs/views/GraphViewMemberKind.js.map +1 -0
- package/dist/projections/graphs/views/GraphViewMemberMetadata.d.ts +22 -0
- package/dist/projections/graphs/views/GraphViewMemberMetadata.d.ts.map +1 -0
- package/dist/projections/graphs/views/GraphViewMemberMetadata.js +4 -0
- package/dist/projections/graphs/views/GraphViewMemberMetadata.js.map +1 -0
- package/dist/projections/graphs/views/GraphViewPropertyMember.d.ts +13 -0
- package/dist/projections/graphs/views/GraphViewPropertyMember.d.ts.map +1 -0
- package/dist/projections/graphs/views/GraphViewPropertyMember.js +4 -0
- package/dist/projections/graphs/views/GraphViewPropertyMember.js.map +1 -0
- package/dist/projections/graphs/views/GraphViewReason.d.ts +33 -0
- package/dist/projections/graphs/views/GraphViewReason.d.ts.map +1 -0
- package/dist/projections/graphs/views/GraphViewReason.js +36 -0
- package/dist/projections/graphs/views/GraphViewReason.js.map +1 -0
- package/dist/projections/graphs/views/GraphViewRelationMember.d.ts +21 -0
- package/dist/projections/graphs/views/GraphViewRelationMember.d.ts.map +1 -0
- package/dist/projections/graphs/views/GraphViewRelationMember.js +4 -0
- package/dist/projections/graphs/views/GraphViewRelationMember.js.map +1 -0
- package/dist/projections/graphs/views/GraphViewSchema.d.ts +10 -0
- package/dist/projections/graphs/views/GraphViewSchema.d.ts.map +1 -0
- package/dist/projections/graphs/views/GraphViewSchema.js +4 -0
- package/dist/projections/graphs/views/GraphViewSchema.js.map +1 -0
- package/dist/projections/graphs/views/GraphViewSchemaEdge.d.ts +14 -0
- package/dist/projections/graphs/views/GraphViewSchemaEdge.d.ts.map +1 -0
- package/dist/projections/graphs/views/GraphViewSchemaEdge.js +4 -0
- package/dist/projections/graphs/views/GraphViewSchemaEdge.js.map +1 -0
- package/dist/projections/graphs/views/GraphViewSchemaNode.d.ts +10 -0
- package/dist/projections/graphs/views/GraphViewSchemaNode.d.ts.map +1 -0
- package/dist/projections/graphs/views/GraphViewSchemaNode.js +4 -0
- package/dist/projections/graphs/views/GraphViewSchemaNode.js.map +1 -0
- package/dist/projections/graphs/views/GraphViewSerializerOptions.d.ts +9 -0
- package/dist/projections/graphs/views/GraphViewSerializerOptions.d.ts.map +1 -0
- package/dist/projections/graphs/views/GraphViewSerializerOptions.js +4 -0
- package/dist/projections/graphs/views/GraphViewSerializerOptions.js.map +1 -0
- package/dist/projections/graphs/views/RecursiveView.d.ts +15 -0
- package/dist/projections/graphs/views/RecursiveView.d.ts.map +1 -0
- package/dist/projections/graphs/views/RecursiveView.js +20 -0
- package/dist/projections/graphs/views/RecursiveView.js.map +1 -0
- package/dist/projections/graphs/views/RelationTargetNotAView.d.ts +16 -0
- package/dist/projections/graphs/views/RelationTargetNotAView.d.ts.map +1 -0
- package/dist/projections/graphs/views/RelationTargetNotAView.js +21 -0
- package/dist/projections/graphs/views/RelationTargetNotAView.js.map +1 -0
- package/dist/projections/graphs/views/TargetLabelMismatch.d.ts +18 -0
- package/dist/projections/graphs/views/TargetLabelMismatch.d.ts.map +1 -0
- package/dist/projections/graphs/views/TargetLabelMismatch.js +23 -0
- package/dist/projections/graphs/views/TargetLabelMismatch.js.map +1 -0
- package/dist/projections/graphs/views/UnknownEdge.d.ts +16 -0
- package/dist/projections/graphs/views/UnknownEdge.d.ts.map +1 -0
- package/dist/projections/graphs/views/UnknownEdge.js +21 -0
- package/dist/projections/graphs/views/UnknownEdge.js.map +1 -0
- package/dist/projections/graphs/views/UnknownEdgeProperty.d.ts +17 -0
- package/dist/projections/graphs/views/UnknownEdgeProperty.d.ts.map +1 -0
- package/dist/projections/graphs/views/UnknownEdgeProperty.js +22 -0
- package/dist/projections/graphs/views/UnknownEdgeProperty.js.map +1 -0
- package/dist/projections/graphs/views/UnknownNodeProperty.d.ts +17 -0
- package/dist/projections/graphs/views/UnknownNodeProperty.d.ts.map +1 -0
- package/dist/projections/graphs/views/UnknownNodeProperty.js +22 -0
- package/dist/projections/graphs/views/UnknownNodeProperty.js.map +1 -0
- package/dist/projections/graphs/views/ViewIsAlsoSchema.d.ts +14 -0
- package/dist/projections/graphs/views/ViewIsAlsoSchema.d.ts.map +1 -0
- package/dist/projections/graphs/views/ViewIsAlsoSchema.js +19 -0
- package/dist/projections/graphs/views/ViewIsAlsoSchema.js.map +1 -0
- package/dist/projections/graphs/views/ViewOfMetadata.d.ts +8 -0
- package/dist/projections/graphs/views/ViewOfMetadata.d.ts.map +1 -0
- package/dist/projections/graphs/views/ViewOfMetadata.js +4 -0
- package/dist/projections/graphs/views/ViewOfMetadata.js.map +1 -0
- package/dist/projections/graphs/views/ViewOfOptions.d.ts +6 -0
- package/dist/projections/graphs/views/ViewOfOptions.d.ts.map +1 -0
- package/dist/projections/graphs/views/ViewOfOptions.js +4 -0
- package/dist/projections/graphs/views/ViewOfOptions.js.map +1 -0
- package/dist/projections/graphs/views/ViewRootNotANode.d.ts +16 -0
- package/dist/projections/graphs/views/ViewRootNotANode.d.ts.map +1 -0
- package/dist/projections/graphs/views/ViewRootNotANode.js +21 -0
- package/dist/projections/graphs/views/ViewRootNotANode.js.map +1 -0
- package/dist/projections/graphs/views/declareGraphViewMember.d.ts +17 -0
- package/dist/projections/graphs/views/declareGraphViewMember.d.ts.map +1 -0
- package/dist/projections/graphs/views/declareGraphViewMember.js +31 -0
- package/dist/projections/graphs/views/declareGraphViewMember.js.map +1 -0
- package/dist/projections/graphs/views/follows.d.ts +13 -0
- package/dist/projections/graphs/views/follows.d.ts.map +1 -0
- package/dist/projections/graphs/views/follows.js +24 -0
- package/dist/projections/graphs/views/follows.js.map +1 -0
- package/dist/projections/graphs/views/fromEdge.d.ts +10 -0
- package/dist/projections/graphs/views/fromEdge.d.ts.map +1 -0
- package/dist/projections/graphs/views/fromEdge.js +15 -0
- package/dist/projections/graphs/views/fromEdge.js.map +1 -0
- package/dist/projections/graphs/views/index.d.ts +41 -0
- package/dist/projections/graphs/views/index.d.ts.map +1 -0
- package/dist/projections/graphs/views/index.js +28 -0
- package/dist/projections/graphs/views/index.js.map +1 -0
- package/dist/projections/graphs/views/viewKey.d.ts +8 -0
- package/dist/projections/graphs/views/viewKey.d.ts.map +1 -0
- package/dist/projections/graphs/views/viewKey.js +13 -0
- package/dist/projections/graphs/views/viewKey.js.map +1 -0
- package/dist/projections/graphs/views/viewOf.d.ts +22 -0
- package/dist/projections/graphs/views/viewOf.d.ts.map +1 -0
- package/dist/projections/graphs/views/viewOf.js +41 -0
- package/dist/projections/graphs/views/viewOf.js.map +1 -0
- package/dist/projections/graphs/views/viewProperty.d.ts +9 -0
- package/dist/projections/graphs/views/viewProperty.d.ts.map +1 -0
- package/dist/projections/graphs/views/viewProperty.js +14 -0
- package/dist/projections/graphs/views/viewProperty.js.map +1 -0
- package/dist/reactors/Reactors.d.ts +15 -5
- package/dist/reactors/Reactors.d.ts.map +1 -1
- package/dist/reactors/Reactors.js +95 -18
- package/dist/reactors/Reactors.js.map +1 -1
- package/dist/reactors/for_Reactors/when_reconnecting_the_observation_stream/given/a_reactor_whose_stream_ends.d.ts +26 -0
- package/dist/reactors/for_Reactors/when_reconnecting_the_observation_stream/given/a_reactor_whose_stream_ends.d.ts.map +1 -0
- package/dist/reactors/for_Reactors/when_reconnecting_the_observation_stream/given/a_reactor_whose_stream_ends.js +64 -0
- package/dist/reactors/for_Reactors/when_reconnecting_the_observation_stream/given/a_reactor_whose_stream_ends.js.map +1 -0
- package/dist/reducers/Reducers.d.ts +11 -5
- package/dist/reducers/Reducers.d.ts.map +1 -1
- package/dist/reducers/Reducers.js +93 -19
- package/dist/reducers/Reducers.js.map +1 -1
- package/dist/reducers/for_Reducers/when_reconnecting_the_observation_stream/given/a_reducer_whose_stream_ends.d.ts +25 -0
- package/dist/reducers/for_Reducers/when_reconnecting_the_observation_stream/given/a_reducer_whose_stream_ends.d.ts.map +1 -0
- package/dist/reducers/for_Reducers/when_reconnecting_the_observation_stream/given/a_reducer_whose_stream_ends.js +70 -0
- package/dist/reducers/for_Reducers/when_reconnecting_the_observation_stream/given/a_reducer_whose_stream_ends.js.map +1 -0
- package/dist/testing/InProcessAppendMetadata.d.ts +30 -0
- package/dist/testing/InProcessAppendMetadata.d.ts.map +1 -0
- package/dist/testing/InProcessAppendMetadata.js +107 -0
- package/dist/testing/InProcessAppendMetadata.js.map +1 -0
- package/dist/testing/InProcessBatchAppend.d.ts +62 -0
- package/dist/testing/InProcessBatchAppend.d.ts.map +1 -0
- package/dist/testing/InProcessBatchAppend.js +131 -0
- package/dist/testing/InProcessBatchAppend.js.map +1 -0
- package/dist/testing/InProcessEventPayload.d.ts +23 -0
- package/dist/testing/InProcessEventPayload.d.ts.map +1 -0
- package/dist/testing/InProcessEventPayload.js +94 -0
- package/dist/testing/InProcessEventPayload.js.map +1 -0
- package/dist/testing/InProcessEventReadCriteria.d.ts +9 -0
- package/dist/testing/InProcessEventReadCriteria.d.ts.map +1 -0
- package/dist/testing/InProcessEventReadCriteria.js +4 -0
- package/dist/testing/InProcessEventReadCriteria.js.map +1 -0
- package/dist/testing/InProcessEventReadFilter.d.ts +14 -0
- package/dist/testing/InProcessEventReadFilter.d.ts.map +1 -0
- package/dist/testing/InProcessEventReadFilter.js +31 -0
- package/dist/testing/InProcessEventReadFilter.js.map +1 -0
- package/dist/testing/InProcessEventSequence.d.ts +8 -5
- package/dist/testing/InProcessEventSequence.d.ts.map +1 -1
- package/dist/testing/InProcessEventSequence.js +59 -275
- package/dist/testing/InProcessEventSequence.js.map +1 -1
- package/dist/testing/InProcessEventSequenceEnvironment.d.ts +13 -0
- package/dist/testing/InProcessEventSequenceEnvironment.d.ts.map +1 -0
- package/dist/testing/InProcessEventSequenceEnvironment.js +4 -0
- package/dist/testing/InProcessEventSequenceEnvironment.js.map +1 -0
- package/dist/testing/InProcessSingleAppend.d.ts +34 -0
- package/dist/testing/InProcessSingleAppend.d.ts.map +1 -0
- package/dist/testing/InProcessSingleAppend.js +95 -0
- package/dist/testing/InProcessSingleAppend.js.map +1 -0
- package/dist/testing/projections/ProjectionCapabilities.d.ts +0 -8
- package/dist/testing/projections/ProjectionCapabilities.d.ts.map +1 -1
- package/dist/testing/projections/ProjectionCapabilities.js +21 -312
- package/dist/testing/projections/ProjectionCapabilities.js.map +1 -1
- package/dist/testing/projections/ProjectionCapabilityReject.d.ts +3 -0
- package/dist/testing/projections/ProjectionCapabilityReject.d.ts.map +1 -0
- package/dist/testing/projections/ProjectionCapabilityReject.js +4 -0
- package/dist/testing/projections/ProjectionCapabilityReject.js.map +1 -0
- package/dist/testing/projections/ProjectionCapabilityReporter.d.ts +12 -0
- package/dist/testing/projections/ProjectionCapabilityReporter.d.ts.map +1 -0
- package/dist/testing/projections/ProjectionCapabilityReporter.js +33 -0
- package/dist/testing/projections/ProjectionCapabilityReporter.js.map +1 -0
- package/dist/testing/projections/ProjectionDefinitionCapabilities.d.ts +11 -0
- package/dist/testing/projections/ProjectionDefinitionCapabilities.d.ts.map +1 -0
- package/dist/testing/projections/ProjectionDefinitionCapabilities.js +45 -0
- package/dist/testing/projections/ProjectionDefinitionCapabilities.js.map +1 -0
- package/dist/testing/projections/ProjectionEventSchemaResolver.d.ts +13 -0
- package/dist/testing/projections/ProjectionEventSchemaResolver.d.ts.map +1 -0
- package/dist/testing/projections/ProjectionEventSchemaResolver.js +22 -0
- package/dist/testing/projections/ProjectionEventSchemaResolver.js.map +1 -0
- package/dist/testing/projections/ProjectionExpressionCapabilities.d.ts +19 -0
- package/dist/testing/projections/ProjectionExpressionCapabilities.d.ts.map +1 -0
- package/dist/testing/projections/ProjectionExpressionCapabilities.js +103 -0
- package/dist/testing/projections/ProjectionExpressionCapabilities.js.map +1 -0
- package/dist/testing/projections/ProjectionInitialValueCapabilities.d.ts +16 -0
- package/dist/testing/projections/ProjectionInitialValueCapabilities.d.ts.map +1 -0
- package/dist/testing/projections/ProjectionInitialValueCapabilities.js +72 -0
- package/dist/testing/projections/ProjectionInitialValueCapabilities.js.map +1 -0
- package/dist/testing/projections/ProjectionMappingCapabilities.d.ts +21 -0
- package/dist/testing/projections/ProjectionMappingCapabilities.d.ts.map +1 -0
- package/dist/testing/projections/ProjectionMappingCapabilities.js +86 -0
- package/dist/testing/projections/ProjectionMappingCapabilities.js.map +1 -0
- package/dist/testing/projections/ProjectionMappingValidation.d.ts +9 -0
- package/dist/testing/projections/ProjectionMappingValidation.d.ts.map +1 -0
- package/dist/testing/projections/ProjectionMappingValidation.js +4 -0
- package/dist/testing/projections/ProjectionMappingValidation.js.map +1 -0
- package/dist/testing/projections/ProjectionReadModelCapabilities.d.ts +11 -0
- package/dist/testing/projections/ProjectionReadModelCapabilities.d.ts.map +1 -0
- package/dist/testing/projections/ProjectionReadModelCapabilities.js +40 -0
- package/dist/testing/projections/ProjectionReadModelCapabilities.js.map +1 -0
- package/dist/testing/projections/ProjectionRootCapabilities.d.ts +20 -0
- package/dist/testing/projections/ProjectionRootCapabilities.d.ts.map +1 -0
- package/dist/testing/projections/ProjectionRootCapabilities.js +73 -0
- package/dist/testing/projections/ProjectionRootCapabilities.js.map +1 -0
- package/dist/testing/projections/ProjectionScalarConverter.d.ts +21 -0
- package/dist/testing/projections/ProjectionScalarConverter.d.ts.map +1 -0
- package/dist/testing/projections/ProjectionScalarConverter.js +105 -0
- package/dist/testing/projections/ProjectionScalarConverter.js.map +1 -0
- package/dist/testing/projections/ProjectionSchemaCapabilities.d.ts +26 -0
- package/dist/testing/projections/ProjectionSchemaCapabilities.d.ts.map +1 -0
- package/dist/testing/projections/ProjectionSchemaCapabilities.js +109 -0
- package/dist/testing/projections/ProjectionSchemaCapabilities.js.map +1 -0
- package/dist/testing/projections/ProjectionValueConverter.d.ts +5 -0
- package/dist/testing/projections/ProjectionValueConverter.d.ts.map +1 -1
- package/dist/testing/projections/ProjectionValueConverter.js +36 -84
- package/dist/testing/projections/ProjectionValueConverter.js.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/dist/types/DecoratorType.d.ts +3 -1
- package/dist/types/DecoratorType.d.ts.map +1 -1
- package/dist/types/DecoratorType.js +2 -0
- package/dist/types/DecoratorType.js.map +1 -1
- package/for_ChronicleClient/when_reconnecting/and_an_observation_stream_lost_its_session.spec.ts +212 -0
- package/observation/ObservationReconnectBackoff.ts +109 -0
- package/observation/ObservationStreamOutcome.ts +12 -0
- package/observation/classifyStreamError.ts +67 -0
- package/observation/for_ObservationReconnectBackoff/given/a_backoff.ts +29 -0
- package/observation/for_ObservationReconnectBackoff/given/a_scripted_stream.ts +52 -0
- package/observation/for_ObservationReconnectBackoff/when_a_stream_delivered_before_it_ended.spec.ts +23 -0
- package/observation/for_ObservationReconnectBackoff/when_a_stream_stayed_open_before_it_ended.spec.ts +25 -0
- package/observation/for_ObservationReconnectBackoff/when_jittering_the_delay.spec.ts +24 -0
- package/observation/for_ObservationReconnectBackoff/when_streams_keep_ending_without_working.spec.ts +24 -0
- package/observation/for_ObservationReconnectBackoff/when_the_base_delay_is_not_positive.spec.ts +18 -0
- package/observation/for_ObservationReconnectBackoff/when_the_settings_are_not_finite.spec.ts +32 -0
- package/observation/for_ObservationReconnectBackoff/when_using_the_defaults.spec.ts +29 -0
- package/observation/for_classifyStreamError/when_classifying_a_stream_error.spec.ts +36 -0
- package/package.json +2 -2
- package/projections/for_Graphs/given/a_discovered_graph.ts +3 -2
- package/projections/for_Graphs/given/a_graph_with_views.ts +91 -0
- package/projections/for_Graphs/given/organization.ts +3 -2
- package/projections/for_Graphs/given/organization_with_views.fixture.ts +129 -0
- package/projections/for_Graphs/when_building_graph_views.spec.ts +218 -0
- package/projections/for_Graphs/when_declaring_an_invalid_graph_view.spec.ts +229 -0
- package/projections/for_Graphs/when_declaring_graph_views.standard.spec.ts +49 -0
- package/projections/for_Graphs/when_discovering_graph_views.spec.ts +58 -0
- package/projections/graphs/Graphs.ts +44 -0
- package/projections/graphs/IGraphs.ts +10 -2
- package/projections/graphs/index.ts +1 -0
- package/projections/graphs/views/AmbiguousDirection.ts +23 -0
- package/projections/graphs/views/DuplicateViewName.ts +23 -0
- package/projections/graphs/views/EdgeNotIncidentOnRoot.ts +24 -0
- package/projections/graphs/views/EdgePropertyViewNotUsedAsTarget.ts +21 -0
- package/projections/graphs/views/EdgePropertyViewSharedAcrossEdges.ts +22 -0
- package/projections/graphs/views/FollowsOptions.ts +20 -0
- package/projections/graphs/views/GraphEdgeDirection.ts +13 -0
- package/projections/graphs/views/GraphView.ts +18 -0
- package/projections/graphs/views/GraphViewBuildResult.ts +19 -0
- package/projections/graphs/views/GraphViewCardinality.ts +13 -0
- package/projections/graphs/views/GraphViewDefinition.ts +20 -0
- package/projections/graphs/views/GraphViewDefinitionBuilder.ts +322 -0
- package/projections/graphs/views/GraphViewDefinitionSerializer.ts +90 -0
- package/projections/graphs/views/GraphViewEdgeReference.ts +8 -0
- package/projections/graphs/views/GraphViewMember.ts +11 -0
- package/projections/graphs/views/GraphViewMemberKind.ts +16 -0
- package/projections/graphs/views/GraphViewMemberMetadata.ts +31 -0
- package/projections/graphs/views/GraphViewPropertyMember.ts +18 -0
- package/projections/graphs/views/GraphViewReason.ts +47 -0
- package/projections/graphs/views/GraphViewRelationMember.ts +29 -0
- package/projections/graphs/views/GraphViewSchema.ts +14 -0
- package/projections/graphs/views/GraphViewSchemaEdge.ts +20 -0
- package/projections/graphs/views/GraphViewSchemaNode.ts +14 -0
- package/projections/graphs/views/GraphViewSerializerOptions.ts +11 -0
- package/projections/graphs/views/RecursiveView.ts +22 -0
- package/projections/graphs/views/RelationTargetNotAView.ts +23 -0
- package/projections/graphs/views/TargetLabelMismatch.ts +25 -0
- package/projections/graphs/views/UnknownEdge.ts +23 -0
- package/projections/graphs/views/UnknownEdgeProperty.ts +24 -0
- package/projections/graphs/views/UnknownNodeProperty.ts +24 -0
- package/projections/graphs/views/ViewIsAlsoSchema.ts +21 -0
- package/projections/graphs/views/ViewOfMetadata.ts +11 -0
- package/projections/graphs/views/ViewOfOptions.ts +8 -0
- package/projections/graphs/views/ViewRootNotANode.ts +23 -0
- package/projections/graphs/views/declareGraphViewMember.ts +36 -0
- package/projections/graphs/views/follows.ts +28 -0
- package/projections/graphs/views/fromEdge.ts +17 -0
- package/projections/graphs/views/index.ts +43 -0
- package/projections/graphs/views/viewKey.ts +15 -0
- package/projections/graphs/views/viewOf.ts +50 -0
- package/projections/graphs/views/viewProperty.ts +16 -0
- package/reactors/Reactors.ts +101 -18
- package/reactors/for_Reactors/when_reconnecting_the_observation_stream/and_a_handler_failed_with_a_lost_session.spec.ts +32 -0
- package/reactors/for_Reactors/when_reconnecting_the_observation_stream/and_a_replaced_stream_fails_late.spec.ts +28 -0
- package/reactors/for_Reactors/when_reconnecting_the_observation_stream/and_a_stream_delivered_before_it_ended.spec.ts +24 -0
- package/reactors/for_Reactors/when_reconnecting_the_observation_stream/and_a_stream_stayed_open_before_it_ended.spec.ts +23 -0
- package/reactors/for_Reactors/when_reconnecting_the_observation_stream/and_it_is_disposed_while_waiting_to_reopen.spec.ts +27 -0
- package/reactors/for_Reactors/when_reconnecting_the_observation_stream/and_streams_keep_ending_without_working.spec.ts +24 -0
- package/reactors/for_Reactors/when_reconnecting_the_observation_stream/and_the_client_reconnected_after_streams_kept_ending.spec.ts +24 -0
- package/reactors/for_Reactors/when_reconnecting_the_observation_stream/and_the_client_reconnected_while_waiting_to_reopen.spec.ts +25 -0
- package/reactors/for_Reactors/when_reconnecting_the_observation_stream/and_the_kernel_lost_the_session.spec.ts +24 -0
- package/reactors/for_Reactors/when_reconnecting_the_observation_stream/given/a_reactor_whose_stream_ends.ts +69 -0
- package/reducers/Reducers.ts +99 -19
- package/reducers/for_Reducers/when_reconnecting_the_observation_stream/and_a_reducer_failed_with_a_lost_session.spec.ts +33 -0
- package/reducers/for_Reducers/when_reconnecting_the_observation_stream/and_a_replaced_stream_fails_late.spec.ts +28 -0
- package/reducers/for_Reducers/when_reconnecting_the_observation_stream/and_a_stream_delivered_before_it_ended.spec.ts +24 -0
- package/reducers/for_Reducers/when_reconnecting_the_observation_stream/and_a_stream_stayed_open_before_it_ended.spec.ts +23 -0
- package/reducers/for_Reducers/when_reconnecting_the_observation_stream/and_it_is_disposed_while_waiting_to_reopen.spec.ts +27 -0
- package/reducers/for_Reducers/when_reconnecting_the_observation_stream/and_streams_keep_ending_without_working.spec.ts +24 -0
- package/reducers/for_Reducers/when_reconnecting_the_observation_stream/and_the_client_reconnected_after_streams_kept_ending.spec.ts +24 -0
- package/reducers/for_Reducers/when_reconnecting_the_observation_stream/and_the_client_reconnected_while_waiting_to_reopen.spec.ts +25 -0
- package/reducers/for_Reducers/when_reconnecting_the_observation_stream/and_the_kernel_lost_the_session.spec.ts +24 -0
- package/reducers/for_Reducers/when_reconnecting_the_observation_stream/given/a_reducer_whose_stream_ends.ts +69 -0
- package/testing/InProcessAppendMetadata.ts +119 -0
- package/testing/InProcessBatchAppend.ts +142 -0
- package/testing/InProcessEventPayload.ts +100 -0
- package/testing/InProcessEventReadCriteria.ts +11 -0
- package/testing/InProcessEventReadFilter.ts +37 -0
- package/testing/InProcessEventSequence.ts +63 -257
- package/testing/InProcessEventSequenceEnvironment.ts +16 -0
- package/testing/InProcessSingleAppend.ts +99 -0
- package/testing/for_InProcessEventSequence/when_preserving_validation_and_commit_order.spec.ts +95 -0
- package/testing/projections/ProjectionCapabilities.ts +23 -279
- package/testing/projections/ProjectionCapabilityReject.ts +5 -0
- package/testing/projections/ProjectionCapabilityReporter.ts +31 -0
- package/testing/projections/ProjectionDefinitionCapabilities.ts +45 -0
- package/testing/projections/ProjectionEventSchemaResolver.ts +23 -0
- package/testing/projections/ProjectionExpressionCapabilities.ts +101 -0
- package/testing/projections/ProjectionInitialValueCapabilities.ts +73 -0
- package/testing/projections/ProjectionMappingCapabilities.ts +85 -0
- package/testing/projections/ProjectionMappingValidation.ts +12 -0
- package/testing/projections/ProjectionReadModelCapabilities.ts +42 -0
- package/testing/projections/ProjectionRootCapabilities.ts +75 -0
- package/testing/projections/ProjectionScalarConverter.ts +106 -0
- package/testing/projections/ProjectionSchemaCapabilities.ts +112 -0
- package/testing/projections/ProjectionValueConverter.ts +37 -76
- package/testing/projections/for_ProjectionCapabilities/when_reporting_the_first_unsupported_operation.spec.ts +74 -0
- package/testing/projections/for_ProjectionValueConverter/when_converting_structured_and_scalar_values.spec.ts +64 -0
- package/types/DecoratorType.ts +4 -1
|
@@ -0,0 +1,322 @@
|
|
|
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 { TypeIntrospector } from '../../../types/index.js';
|
|
6
|
+
import { getEdgeMetadata } from '../edge.js';
|
|
7
|
+
import type { GraphEdgeModel } from '../GraphEdgeModel.js';
|
|
8
|
+
import type { GraphModel } from '../GraphModel.js';
|
|
9
|
+
import { GraphSchemaWriter } from '../GraphSchemaWriter.js';
|
|
10
|
+
import { isGraphElement } from '../isGraphElement.js';
|
|
11
|
+
import { AmbiguousDirection } from './AmbiguousDirection.js';
|
|
12
|
+
import { DuplicateViewName } from './DuplicateViewName.js';
|
|
13
|
+
import { EdgeNotIncidentOnRoot } from './EdgeNotIncidentOnRoot.js';
|
|
14
|
+
import { EdgePropertyViewNotUsedAsTarget } from './EdgePropertyViewNotUsedAsTarget.js';
|
|
15
|
+
import { EdgePropertyViewSharedAcrossEdges } from './EdgePropertyViewSharedAcrossEdges.js';
|
|
16
|
+
import { GraphEdgeDirection } from './GraphEdgeDirection.js';
|
|
17
|
+
import { GraphViewCardinality } from './GraphViewCardinality.js';
|
|
18
|
+
import type { GraphViewBuildResult } from './GraphViewBuildResult.js';
|
|
19
|
+
import type { GraphViewDefinition } from './GraphViewDefinition.js';
|
|
20
|
+
import type { GraphViewEdgeReference } from './GraphViewEdgeReference.js';
|
|
21
|
+
import type { GraphViewMember } from './GraphViewMember.js';
|
|
22
|
+
import { getGraphViewMemberMetadata } from './declareGraphViewMember.js';
|
|
23
|
+
import { GraphViewMemberKind } from './GraphViewMemberKind.js';
|
|
24
|
+
import { RecursiveView } from './RecursiveView.js';
|
|
25
|
+
import { RelationTargetNotAView } from './RelationTargetNotAView.js';
|
|
26
|
+
import { TargetLabelMismatch } from './TargetLabelMismatch.js';
|
|
27
|
+
import { UnknownEdge } from './UnknownEdge.js';
|
|
28
|
+
import { UnknownEdgeProperty } from './UnknownEdgeProperty.js';
|
|
29
|
+
import { UnknownNodeProperty } from './UnknownNodeProperty.js';
|
|
30
|
+
import { ViewIsAlsoSchema } from './ViewIsAlsoSchema.js';
|
|
31
|
+
import { getViewOfMetadata } from './viewOf.js';
|
|
32
|
+
import { ViewRootNotANode } from './ViewRootNotANode.js';
|
|
33
|
+
|
|
34
|
+
interface NodeInfo {
|
|
35
|
+
readonly label: string;
|
|
36
|
+
readonly keyProperty: string;
|
|
37
|
+
readonly properties: readonly string[];
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
interface EdgeInfo {
|
|
41
|
+
readonly edgeType: string;
|
|
42
|
+
readonly identifiedBy?: string;
|
|
43
|
+
readonly sourceLabel: string;
|
|
44
|
+
readonly targetLabel: string;
|
|
45
|
+
readonly properties: readonly string[];
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
interface PropertyMemberInfo {
|
|
49
|
+
readonly kind: GraphViewMemberKind.Property;
|
|
50
|
+
readonly name: string;
|
|
51
|
+
readonly source: string;
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
interface EdgePropertyMemberInfo {
|
|
55
|
+
readonly kind: GraphViewMemberKind.EdgeProperty;
|
|
56
|
+
readonly name: string;
|
|
57
|
+
readonly requested: string;
|
|
58
|
+
source?: string;
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
interface RelationMemberInfo {
|
|
62
|
+
readonly kind: GraphViewMemberKind.Relation;
|
|
63
|
+
readonly name: string;
|
|
64
|
+
readonly edge: EdgeInfo;
|
|
65
|
+
readonly direction: GraphEdgeDirection;
|
|
66
|
+
readonly cardinality: GraphViewCardinality;
|
|
67
|
+
readonly target: Function;
|
|
68
|
+
readonly targetName: string;
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
type MemberInfo = PropertyMemberInfo | EdgePropertyMemberInfo | RelationMemberInfo;
|
|
72
|
+
|
|
73
|
+
interface ViewInfo {
|
|
74
|
+
readonly type: Constructor;
|
|
75
|
+
readonly name: string;
|
|
76
|
+
readonly node: NodeInfo;
|
|
77
|
+
readonly members: readonly MemberInfo[];
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
/**
|
|
81
|
+
* Validates the views declared over a graph and builds their {@link GraphViewDefinition}. Every rule of a view has a
|
|
82
|
+
* reason code, carried by the error that reports it. One invalid view never stops the discovery of anything else; it
|
|
83
|
+
* is reported, and the views of its graph are then withheld as a whole, because a view is read together with the views
|
|
84
|
+
* it nests.
|
|
85
|
+
*/
|
|
86
|
+
export class GraphViewDefinitionBuilder {
|
|
87
|
+
private readonly _schemaWriter = new GraphSchemaWriter();
|
|
88
|
+
|
|
89
|
+
/**
|
|
90
|
+
* Builds the definition of the views of one graph.
|
|
91
|
+
* @param model - The {@link GraphModel} the views read.
|
|
92
|
+
* @param views - The view types that name the graph.
|
|
93
|
+
* @returns The {@link GraphViewBuildResult}.
|
|
94
|
+
*/
|
|
95
|
+
build(model: GraphModel, views: readonly Constructor[]): GraphViewBuildResult {
|
|
96
|
+
const failures = new Map<Constructor, Error>();
|
|
97
|
+
const nodes = new Map<Function, NodeInfo>(model.nodes.map(node => [node.type, {
|
|
98
|
+
label: node.label,
|
|
99
|
+
keyProperty: node.keyProperty,
|
|
100
|
+
properties: Object.keys(this._schemaWriter.propertiesOf(node.type, []))
|
|
101
|
+
}]));
|
|
102
|
+
const edgesByClass = new Map<Function, EdgeInfo>();
|
|
103
|
+
const edgesByType = new Map<string, EdgeInfo>();
|
|
104
|
+
for (const edge of model.edges) {
|
|
105
|
+
const info = this.edgeInfo(edge, nodes);
|
|
106
|
+
edgesByClass.set(edge.type, info);
|
|
107
|
+
edgesByType.set(edge.edgeType, info);
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
const declared = new Set<Function>(views);
|
|
111
|
+
const names = new Set<string>();
|
|
112
|
+
const resolved = new Map<Constructor, ViewInfo>();
|
|
113
|
+
for (const type of views) {
|
|
114
|
+
try {
|
|
115
|
+
resolved.set(type, this.resolve(model.name, type, declared, names, nodes, edgesByClass, edgesByType));
|
|
116
|
+
} catch (error) {
|
|
117
|
+
failures.set(type, error instanceof Error ? error : new Error(String(error)));
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
this.validateAcrossViews(resolved, edgesByType, failures);
|
|
122
|
+
if (failures.size > 0) return { failures };
|
|
123
|
+
|
|
124
|
+
const definition: GraphViewDefinition = {
|
|
125
|
+
graph: model.name,
|
|
126
|
+
schema: {
|
|
127
|
+
nodes: [...nodes.values()].map(node => ({ label: node.label, key: node.keyProperty, properties: node.properties })),
|
|
128
|
+
edges: [...edgesByType.values()].map(edge => ({
|
|
129
|
+
type: edge.edgeType,
|
|
130
|
+
source: edge.sourceLabel,
|
|
131
|
+
target: edge.targetLabel,
|
|
132
|
+
...(edge.identifiedBy === undefined ? {} : { identifiedBy: edge.identifiedBy }),
|
|
133
|
+
properties: edge.properties
|
|
134
|
+
}))
|
|
135
|
+
},
|
|
136
|
+
views: [...resolved.values()]
|
|
137
|
+
.map(view => ({ name: view.name, root: view.node.label, members: view.members.map(member => this.member(member)) }))
|
|
138
|
+
.sort((left, right) => (left.name === right.name ? 0 : left.name < right.name ? -1 : 1))
|
|
139
|
+
};
|
|
140
|
+
return { definition, failures };
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
private edgeInfo(edge: GraphEdgeModel, nodes: ReadonlyMap<Function, NodeInfo>): EdgeInfo {
|
|
144
|
+
return {
|
|
145
|
+
edgeType: edge.edgeType,
|
|
146
|
+
identifiedBy: edge.identifyingProperty,
|
|
147
|
+
sourceLabel: nodes.get(edge.sourceNode)?.label ?? '',
|
|
148
|
+
targetLabel: nodes.get(edge.targetNode)?.label ?? '',
|
|
149
|
+
properties: Object.keys(this._schemaWriter.propertiesOf(edge.type, edge.excludedProperties))
|
|
150
|
+
};
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
private resolve(
|
|
154
|
+
graph: string,
|
|
155
|
+
type: Constructor,
|
|
156
|
+
declared: ReadonlySet<Function>,
|
|
157
|
+
names: Set<string>,
|
|
158
|
+
nodes: ReadonlyMap<Function, NodeInfo>,
|
|
159
|
+
edgesByClass: ReadonlyMap<Function, EdgeInfo>,
|
|
160
|
+
edgesByType: ReadonlyMap<string, EdgeInfo>
|
|
161
|
+
): ViewInfo {
|
|
162
|
+
const metadata = getViewOfMetadata(type)!;
|
|
163
|
+
const name = metadata.name;
|
|
164
|
+
const duplicate = names.has(name);
|
|
165
|
+
names.add(name);
|
|
166
|
+
if (isGraphElement(type)) throw new ViewIsAlsoSchema(type);
|
|
167
|
+
if (duplicate) throw new DuplicateViewName(type, graph, name);
|
|
168
|
+
|
|
169
|
+
const rootType = metadata.root();
|
|
170
|
+
const node = nodes.get(rootType);
|
|
171
|
+
if (node === undefined) throw new ViewRootNotANode(type, graph, rootType);
|
|
172
|
+
|
|
173
|
+
const members: MemberInfo[] = [];
|
|
174
|
+
for (const property of TypeIntrospector.getTrackedProperties(type)) {
|
|
175
|
+
const member = getGraphViewMemberMetadata(type.prototype, property);
|
|
176
|
+
if (member === undefined) continue;
|
|
177
|
+
|
|
178
|
+
const requested = member.source ?? property;
|
|
179
|
+
switch (member.kind) {
|
|
180
|
+
case GraphViewMemberKind.Property: {
|
|
181
|
+
const source = member.isKey ? node.keyProperty : this.find(node.properties, requested);
|
|
182
|
+
if (source === undefined) throw new UnknownNodeProperty(type, property, node.label, requested);
|
|
183
|
+
members.push({ kind: GraphViewMemberKind.Property, name: property, source });
|
|
184
|
+
break;
|
|
185
|
+
}
|
|
186
|
+
case GraphViewMemberKind.EdgeProperty:
|
|
187
|
+
members.push({ kind: GraphViewMemberKind.EdgeProperty, name: property, requested });
|
|
188
|
+
break;
|
|
189
|
+
case GraphViewMemberKind.Relation: {
|
|
190
|
+
const edge = this.edgeOf(member.edge!, edgesByClass, edgesByType);
|
|
191
|
+
if (edge === undefined) throw new UnknownEdge(type, property, this.edgeName(member.edge!));
|
|
192
|
+
const direction = this.directionOf(type, property, edge, node, member.direction);
|
|
193
|
+
const target = member.view!();
|
|
194
|
+
if (!declared.has(target)) throw new RelationTargetNotAView(type, property, target);
|
|
195
|
+
const expected = direction === GraphEdgeDirection.Outgoing ? edge.targetLabel : edge.sourceLabel;
|
|
196
|
+
const actual = nodes.get(getViewOfMetadata(target)!.root())?.label;
|
|
197
|
+
if (actual !== undefined && actual !== expected) throw new TargetLabelMismatch(type, property, target, expected, actual);
|
|
198
|
+
members.push({
|
|
199
|
+
kind: GraphViewMemberKind.Relation,
|
|
200
|
+
name: property,
|
|
201
|
+
edge,
|
|
202
|
+
direction,
|
|
203
|
+
cardinality: member.cardinality ?? GraphViewCardinality.Many,
|
|
204
|
+
target,
|
|
205
|
+
targetName: getViewOfMetadata(target)!.name
|
|
206
|
+
});
|
|
207
|
+
break;
|
|
208
|
+
}
|
|
209
|
+
}
|
|
210
|
+
}
|
|
211
|
+
|
|
212
|
+
return { type, name, node, members };
|
|
213
|
+
}
|
|
214
|
+
|
|
215
|
+
private directionOf(type: Function, member: string, edge: EdgeInfo, node: NodeInfo, explicit: GraphEdgeDirection | undefined): GraphEdgeDirection {
|
|
216
|
+
const outgoing = edge.sourceLabel === node.label;
|
|
217
|
+
const incoming = edge.targetLabel === node.label;
|
|
218
|
+
if (!outgoing && !incoming) throw new EdgeNotIncidentOnRoot(type, member, edge.edgeType, node.label);
|
|
219
|
+
if (outgoing && incoming) {
|
|
220
|
+
if (explicit === undefined) throw new AmbiguousDirection(type, member, edge.edgeType);
|
|
221
|
+
return explicit;
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
const derived = outgoing ? GraphEdgeDirection.Outgoing : GraphEdgeDirection.Incoming;
|
|
225
|
+
// An explicit direction the edge cannot be followed in does not start at the root of the view.
|
|
226
|
+
if (explicit !== undefined && explicit !== derived) throw new EdgeNotIncidentOnRoot(type, member, edge.edgeType, node.label);
|
|
227
|
+
return derived;
|
|
228
|
+
}
|
|
229
|
+
|
|
230
|
+
private validateAcrossViews(resolved: ReadonlyMap<Constructor, ViewInfo>, edgesByType: ReadonlyMap<string, EdgeInfo>, failures: Map<Constructor, Error>): void {
|
|
231
|
+
const used = new Map<Function, Set<string>>();
|
|
232
|
+
for (const view of resolved.values()) {
|
|
233
|
+
for (const member of view.members) {
|
|
234
|
+
if (member.kind !== GraphViewMemberKind.Relation) continue;
|
|
235
|
+
const edges = used.get(member.target) ?? new Set<string>();
|
|
236
|
+
edges.add(member.edge.edgeType);
|
|
237
|
+
used.set(member.target, edges);
|
|
238
|
+
}
|
|
239
|
+
}
|
|
240
|
+
|
|
241
|
+
for (const view of resolved.values()) {
|
|
242
|
+
try {
|
|
243
|
+
const cycle = this.cycleThrough(view, resolved);
|
|
244
|
+
if (cycle !== undefined) throw new RecursiveView(view.type, cycle);
|
|
245
|
+
this.validateEdgeProperties(view, used.get(view.type), edgesByType);
|
|
246
|
+
} catch (error) {
|
|
247
|
+
failures.set(view.type, error instanceof Error ? error : new Error(String(error)));
|
|
248
|
+
}
|
|
249
|
+
}
|
|
250
|
+
}
|
|
251
|
+
|
|
252
|
+
private validateEdgeProperties(view: ViewInfo, edges: ReadonlySet<string> | undefined, edgesByType: ReadonlyMap<string, EdgeInfo>): void {
|
|
253
|
+
const members = view.members.filter((member): member is EdgePropertyMemberInfo => member.kind === GraphViewMemberKind.EdgeProperty);
|
|
254
|
+
if (members.length === 0) return;
|
|
255
|
+
if (edges === undefined || edges.size === 0) throw new EdgePropertyViewNotUsedAsTarget(view.type);
|
|
256
|
+
if (edges.size > 1) throw new EdgePropertyViewSharedAcrossEdges(view.type, [...edges]);
|
|
257
|
+
|
|
258
|
+
const edge = edgesByType.get([...edges][0])!;
|
|
259
|
+
for (const member of members) {
|
|
260
|
+
member.source = this.find(edge.properties, member.requested);
|
|
261
|
+
if (member.source === undefined) throw new UnknownEdgeProperty(view.type, member.name, edge.edgeType, member.requested);
|
|
262
|
+
}
|
|
263
|
+
}
|
|
264
|
+
|
|
265
|
+
private cycleThrough(start: ViewInfo, resolved: ReadonlyMap<Constructor, ViewInfo>): string[] | undefined {
|
|
266
|
+
const visited = new Set<Function>();
|
|
267
|
+
const walk = (current: ViewInfo, path: string[]): string[] | undefined => {
|
|
268
|
+
for (const member of current.members) {
|
|
269
|
+
if (member.kind !== GraphViewMemberKind.Relation) continue;
|
|
270
|
+
const next = resolved.get(member.target as Constructor);
|
|
271
|
+
if (next === undefined) continue;
|
|
272
|
+
if (next === start) return [...path, next.name];
|
|
273
|
+
if (visited.has(next.type)) continue;
|
|
274
|
+
visited.add(next.type);
|
|
275
|
+
const found = walk(next, [...path, next.name]);
|
|
276
|
+
if (found !== undefined) return found;
|
|
277
|
+
}
|
|
278
|
+
|
|
279
|
+
return undefined;
|
|
280
|
+
};
|
|
281
|
+
|
|
282
|
+
return walk(start, [start.name]);
|
|
283
|
+
}
|
|
284
|
+
|
|
285
|
+
private member(member: MemberInfo): GraphViewMember {
|
|
286
|
+
switch (member.kind) {
|
|
287
|
+
case GraphViewMemberKind.Relation:
|
|
288
|
+
return {
|
|
289
|
+
name: member.name,
|
|
290
|
+
kind: member.kind,
|
|
291
|
+
edge: member.edge.edgeType,
|
|
292
|
+
direction: member.direction,
|
|
293
|
+
cardinality: member.cardinality,
|
|
294
|
+
view: member.targetName
|
|
295
|
+
};
|
|
296
|
+
case GraphViewMemberKind.EdgeProperty:
|
|
297
|
+
return { name: member.name, kind: member.kind, source: member.source! };
|
|
298
|
+
default:
|
|
299
|
+
return { name: member.name, kind: member.kind, source: member.source };
|
|
300
|
+
}
|
|
301
|
+
}
|
|
302
|
+
|
|
303
|
+
private edgeOf(
|
|
304
|
+
reference: GraphViewEdgeReference,
|
|
305
|
+
edgesByClass: ReadonlyMap<Function, EdgeInfo>,
|
|
306
|
+
edgesByType: ReadonlyMap<string, EdgeInfo>
|
|
307
|
+
): EdgeInfo | undefined {
|
|
308
|
+
return typeof reference === 'string' ? edgesByType.get(reference) : edgesByClass.get(reference());
|
|
309
|
+
}
|
|
310
|
+
|
|
311
|
+
private edgeName(reference: GraphViewEdgeReference): string {
|
|
312
|
+
if (typeof reference === 'string') return reference;
|
|
313
|
+
const type = reference();
|
|
314
|
+
return getEdgeMetadata(type)?.type ?? type.name;
|
|
315
|
+
}
|
|
316
|
+
|
|
317
|
+
// Names are matched without regard to case, and an exact match wins.
|
|
318
|
+
private find(names: readonly string[], wanted: string): string | undefined {
|
|
319
|
+
const lowered = wanted.toLowerCase();
|
|
320
|
+
return names.find(name => name === wanted) ?? names.find(name => name.toLowerCase() === lowered);
|
|
321
|
+
}
|
|
322
|
+
}
|
|
@@ -0,0 +1,90 @@
|
|
|
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 { GraphViewMemberKind } from './GraphViewMemberKind.js';
|
|
5
|
+
import type { GraphView } from './GraphView.js';
|
|
6
|
+
import type { GraphViewDefinition } from './GraphViewDefinition.js';
|
|
7
|
+
import type { GraphViewMember } from './GraphViewMember.js';
|
|
8
|
+
import type { GraphViewSchema } from './GraphViewSchema.js';
|
|
9
|
+
import type { GraphViewSerializerOptions } from './GraphViewSerializerOptions.js';
|
|
10
|
+
|
|
11
|
+
/**
|
|
12
|
+
* Serializes a {@link GraphViewDefinition} canonically. The text is the same for every client that declares the same
|
|
13
|
+
* views: LF line endings, two-space indentation, a fixed order of properties, the views sorted by name in ordinal
|
|
14
|
+
* order, the members in declaration order and one trailing newline.
|
|
15
|
+
*/
|
|
16
|
+
export class GraphViewDefinitionSerializer {
|
|
17
|
+
/**
|
|
18
|
+
* Serializes a definition.
|
|
19
|
+
* @param definition - The {@link GraphViewDefinition}.
|
|
20
|
+
* @param options - Whether to include the schema, which is the form of the conformance fixture.
|
|
21
|
+
* @returns The canonical text.
|
|
22
|
+
*/
|
|
23
|
+
serialize(definition: GraphViewDefinition, options: GraphViewSerializerOptions = {}): string {
|
|
24
|
+
const views = [...definition.views].sort((left, right) => this.compareOrdinal(left.name, right.name));
|
|
25
|
+
const lines = ['{', ` "graph": ${JSON.stringify(definition.graph)},`];
|
|
26
|
+
if (options.includeSchema === true && definition.schema !== undefined) lines.push(...this.schema(definition.schema));
|
|
27
|
+
if (views.length === 0) {
|
|
28
|
+
lines.push(' "views": []');
|
|
29
|
+
} else {
|
|
30
|
+
lines.push(' "views": [');
|
|
31
|
+
views.forEach((view, index) => lines.push(...this.view(view, index < views.length - 1)));
|
|
32
|
+
lines.push(' ]');
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
lines.push('}');
|
|
36
|
+
return `${lines.join('\n')}\n`;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
private schema(schema: GraphViewSchema): string[] {
|
|
40
|
+
const list = (names: readonly string[]) => (names.length === 0 ? '[]' : `[ ${names.map(name => JSON.stringify(name)).join(', ')} ]`);
|
|
41
|
+
const nodes = schema.nodes.map(node =>
|
|
42
|
+
`{ "label": ${JSON.stringify(node.label)}, "key": ${JSON.stringify(node.key)}, "properties": ${list(node.properties)} }`);
|
|
43
|
+
const edges = schema.edges.map(edge => {
|
|
44
|
+
const identity = edge.identifiedBy === undefined ? '' : ` "identifiedBy": ${JSON.stringify(edge.identifiedBy)},`;
|
|
45
|
+
return `{ "type": ${JSON.stringify(edge.type)}, "source": ${JSON.stringify(edge.source)}, "target": ${JSON.stringify(edge.target)},${identity} "properties": ${list(edge.properties)} }`;
|
|
46
|
+
});
|
|
47
|
+
const block = (name: string, entries: string[], last: boolean) => [
|
|
48
|
+
entries.length === 0 ? ` "${name}": []${last ? '' : ','}` : ` "${name}": [`,
|
|
49
|
+
...(entries.length === 0 ? [] : [
|
|
50
|
+
...entries.map((entry, index) => ` ${entry}${index < entries.length - 1 ? ',' : ''}`),
|
|
51
|
+
` ]${last ? '' : ','}`
|
|
52
|
+
])
|
|
53
|
+
];
|
|
54
|
+
return [' "schema": {', ...block('nodes', nodes, false), ...block('edges', edges, true), ' },'];
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
private view(view: GraphView, hasNext: boolean): string[] {
|
|
58
|
+
const lines = [' {', ` "name": ${JSON.stringify(view.name)},`, ` "root": ${JSON.stringify(view.root)},`];
|
|
59
|
+
if (view.members.length === 0) {
|
|
60
|
+
lines.push(' "members": []');
|
|
61
|
+
} else {
|
|
62
|
+
lines.push(' "members": [');
|
|
63
|
+
view.members.forEach((member, index) => lines.push(` ${this.member(member)}${index < view.members.length - 1 ? ',' : ''}`));
|
|
64
|
+
lines.push(' ]');
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
lines.push(hasNext ? ' },' : ' }');
|
|
68
|
+
return lines;
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
private member(member: GraphViewMember): string {
|
|
72
|
+
const parts = [`"name": ${JSON.stringify(member.name)}`, `"kind": ${JSON.stringify(member.kind)}`];
|
|
73
|
+
if (member.kind === GraphViewMemberKind.Relation) {
|
|
74
|
+
parts.push(
|
|
75
|
+
`"edge": ${JSON.stringify(member.edge)}`,
|
|
76
|
+
`"direction": ${JSON.stringify(member.direction)}`,
|
|
77
|
+
`"cardinality": ${JSON.stringify(member.cardinality)}`,
|
|
78
|
+
`"view": ${JSON.stringify(member.view)}`);
|
|
79
|
+
} else {
|
|
80
|
+
parts.push(`"source": ${JSON.stringify(member.source)}`);
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
return `{ ${parts.join(', ')} }`;
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
private compareOrdinal(left: string, right: string): number {
|
|
87
|
+
if (left === right) return 0;
|
|
88
|
+
return left < right ? -1 : 1;
|
|
89
|
+
}
|
|
90
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
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
|
+
* Names the edge a relation follows: a function returning the edge class, which is resolved when the views are
|
|
6
|
+
* validated so the classes can be declared in any order, or the edge type string, for example MEMBER_OF.
|
|
7
|
+
*/
|
|
8
|
+
export type GraphViewEdgeReference = (() => Function) | string;
|
|
@@ -0,0 +1,11 @@
|
|
|
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 { GraphViewPropertyMember } from './GraphViewPropertyMember.js';
|
|
5
|
+
import type { GraphViewRelationMember } from './GraphViewRelationMember.js';
|
|
6
|
+
|
|
7
|
+
/**
|
|
8
|
+
* Represents a member of a view: a property of the root node, a relation to a nested view or a property of the edge
|
|
9
|
+
* that was followed.
|
|
10
|
+
*/
|
|
11
|
+
export type GraphViewMember = GraphViewPropertyMember | GraphViewRelationMember;
|
|
@@ -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 the kind of a member of a graph view.
|
|
6
|
+
*/
|
|
7
|
+
export enum GraphViewMemberKind {
|
|
8
|
+
/** A property of the root node. */
|
|
9
|
+
Property = 'property',
|
|
10
|
+
|
|
11
|
+
/** A relation that follows one declared edge type in one direction to a nested view. */
|
|
12
|
+
Relation = 'relation',
|
|
13
|
+
|
|
14
|
+
/** A property of the edge that was followed to reach the view. */
|
|
15
|
+
EdgeProperty = 'edgeProperty'
|
|
16
|
+
}
|
|
@@ -0,0 +1,31 @@
|
|
|
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
|
+
import type { GraphViewEdgeReference } from './GraphViewEdgeReference.js';
|
|
7
|
+
import type { GraphViewMemberKind } from './GraphViewMemberKind.js';
|
|
8
|
+
|
|
9
|
+
/** Metadata stored by the member decorators of a graph view. */
|
|
10
|
+
export interface GraphViewMemberMetadata {
|
|
11
|
+
/** The kind of the member. */
|
|
12
|
+
readonly kind: GraphViewMemberKind;
|
|
13
|
+
|
|
14
|
+
/** Whether the member is bound to the key of the root node. */
|
|
15
|
+
readonly isKey: boolean;
|
|
16
|
+
|
|
17
|
+
/** The name of the property of the node or edge the member reads. When missing, the name of the member is used. */
|
|
18
|
+
readonly source?: string;
|
|
19
|
+
|
|
20
|
+
/** The edge a relation follows. */
|
|
21
|
+
readonly edge?: GraphViewEdgeReference;
|
|
22
|
+
|
|
23
|
+
/** A function returning the class of the view a relation yields. */
|
|
24
|
+
readonly view?: () => Function;
|
|
25
|
+
|
|
26
|
+
/** The explicit direction of a relation. When missing, it is derived from the labels of the edge. */
|
|
27
|
+
readonly direction?: GraphEdgeDirection;
|
|
28
|
+
|
|
29
|
+
/** The cardinality of a relation. */
|
|
30
|
+
readonly cardinality?: GraphViewCardinality;
|
|
31
|
+
}
|
|
@@ -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 { GraphViewMemberKind } from './GraphViewMemberKind.js';
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* Represents a member of a view that reads a property of the root node, or of the edge that was followed.
|
|
8
|
+
*/
|
|
9
|
+
export interface GraphViewPropertyMember {
|
|
10
|
+
/** The name of the member. */
|
|
11
|
+
readonly name: string;
|
|
12
|
+
|
|
13
|
+
/** The kind of the member: a property of the node, or a property of the edge. */
|
|
14
|
+
readonly kind: GraphViewMemberKind.Property | GraphViewMemberKind.EdgeProperty;
|
|
15
|
+
|
|
16
|
+
/** The name of the property of the node or edge that is read. */
|
|
17
|
+
readonly source: string;
|
|
18
|
+
}
|
|
@@ -0,0 +1,47 @@
|
|
|
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 stable reason codes of the rules a graph view declaration must follow. Every error raised for an
|
|
6
|
+
* invalid view carries one of them in its reason.
|
|
7
|
+
*/
|
|
8
|
+
export enum GraphViewReason {
|
|
9
|
+
/** The root of the view is not a node declared in the graph. */
|
|
10
|
+
ViewRootNotANode = 'ViewRootNotANode',
|
|
11
|
+
|
|
12
|
+
/** A view type is also a node or an edge. */
|
|
13
|
+
ViewIsAlsoSchema = 'ViewIsAlsoSchema',
|
|
14
|
+
|
|
15
|
+
/** Two views of a graph have the same name. */
|
|
16
|
+
DuplicateViewName = 'DuplicateViewName',
|
|
17
|
+
|
|
18
|
+
/** A property member names a property the root node does not declare. */
|
|
19
|
+
UnknownNodeProperty = 'UnknownNodeProperty',
|
|
20
|
+
|
|
21
|
+
/** A relation names an edge type the graph does not declare. */
|
|
22
|
+
UnknownEdge = 'UnknownEdge',
|
|
23
|
+
|
|
24
|
+
/** An edge property member names a property the edge does not declare. */
|
|
25
|
+
UnknownEdgeProperty = 'UnknownEdgeProperty',
|
|
26
|
+
|
|
27
|
+
/** The source and the target label of the edge are both different from the label of the root of the view. */
|
|
28
|
+
EdgeNotIncidentOnRoot = 'EdgeNotIncidentOnRoot',
|
|
29
|
+
|
|
30
|
+
/** The edge is a self edge and the relation gives no explicit direction. */
|
|
31
|
+
AmbiguousDirection = 'AmbiguousDirection',
|
|
32
|
+
|
|
33
|
+
/** The root of the target view is not the label at the far end of the edge. */
|
|
34
|
+
TargetLabelMismatch = 'TargetLabelMismatch',
|
|
35
|
+
|
|
36
|
+
/** The target of a relation is not a declared view. */
|
|
37
|
+
RelationTargetNotAView = 'RelationTargetNotAView',
|
|
38
|
+
|
|
39
|
+
/** A view contains itself, directly or transitively. */
|
|
40
|
+
RecursiveView = 'RecursiveView',
|
|
41
|
+
|
|
42
|
+
/** A view with edge property members is not the target of any relation. */
|
|
43
|
+
EdgePropertyViewNotUsedAsTarget = 'EdgePropertyViewNotUsedAsTarget',
|
|
44
|
+
|
|
45
|
+
/** A view with edge property members is the target of relations of more than one edge type. */
|
|
46
|
+
EdgePropertyViewSharedAcrossEdges = 'EdgePropertyViewSharedAcrossEdges'
|
|
47
|
+
}
|
|
@@ -0,0 +1,29 @@
|
|
|
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
|
+
import type { GraphViewMemberKind } from './GraphViewMemberKind.js';
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* Represents a member of a view that follows one edge type in one direction to a nested view.
|
|
10
|
+
*/
|
|
11
|
+
export interface GraphViewRelationMember {
|
|
12
|
+
/** The name of the member. */
|
|
13
|
+
readonly name: string;
|
|
14
|
+
|
|
15
|
+
/** The kind of the member. */
|
|
16
|
+
readonly kind: GraphViewMemberKind.Relation;
|
|
17
|
+
|
|
18
|
+
/** The edge type that is followed, for example MEMBER_OF. */
|
|
19
|
+
readonly edge: string;
|
|
20
|
+
|
|
21
|
+
/** The direction in which the edge is followed, seen from the root node of the view. */
|
|
22
|
+
readonly direction: GraphEdgeDirection;
|
|
23
|
+
|
|
24
|
+
/** Whether the relation yields a list or a single item. */
|
|
25
|
+
readonly cardinality: GraphViewCardinality;
|
|
26
|
+
|
|
27
|
+
/** The name of the nested view. */
|
|
28
|
+
readonly view: string;
|
|
29
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
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 { GraphViewSchemaEdge } from './GraphViewSchemaEdge.js';
|
|
5
|
+
import type { GraphViewSchemaNode } from './GraphViewSchemaNode.js';
|
|
6
|
+
|
|
7
|
+
/** Represents the nodes and edges of the graph the views were validated against. */
|
|
8
|
+
export interface GraphViewSchema {
|
|
9
|
+
/** The nodes. */
|
|
10
|
+
readonly nodes: readonly GraphViewSchemaNode[];
|
|
11
|
+
|
|
12
|
+
/** The edges. */
|
|
13
|
+
readonly edges: readonly GraphViewSchemaEdge[];
|
|
14
|
+
}
|
|
@@ -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
|
+
/** Represents an edge of the graph the views were validated against. */
|
|
5
|
+
export interface GraphViewSchemaEdge {
|
|
6
|
+
/** The edge type, for example MEMBER_OF. */
|
|
7
|
+
readonly type: string;
|
|
8
|
+
|
|
9
|
+
/** The label of the node the edge starts at. */
|
|
10
|
+
readonly source: string;
|
|
11
|
+
|
|
12
|
+
/** The label of the node the edge ends at. */
|
|
13
|
+
readonly target: string;
|
|
14
|
+
|
|
15
|
+
/** The name of the property that identifies the edge, for an identified edge. */
|
|
16
|
+
readonly identifiedBy?: string;
|
|
17
|
+
|
|
18
|
+
/** The names of the properties of the edge. */
|
|
19
|
+
readonly properties: readonly string[];
|
|
20
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
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
|
+
/** Represents a node of the graph the views were validated against. */
|
|
5
|
+
export interface GraphViewSchemaNode {
|
|
6
|
+
/** The node label. */
|
|
7
|
+
readonly label: string;
|
|
8
|
+
|
|
9
|
+
/** The name of the property that holds the key of the node. */
|
|
10
|
+
readonly key: string;
|
|
11
|
+
|
|
12
|
+
/** The names of the properties of the node. */
|
|
13
|
+
readonly properties: readonly string[];
|
|
14
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
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
|
+
/** Options of the {@link GraphViewDefinitionSerializer}. */
|
|
5
|
+
export interface GraphViewSerializerOptions {
|
|
6
|
+
/**
|
|
7
|
+
* Whether to also write the schema, the nodes and edges the views were validated against, between the graph and
|
|
8
|
+
* the views. It is the form of the shared conformance fixture. Defaults to false.
|
|
9
|
+
*/
|
|
10
|
+
readonly includeSchema?: boolean;
|
|
11
|
+
}
|
|
@@ -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 contains itself, directly or transitively.
|
|
8
|
+
*/
|
|
9
|
+
export class RecursiveView extends Error {
|
|
10
|
+
/** The stable reason code of the rule that was broken. */
|
|
11
|
+
readonly reason = GraphViewReason.RecursiveView;
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Creates a new {@link RecursiveView}.
|
|
15
|
+
* @param view - The view type.
|
|
16
|
+
* @param path - The names of the views that make the cycle, starting and ending with the view.
|
|
17
|
+
*/
|
|
18
|
+
constructor(view: Function, path: readonly string[]) {
|
|
19
|
+
super(`The view '${view.name}' contains itself: ${path.join(' -> ')}. Nesting must be finite.`);
|
|
20
|
+
this.name = 'RecursiveView';
|
|
21
|
+
}
|
|
22
|
+
}
|