@cratis/event-models 0.233.0 → 0.235.0

package/dist/Cards/ArtifactCard.d.ts

@@ -8,6 +8,7 @@ export interface ArtifactCardProps extends Omit<CardProps, 'backgroundColor' | '
     kind: ArtifactCardKind;
     artifactId?: Guid;
     summary?: string;
+    description?: string;
     tags?: readonly string[];
     marker?: ReactNode;
     schema?: string | JsonSchema;
@@ -15,4 +16,4 @@ export interface ArtifactCardProps extends Omit<CardProps, 'backgroundColor' | '
     actions?: readonly CardAction[];
     onActivate?: (artifactId: Guid, host: DOMRect) => void;
 }
-export declare const ArtifactCard: ({ kind, artifactId, summary, tags, marker, schema, showDetails, actions, onActivate, onSelected, ...cardProps }: ArtifactCardProps) => React.JSX.Element;
+export declare const ArtifactCard: ({ kind, artifactId, summary, description, tags, marker, schema, showDetails, actions, onActivate, onSelected, ...cardProps }: ArtifactCardProps) => React.JSX.Element;

package/dist/Collections/CollectionGrid.d.ts

@@ -25,4 +25,4 @@ export interface CollectionGridProps extends CollectionGridEditor {
     rowLabels?: (props: RowLabelsColumnProps) => ReactNode;
     onActorsReordered?: RowLabelsColumnProps['onActorsReordered'];
 }
-export declare const CollectionGrid: ({ collection, getZoom, slots, onDeselect, onCollectionMoving, onCollectionMoved, canMove, onAddModule, onModulesReordered, onCollapseChanged, onRenameModule, onModulesChanged, onFeaturesChanged, onPersistenceError, rowLabels, onActorsReordered, onAddFeature, onRenameFeature, onFeatureCollapseChanged, onFeaturesReordered, onAddSlice, onReorderSlices, onMoveSlice, validateSliceDrop, onSliceCollapseChanged, onSliceRenamed, onSliceDuplicated }: CollectionGridProps) => import("react").JSX.Element;
+export declare const CollectionGrid: ({ collection, getZoom, slots, onDeselect, onCollectionMoving, onCollectionMoved, canMove, onAddModule, onModulesReordered, onCollapseChanged, onRenameModule, onModulesChanged, onFeaturesChanged, onPersistenceError, rowLabels, onActorsReordered, onAddFeature, onRenameFeature, onFeatureCollapseChanged, onFeaturesReordered, onAddSlice, onReorderSlices, onMoveSlice, validateSliceDrop, onSliceCollapseChanged, onSliceRenamed, onSliceDuplicated, takenArtifactNames }: CollectionGridProps) => import("react").JSX.Element;

package/dist/Collections/CollectionGridEditor.d.ts

@@ -1,6 +1,7 @@
 import type { Guid } from '@cratis/fundamentals';
 import type { Feature, Slice } from '../Model';
 import type { ValidateSliceDrop } from '../SliceDragging';
+import type { ArtifactNames } from '../Slices/ArtifactNames';
 export interface CollectionGridEditor {
     onAddFeature?: (moduleId: Guid, name?: string, parentId?: Guid) => Promise<Feature | undefined>;
     onRenameFeature?: (featureId: Guid, name: string) => Promise<void>;
@@ -13,4 +14,5 @@ export interface CollectionGridEditor {
     onSliceCollapseChanged?: (featureId: Guid, sliceId: Guid, collapsed: boolean) => void;
     onSliceRenamed?: (featureId: Guid, sliceId: Guid, name: string) => void;
     onSliceDuplicated?: (featureId: Guid, sourceSliceId: Guid, newSliceId: Guid) => void;
+    takenArtifactNames?: () => ArtifactNames;
 }

package/dist/Collections/collectionGridLayout.d.ts

@@ -1,5 +1,6 @@
 import { type Feature, type ModuleCollection, type Slice } from '../Model';
 import { RowType } from '../Rows';
+import { type BoardDensity, type BoardTextSize } from '../Presentation';
 export interface CollectionSlice {
     slice: Slice;
     moduleId: string;
@@ -8,8 +9,8 @@ export interface CollectionSlice {
 export declare const collectionSlices: (collection: ModuleCollection) => CollectionSlice[];
 export type SliceDetailsVisibility = (slice: CollectionSlice) => boolean;
 export declare const collectionRows: (collection: ModuleCollection) => RowType[];
-export declare const collectionRowHeights: (collection: ModuleCollection, showsDetails?: SliceDetailsVisibility) => Record<RowType, number>;
+export declare const collectionRowHeights: (collection: ModuleCollection, showsDetails?: SliceDetailsVisibility, textSize?: BoardTextSize) => Record<RowType, number>;
 export declare const collectionContentHeight: (collection: ModuleCollection, rows: readonly RowType[], heights: Readonly<Record<RowType, number>>) => number;
 export declare const featureWidth: (feature: Feature) => number;
 export declare const featureColumns: (features: Feature[]) => Feature[];
-export declare const collectionModuleWidth: (name: string, features: Feature[]) => number;
+export declare const collectionModuleWidth: (name: string, features: Feature[], density?: BoardDensity) => number;

package/dist/Collections/estimateCollectionSize.d.ts

@@ -1,8 +1,9 @@
 import type { ModuleCollection } from '../Model';
+import { type BoardDensity, type BoardTextSize } from '../Presentation';
 import { type SliceDetailsVisibility } from './collectionGridLayout';
 export interface CollectionSizeEstimate {
     width: number;
     height: number;
     moduleWidths: number[];
 }
-export declare const estimateCollectionSize: (collection: ModuleCollection, showsDetails?: SliceDetailsVisibility) => CollectionSizeEstimate;
+export declare const estimateCollectionSize: (collection: ModuleCollection, showsDetails?: SliceDetailsVisibility, density?: BoardDensity, textSize?: BoardTextSize) => CollectionSizeEstimate;

package/dist/Descriptions/Description.d.ts

@@ -0,0 +1,13 @@
+export interface DescriptionProps {
+    description?: string;
+    documentation?: string;
+    lines?: 1 | 2;
+    tooltipPosition?: 'top' | 'bottom';
+    plain?: boolean;
+}
+export interface DescriptionFullProps {
+    description?: string;
+    documentation?: string;
+}
+export declare const DescriptionFull: ({ description, documentation }: DescriptionFullProps) => import("react").JSX.Element | null;
+export declare const Description: ({ description, documentation, lines, tooltipPosition, plain }: DescriptionProps) => import("react").JSX.Element | null;

package/dist/Descriptions/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Description';
+export * from './shownText';

package/dist/Descriptions/shownText.d.ts

@@ -0,0 +1 @@
+export declare const shownText: (text: string | undefined) => string | undefined;

package/dist/Features/FeatureHeader.d.ts

@@ -5,6 +5,8 @@ import { type HeaderDragStart } from '../HeaderDragging';
 export interface FeatureHeaderProps {
     featureId: Guid;
     name: string;
+    description?: string;
+    documentation?: string;
     height: number;
     collapsed: boolean;
     onToggleCollapse?: () => void;
@@ -20,4 +22,4 @@ export interface FeatureHeaderProps {
     onAddSubFeature?: () => void;
     onAddSlice?: (sliceType: SliceType) => void;
 }
-export declare const FeatureHeader: ({ featureId, name, height, collapsed, onToggleCollapse, onRenamed, status, selectableStatuses, unselectableStatusReason, detailsVisible, onToggleDetails, dragging, onDragStart, error, onAddSubFeature, onAddSlice, }: FeatureHeaderProps) => import("react").JSX.Element;
+export declare const FeatureHeader: ({ featureId, name, description, documentation, height, collapsed, onToggleCollapse, onRenamed, status, selectableStatuses, unselectableStatusReason, detailsVisible, onToggleDetails, dragging, onDragStart, error, onAddSubFeature, onAddSlice, }: FeatureHeaderProps) => import("react").JSX.Element;

package/dist/Headers/PillHeader.d.ts

@@ -15,6 +15,9 @@ export interface PillHeaderProps {
     /** Extra affordances rendered right after the collapse button, before the label — such as the conversation button. */
     leadingContent?: React.ReactNode;
     marker?: React.ReactNode;
+    /** Host-supplied text drawn under the label, clamped to one line, with the documentation in its tooltip. Nothing is drawn without it, or while collapsed. */
+    description?: string;
+    documentation?: string;
     children?: React.ReactNode;
     draggable?: boolean;
     onPointerDown?: React.PointerEventHandler<HTMLDivElement>;

package/dist/Layout/cardHeight.d.ts

@@ -2,4 +2,4 @@ import type { JsonSchema } from '@cratis/components/SchemaEditor';
 export interface CardLayoutInput {
     schema?: string | JsonSchema;
 }
-export declare function detailedCardHeight(card: CardLayoutInput): number;
+export declare function detailedCardHeight(card: CardLayoutInput, textScale?: number): number;

package/dist/Layout/sliceLayout.d.ts

@@ -12,8 +12,8 @@ export declare function sliceColumnWidth(slice: SliceLayoutInput | {
     sliceType: SliceType;
     eventCount: number;
 }): number;
-export declare function rowHeightForSlice(rowType: RowType, slice: SliceLayoutInput, showDetails?: boolean): number;
+export declare function rowHeightForSlice(rowType: RowType, slice: SliceLayoutInput, showDetails?: boolean, textScale?: number): number;
 export declare function computeGlobalRowHeights(slices: readonly {
     slice: SliceLayoutInput;
     showDetails?: boolean;
-}[], contentRows: readonly RowType[]): Record<RowType, number>;
+}[], contentRows: readonly RowType[], textScale?: number): Record<RowType, number>;

package/dist/Model/CommandItem.d.ts

@@ -5,6 +5,8 @@ import type { CommandPropertyRules } from './CommandPropertyRules';
 export interface CommandItem {
     id: Guid;
     name: string;
+    description?: string;
+    documentation?: string;
     schema: JsonSchema;
     stateSchema: JsonSchema;
     logicDescription: string;

package/dist/Model/EventItem.d.ts

@@ -5,6 +5,8 @@ import type { EventVisibility } from './EventVisibility';
 export interface EventItem {
     id: Guid;
     name: string;
+    description?: string;
+    documentation?: string;
     schema: JsonSchema;
     sourceEventId?: string;
     tags?: string[];

package/dist/Model/Feature.d.ts

@@ -4,6 +4,8 @@ import type { Slice } from './Slice';
 export interface Feature {
     id: Guid;
     name: string;
+    description?: string;
+    documentation?: string;
     subFeatures: Feature[];
     slices: Slice[];
     collapsed: boolean;

package/dist/Model/Module.d.ts

@@ -4,6 +4,8 @@ import type { ScreenTemplate } from './ScreenTemplate';
 export interface Module {
     id: Guid;
     name: string;
+    description?: string;
+    documentation?: string;
     features: Feature[];
     collapsed: boolean;
     sortOrder: number;

package/dist/Model/ReadModelItem.d.ts

@@ -3,6 +3,8 @@ import type { JsonSchema } from '@cratis/components/types';
 export interface ReadModelItem {
     id: Guid;
     name: string;
+    description?: string;
+    documentation?: string;
     schema: JsonSchema;
     materializes: boolean;
 }

package/dist/Model/Slice.d.ts

@@ -19,6 +19,7 @@ export interface Slice {
     name: string;
     sliceType: SliceType;
     description: string;
+    documentation?: string;
     status: SliceStatus;
     collapsed: boolean;
     sortOrder: number;

package/dist/Model/SliceSpecification.d.ts

@@ -12,6 +12,8 @@ import type { SpecificationWhenEvent } from './SpecificationWhenEvent';
 export interface SliceSpecification {
     id: Guid;
     name: string;
+    description?: string;
+    documentation?: string;
     given: SpecificationGivenEvent[];
     givenContexts?: SpecificationGivenContext[];
     when?: SpecificationCommand;

package/dist/Modules/ModuleHeader.d.ts

@@ -4,6 +4,8 @@ import { type HeaderDragStart } from '../HeaderDragging';
 export interface ModuleHeaderProps {
     moduleId: Guid;
     name: string;
+    description?: string;
+    documentation?: string;
     height: number;
     collapsed: boolean;
     onToggleCollapse?: () => void;
@@ -17,4 +19,4 @@ export interface ModuleHeaderProps {
     onDragStart?: (start: HeaderDragStart) => void;
     error?: string;
 }
-export declare const ModuleHeader: ({ moduleId, name, height, collapsed, onToggleCollapse, onAddModule, onAddFeature, onRenamed, validateName, status, detailsVisible, onToggleDetails, onDragStart, error, }: ModuleHeaderProps) => import("react").JSX.Element;
+export declare const ModuleHeader: ({ moduleId, name, description, documentation, height, collapsed, onToggleCollapse, onAddModule, onAddFeature, onRenamed, validateName, status, detailsVisible, onToggleDetails, onDragStart, error, }: ModuleHeaderProps) => import("react").JSX.Element;

package/dist/Modules/moduleWidth.d.ts

@@ -1,2 +1,2 @@
 import { type MeasureLabelWidth } from '../Geometry';
-export declare function moduleWidth(featureWidths: readonly number[], name: string, measure?: MeasureLabelWidth): number;
+export declare function moduleWidth(featureWidths: readonly number[], name: string, measure?: MeasureLabelWidth, featureGap?: number): number;

package/dist/Presentation/BoardDensity.d.ts

@@ -0,0 +1,7 @@
+export type BoardDensity = 'compact' | 'comfortable' | 'spacious';
+export declare const defaultBoardDensity: BoardDensity;
+export interface BoardGaps {
+    module: number;
+    feature: number;
+}
+export declare const boardGaps: (density?: BoardDensity) => BoardGaps;

package/dist/Presentation/BoardTextSize.d.ts

@@ -0,0 +1,3 @@
+export type BoardTextSize = 'small' | 'medium' | 'large';
+export declare const defaultBoardTextSize: BoardTextSize;
+export declare const boardTextScale: (size?: BoardTextSize) => number;

package/dist/Presentation/EventModelPresentation.d.ts

@@ -1,3 +1,5 @@
+import type { BoardDensity } from './BoardDensity';
+import type { BoardTextSize } from './BoardTextSize';
 import type { DetailLevel } from './DetailLevel';
 import type { DetailsVisibilityState } from './detailsVisibility';
 import type { VisualizationMode } from './VisualizationMode';
@@ -6,4 +8,6 @@ export interface EventModelPresentation {
     visualizationMode: VisualizationMode;
     detailsVisibility: DetailsVisibilityState;
     showStatuses?: boolean;
+    density?: BoardDensity;
+    textSize?: BoardTextSize;
 }

package/dist/Presentation/index.d.ts

@@ -1,5 +1,7 @@
 export * from './VisualizationMode';
 export * from './DetailLevel';
+export * from './BoardDensity';
+export * from './BoardTextSize';
 export * from './detailsVisibility';
 export * from './EventModelPresentation';
 export * from './defaultEventModelPresentation';

package/dist/Reading/readDescriptions.d.ts

@@ -0,0 +1,8 @@
+import type { DocumentNode } from './DocumentNode';
+export declare const readDescriptions: (node: DocumentNode) => {
+    description?: string;
+    documentation?: string;
+};
+export declare const readDocumentation: (node: DocumentNode) => {
+    documentation?: string;
+};

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

@@ -8,7 +8,9 @@ export interface InteractionCardProps {
     artifactId: Guid;
     name: string;
     schema: JsonSchema;
+    description?: string;
+    documentation?: string;
     showDetails?: boolean;
     onRenamed?: (name: string) => void;
 }
-export declare const InteractionCard: ({ sliceId, kind, artifactId, name, schema, showDetails, onRenamed }: InteractionCardProps) => import("react").JSX.Element;
+export declare const InteractionCard: ({ sliceId, kind, artifactId, name, schema, description, documentation, showDetails, onRenamed }: InteractionCardProps) => import("react").JSX.Element;

package/dist/Slices/ArtifactNames.d.ts

@@ -0,0 +1,5 @@
+export interface ArtifactNames {
+    commands: readonly string[];
+    events: readonly string[];
+    readModels: readonly string[];
+}

package/dist/Slices/SliceHeaderSlice.d.ts

@@ -1,2 +1,2 @@
 import type { Slice } from '../Model';
-export type SliceHeaderSlice = Pick<Slice, 'id' | 'name' | 'sliceType' | 'status' | 'translationDirection' | 'annotations'>;
+export type SliceHeaderSlice = Pick<Slice, 'id' | 'name' | 'sliceType' | 'status' | 'translationDirection' | 'annotations'> & Partial<Pick<Slice, 'description' | 'documentation'>>;

package/dist/Slices/SlicesArea.d.ts

@@ -3,6 +3,7 @@ import type { Guid } from '@cratis/fundamentals';
 import { useSliceDrag, type ValidateSliceDrop } from '../SliceDragging';
 import type { Slice, SliceType } from '../Model';
 import type { SliceNames } from './SliceNames';
+import type { ArtifactNames } from './ArtifactNames';
 import { type SliceAreaItem } from './sliceAreaState';
 export interface SlicesAreaHandle<T extends SliceAreaItem> {
     addSlice: (sliceType: SliceType, afterSliceId?: Guid, names?: SliceNames) => void;
@@ -21,6 +22,7 @@ export interface SlicesAreaProps<T extends SliceAreaItem> {
     featureCollapsed: boolean;
     hideEmptyPlaceholder?: boolean;
     onSlicesChanged?: (slices: T[]) => void;
+    takenArtifactNames?: (slices: T[]) => ArtifactNames;
     createSlice: (slice: Slice) => T;
     onAddSlice?: (slice: T, afterSliceId?: Guid) => Promise<Guid | undefined>;
     onReorderSlices?: (sliceIds: Guid[]) => Promise<boolean>;
@@ -35,4 +37,4 @@ export interface SlicesAreaProps<T extends SliceAreaItem> {
         updateSlices: SlicesAreaHandle<T>['updateSlices'];
     }) => ReactNode;
 }
-export declare function SlicesArea<T extends SliceAreaItem>({ ref, initialSlices, moduleId, featureId, featureCollapsed, hideEmptyPlaceholder, onSlicesChanged, createSlice, onAddSlice, onReorderSlices, onMoveSlice, validateSliceDrop, renderSlice, }: SlicesAreaProps<T>): import("react").JSX.Element | null;
+export declare function SlicesArea<T extends SliceAreaItem>({ ref, initialSlices, moduleId, featureId, featureCollapsed, hideEmptyPlaceholder, onSlicesChanged, takenArtifactNames, createSlice, onAddSlice, onReorderSlices, onMoveSlice, validateSliceDrop, renderSlice, }: SlicesAreaProps<T>): import("react").JSX.Element | null;

package/dist/Slices/createOptimisticSlice.d.ts

@@ -1,3 +1,4 @@
 import { SliceType, type Slice } from '../Model';
+import type { ArtifactNames } from './ArtifactNames';
 import type { SliceNames } from './SliceNames';
-export declare const createOptimisticSlice: (sliceType: SliceType, names?: SliceNames) => Slice;
+export declare const createOptimisticSlice: (sliceType: SliceType, names?: SliceNames, sliceNames?: readonly string[], artifactNames?: ArtifactNames) => Slice;

package/dist/Slices/duplicatedSlice.d.ts

@@ -0,0 +1,4 @@
+import type { Guid } from '@cratis/fundamentals';
+import type { Slice } from '../Model';
+import type { ArtifactNames } from './ArtifactNames';
+export declare const duplicatedSlice: (source: Slice, id: Guid, sliceNames: readonly string[], artifactNames: ArtifactNames) => Slice;

package/dist/Slices/index.d.ts

@@ -11,6 +11,10 @@ export * from './SlicesArea';
 export * from './SliceNames';
 export * from './createOptimisticSlice';
 export * from './sliceAreaState';
+export * from './uniqueName';
+export * from './ArtifactNames';
+export * from './takenArtifactNames';
+export * from './duplicatedSlice';
 export * from './SliceColumnFrame';
 export * from './SliceRows';
 export * from './SlicePlaceholder';

package/dist/Slices/sliceAreaState.d.ts

@@ -39,5 +39,4 @@ export declare const completeMoveOut: <T extends SliceAreaItem>(state: SliceArea
 export declare const movePendingSliceIn: <T extends SliceAreaItem>(state: SliceAreaState<T>, slice: T, index: number) => SliceAreaState<T>;
 export declare const completeMoveIn: <T extends SliceAreaItem>(state: SliceAreaState<T>, id: Guid, succeeded: boolean) => SliceAreaState<T>;
 export declare const reconcileSliceSnapshot: <T extends SliceAreaItem>(state: SliceAreaState<T>, snapshot: T[]) => SliceAreaState<T>;
-export declare const duplicateSliceName: (names: string[], original: string) => string;
 export {};

package/dist/Slices/takenArtifactNames.d.ts

@@ -0,0 +1,5 @@
+import type { Slice } from '../Model';
+import type { ArtifactNames } from './ArtifactNames';
+export declare const noArtifactNames: ArtifactNames;
+export declare const artifactNamesOf: (slices: readonly Slice[]) => ArtifactNames;
+export declare const combineArtifactNames: (...names: ArtifactNames[]) => ArtifactNames;

package/dist/Slices/uniqueName.d.ts

@@ -0,0 +1 @@
+export declare function uniqueName(base: string, taken: readonly string[]): string;

package/dist/Specifications/SpecificationHeader.d.ts

@@ -2,6 +2,8 @@ import type { ReactNode } from 'react';
 import { SpecificationRunState } from './SpecificationRunState';
 export interface SpecificationHeaderProps {
     name: string;
+    description?: string;
+    documentation?: string;
     collapsed: boolean;
     onToggleCollapse?: () => void;
     runState: SpecificationRunState;
@@ -13,4 +15,4 @@ export interface SpecificationHeaderProps {
     runControl?: ReactNode;
     gutter?: ReactNode;
 }
-export declare const SpecificationHeader: ({ name, 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, executionLabel, onRenamed, onDeleted, runControl, gutter, }: SpecificationHeaderProps) => import("react").JSX.Element;

package/dist/Tooltips/GridTooltip.d.ts

@@ -3,6 +3,7 @@ export type GridTooltipPosition = 'top' | 'bottom' | 'left' | 'right';
 export interface GridTooltipProps {
     content: React.ReactNode;
     position?: GridTooltipPosition;
+    openOnFocus?: boolean;
     children: React.ReactNode;
 }
 /**
@@ -18,6 +19,8 @@ export interface GridTooltipProps {
  * The bubble closes when the card is no longer under the pointer even if no leave arrives: the canvas pans and
  * zooms under a still pointer, and the browser reports a pointer leaving only when the pointer moves.
  *
+ * With openOnFocus, keyboard focus on anything inside the anchor opens the bubble too, and Escape closes it.
+ *
  * Hover is tracked for mouse pointers only: a touch tap synthesizes an enter with no matching leave,
  * which would strand the bubble on screen on a tablet.
  */

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

@@ -117,6 +117,14 @@
                 "name": {
                     "type": "string"
                 },
+                "description": {
+                    "type": "string",
+                    "description": "Short host-supplied text drawn on the board. Absent or blank draws nothing."
+                },
+                "documentation": {
+                    "type": "string",
+                    "description": "Longer host-supplied text shown with the description on hover or focus. Absent or blank draws nothing."
+                },
                 "features": {
                     "type": "array",
                     "items": {
@@ -149,6 +157,14 @@
                 "name": {
                     "type": "string"
                 },
+                "description": {
+                    "type": "string",
+                    "description": "Short host-supplied text drawn on the board. Absent or blank draws nothing."
+                },
+                "documentation": {
+                    "type": "string",
+                    "description": "Longer host-supplied text shown with the description on hover or focus. Absent or blank draws nothing."
+                },
                 "subFeatures": {
                     "type": "array",
                     "items": {
@@ -212,6 +228,10 @@
                 "description": {
                     "type": "string"
                 },
+                "documentation": {
+                    "type": "string",
+                    "description": "Longer host-supplied text shown with the description on hover or focus. Absent or blank draws nothing."
+                },
                 "status": {
                     "type": "integer",
                     "description": "Where the slice is in its workflow. Known values: 0 = notStarted, 1 = draft, 2 = readyForImplementation, 3 = inProgress, 4 = readyForReview, 5 = done, 6 = analysis. Any other integer is drawn as an explicit unknown."
@@ -390,6 +410,14 @@
                 "name": {
                     "type": "string"
                 },
+                "description": {
+                    "type": "string",
+                    "description": "Short host-supplied text drawn on the board. Absent or blank draws nothing."
+                },
+                "documentation": {
+                    "type": "string",
+                    "description": "Longer host-supplied text shown with the description on hover or focus. Absent or blank draws nothing."
+                },
                 "schema": {
                     "$ref": "#/$defs/JsonSchema"
                 },
@@ -485,6 +513,14 @@
                 "name": {
                     "type": "string"
                 },
+                "description": {
+                    "type": "string",
+                    "description": "Short host-supplied text drawn on the board. Absent or blank draws nothing."
+                },
+                "documentation": {
+                    "type": "string",
+                    "description": "Longer host-supplied text shown with the description on hover or focus. Absent or blank draws nothing."
+                },
                 "schema": {
                     "$ref": "#/$defs/JsonSchema"
                 },
@@ -605,6 +641,14 @@
                 "name": {
                     "type": "string"
                 },
+                "description": {
+                    "type": "string",
+                    "description": "Short host-supplied text drawn on the board. Absent or blank draws nothing."
+                },
+                "documentation": {
+                    "type": "string",
+                    "description": "Longer host-supplied text shown with the description on hover or focus. Absent or blank draws nothing."
+                },
                 "schema": {
                     "$ref": "#/$defs/JsonSchema"
                 },
@@ -779,6 +823,14 @@
                 "name": {
                     "type": "string"
                 },
+                "description": {
+                    "type": "string",
+                    "description": "Short host-supplied text drawn on the board. Absent or blank draws nothing."
+                },
+                "documentation": {
+                    "type": "string",
+                    "description": "Longer host-supplied text shown with the description on hover or focus. Absent or blank draws nothing."
+                },
                 "given": {
                     "type": "array",
                     "items": {