@almadar/ui 6.55.0 → 6.57.0

package/dist/avl/index.d.ts

@@ -2,10 +2,10 @@ import { OperatorCategory } from '@almadar/std';
 import * as React$1 from 'react';
 import React__default from 'react';
 import { FieldType, EntityPersistence, SExpr, EvalTrace, A11yProps, EventEmit, Expression, UISlot, OrbitalSchema, EntityData, EditFocus, EventPayload, AriaRole, DomainQuestion, DomainQuestionAnswer, ThemeDefinition, CircuitStepResult, GuardEvaluation, EffectTrace } from '@almadar/core';
-import { A as AvlNodeData, F as FileTreeItem } from '../FileTree-DUi7e7Z8.js';
-export { a as AvlEdgeData, b as AvlStateMachine, c as AvlStateMachineProps, B as BehaviorView, M as ModuleCard, s as schemaToFlowGraph } from '../FileTree-DUi7e7Z8.js';
-import { T as TraitLevelData, d as TraitTransitionInfo, c as TransitionLevelData } from '../avl-schema-parser-C0wnAp5x.js';
-export { A as ApplicationLevelData, C as CrossLink, b as OrbitalLevelData, p as parseApplicationLevel, e as parseOrbitalLevel, f as parseTraitLevel, g as parseTransitionLevel, t as traitLevelFromTrait } from '../avl-schema-parser-C0wnAp5x.js';
+import { A as AvlAnnotations, a as AvlNodeData, F as FileTreeItem, b as AvlNote } from '../FileTree-BSfgp-HH.js';
+export { c as AvlEdgeData, d as AvlStateMachine, e as AvlStateMachineProps, B as BehaviorView, M as ModuleCard, s as schemaToFlowGraph } from '../FileTree-BSfgp-HH.js';
+import { T as TraitLevelData, d as TraitTransitionInfo, c as TransitionLevelData, S as SerializedEffect } from '../avl-schema-parser-CH1QoZw1.js';
+export { A as ApplicationLevelData, C as CrossLink, b as OrbitalLevelData, p as parseApplicationLevel, e as parseOrbitalLevel, f as parseTraitLevel, g as parseTransitionLevel, t as traitLevelFromTrait } from '../avl-schema-parser-CH1QoZw1.js';
 import { NodeProps, EdgeProps, Edge, Node, NodeTypes, ReactFlowProps } from '@xyflow/react';
 import { AnyPatternConfig } from '@almadar/core/patterns';
 import { useDraggable } from '@dnd-kit/core';
@@ -620,6 +620,8 @@ declare const DependencyColumnNode: React__default.NamedExoticComponent<NodeProp
 
 interface MiniStateMachineProps {
     data: TraitLevelData;
+    /** Author notes, shown in a popover on hover of a state or an effect. */
+    annotations?: AvlAnnotations;
     className?: string;
 }
 declare const MiniStateMachine: React__default.FC<MiniStateMachineProps>;
@@ -1959,10 +1961,25 @@ declare const AvlClickTarget: React__default.FC<AvlClickTargetProps>;
  * transition.
  */
 
+/**
+ * One transition explained: from-state, event and to-state, the guard that
+ * must hold, and each effect it runs in order, drawn as circuit boards.
+ *
+ * @capabilities transition explainer, event guard effects walkthrough, state machine step detail
+ */
 interface AvlTransitionDetailProps {
+    /** Orbital the transition belongs to. */
     orbital: string;
+    /** Trait the transition belongs to. */
     trait: string;
+    /** The transition to explain.
+     * @example {"from":"pending","to":"paid","event":"PAY","guard":[">","@payload.amount",0],"effects":[{"type":"set","args":["@entity.total","@payload.amount"]},{"type":"persist","args":["update","Order","@entity"]}],"index":0}
+     */
     transition: TraitTransitionInfo;
+    /** Author explanations shown in a popover on hover: the transition's event note and per-effect-type notes.
+     * @example {"transitions":{"PAY":{"title":"Paying","body":"The customer pays the order total."}},"effects":{"persist":{"body":"Saves the order."}}}
+     */
+    annotations?: AvlAnnotations;
     /** The latest played run of this transition (see `transitionPlayback`). */
     playback?: AvlTransitionPlayback;
     /** Emits UI:{stepEvent} with an {@link AvlStepRequest} when Step is pressed. */
@@ -1971,6 +1988,58 @@ interface AvlTransitionDetailProps {
 }
 declare const AvlTransitionDetail: React__default.FC<AvlTransitionDetailProps>;
 
+/**
+ * AvlTransitionExplainer — the render-ui face of {@link AvlTransitionDetail}:
+ * one transition explained (from, event, to, the guard that must hold, each
+ * effect in order) with optional author notes. Playing a transition is a host
+ * capability and stays on AvlTransitionDetail.
+ */
+
+/** A transition as `.lolo` data hands it over: `guard` is omitted when there is none. */
+interface ExplainedTransition {
+    from: string;
+    to: string;
+    event: string;
+    guard?: SExpr;
+    effects: SerializedEffect[];
+    index: number;
+}
+/**
+ * One transition explained step by step: from-state, event and to-state, the
+ * guard that must hold, and each effect it runs in order.
+ *
+ * @capabilities transition explainer, event guard effects walkthrough, what happens when an event fires
+ */
+interface AvlTransitionExplainerProps extends A11yProps {
+    /** Orbital the transition belongs to. */
+    orbitalName: string;
+    /** Trait the transition belongs to. */
+    traitName: string;
+    /** The transition to explain.
+     * @example {"from":"pending","to":"paid","event":"PAY","effects":[{"type":"set","args":[]},{"type":"persist","args":[]}],"index":0}
+     */
+    transition: ExplainedTransition;
+    /** Author explanations shown in a popover on hover: the event's note and per-effect-type notes.
+     * @example {"transitions":{"PAY":{"title":"Paying","body":"The customer pays the order total."}},"effects":{"persist":{"body":"Saves the order."}}}
+     */
+    annotations?: AvlAnnotations;
+    className?: string;
+}
+declare const AvlTransitionExplainer: React__default.FC<AvlTransitionExplainerProps>;
+
+/**
+ * AvlEffectChip — one effect glyph that names itself: its operator, the
+ * plain-language category, and the std registry description, on hover/focus.
+ */
+
+interface AvlEffectChipProps {
+    effectType: string;
+    /** Glyph box in px. @default 16 */
+    size?: number;
+    note?: AvlNote;
+}
+declare const AvlEffectChip: React__default.FC<AvlEffectChipProps>;
+
 /**
  * AVL layered graph: labelled columns of pills, left to right, with edges between pills.
  * The one layout behind the app's dependencies, one orbital's trait flow and a deployment's
@@ -2105,4 +2174,4 @@ declare namespace KnobSettingRow {
     var displayName: string;
 }
 
-export { AVL_GLYPH_KINDS, AVL_GRAPH_NODE_TYPES, AvlApplication, type AvlApplicationProps, AvlBackwardEdge, type AvlBaseProps, AvlBehaviorGlyph, type AvlBehaviorGlyphProps, AvlBinding, AvlBindingEdge, type AvlBindingProps, AvlBindingRef, type AvlBindingRefProps, AvlCircuit, type AvlCircuitProps, AvlClickTarget, type AvlClickTargetProps, AvlClosedCircuit, type AvlClosedCircuitProps, type AvlClosedCircuitState, type AvlClosedCircuitTransition, AvlCosmicZoom, type AvlCosmicZoomProps, AvlEffect, type AvlEffectProps, AvlEmitListen, type AvlEmitListenProps, AvlEntity, type AvlEntityProps, AvlEvent, type AvlEventProps, AvlEventWireEdge, type AvlEventWireEdgeData, AvlExprTree, type AvlExprTreeNode, type AvlExprTreeProps, AvlField, type AvlFieldProps, AvlFieldType, type AvlFieldTypeProps, AvlGlyph, type AvlGlyphKind, type AvlGlyphProps, AvlGraphCanvas, type AvlGraphCanvasProps, AvlGuard, type AvlGuardProps, AvlLiteral, type AvlLiteralProps, AvlNodeData, AvlOperator, type AvlOperatorProps, AvlOrbital, type AvlOrbitalProps, AvlOrbitalUnit, type AvlOrbitalUnitPage, type AvlOrbitalUnitProps, type AvlOrbitalUnitTrait, AvlOrbitalsCosmicZoom, type AvlOrbitalsCosmicZoomProps, AvlPage, AvlPageEdge, type AvlPageProps, AvlPersistence, type AvlPersistenceProps, type AvlPlayStep, AvlSExpr, type AvlSExprProps, AvlSlotMap, type AvlSlotMapProps, type AvlSlotMapSlot, AvlState, type AvlStateMachinePlayback, type AvlStateProps, type AvlStepRequest, AvlSwimLane, type AvlSwimLaneProps, AvlTrait, type AvlTraitProps, AvlTraitScene, type AvlTraitSceneProps, AvlTransition, AvlTransitionDetail, type AvlTransitionDetailProps, AvlTransitionEdge, type AvlTransitionEdgeData, AvlTransitionLane, type AvlTransitionLaneProps, type AvlTransitionPlayback, type AvlTransitionProps, AvlTransitionScene, type AvlTransitionSceneProps, type BehaviorGlyphChild, type BehaviorGlyphConnection, type BehaviorLevel, CANVAS_TOOLS, CONNECTION_COLORS, type CanvasContainerNode, CanvasDndProvider, type CanvasDndProviderProps, type CanvasDragKind, type CanvasDragPayload, type CanvasDropEvent, type CanvasDropTarget, type CanvasFocusChange, type CanvasResolvedDrop, type CanvasScope, type CanvasStateGroup, type CanvasStateOption, type CanvasStateOptions, type CanvasStateView, type CanvasTool, type CanvasVerify, CanvasVerifyContext, type CanvasViewOptions, type CardVerdict, DEPLOYMENT_ROW, DOMAIN_COLORS, DependencyColumnNode, type DependencyLayer, DependencyNode, DetailView, EDITABLE, EFFECT_CATEGORY_COLORS, type EffectCategory, type ElementEditAccess, ElementEditAccessContext, type ElementEditAccessResolver, type ElementKnob, type ElementPropAccess, type ElementSettings, type ElkLayout, type EventEdgeData, EventFlowEdge, FIELD_TYPE_SHAPES, type FieldTypeShape, FlowCanvas, type FlowCanvasProps, type GlyphSize, type InlineTextEditOptions, KnobField, type KnobFieldProps, KnobSettingRow, type KnobSettingRowProps, LIVE_STATE, type LayerIdParts, type LayeredColumn, type LayeredColumnId, type LayeredEdge, type LayeredGraphInput, type LayeredRow, type LayeredUnit, LayersPanel, type LayersPanelProps, type LayoutEdge, type LayoutNode, MiniStateMachine, OPERATOR_CATEGORY_COLORS, OrbInspector, type OrbInspectorProps, OrbPreviewNode, type PatternEventSource, type PlayedStep, type PreviewNodeData, type RenderUIEntry, STATE_COLORS, type SelectedPattern, type StateRole, SystemBandNode, type SystemDependencies, SystemMapContext, type SystemMapContextValue, SystemNode, type TraitFlowEdge, type TraitFlowUnit, TraitLevelData, TraitTransitionInfo, type TraitView, TransitionLevelData, type UseCanvasDraggableArgs, type UseCanvasDraggableResult, type UseCanvasDroppableArgs, type UseCanvasDroppableResult, type ViewLevel, ZOOM_BAND_THRESHOLDS, type ZoomBand, ZoomBandContext, ZoomBreadcrumb, type ZoomBreadcrumbProps, ZoomLegend, type ZoomLegendProps, ZoomLevel, arcPath, armPosition, armsOf, canvasViewGraph, computeTraitLayout, computeZoomBand, curveControlPoint, dependencyReach, deploymentGraph, deriveEditFocusFromElement, dropBusEvent, edgePath, effectCategoryOf, firedTransition, flowNeighbors, getStateRole, gridPositions, hasCanvasTool, initialStateOf, layeredGraph, optionForPlayedStep, parseLayerId, propAccessAt, radialPositions, ringPositions, schemaToDependencyGraph, schemaToLayerItems, schemaToOverviewGraph, stateMachinePlayback, stateOptionsOf, traitFlowGraph, transitionPlayback, useCanvasDraggable, useCanvasDroppable, useInlineTextEdit, useZoomBand, zoomProgress };
+export { AVL_GLYPH_KINDS, AVL_GRAPH_NODE_TYPES, AvlAnnotations, AvlApplication, type AvlApplicationProps, AvlBackwardEdge, type AvlBaseProps, AvlBehaviorGlyph, type AvlBehaviorGlyphProps, AvlBinding, AvlBindingEdge, type AvlBindingProps, AvlBindingRef, type AvlBindingRefProps, AvlCircuit, type AvlCircuitProps, AvlClickTarget, type AvlClickTargetProps, AvlClosedCircuit, type AvlClosedCircuitProps, type AvlClosedCircuitState, type AvlClosedCircuitTransition, AvlCosmicZoom, type AvlCosmicZoomProps, AvlEffect, AvlEffectChip, type AvlEffectChipProps, type AvlEffectProps, AvlEmitListen, type AvlEmitListenProps, AvlEntity, type AvlEntityProps, AvlEvent, type AvlEventProps, AvlEventWireEdge, type AvlEventWireEdgeData, AvlExprTree, type AvlExprTreeNode, type AvlExprTreeProps, AvlField, type AvlFieldProps, AvlFieldType, type AvlFieldTypeProps, AvlGlyph, type AvlGlyphKind, type AvlGlyphProps, AvlGraphCanvas, type AvlGraphCanvasProps, AvlGuard, type AvlGuardProps, AvlLiteral, type AvlLiteralProps, AvlNodeData, AvlNote, AvlOperator, type AvlOperatorProps, AvlOrbital, type AvlOrbitalProps, AvlOrbitalUnit, type AvlOrbitalUnitPage, type AvlOrbitalUnitProps, type AvlOrbitalUnitTrait, AvlOrbitalsCosmicZoom, type AvlOrbitalsCosmicZoomProps, AvlPage, AvlPageEdge, type AvlPageProps, AvlPersistence, type AvlPersistenceProps, type AvlPlayStep, AvlSExpr, type AvlSExprProps, AvlSlotMap, type AvlSlotMapProps, type AvlSlotMapSlot, AvlState, type AvlStateMachinePlayback, type AvlStateProps, type AvlStepRequest, AvlSwimLane, type AvlSwimLaneProps, AvlTrait, type AvlTraitProps, AvlTraitScene, type AvlTraitSceneProps, AvlTransition, AvlTransitionDetail, type AvlTransitionDetailProps, AvlTransitionEdge, type AvlTransitionEdgeData, AvlTransitionExplainer, type AvlTransitionExplainerProps, AvlTransitionLane, type AvlTransitionLaneProps, type AvlTransitionPlayback, type AvlTransitionProps, AvlTransitionScene, type AvlTransitionSceneProps, type BehaviorGlyphChild, type BehaviorGlyphConnection, type BehaviorLevel, CANVAS_TOOLS, CONNECTION_COLORS, type CanvasContainerNode, CanvasDndProvider, type CanvasDndProviderProps, type CanvasDragKind, type CanvasDragPayload, type CanvasDropEvent, type CanvasDropTarget, type CanvasFocusChange, type CanvasResolvedDrop, type CanvasScope, type CanvasStateGroup, type CanvasStateOption, type CanvasStateOptions, type CanvasStateView, type CanvasTool, type CanvasVerify, CanvasVerifyContext, type CanvasViewOptions, type CardVerdict, DEPLOYMENT_ROW, DOMAIN_COLORS, DependencyColumnNode, type DependencyLayer, DependencyNode, DetailView, EDITABLE, EFFECT_CATEGORY_COLORS, type EffectCategory, type ElementEditAccess, ElementEditAccessContext, type ElementEditAccessResolver, type ElementKnob, type ElementPropAccess, type ElementSettings, type ElkLayout, type EventEdgeData, EventFlowEdge, FIELD_TYPE_SHAPES, type FieldTypeShape, FlowCanvas, type FlowCanvasProps, type GlyphSize, type InlineTextEditOptions, KnobField, type KnobFieldProps, KnobSettingRow, type KnobSettingRowProps, LIVE_STATE, type LayerIdParts, type LayeredColumn, type LayeredColumnId, type LayeredEdge, type LayeredGraphInput, type LayeredRow, type LayeredUnit, LayersPanel, type LayersPanelProps, type LayoutEdge, type LayoutNode, MiniStateMachine, OPERATOR_CATEGORY_COLORS, OrbInspector, type OrbInspectorProps, OrbPreviewNode, type PatternEventSource, type PlayedStep, type PreviewNodeData, type RenderUIEntry, STATE_COLORS, type SelectedPattern, type StateRole, SystemBandNode, type SystemDependencies, SystemMapContext, type SystemMapContextValue, SystemNode, type TraitFlowEdge, type TraitFlowUnit, TraitLevelData, TraitTransitionInfo, type TraitView, TransitionLevelData, type UseCanvasDraggableArgs, type UseCanvasDraggableResult, type UseCanvasDroppableArgs, type UseCanvasDroppableResult, type ViewLevel, ZOOM_BAND_THRESHOLDS, type ZoomBand, ZoomBandContext, ZoomBreadcrumb, type ZoomBreadcrumbProps, ZoomLegend, type ZoomLegendProps, ZoomLevel, arcPath, armPosition, armsOf, canvasViewGraph, computeTraitLayout, computeZoomBand, curveControlPoint, dependencyReach, deploymentGraph, deriveEditFocusFromElement, dropBusEvent, edgePath, effectCategoryOf, firedTransition, flowNeighbors, getStateRole, gridPositions, hasCanvasTool, initialStateOf, layeredGraph, optionForPlayedStep, parseLayerId, propAccessAt, radialPositions, ringPositions, schemaToDependencyGraph, schemaToLayerItems, schemaToOverviewGraph, stateMachinePlayback, stateOptionsOf, traitFlowGraph, transitionPlayback, useCanvasDraggable, useCanvasDroppable, useInlineTextEdit, useZoomBand, zoomProgress };