@eventcatalog/visualiser 4.0.1 → 4.1.1

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/dist/index.d.mts CHANGED
@@ -14,6 +14,8 @@ type EventCatalogResource = {
14
14
  collection?: string;
15
15
  filePath?: string;
16
16
  id?: string;
17
+ /** Marks the resource represented by the current visualizer page. */
18
+ isFocused?: boolean;
17
19
  };
18
20
  /**
19
21
  * Message types (Events, Commands, Queries)
@@ -731,10 +733,31 @@ declare const OwnerIndicator: react.NamedExoticComponent<{
731
733
  iconClass?: string;
732
734
  }>;
733
735
 
736
+ declare const ENTITY_TARGET_HANDLE_ID = "__eventcatalog-entity-target";
737
+ interface EntityProperty {
738
+ name: string;
739
+ type: string;
740
+ required?: boolean;
741
+ description?: string;
742
+ references?: string;
743
+ referencesIdentifier?: string;
744
+ referenceTarget?: "entity";
745
+ relationType?: string;
746
+ enum?: string[];
747
+ properties?: EntityProperty[];
748
+ items?: {
749
+ type: string;
750
+ properties?: EntityProperty[];
751
+ };
752
+ }
753
+ declare const getPropertyTypeLabel: (property: any) => any;
754
+ declare const getNestedEntityProperties: (property: EntityProperty) => EntityProperty[];
734
755
  declare const _default$c: react.NamedExoticComponent<any>;
735
756
 
736
757
  declare const _default$b: react.NamedExoticComponent<any>;
737
758
 
759
+ declare const _default$a: react.NamedExoticComponent<any>;
760
+
738
761
  /**
739
762
  * A system rendered on the System Diagram.
740
763
  *
@@ -743,7 +766,7 @@ declare const _default$b: react.NamedExoticComponent<any>;
743
766
  * Left-clicking the node navigates to the system's architecture map.
744
767
  * Right-click (handled by the NodeGraph context-menu wrapper) offers docs / map / context.
745
768
  */
746
- declare const _default$a: react.NamedExoticComponent<any>;
769
+ declare const _default$9: react.NamedExoticComponent<any>;
747
770
 
748
771
  /**
749
772
  * An actor (person/role) on the System Diagram.
@@ -752,11 +775,9 @@ declare const _default$a: react.NamedExoticComponent<any>;
752
775
  * card with the actor icon in a circular badge centered at the top and the actor
753
776
  * name centered below. This reads as "a person", not "a system", at a glance.
754
777
  */
755
- declare const _default$9: react.NamedExoticComponent<any>;
756
-
757
- declare const _default$8: react.NamedExoticComponent<NodeProps>;
778
+ declare const _default$8: react.NamedExoticComponent<any>;
758
779
 
759
- declare const _default$7: react.NamedExoticComponent<any>;
780
+ declare const _default$7: react.NamedExoticComponent<NodeProps>;
760
781
 
761
782
  declare const _default$6: react.NamedExoticComponent<any>;
762
783
 
@@ -833,10 +854,17 @@ declare const AnimatedMessageEdge: react.MemoExoticComponent<({ id, sourceX, sou
833
854
 
834
855
  declare const _default: react.NamedExoticComponent<EdgeProps>;
835
856
 
857
+ declare function LabelledDefaultEdge(props: EdgeProps): react_jsx_runtime.JSX.Element;
858
+ declare function LabelledSmoothStepEdge(props: EdgeProps): react_jsx_runtime.JSX.Element;
859
+ declare function LabelledStepEdge(props: EdgeProps): react_jsx_runtime.JSX.Element;
860
+
836
861
  declare const edgeTypes: {
837
862
  animated: react.MemoExoticComponent<({ id, sourceX, sourceY, targetX, targetY, sourcePosition, targetPosition, data, label, markerEnd, markerStart, }: any) => react_jsx_runtime.JSX.Element>;
838
863
  "flow-edge": react.NamedExoticComponent<CustomEdgeProps>;
839
864
  multiline: react.NamedExoticComponent<_xyflow_react.EdgeProps>;
865
+ default: typeof LabelledDefaultEdge;
866
+ smoothstep: typeof LabelledSmoothStepEdge;
867
+ step: typeof LabelledStepEdge;
840
868
  };
841
869
 
842
870
  /**
@@ -898,4 +926,4 @@ declare function layoutGraph(nodes: GraphNode[], edges: GraphEdge[], options?: {
898
926
  edges: Edge[];
899
927
  };
900
928
 
901
- export { ACTOR, AGENT, AGENT_TOOL, _default$o as Actor, type ActorNode, type Agent$1 as Agent, _default$i as AgentNode, type AgentTool$1 as AgentTool, _default$j as AgentToolNode, type AgentToolNode as AgentToolNodeType, AnimatedMessageEdge, type BaseNodeData, CHANNEL, COMMAND, type Channel, type ChannelNode, _default$f as Command, type CommandNode, _default$9 as ContextActorNode, type ContextMenuItem, _default$c as CustomNode, DATA, type Data, type DataNode, _default$s as DataProductNode, _default$b as DomainNode, type DslGraph, EVENT, type EdgeType, _default$7 as EntityNode, _default$e as Event, type EventCatalogResource, type EventNode, type ExternalSystem, _default$2 as ExternalSystem2Node, type ExternalSystemNode, _default$q as Field, type FieldNode as FieldNodeType, _default$1 as FlowEdge, _default$r as FlowExpandedNode, _default$6 as FlowNode, FocusModeModal, type GraphEdge, type GraphEdgeType, type GraphNode, _default$5 as GroupNode, MESSAGE, type MermaidExportOptions, MermaidView, type Message, _default$t as MessageGroupExpandedNode, type MessageGroupExpandedNodeData, _default$u as MessageGroupNode, type MessageGroupNodeData, type MessageGroupNode as MessageGroupNodeType, _default as MultilineEdgeLabel, type NodeCategory, type NodeConfiguration, _default$v as NodeContextMenu, NodeGraph, type NodeGraphProps, type NodeType, _default$k as Note, type NoteNode, NotesIndicator, OwnerIndicator, QUERY, _default$g as Query, type QueryNode, type RegisteredNode, SERVICE, _default$h as Service, type ServiceNode, type Service as ServiceType, _default$4 as StepNode, _default$w as StepWalkthrough, _default$8 as SystemGroupNode, _default$a as SystemNode, _default$3 as UserNode, VIEW, type View, type ViewNode, VisualiserSearch, type VisualizerCallbacks, type VisualizerLink, type VisualizerMode, _default$n as actorConfig, buildNodeData, calculatedNodes, convertToMermaid, createDagreGraph, createEdge, createNode, _default$m as dataNodeConfig, edgeTypes, _default$d as eventConfig, exportNodeGraphForStudio, _default$l as externalSystemConfig, _default$p as fieldConfig, generateIdForNode, generateIdForNodes, generatedIdForEdge, getColorFromString, getEdgeLabelForMessageAsSource, getEdgeLabelForServiceAsTarget, getNodesAndEdgesFromDagre, layoutGraph, nodeComponents, nodeConfigs, normalizeOwners };
929
+ export { ACTOR, AGENT, AGENT_TOOL, _default$o as Actor, type ActorNode, type Agent$1 as Agent, _default$i as AgentNode, type AgentTool$1 as AgentTool, _default$j as AgentToolNode, type AgentToolNode as AgentToolNodeType, AnimatedMessageEdge, type BaseNodeData, CHANNEL, COMMAND, type Channel, type ChannelNode, _default$f as Command, type CommandNode, _default$8 as ContextActorNode, type ContextMenuItem, _default$b as CustomNode, DATA, type Data, type DataNode, _default$s as DataProductNode, _default$a as DomainNode, type DslGraph, ENTITY_TARGET_HANDLE_ID, EVENT, type EdgeType, _default$c as EntityNode, type EntityProperty, _default$e as Event, type EventCatalogResource, type EventNode, type ExternalSystem, _default$2 as ExternalSystem2Node, type ExternalSystemNode, _default$q as Field, type FieldNode as FieldNodeType, _default$1 as FlowEdge, _default$r as FlowExpandedNode, _default$6 as FlowNode, FocusModeModal, type GraphEdge, type GraphEdgeType, type GraphNode, _default$5 as GroupNode, LabelledDefaultEdge, LabelledSmoothStepEdge, LabelledStepEdge, MESSAGE, type MermaidExportOptions, MermaidView, type Message, _default$t as MessageGroupExpandedNode, type MessageGroupExpandedNodeData, _default$u as MessageGroupNode, type MessageGroupNodeData, type MessageGroupNode as MessageGroupNodeType, _default as MultilineEdgeLabel, type NodeCategory, type NodeConfiguration, _default$v as NodeContextMenu, NodeGraph, type NodeGraphProps, type NodeType, _default$k as Note, type NoteNode, NotesIndicator, OwnerIndicator, QUERY, _default$g as Query, type QueryNode, type RegisteredNode, SERVICE, _default$h as Service, type ServiceNode, type Service as ServiceType, _default$4 as StepNode, _default$w as StepWalkthrough, _default$7 as SystemGroupNode, _default$9 as SystemNode, _default$3 as UserNode, VIEW, type View, type ViewNode, VisualiserSearch, type VisualizerCallbacks, type VisualizerLink, type VisualizerMode, _default$n as actorConfig, buildNodeData, calculatedNodes, convertToMermaid, createDagreGraph, createEdge, createNode, _default$m as dataNodeConfig, edgeTypes, _default$d as eventConfig, exportNodeGraphForStudio, _default$l as externalSystemConfig, _default$p as fieldConfig, generateIdForNode, generateIdForNodes, generatedIdForEdge, getColorFromString, getEdgeLabelForMessageAsSource, getEdgeLabelForServiceAsTarget, getNestedEntityProperties, getNodesAndEdgesFromDagre, getPropertyTypeLabel, layoutGraph, nodeComponents, nodeConfigs, normalizeOwners };
package/dist/index.d.ts CHANGED
@@ -14,6 +14,8 @@ type EventCatalogResource = {
14
14
  collection?: string;
15
15
  filePath?: string;
16
16
  id?: string;
17
+ /** Marks the resource represented by the current visualizer page. */
18
+ isFocused?: boolean;
17
19
  };
18
20
  /**
19
21
  * Message types (Events, Commands, Queries)
@@ -731,10 +733,31 @@ declare const OwnerIndicator: react.NamedExoticComponent<{
731
733
  iconClass?: string;
732
734
  }>;
733
735
 
736
+ declare const ENTITY_TARGET_HANDLE_ID = "__eventcatalog-entity-target";
737
+ interface EntityProperty {
738
+ name: string;
739
+ type: string;
740
+ required?: boolean;
741
+ description?: string;
742
+ references?: string;
743
+ referencesIdentifier?: string;
744
+ referenceTarget?: "entity";
745
+ relationType?: string;
746
+ enum?: string[];
747
+ properties?: EntityProperty[];
748
+ items?: {
749
+ type: string;
750
+ properties?: EntityProperty[];
751
+ };
752
+ }
753
+ declare const getPropertyTypeLabel: (property: any) => any;
754
+ declare const getNestedEntityProperties: (property: EntityProperty) => EntityProperty[];
734
755
  declare const _default$c: react.NamedExoticComponent<any>;
735
756
 
736
757
  declare const _default$b: react.NamedExoticComponent<any>;
737
758
 
759
+ declare const _default$a: react.NamedExoticComponent<any>;
760
+
738
761
  /**
739
762
  * A system rendered on the System Diagram.
740
763
  *
@@ -743,7 +766,7 @@ declare const _default$b: react.NamedExoticComponent<any>;
743
766
  * Left-clicking the node navigates to the system's architecture map.
744
767
  * Right-click (handled by the NodeGraph context-menu wrapper) offers docs / map / context.
745
768
  */
746
- declare const _default$a: react.NamedExoticComponent<any>;
769
+ declare const _default$9: react.NamedExoticComponent<any>;
747
770
 
748
771
  /**
749
772
  * An actor (person/role) on the System Diagram.
@@ -752,11 +775,9 @@ declare const _default$a: react.NamedExoticComponent<any>;
752
775
  * card with the actor icon in a circular badge centered at the top and the actor
753
776
  * name centered below. This reads as "a person", not "a system", at a glance.
754
777
  */
755
- declare const _default$9: react.NamedExoticComponent<any>;
756
-
757
- declare const _default$8: react.NamedExoticComponent<NodeProps>;
778
+ declare const _default$8: react.NamedExoticComponent<any>;
758
779
 
759
- declare const _default$7: react.NamedExoticComponent<any>;
780
+ declare const _default$7: react.NamedExoticComponent<NodeProps>;
760
781
 
761
782
  declare const _default$6: react.NamedExoticComponent<any>;
762
783
 
@@ -833,10 +854,17 @@ declare const AnimatedMessageEdge: react.MemoExoticComponent<({ id, sourceX, sou
833
854
 
834
855
  declare const _default: react.NamedExoticComponent<EdgeProps>;
835
856
 
857
+ declare function LabelledDefaultEdge(props: EdgeProps): react_jsx_runtime.JSX.Element;
858
+ declare function LabelledSmoothStepEdge(props: EdgeProps): react_jsx_runtime.JSX.Element;
859
+ declare function LabelledStepEdge(props: EdgeProps): react_jsx_runtime.JSX.Element;
860
+
836
861
  declare const edgeTypes: {
837
862
  animated: react.MemoExoticComponent<({ id, sourceX, sourceY, targetX, targetY, sourcePosition, targetPosition, data, label, markerEnd, markerStart, }: any) => react_jsx_runtime.JSX.Element>;
838
863
  "flow-edge": react.NamedExoticComponent<CustomEdgeProps>;
839
864
  multiline: react.NamedExoticComponent<_xyflow_react.EdgeProps>;
865
+ default: typeof LabelledDefaultEdge;
866
+ smoothstep: typeof LabelledSmoothStepEdge;
867
+ step: typeof LabelledStepEdge;
840
868
  };
841
869
 
842
870
  /**
@@ -898,4 +926,4 @@ declare function layoutGraph(nodes: GraphNode[], edges: GraphEdge[], options?: {
898
926
  edges: Edge[];
899
927
  };
900
928
 
901
- export { ACTOR, AGENT, AGENT_TOOL, _default$o as Actor, type ActorNode, type Agent$1 as Agent, _default$i as AgentNode, type AgentTool$1 as AgentTool, _default$j as AgentToolNode, type AgentToolNode as AgentToolNodeType, AnimatedMessageEdge, type BaseNodeData, CHANNEL, COMMAND, type Channel, type ChannelNode, _default$f as Command, type CommandNode, _default$9 as ContextActorNode, type ContextMenuItem, _default$c as CustomNode, DATA, type Data, type DataNode, _default$s as DataProductNode, _default$b as DomainNode, type DslGraph, EVENT, type EdgeType, _default$7 as EntityNode, _default$e as Event, type EventCatalogResource, type EventNode, type ExternalSystem, _default$2 as ExternalSystem2Node, type ExternalSystemNode, _default$q as Field, type FieldNode as FieldNodeType, _default$1 as FlowEdge, _default$r as FlowExpandedNode, _default$6 as FlowNode, FocusModeModal, type GraphEdge, type GraphEdgeType, type GraphNode, _default$5 as GroupNode, MESSAGE, type MermaidExportOptions, MermaidView, type Message, _default$t as MessageGroupExpandedNode, type MessageGroupExpandedNodeData, _default$u as MessageGroupNode, type MessageGroupNodeData, type MessageGroupNode as MessageGroupNodeType, _default as MultilineEdgeLabel, type NodeCategory, type NodeConfiguration, _default$v as NodeContextMenu, NodeGraph, type NodeGraphProps, type NodeType, _default$k as Note, type NoteNode, NotesIndicator, OwnerIndicator, QUERY, _default$g as Query, type QueryNode, type RegisteredNode, SERVICE, _default$h as Service, type ServiceNode, type Service as ServiceType, _default$4 as StepNode, _default$w as StepWalkthrough, _default$8 as SystemGroupNode, _default$a as SystemNode, _default$3 as UserNode, VIEW, type View, type ViewNode, VisualiserSearch, type VisualizerCallbacks, type VisualizerLink, type VisualizerMode, _default$n as actorConfig, buildNodeData, calculatedNodes, convertToMermaid, createDagreGraph, createEdge, createNode, _default$m as dataNodeConfig, edgeTypes, _default$d as eventConfig, exportNodeGraphForStudio, _default$l as externalSystemConfig, _default$p as fieldConfig, generateIdForNode, generateIdForNodes, generatedIdForEdge, getColorFromString, getEdgeLabelForMessageAsSource, getEdgeLabelForServiceAsTarget, getNodesAndEdgesFromDagre, layoutGraph, nodeComponents, nodeConfigs, normalizeOwners };
929
+ export { ACTOR, AGENT, AGENT_TOOL, _default$o as Actor, type ActorNode, type Agent$1 as Agent, _default$i as AgentNode, type AgentTool$1 as AgentTool, _default$j as AgentToolNode, type AgentToolNode as AgentToolNodeType, AnimatedMessageEdge, type BaseNodeData, CHANNEL, COMMAND, type Channel, type ChannelNode, _default$f as Command, type CommandNode, _default$8 as ContextActorNode, type ContextMenuItem, _default$b as CustomNode, DATA, type Data, type DataNode, _default$s as DataProductNode, _default$a as DomainNode, type DslGraph, ENTITY_TARGET_HANDLE_ID, EVENT, type EdgeType, _default$c as EntityNode, type EntityProperty, _default$e as Event, type EventCatalogResource, type EventNode, type ExternalSystem, _default$2 as ExternalSystem2Node, type ExternalSystemNode, _default$q as Field, type FieldNode as FieldNodeType, _default$1 as FlowEdge, _default$r as FlowExpandedNode, _default$6 as FlowNode, FocusModeModal, type GraphEdge, type GraphEdgeType, type GraphNode, _default$5 as GroupNode, LabelledDefaultEdge, LabelledSmoothStepEdge, LabelledStepEdge, MESSAGE, type MermaidExportOptions, MermaidView, type Message, _default$t as MessageGroupExpandedNode, type MessageGroupExpandedNodeData, _default$u as MessageGroupNode, type MessageGroupNodeData, type MessageGroupNode as MessageGroupNodeType, _default as MultilineEdgeLabel, type NodeCategory, type NodeConfiguration, _default$v as NodeContextMenu, NodeGraph, type NodeGraphProps, type NodeType, _default$k as Note, type NoteNode, NotesIndicator, OwnerIndicator, QUERY, _default$g as Query, type QueryNode, type RegisteredNode, SERVICE, _default$h as Service, type ServiceNode, type Service as ServiceType, _default$4 as StepNode, _default$w as StepWalkthrough, _default$7 as SystemGroupNode, _default$9 as SystemNode, _default$3 as UserNode, VIEW, type View, type ViewNode, VisualiserSearch, type VisualizerCallbacks, type VisualizerLink, type VisualizerMode, _default$n as actorConfig, buildNodeData, calculatedNodes, convertToMermaid, createDagreGraph, createEdge, createNode, _default$m as dataNodeConfig, edgeTypes, _default$d as eventConfig, exportNodeGraphForStudio, _default$l as externalSystemConfig, _default$p as fieldConfig, generateIdForNode, generateIdForNodes, generatedIdForEdge, getColorFromString, getEdgeLabelForMessageAsSource, getEdgeLabelForServiceAsTarget, getNestedEntityProperties, getNodesAndEdgesFromDagre, getPropertyTypeLabel, layoutGraph, nodeComponents, nodeConfigs, normalizeOwners };