@cratis/event-models 0.170.0 → 0.171.0

package/dist/Messages/SpecificationValueMessages.d.ts

@@ -4,5 +4,6 @@ export interface SpecificationValueMessages {
     roles: string;
     authenticated: string;
     anonymous: string;
+    eventSource?: string;
 }
 export declare const defaultSpecificationValueMessages: SpecificationValueMessages;

package/dist/Model/SliceSpecification.d.ts

@@ -7,15 +7,18 @@ import type { SpecificationGivenEvent } from './SpecificationGivenEvent';
 import type { SpecificationReadModel } from './SpecificationReadModel';
 import type { SpecificationRunOutcome } from './SpecificationRunOutcome';
 import type { SpecificationThenEvent } from './SpecificationThenEvent';
+import type { SpecificationWhenEvent } from './SpecificationWhenEvent';
 export interface SliceSpecification {
     id: Guid;
     name: string;
     given: SpecificationGivenEvent[];
     givenContexts?: SpecificationGivenContext[];
     when?: SpecificationCommand;
+    whenEvent?: SpecificationWhenEvent;
     caller?: SpecificationCaller;
     givenReadModel?: SpecificationReadModel;
     thenEvents: SpecificationThenEvent[];
+    thenReadModel?: SpecificationReadModel;
     thenErrors: SpecificationError[];
     collapsed: boolean;
     lastRunOutcome?: SpecificationRunOutcome;

package/dist/Model/SpecificationWhenEvent.d.ts

@@ -0,0 +1,8 @@
+import type { Guid } from '@cratis/fundamentals';
+export interface SpecificationWhenEvent {
+    id: Guid;
+    name: string;
+    eventId: Guid;
+    eventSourceId?: string;
+    values: Record<string, unknown>;
+}

package/dist/Model/index.d.ts

@@ -46,6 +46,7 @@ export * from './SpecificationGivenContext';
 export * from './SpecificationReadModel';
 export * from './SpecificationRunOutcome';
 export * from './SpecificationThenEvent';
+export * from './SpecificationWhenEvent';
 export * from './StickyNote';
 export * from './TranslationDirection';
 export * from './UserExperienceActor';

package/dist/Specifications/formatSpecificationValues.d.ts

@@ -1,4 +1,5 @@
 import type { SpecificationCaller } from '../Model';
-import type { SpecificationValueMessages } from '../Messages';
+import { type SpecificationValueMessages } from '../Messages';
 export declare const formatSpecificationValue: (value: unknown) => string;
+export declare const eventSourceSummary: (eventSourceId: string, words: SpecificationValueMessages) => string;
 export declare const callerSummary: (caller: SpecificationCaller, words: SpecificationValueMessages) => string | undefined;

package/dist/event-model-document.schema.json

@@ -763,6 +763,10 @@
                 "when": {
                     "$ref": "#/$defs/SpecificationCommand"
                 },
+                "whenEvent": {
+                    "$ref": "#/$defs/SpecificationWhenEvent",
+                    "description": "The one event the specification appends as its action. When present, the When shows only this event."
+                },
                 "givenReadModel": {
                     "$ref": "#/$defs/SpecificationReadModel"
                 },
@@ -784,6 +788,10 @@
                         "$ref": "#/$defs/SpecificationError"
                     }
                 },
+                "thenReadModel": {
+                    "$ref": "#/$defs/SpecificationReadModel",
+                    "description": "The read model, and the values in it, the specification expects afterwards."
+                },
                 "caller": {
                     "$ref": "#/$defs/SpecificationCaller"
                 },
@@ -863,6 +871,32 @@
                 }
             }
         },
+        "SpecificationWhenEvent": {
+            "type": "object",
+            "required": [
+                "id",
+                "eventId"
+            ],
+            "properties": {
+                "id": {
+                    "$ref": "#/$defs/Guid"
+                },
+                "name": {
+                    "type": "string"
+                },
+                "eventId": {
+                    "$ref": "#/$defs/Guid"
+                },
+                "eventSourceId": {
+                    "type": "string",
+                    "description": "The event source the event is appended to; absent when the specification does not state one."
+                },
+                "values": {
+                    "type": "object",
+                    "additionalProperties": true
+                }
+            }
+        },
         "SpecificationCommand": {
             "type": "object",
             "required": [