@eventcatalog/visualiser 3.18.1 → 3.18.2

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.
Files changed (9) hide show
  1. package/dist/index.d.mts +50 -13
  2. package/dist/index.d.ts +50 -13
  3. package/dist/index.js +1829 -1619
  4. package/dist/index.js.map +1 -1
  5. package/dist/index.mjs +1141 -931
  6. package/dist/index.mjs.map +1 -1
  7. package/dist/styles-core.css +9 -0
  8. package/dist/styles.css +9 -0
  9. package/package.json +1 -1
package/dist/index.d.mts CHANGED
@@ -35,6 +35,13 @@ type Message = {
35
35
  path?: string;
36
36
  /** HTTP status codes (e.g. [200, 401, 500]) */
37
37
  statusCodes?: number[];
38
+ styles?: {
39
+ icon?: string;
40
+ node?: {
41
+ color?: string;
42
+ label?: string;
43
+ };
44
+ };
38
45
  };
39
46
  /**
40
47
  * Note attached to a resource
@@ -59,6 +66,13 @@ type Service = {
59
66
  notes?: Note[];
60
67
  specifications?: unknown;
61
68
  externalSystem?: boolean;
69
+ styles?: {
70
+ icon?: string;
71
+ node?: {
72
+ color?: string;
73
+ label?: string;
74
+ };
75
+ };
62
76
  };
63
77
  /**
64
78
  * Channel type
@@ -76,6 +90,13 @@ type Channel = {
76
90
  notes?: Note[];
77
91
  /** Delivery guarantee (e.g. at-most-once, at-least-once, exactly-once) */
78
92
  deliveryGuarantee?: string;
93
+ styles?: {
94
+ icon?: string;
95
+ node?: {
96
+ color?: string;
97
+ label?: string;
98
+ };
99
+ };
79
100
  };
80
101
  /**
81
102
  * External System type
@@ -95,10 +116,18 @@ type Data = {
95
116
  summary: string;
96
117
  owners?: string[];
97
118
  type?: string;
119
+ container_type?: string;
98
120
  schemas?: string[];
99
121
  deprecated?: boolean;
100
122
  draft?: boolean;
101
123
  notes?: Note[];
124
+ styles?: {
125
+ icon?: string;
126
+ node?: {
127
+ color?: string;
128
+ label?: string;
129
+ };
130
+ };
102
131
  };
103
132
  /**
104
133
  * View type
@@ -396,7 +425,7 @@ interface StepWalkthroughProps {
396
425
  onStepChange: (nodeId: string | null, highlightPaths?: string[], shouldZoomOut?: boolean) => void;
397
426
  mode?: "full" | "simple";
398
427
  }
399
- declare const _default$p: react__default.NamedExoticComponent<StepWalkthroughProps>;
428
+ declare const _default$q: react__default.NamedExoticComponent<StepWalkthroughProps>;
400
429
 
401
430
  interface FocusModeModalProps {
402
431
  isOpen: boolean;
@@ -413,7 +442,7 @@ interface NodeContextMenuProps {
413
442
  items: ContextMenuItem[];
414
443
  children: React.ReactNode;
415
444
  }
416
- declare const _default$o: react.NamedExoticComponent<NodeContextMenuProps>;
445
+ declare const _default$p: react.NamedExoticComponent<NodeContextMenuProps>;
417
446
 
418
447
  type MessageGroupNodeData = {
419
448
  mode?: string;
@@ -431,7 +460,7 @@ type MessageGroupNodeData = {
431
460
  };
432
461
  };
433
462
  type MessageGroupNode = Node<MessageGroupNodeData, "messageGroup">;
434
- declare const _default$n: react.NamedExoticComponent<MessageGroupNode>;
463
+ declare const _default$o: react.NamedExoticComponent<MessageGroupNode>;
435
464
 
436
465
  type MessageGroupExpandedNodeData = {
437
466
  groupName: string;
@@ -439,7 +468,7 @@ type MessageGroupExpandedNodeData = {
439
468
  messageCount: number;
440
469
  onCollapse?: string;
441
470
  };
442
- declare const _default$m: react.NamedExoticComponent<{
471
+ declare const _default$n: react.NamedExoticComponent<{
443
472
  data: MessageGroupExpandedNodeData;
444
473
  }>;
445
474
 
@@ -455,10 +484,17 @@ type DataProductNodeData = EventCatalogResource & {
455
484
  deprecated?: boolean;
456
485
  draft?: boolean;
457
486
  notes?: Note[];
487
+ styles?: {
488
+ icon?: string;
489
+ node?: {
490
+ color?: string;
491
+ label?: string;
492
+ };
493
+ };
458
494
  };
459
495
  };
460
496
  type DataProductNode = Node<DataProductNodeData, "data-product">;
461
- declare const _default$l: react.NamedExoticComponent<DataProductNode>;
497
+ declare const _default$m: react.NamedExoticComponent<DataProductNode>;
462
498
 
463
499
  type FieldNodeData = {
464
500
  name: string;
@@ -466,9 +502,9 @@ type FieldNodeData = {
466
502
  mode?: "simple" | "full";
467
503
  };
468
504
  type FieldNode = Node<FieldNodeData, "field">;
469
- declare const _default$k: react.NamedExoticComponent<FieldNode>;
505
+ declare const _default$l: react.NamedExoticComponent<FieldNode>;
470
506
 
471
- declare const _default$j: NodeConfiguration;
507
+ declare const _default$k: NodeConfiguration;
472
508
 
473
509
  type ActorNodeData = EventCatalogResource & {
474
510
  name: string;
@@ -478,9 +514,9 @@ type ActorNodeData = EventCatalogResource & {
478
514
  notes?: Note[];
479
515
  };
480
516
  type ActorNode = Node<ActorNodeData, "actor">;
481
- declare const _default$i: react.NamedExoticComponent<ActorNode>;
517
+ declare const _default$j: react.NamedExoticComponent<ActorNode>;
482
518
 
483
- declare const _default$h: NodeConfiguration;
519
+ declare const _default$i: NodeConfiguration;
484
520
 
485
521
  type ViewNodeData = EventCatalogResource & {
486
522
  view: View;
@@ -492,7 +528,7 @@ type DataNodeData = EventCatalogResource & {
492
528
  };
493
529
  type DataNode = Node<DataNodeData, "data">;
494
530
 
495
- declare const _default$g: NodeConfiguration;
531
+ declare const _default$h: NodeConfiguration;
496
532
 
497
533
  type ExternalSystemNodeData = EventCatalogResource & {
498
534
  externalSystem: ExternalSystem & {
@@ -502,7 +538,7 @@ type ExternalSystemNodeData = EventCatalogResource & {
502
538
  };
503
539
  type ExternalSystemNode = Node<ExternalSystemNodeData, "external-system">;
504
540
 
505
- declare const _default$f: NodeConfiguration;
541
+ declare const _default$g: NodeConfiguration;
506
542
 
507
543
  type NoteNodeData = {
508
544
  id: string;
@@ -517,7 +553,7 @@ interface NoteNodeProps extends NoteNode {
517
553
  showResizer?: boolean;
518
554
  readOnly?: boolean;
519
555
  }
520
- declare const _default$e: react__default.NamedExoticComponent<NoteNodeProps>;
556
+ declare const _default$f: react__default.NamedExoticComponent<NoteNodeProps>;
521
557
 
522
558
  type ChannelNodeData = EventCatalogResource & {
523
559
  channel: Channel;
@@ -528,6 +564,7 @@ type ServiceNodeData = EventCatalogResource & {
528
564
  service: Service;
529
565
  };
530
566
  type ServiceNode = Node<ServiceNodeData, "service">;
567
+ declare const _default$e: react.NamedExoticComponent<ServiceNode>;
531
568
 
532
569
  type QueryNodeData = EventCatalogResource & {
533
570
  message: Message;
@@ -708,4 +745,4 @@ declare function layoutGraph(nodes: GraphNode[], edges: GraphEdge[], options?: {
708
745
  edges: Edge[];
709
746
  };
710
747
 
711
- export { ACTOR, _default$i as Actor, type ActorNode, AnimatedMessageEdge, type BaseNodeData, CHANNEL, COMMAND, type Channel, type ChannelNode, _default$c as Command, type CommandNode, type ContextMenuItem, _default$9 as CustomNode, DATA, type Data, type DataNode, _default$l as DataProductNode, _default$8 as DomainNode, type DslGraph, EVENT, type EdgeType, _default$7 as EntityNode, _default$b as Event, type EventCatalogResource, type EventNode, type ExternalSystem, _default$2 as ExternalSystem2Node, type ExternalSystemNode, _default$k as Field, type FieldNode as FieldNodeType, _default$1 as FlowEdge, _default$6 as FlowNode, FocusModeModal, type GraphEdge, type GraphEdgeType, type GraphNode, _default$5 as GroupNode, MESSAGE, type MermaidExportOptions, MermaidView, type Message, _default$m as MessageGroupExpandedNode, type MessageGroupExpandedNodeData, _default$n as MessageGroupNode, type MessageGroupNodeData, type MessageGroupNode as MessageGroupNodeType, _default as MultilineEdgeLabel, type NodeCategory, type NodeConfiguration, _default$o as NodeContextMenu, NodeGraph, type NodeGraphProps, type NodeType, _default$e as Note, type NoteNode, NotesIndicator, OwnerIndicator, QUERY, _default$d as Query, type QueryNode, type RegisteredNode, SERVICE, type Service, type ServiceNode, _default$4 as StepNode, _default$p as StepWalkthrough, _default$3 as UserNode, VIEW, type View, type ViewNode, VisualiserSearch, type VisualizerCallbacks, type VisualizerLink, type VisualizerMode, _default$h as actorConfig, buildNodeData, calculatedNodes, convertToMermaid, createDagreGraph, createEdge, createNode, _default$g as dataNodeConfig, edgeTypes, _default$a as eventConfig, exportNodeGraphForStudio, _default$f as externalSystemConfig, _default$j as fieldConfig, generateIdForNode, generateIdForNodes, generatedIdForEdge, getColorFromString, getEdgeLabelForMessageAsSource, getEdgeLabelForServiceAsTarget, getNodesAndEdgesFromDagre, layoutGraph, nodeComponents, nodeConfigs, normalizeOwners };
748
+ export { ACTOR, _default$j as Actor, type ActorNode, AnimatedMessageEdge, type BaseNodeData, CHANNEL, COMMAND, type Channel, type ChannelNode, _default$c as Command, type CommandNode, type ContextMenuItem, _default$9 as CustomNode, DATA, type Data, type DataNode, _default$m as DataProductNode, _default$8 as DomainNode, type DslGraph, EVENT, type EdgeType, _default$7 as EntityNode, _default$b as Event, type EventCatalogResource, type EventNode, type ExternalSystem, _default$2 as ExternalSystem2Node, type ExternalSystemNode, _default$l as Field, type FieldNode as FieldNodeType, _default$1 as FlowEdge, _default$6 as FlowNode, FocusModeModal, type GraphEdge, type GraphEdgeType, type GraphNode, _default$5 as GroupNode, MESSAGE, type MermaidExportOptions, MermaidView, type Message, _default$n as MessageGroupExpandedNode, type MessageGroupExpandedNodeData, _default$o as MessageGroupNode, type MessageGroupNodeData, type MessageGroupNode as MessageGroupNodeType, _default as MultilineEdgeLabel, type NodeCategory, type NodeConfiguration, _default$p as NodeContextMenu, NodeGraph, type NodeGraphProps, type NodeType, _default$f as Note, type NoteNode, NotesIndicator, OwnerIndicator, QUERY, _default$d as Query, type QueryNode, type RegisteredNode, SERVICE, _default$e as Service, type ServiceNode, type Service as ServiceType, _default$4 as StepNode, _default$q as StepWalkthrough, _default$3 as UserNode, VIEW, type View, type ViewNode, VisualiserSearch, type VisualizerCallbacks, type VisualizerLink, type VisualizerMode, _default$i as actorConfig, buildNodeData, calculatedNodes, convertToMermaid, createDagreGraph, createEdge, createNode, _default$h as dataNodeConfig, edgeTypes, _default$a as eventConfig, exportNodeGraphForStudio, _default$g as externalSystemConfig, _default$k as fieldConfig, generateIdForNode, generateIdForNodes, generatedIdForEdge, getColorFromString, getEdgeLabelForMessageAsSource, getEdgeLabelForServiceAsTarget, getNodesAndEdgesFromDagre, layoutGraph, nodeComponents, nodeConfigs, normalizeOwners };
package/dist/index.d.ts CHANGED
@@ -35,6 +35,13 @@ type Message = {
35
35
  path?: string;
36
36
  /** HTTP status codes (e.g. [200, 401, 500]) */
37
37
  statusCodes?: number[];
38
+ styles?: {
39
+ icon?: string;
40
+ node?: {
41
+ color?: string;
42
+ label?: string;
43
+ };
44
+ };
38
45
  };
39
46
  /**
40
47
  * Note attached to a resource
@@ -59,6 +66,13 @@ type Service = {
59
66
  notes?: Note[];
60
67
  specifications?: unknown;
61
68
  externalSystem?: boolean;
69
+ styles?: {
70
+ icon?: string;
71
+ node?: {
72
+ color?: string;
73
+ label?: string;
74
+ };
75
+ };
62
76
  };
63
77
  /**
64
78
  * Channel type
@@ -76,6 +90,13 @@ type Channel = {
76
90
  notes?: Note[];
77
91
  /** Delivery guarantee (e.g. at-most-once, at-least-once, exactly-once) */
78
92
  deliveryGuarantee?: string;
93
+ styles?: {
94
+ icon?: string;
95
+ node?: {
96
+ color?: string;
97
+ label?: string;
98
+ };
99
+ };
79
100
  };
80
101
  /**
81
102
  * External System type
@@ -95,10 +116,18 @@ type Data = {
95
116
  summary: string;
96
117
  owners?: string[];
97
118
  type?: string;
119
+ container_type?: string;
98
120
  schemas?: string[];
99
121
  deprecated?: boolean;
100
122
  draft?: boolean;
101
123
  notes?: Note[];
124
+ styles?: {
125
+ icon?: string;
126
+ node?: {
127
+ color?: string;
128
+ label?: string;
129
+ };
130
+ };
102
131
  };
103
132
  /**
104
133
  * View type
@@ -396,7 +425,7 @@ interface StepWalkthroughProps {
396
425
  onStepChange: (nodeId: string | null, highlightPaths?: string[], shouldZoomOut?: boolean) => void;
397
426
  mode?: "full" | "simple";
398
427
  }
399
- declare const _default$p: react__default.NamedExoticComponent<StepWalkthroughProps>;
428
+ declare const _default$q: react__default.NamedExoticComponent<StepWalkthroughProps>;
400
429
 
401
430
  interface FocusModeModalProps {
402
431
  isOpen: boolean;
@@ -413,7 +442,7 @@ interface NodeContextMenuProps {
413
442
  items: ContextMenuItem[];
414
443
  children: React.ReactNode;
415
444
  }
416
- declare const _default$o: react.NamedExoticComponent<NodeContextMenuProps>;
445
+ declare const _default$p: react.NamedExoticComponent<NodeContextMenuProps>;
417
446
 
418
447
  type MessageGroupNodeData = {
419
448
  mode?: string;
@@ -431,7 +460,7 @@ type MessageGroupNodeData = {
431
460
  };
432
461
  };
433
462
  type MessageGroupNode = Node<MessageGroupNodeData, "messageGroup">;
434
- declare const _default$n: react.NamedExoticComponent<MessageGroupNode>;
463
+ declare const _default$o: react.NamedExoticComponent<MessageGroupNode>;
435
464
 
436
465
  type MessageGroupExpandedNodeData = {
437
466
  groupName: string;
@@ -439,7 +468,7 @@ type MessageGroupExpandedNodeData = {
439
468
  messageCount: number;
440
469
  onCollapse?: string;
441
470
  };
442
- declare const _default$m: react.NamedExoticComponent<{
471
+ declare const _default$n: react.NamedExoticComponent<{
443
472
  data: MessageGroupExpandedNodeData;
444
473
  }>;
445
474
 
@@ -455,10 +484,17 @@ type DataProductNodeData = EventCatalogResource & {
455
484
  deprecated?: boolean;
456
485
  draft?: boolean;
457
486
  notes?: Note[];
487
+ styles?: {
488
+ icon?: string;
489
+ node?: {
490
+ color?: string;
491
+ label?: string;
492
+ };
493
+ };
458
494
  };
459
495
  };
460
496
  type DataProductNode = Node<DataProductNodeData, "data-product">;
461
- declare const _default$l: react.NamedExoticComponent<DataProductNode>;
497
+ declare const _default$m: react.NamedExoticComponent<DataProductNode>;
462
498
 
463
499
  type FieldNodeData = {
464
500
  name: string;
@@ -466,9 +502,9 @@ type FieldNodeData = {
466
502
  mode?: "simple" | "full";
467
503
  };
468
504
  type FieldNode = Node<FieldNodeData, "field">;
469
- declare const _default$k: react.NamedExoticComponent<FieldNode>;
505
+ declare const _default$l: react.NamedExoticComponent<FieldNode>;
470
506
 
471
- declare const _default$j: NodeConfiguration;
507
+ declare const _default$k: NodeConfiguration;
472
508
 
473
509
  type ActorNodeData = EventCatalogResource & {
474
510
  name: string;
@@ -478,9 +514,9 @@ type ActorNodeData = EventCatalogResource & {
478
514
  notes?: Note[];
479
515
  };
480
516
  type ActorNode = Node<ActorNodeData, "actor">;
481
- declare const _default$i: react.NamedExoticComponent<ActorNode>;
517
+ declare const _default$j: react.NamedExoticComponent<ActorNode>;
482
518
 
483
- declare const _default$h: NodeConfiguration;
519
+ declare const _default$i: NodeConfiguration;
484
520
 
485
521
  type ViewNodeData = EventCatalogResource & {
486
522
  view: View;
@@ -492,7 +528,7 @@ type DataNodeData = EventCatalogResource & {
492
528
  };
493
529
  type DataNode = Node<DataNodeData, "data">;
494
530
 
495
- declare const _default$g: NodeConfiguration;
531
+ declare const _default$h: NodeConfiguration;
496
532
 
497
533
  type ExternalSystemNodeData = EventCatalogResource & {
498
534
  externalSystem: ExternalSystem & {
@@ -502,7 +538,7 @@ type ExternalSystemNodeData = EventCatalogResource & {
502
538
  };
503
539
  type ExternalSystemNode = Node<ExternalSystemNodeData, "external-system">;
504
540
 
505
- declare const _default$f: NodeConfiguration;
541
+ declare const _default$g: NodeConfiguration;
506
542
 
507
543
  type NoteNodeData = {
508
544
  id: string;
@@ -517,7 +553,7 @@ interface NoteNodeProps extends NoteNode {
517
553
  showResizer?: boolean;
518
554
  readOnly?: boolean;
519
555
  }
520
- declare const _default$e: react__default.NamedExoticComponent<NoteNodeProps>;
556
+ declare const _default$f: react__default.NamedExoticComponent<NoteNodeProps>;
521
557
 
522
558
  type ChannelNodeData = EventCatalogResource & {
523
559
  channel: Channel;
@@ -528,6 +564,7 @@ type ServiceNodeData = EventCatalogResource & {
528
564
  service: Service;
529
565
  };
530
566
  type ServiceNode = Node<ServiceNodeData, "service">;
567
+ declare const _default$e: react.NamedExoticComponent<ServiceNode>;
531
568
 
532
569
  type QueryNodeData = EventCatalogResource & {
533
570
  message: Message;
@@ -708,4 +745,4 @@ declare function layoutGraph(nodes: GraphNode[], edges: GraphEdge[], options?: {
708
745
  edges: Edge[];
709
746
  };
710
747
 
711
- export { ACTOR, _default$i as Actor, type ActorNode, AnimatedMessageEdge, type BaseNodeData, CHANNEL, COMMAND, type Channel, type ChannelNode, _default$c as Command, type CommandNode, type ContextMenuItem, _default$9 as CustomNode, DATA, type Data, type DataNode, _default$l as DataProductNode, _default$8 as DomainNode, type DslGraph, EVENT, type EdgeType, _default$7 as EntityNode, _default$b as Event, type EventCatalogResource, type EventNode, type ExternalSystem, _default$2 as ExternalSystem2Node, type ExternalSystemNode, _default$k as Field, type FieldNode as FieldNodeType, _default$1 as FlowEdge, _default$6 as FlowNode, FocusModeModal, type GraphEdge, type GraphEdgeType, type GraphNode, _default$5 as GroupNode, MESSAGE, type MermaidExportOptions, MermaidView, type Message, _default$m as MessageGroupExpandedNode, type MessageGroupExpandedNodeData, _default$n as MessageGroupNode, type MessageGroupNodeData, type MessageGroupNode as MessageGroupNodeType, _default as MultilineEdgeLabel, type NodeCategory, type NodeConfiguration, _default$o as NodeContextMenu, NodeGraph, type NodeGraphProps, type NodeType, _default$e as Note, type NoteNode, NotesIndicator, OwnerIndicator, QUERY, _default$d as Query, type QueryNode, type RegisteredNode, SERVICE, type Service, type ServiceNode, _default$4 as StepNode, _default$p as StepWalkthrough, _default$3 as UserNode, VIEW, type View, type ViewNode, VisualiserSearch, type VisualizerCallbacks, type VisualizerLink, type VisualizerMode, _default$h as actorConfig, buildNodeData, calculatedNodes, convertToMermaid, createDagreGraph, createEdge, createNode, _default$g as dataNodeConfig, edgeTypes, _default$a as eventConfig, exportNodeGraphForStudio, _default$f as externalSystemConfig, _default$j as fieldConfig, generateIdForNode, generateIdForNodes, generatedIdForEdge, getColorFromString, getEdgeLabelForMessageAsSource, getEdgeLabelForServiceAsTarget, getNodesAndEdgesFromDagre, layoutGraph, nodeComponents, nodeConfigs, normalizeOwners };
748
+ export { ACTOR, _default$j as Actor, type ActorNode, AnimatedMessageEdge, type BaseNodeData, CHANNEL, COMMAND, type Channel, type ChannelNode, _default$c as Command, type CommandNode, type ContextMenuItem, _default$9 as CustomNode, DATA, type Data, type DataNode, _default$m as DataProductNode, _default$8 as DomainNode, type DslGraph, EVENT, type EdgeType, _default$7 as EntityNode, _default$b as Event, type EventCatalogResource, type EventNode, type ExternalSystem, _default$2 as ExternalSystem2Node, type ExternalSystemNode, _default$l as Field, type FieldNode as FieldNodeType, _default$1 as FlowEdge, _default$6 as FlowNode, FocusModeModal, type GraphEdge, type GraphEdgeType, type GraphNode, _default$5 as GroupNode, MESSAGE, type MermaidExportOptions, MermaidView, type Message, _default$n as MessageGroupExpandedNode, type MessageGroupExpandedNodeData, _default$o as MessageGroupNode, type MessageGroupNodeData, type MessageGroupNode as MessageGroupNodeType, _default as MultilineEdgeLabel, type NodeCategory, type NodeConfiguration, _default$p as NodeContextMenu, NodeGraph, type NodeGraphProps, type NodeType, _default$f as Note, type NoteNode, NotesIndicator, OwnerIndicator, QUERY, _default$d as Query, type QueryNode, type RegisteredNode, SERVICE, _default$e as Service, type ServiceNode, type Service as ServiceType, _default$4 as StepNode, _default$q as StepWalkthrough, _default$3 as UserNode, VIEW, type View, type ViewNode, VisualiserSearch, type VisualizerCallbacks, type VisualizerLink, type VisualizerMode, _default$i as actorConfig, buildNodeData, calculatedNodes, convertToMermaid, createDagreGraph, createEdge, createNode, _default$h as dataNodeConfig, edgeTypes, _default$a as eventConfig, exportNodeGraphForStudio, _default$g as externalSystemConfig, _default$k as fieldConfig, generateIdForNode, generateIdForNodes, generatedIdForEdge, getColorFromString, getEdgeLabelForMessageAsSource, getEdgeLabelForServiceAsTarget, getNodesAndEdgesFromDagre, layoutGraph, nodeComponents, nodeConfigs, normalizeOwners };