@cratis/event-models 0.243.4 → 0.244.0

package/README.md

@@ -66,9 +66,11 @@ Add optional `annotations` to each slice in your document:
 ]
 ```
 
-Each finding requires `severity` (`information`, `warning` or `error`) and a string `message`; `code` and `eventId` are optional. The reader rejects unknown severities with `InvalidEventModelDocument` and the offending path. The header badge uses the worst severity and lists every finding in its tooltip and accessible label. Localize its words through `EventModelMessages.annotations`.
+Each finding requires `severity` (`information`, `warning` or `error`) and a string `message`; `code` and the targets below are optional. The reader rejects unknown severities with `InvalidEventModelDocument` and the offending path. The header badge uses the worst severity and lists every finding in its tooltip and accessible label. Localize its words through `EventModelMessages.annotations`.
 
-An `eventId` targets the card's own id within that slice, including a reference card's id rather than its `sourceEventId`. Matching cards get a dashed outline and a message badge; unmatched ids are ignored by the events row. Findings work on read-only and collapsed headers and never change layout estimates. Omit `annotations` to keep the existing rendering. The built-in State View ordering warning shares the marker but its check is unchanged. See the `annotations` fixture and the Slices Area `Annotations` story.
+An `eventId` targets the card's own id within that slice, including a reference card's id rather than its `sourceEventId`. Matching cards get a dashed outline and a message badge; unmatched ids are ignored by the events row. Other optional ids target other cards of the same slice: `commandId` the command card, `readModelId` one of its read model cards (the first or an additional one), and `specificationId` one specification. A finding with a `specificationId` and no `specificationStep` marks that specification's header; with `specificationStep` (`given`, `givenReadModel`, `when`, `append` or `then`) and a `stepIndex` (its position among the steps of that kind, starting at 0) it is aimed at one step, and the host places it. The reader rejects an unknown `specificationStep`. Cards that carry a finding get the same dashed outline and badge as an event card. Ids that match nothing are ignored.
+
+Findings work on read-only and collapsed headers and never change layout estimates. Omit `annotations` to keep the existing rendering. The built-in State View ordering warning shares the marker but its check is unchanged. See the `annotations` fixture and the Slices Area `Annotations` story.
 
 ## Select scopes, emphasize dependencies and draw slice links
 

package/dist/Model/SliceAnnotation.d.ts

@@ -1,8 +1,14 @@
 import type { Guid } from '@cratis/fundamentals';
 import type { AnnotationSeverity } from './AnnotationSeverity';
+import type { SliceAnnotationStep } from './SliceAnnotationStep';
 export interface SliceAnnotation {
     severity: AnnotationSeverity;
     code?: string;
     message: string;
     eventId?: Guid;
+    commandId?: Guid;
+    readModelId?: Guid;
+    specificationId?: Guid;
+    specificationStep?: SliceAnnotationStep;
+    stepIndex?: number;
 }

package/dist/Model/SliceAnnotationStep.d.ts

@@ -0,0 +1,7 @@
+export declare enum SliceAnnotationStep {
+    given = "given",
+    givenReadModel = "givenReadModel",
+    when = "when",
+    append = "append",
+    then = "then"
+}

package/dist/Model/index.d.ts

@@ -40,6 +40,7 @@ export * from './ReadModelItem';
 export * from './ScreenTemplate';
 export * from './Slice';
 export * from './SliceAnnotation';
+export * from './SliceAnnotationStep';
 export * from './SliceSpecification';
 export * from './SliceStatus';
 export * from './SliceType';

package/dist/Rows/Interaction/InteractionCard.d.ts

@@ -1,6 +1,7 @@
 import type { Guid } from '@cratis/fundamentals';
 import type { JsonSchema } from '@cratis/components/types';
 import { ArtifactCardKind } from '../../Cards';
+import type { SliceAnnotation } from '../../Model';
 export type InteractionCardKind = ArtifactCardKind.command | ArtifactCardKind.readModel;
 export interface InteractionCardProps {
     sliceId: Guid;
@@ -11,6 +12,7 @@ export interface InteractionCardProps {
     description?: string;
     documentation?: string;
     showDetails?: boolean;
+    annotations?: readonly SliceAnnotation[];
     onRenamed?: (name: string) => void;
 }
-export declare const InteractionCard: ({ sliceId, kind, artifactId, name, schema, description, documentation, showDetails, onRenamed }: InteractionCardProps) => import("react").JSX.Element;
+export declare const InteractionCard: ({ sliceId, kind, artifactId, name, schema, description, documentation, showDetails, annotations, onRenamed }: InteractionCardProps) => import("react").JSX.Element;

package/dist/Specifications/SpecificationCollection.d.ts

@@ -1,6 +1,6 @@
 import { type ReactNode } from 'react';
 import { Guid } from '@cratis/fundamentals';
-import type { SliceSpecification } from '../Model';
+import type { SliceAnnotation, SliceSpecification } from '../Model';
 import { SpecificationRunState } from './SpecificationRunState';
 export interface SpecificationCollectionProps {
     sliceId: Guid;
@@ -13,6 +13,7 @@ export interface SpecificationCollectionProps {
     };
     executionLabel?: string;
     nameNoticeFor?: (specification: SliceSpecification) => string | undefined;
+    annotations?: readonly SliceAnnotation[];
     renderRows: (specification: SliceSpecification) => ReactNode;
 }
-export declare const SpecificationCollection: ({ sliceId, width, collapsed, specifications: incoming, runInfoFor, executionLabel, nameNoticeFor, renderRows }: SpecificationCollectionProps) => import("react").JSX.Element | null;
+export declare const SpecificationCollection: ({ sliceId, width, collapsed, specifications: incoming, runInfoFor, executionLabel, nameNoticeFor, annotations, renderRows }: SpecificationCollectionProps) => import("react").JSX.Element | null;

package/dist/Specifications/SpecificationHeader.d.ts

@@ -1,4 +1,5 @@
 import type { ReactNode } from 'react';
+import type { SliceAnnotation } from '../Model';
 import { SpecificationRunState } from './SpecificationRunState';
 export interface SpecificationHeaderProps {
     name: string;
@@ -9,10 +10,11 @@ export interface SpecificationHeaderProps {
     runState: SpecificationRunState;
     runMessage?: string;
     nameNotice?: string;
+    annotations?: readonly SliceAnnotation[];
     executionLabel?: string;
     onRenamed?: (name: string) => void;
     onDeleted?: () => void;
     runControl?: ReactNode;
     gutter?: ReactNode;
 }
-export declare const SpecificationHeader: ({ name, description, documentation, collapsed, onToggleCollapse, runState, runMessage, nameNotice, executionLabel, onRenamed, onDeleted, runControl, gutter, }: SpecificationHeaderProps) => import("react").JSX.Element;
+export declare const SpecificationHeader: ({ name, description, documentation, collapsed, onToggleCollapse, runState, runMessage, nameNotice, annotations, executionLabel, onRenamed, onDeleted, runControl, gutter, }: SpecificationHeaderProps) => import("react").JSX.Element;

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

@@ -335,6 +335,27 @@
                 "eventId": {
                     "$ref": "#/$defs/Guid",
                     "description": "The id of an owned or reference event card in this slice; unmatched ids are ignored."
+                },
+                "commandId": {
+                    "$ref": "#/$defs/Guid",
+                    "description": "The id of the slice's command card; an unmatched id is ignored."
+                },
+                "readModelId": {
+                    "$ref": "#/$defs/Guid",
+                    "description": "The id of one of the slice's read model cards; an unmatched id is ignored."
+                },
+                "specificationId": {
+                    "$ref": "#/$defs/Guid",
+                    "description": "The id of one of the slice's specifications; the finding marks its header. An unmatched id is ignored."
+                },
+                "specificationStep": {
+                    "type": "string",
+                    "enum": ["given", "givenReadModel", "when", "append", "then"],
+                    "description": "The kind of step of the specification the finding is about."
+                },
+                "stepIndex": {
+                    "type": "number",
+                    "description": "The position of the step among the steps of its kind."
                 }
             }
         },