@eventcatalog/sdk 2.25.0 → 2.26.1

package/dist/index.d.mts

@@ -1,5 +1,9 @@
+interface ExtensionProperties {
+  [key: `x-${string}`]: unknown;
+}
+
 // Base type for all resources (domains, services and messages)
-interface BaseSchema {
+interface BaseSchema extends ExtensionProperties {
   id: string;
   name: string;
   summary?: string;
@@ -86,12 +90,27 @@ type SendsPointer = {
   group?: string;
 };
 
+type TriggerPointer = {
+  id: string;
+  version?: string;
+  condition?: string;
+};
+
 type ReceivesPointer = {
   id: string;
   version?: string;
   fields?: string[];
   from?: ChannelPointer[];
   group?: string;
+  triggers?: TriggerPointer[];
+};
+
+type MessagePointerInput = {
+  id: string;
+  version: string;
+  fields?: string[];
+  group?: string;
+  triggers?: TriggerPointer[];
 };
 
 interface ResourceGroup {
@@ -131,6 +150,8 @@ interface CustomDoc {
 interface MessageDetailsPanelProperty {
   producers?: DetailPanelProperty;
   consumers?: DetailPanelProperty;
+  triggers?: DetailPanelProperty;
+  triggeredBy?: DetailPanelProperty;
   channels?: DetailPanelProperty;
   versions?: DetailPanelProperty;
   repository?: DetailPanelProperty;
@@ -1790,12 +1811,7 @@ declare const _default: (path: string) => {
      *
      * ```
      */
-    addEventToService: (id: string, direction: string, event: {
-        id: string;
-        version: string;
-        fields?: string[];
-        group?: string;
-    }, version?: string) => Promise<void>;
+    addEventToService: (id: string, direction: string, event: MessagePointerInput, version?: string) => Promise<void>;
     /**
      * Add a data store to a service by it's id.
      *
@@ -1835,12 +1851,7 @@ declare const _default: (path: string) => {
      *
      * ```
      */
-    addCommandToService: (id: string, direction: string, event: {
-        id: string;
-        version: string;
-        fields?: string[];
-        group?: string;
-    }, version?: string) => Promise<void>;
+    addCommandToService: (id: string, direction: string, event: MessagePointerInput, version?: string) => Promise<void>;
     /**
      * Add a query to a service by it's id.
      *
@@ -1860,12 +1871,7 @@ declare const _default: (path: string) => {
      *
      * ```
      */
-    addQueryToService: (id: string, direction: string, event: {
-        id: string;
-        version: string;
-        fields?: string[];
-        group?: string;
-    }, version?: string) => Promise<void>;
+    addQueryToService: (id: string, direction: string, event: MessagePointerInput, version?: string) => Promise<void>;
     /**
      * Add an entity to a service by its id.
      *
@@ -1992,24 +1998,9 @@ declare const _default: (path: string) => {
         content: string;
         fileName: string;
     }, version?: string) => Promise<void>;
-    addEventToAgent: (id: string, direction: string, message: {
-        id: string;
-        version: string;
-        fields?: string[];
-        group?: string;
-    }, version?: string) => Promise<void>;
-    addCommandToAgent: (id: string, direction: string, message: {
-        id: string;
-        version: string;
-        fields?: string[];
-        group?: string;
-    }, version?: string) => Promise<void>;
-    addQueryToAgent: (id: string, direction: string, message: {
-        id: string;
-        version: string;
-        fields?: string[];
-        group?: string;
-    }, version?: string) => Promise<void>;
+    addEventToAgent: (id: string, direction: string, message: MessagePointerInput, version?: string) => Promise<void>;
+    addCommandToAgent: (id: string, direction: string, message: MessagePointerInput, version?: string) => Promise<void>;
+    addQueryToAgent: (id: string, direction: string, message: MessagePointerInput, version?: string) => Promise<void>;
     addDataStoreToAgent: (id: string, direction: string, dataStore: {
         id: string;
         version: string;
@@ -2179,12 +2170,7 @@ declare const _default: (path: string) => {
      *
      * ```
      */
-    addEventToDomain: (id: string, direction: string, message: {
-        id: string;
-        version: string;
-        fields?: string[];
-        group?: string;
-    }, version?: string) => Promise<void>;
+    addEventToDomain: (id: string, direction: string, message: MessagePointerInput, version?: string) => Promise<void>;
     /**
      * Add a command to a domain by its id.
      *
@@ -2202,12 +2188,7 @@ declare const _default: (path: string) => {
      *
      * ```
      */
-    addCommandToDomain: (id: string, direction: string, message: {
-        id: string;
-        version: string;
-        fields?: string[];
-        group?: string;
-    }, version?: string) => Promise<void>;
+    addCommandToDomain: (id: string, direction: string, message: MessagePointerInput, version?: string) => Promise<void>;
     /**
      * Add a query to a domain by its id.
      *
@@ -2225,12 +2206,7 @@ declare const _default: (path: string) => {
      *
      * ```
      */
-    addQueryToDomain: (id: string, direction: string, message: {
-        id: string;
-        version: string;
-        fields?: string[];
-        group?: string;
-    }, version?: string) => Promise<void>;
+    addQueryToDomain: (id: string, direction: string, message: MessagePointerInput, version?: string) => Promise<void>;
     /**
      * ================================
      *            Teams
@@ -2447,21 +2423,21 @@ declare const _default: (path: string) => {
     getProducersAndConsumersForMessage: (id: string, version?: string, options?: {
         latestOnly?: boolean;
     }) => Promise<{
-        producers: (Service | Agent)[];
-        consumers: (Service | Agent)[];
+        producers: (Service | Agent | Domain)[];
+        consumers: (Service | Agent | Domain)[];
     }>;
     /**
      * Returns the consumers of a given schema path
      * @param path - The path to the schema to get the consumers for
      * @returns (Service|Agent)[]
      */
-    getConsumersOfSchema: (path: string) => Promise<(Service | Agent)[]>;
+    getConsumersOfSchema: (path: string) => Promise<(Service | Agent | Domain)[]>;
     /**
      * Returns the producers of a given schema path
      * @param path - The path to the schema to get the producers for
      * @returns (Service|Agent)[]
      */
-    getProducersOfSchema: (path: string) => Promise<(Service | Agent)[]>;
+    getProducersOfSchema: (path: string) => Promise<(Service | Agent | Domain)[]>;
     /**
      * Returns the schema for a given message (event, command or query) by its id and version.
      * If no version is given, the latest version is used.
@@ -3010,4 +2986,4 @@ declare const _default: (path: string) => {
     toDSL: (resource: (Event | Command | Query | Service | Domain) | (Event | Command | Query | Service | Domain)[], options: ToDSLOptions) => Promise<string>;
 };
 
-export { type Adr, type AdrPointer, type AdrResourcePointer, type AdrStatus, type Agent, type AgentModel, type AgentTool, type Badge, type BaseSchema, type CatalogSnapshot, type Changelog, type Channel, type ChannelPointer, type Command, type Container, type CustomDoc, type DataProduct, type DataProductOutputPointer, type Diagram, type DiffSummary, type Domain, type Entity, type Event, type EventCatalog, type Flow, type FlowActorStepInput, type FlowAgentStepInput, FlowBuilder, type FlowBuilderInput, type FlowCustomStepInput, type FlowDataProductStepInput, type FlowDataStoreStepInput, type FlowExternalSystemStepInput, type FlowMessageStepInput, type FlowServiceStepInput, type FlowStep, type FlowStepInput, type FlowSubFlowStepInput, type Message, type Operation, type Query, type ReceivesPointer, type RelationshipChange, type ResourceChange, type ResourceChangeType, type ResourceGroup, type ResourcePointer, type SchemaPointer, type SendsPointer, type Service, type SnapshotDiff, type SnapshotGitInfo, type SnapshotMeta, type SnapshotOptions, type SnapshotResourceType, type SnapshotResources, type SnapshotResult, type Specification, type Specifications, type System, type SystemActorRelationship, type SystemRelationshipPointer, type SystemScope, type Team, type UbiquitousLanguage, type UbiquitousLanguageDictionary, type User, _default as default };
+export { type Adr, type AdrPointer, type AdrResourcePointer, type AdrStatus, type Agent, type AgentModel, type AgentTool, type Badge, type BaseSchema, type CatalogSnapshot, type Changelog, type Channel, type ChannelPointer, type Command, type Container, type CustomDoc, type DataProduct, type DataProductOutputPointer, type Diagram, type DiffSummary, type Domain, type Entity, type Event, type EventCatalog, type ExtensionProperties, type Flow, type FlowActorStepInput, type FlowAgentStepInput, FlowBuilder, type FlowBuilderInput, type FlowCustomStepInput, type FlowDataProductStepInput, type FlowDataStoreStepInput, type FlowExternalSystemStepInput, type FlowMessageStepInput, type FlowServiceStepInput, type FlowStep, type FlowStepInput, type FlowSubFlowStepInput, type Message, type MessagePointerInput, type Operation, type Query, type ReceivesPointer, type RelationshipChange, type ResourceChange, type ResourceChangeType, type ResourceGroup, type ResourcePointer, type SchemaPointer, type SendsPointer, type Service, type SnapshotDiff, type SnapshotGitInfo, type SnapshotMeta, type SnapshotOptions, type SnapshotResourceType, type SnapshotResources, type SnapshotResult, type Specification, type Specifications, type System, type SystemActorRelationship, type SystemRelationshipPointer, type SystemScope, type Team, type TriggerPointer, type UbiquitousLanguage, type UbiquitousLanguageDictionary, type User, _default as default };

package/dist/index.d.ts

@@ -1,5 +1,9 @@
+interface ExtensionProperties {
+  [key: `x-${string}`]: unknown;
+}
+
 // Base type for all resources (domains, services and messages)
-interface BaseSchema {
+interface BaseSchema extends ExtensionProperties {
   id: string;
   name: string;
   summary?: string;
@@ -86,12 +90,27 @@ type SendsPointer = {
   group?: string;
 };
 
+type TriggerPointer = {
+  id: string;
+  version?: string;
+  condition?: string;
+};
+
 type ReceivesPointer = {
   id: string;
   version?: string;
   fields?: string[];
   from?: ChannelPointer[];
   group?: string;
+  triggers?: TriggerPointer[];
+};
+
+type MessagePointerInput = {
+  id: string;
+  version: string;
+  fields?: string[];
+  group?: string;
+  triggers?: TriggerPointer[];
 };
 
 interface ResourceGroup {
@@ -131,6 +150,8 @@ interface CustomDoc {
 interface MessageDetailsPanelProperty {
   producers?: DetailPanelProperty;
   consumers?: DetailPanelProperty;
+  triggers?: DetailPanelProperty;
+  triggeredBy?: DetailPanelProperty;
   channels?: DetailPanelProperty;
   versions?: DetailPanelProperty;
   repository?: DetailPanelProperty;
@@ -1790,12 +1811,7 @@ declare const _default: (path: string) => {
      *
      * ```
      */
-    addEventToService: (id: string, direction: string, event: {
-        id: string;
-        version: string;
-        fields?: string[];
-        group?: string;
-    }, version?: string) => Promise<void>;
+    addEventToService: (id: string, direction: string, event: MessagePointerInput, version?: string) => Promise<void>;
     /**
      * Add a data store to a service by it's id.
      *
@@ -1835,12 +1851,7 @@ declare const _default: (path: string) => {
      *
      * ```
      */
-    addCommandToService: (id: string, direction: string, event: {
-        id: string;
-        version: string;
-        fields?: string[];
-        group?: string;
-    }, version?: string) => Promise<void>;
+    addCommandToService: (id: string, direction: string, event: MessagePointerInput, version?: string) => Promise<void>;
     /**
      * Add a query to a service by it's id.
      *
@@ -1860,12 +1871,7 @@ declare const _default: (path: string) => {
      *
      * ```
      */
-    addQueryToService: (id: string, direction: string, event: {
-        id: string;
-        version: string;
-        fields?: string[];
-        group?: string;
-    }, version?: string) => Promise<void>;
+    addQueryToService: (id: string, direction: string, event: MessagePointerInput, version?: string) => Promise<void>;
     /**
      * Add an entity to a service by its id.
      *
@@ -1992,24 +1998,9 @@ declare const _default: (path: string) => {
         content: string;
         fileName: string;
     }, version?: string) => Promise<void>;
-    addEventToAgent: (id: string, direction: string, message: {
-        id: string;
-        version: string;
-        fields?: string[];
-        group?: string;
-    }, version?: string) => Promise<void>;
-    addCommandToAgent: (id: string, direction: string, message: {
-        id: string;
-        version: string;
-        fields?: string[];
-        group?: string;
-    }, version?: string) => Promise<void>;
-    addQueryToAgent: (id: string, direction: string, message: {
-        id: string;
-        version: string;
-        fields?: string[];
-        group?: string;
-    }, version?: string) => Promise<void>;
+    addEventToAgent: (id: string, direction: string, message: MessagePointerInput, version?: string) => Promise<void>;
+    addCommandToAgent: (id: string, direction: string, message: MessagePointerInput, version?: string) => Promise<void>;
+    addQueryToAgent: (id: string, direction: string, message: MessagePointerInput, version?: string) => Promise<void>;
     addDataStoreToAgent: (id: string, direction: string, dataStore: {
         id: string;
         version: string;
@@ -2179,12 +2170,7 @@ declare const _default: (path: string) => {
      *
      * ```
      */
-    addEventToDomain: (id: string, direction: string, message: {
-        id: string;
-        version: string;
-        fields?: string[];
-        group?: string;
-    }, version?: string) => Promise<void>;
+    addEventToDomain: (id: string, direction: string, message: MessagePointerInput, version?: string) => Promise<void>;
     /**
      * Add a command to a domain by its id.
      *
@@ -2202,12 +2188,7 @@ declare const _default: (path: string) => {
      *
      * ```
      */
-    addCommandToDomain: (id: string, direction: string, message: {
-        id: string;
-        version: string;
-        fields?: string[];
-        group?: string;
-    }, version?: string) => Promise<void>;
+    addCommandToDomain: (id: string, direction: string, message: MessagePointerInput, version?: string) => Promise<void>;
     /**
      * Add a query to a domain by its id.
      *
@@ -2225,12 +2206,7 @@ declare const _default: (path: string) => {
      *
      * ```
      */
-    addQueryToDomain: (id: string, direction: string, message: {
-        id: string;
-        version: string;
-        fields?: string[];
-        group?: string;
-    }, version?: string) => Promise<void>;
+    addQueryToDomain: (id: string, direction: string, message: MessagePointerInput, version?: string) => Promise<void>;
     /**
      * ================================
      *            Teams
@@ -2447,21 +2423,21 @@ declare const _default: (path: string) => {
     getProducersAndConsumersForMessage: (id: string, version?: string, options?: {
         latestOnly?: boolean;
     }) => Promise<{
-        producers: (Service | Agent)[];
-        consumers: (Service | Agent)[];
+        producers: (Service | Agent | Domain)[];
+        consumers: (Service | Agent | Domain)[];
     }>;
     /**
      * Returns the consumers of a given schema path
      * @param path - The path to the schema to get the consumers for
      * @returns (Service|Agent)[]
      */
-    getConsumersOfSchema: (path: string) => Promise<(Service | Agent)[]>;
+    getConsumersOfSchema: (path: string) => Promise<(Service | Agent | Domain)[]>;
     /**
      * Returns the producers of a given schema path
      * @param path - The path to the schema to get the producers for
      * @returns (Service|Agent)[]
      */
-    getProducersOfSchema: (path: string) => Promise<(Service | Agent)[]>;
+    getProducersOfSchema: (path: string) => Promise<(Service | Agent | Domain)[]>;
     /**
      * Returns the schema for a given message (event, command or query) by its id and version.
      * If no version is given, the latest version is used.
@@ -3010,4 +2986,4 @@ declare const _default: (path: string) => {
     toDSL: (resource: (Event | Command | Query | Service | Domain) | (Event | Command | Query | Service | Domain)[], options: ToDSLOptions) => Promise<string>;
 };
 
-export { type Adr, type AdrPointer, type AdrResourcePointer, type AdrStatus, type Agent, type AgentModel, type AgentTool, type Badge, type BaseSchema, type CatalogSnapshot, type Changelog, type Channel, type ChannelPointer, type Command, type Container, type CustomDoc, type DataProduct, type DataProductOutputPointer, type Diagram, type DiffSummary, type Domain, type Entity, type Event, type EventCatalog, type Flow, type FlowActorStepInput, type FlowAgentStepInput, FlowBuilder, type FlowBuilderInput, type FlowCustomStepInput, type FlowDataProductStepInput, type FlowDataStoreStepInput, type FlowExternalSystemStepInput, type FlowMessageStepInput, type FlowServiceStepInput, type FlowStep, type FlowStepInput, type FlowSubFlowStepInput, type Message, type Operation, type Query, type ReceivesPointer, type RelationshipChange, type ResourceChange, type ResourceChangeType, type ResourceGroup, type ResourcePointer, type SchemaPointer, type SendsPointer, type Service, type SnapshotDiff, type SnapshotGitInfo, type SnapshotMeta, type SnapshotOptions, type SnapshotResourceType, type SnapshotResources, type SnapshotResult, type Specification, type Specifications, type System, type SystemActorRelationship, type SystemRelationshipPointer, type SystemScope, type Team, type UbiquitousLanguage, type UbiquitousLanguageDictionary, type User, _default as default };
+export { type Adr, type AdrPointer, type AdrResourcePointer, type AdrStatus, type Agent, type AgentModel, type AgentTool, type Badge, type BaseSchema, type CatalogSnapshot, type Changelog, type Channel, type ChannelPointer, type Command, type Container, type CustomDoc, type DataProduct, type DataProductOutputPointer, type Diagram, type DiffSummary, type Domain, type Entity, type Event, type EventCatalog, type ExtensionProperties, type Flow, type FlowActorStepInput, type FlowAgentStepInput, FlowBuilder, type FlowBuilderInput, type FlowCustomStepInput, type FlowDataProductStepInput, type FlowDataStoreStepInput, type FlowExternalSystemStepInput, type FlowMessageStepInput, type FlowServiceStepInput, type FlowStep, type FlowStepInput, type FlowSubFlowStepInput, type Message, type MessagePointerInput, type Operation, type Query, type ReceivesPointer, type RelationshipChange, type ResourceChange, type ResourceChangeType, type ResourceGroup, type ResourcePointer, type SchemaPointer, type SendsPointer, type Service, type SnapshotDiff, type SnapshotGitInfo, type SnapshotMeta, type SnapshotOptions, type SnapshotResourceType, type SnapshotResources, type SnapshotResult, type Specification, type Specifications, type System, type SystemActorRelationship, type SystemRelationshipPointer, type SystemScope, type Team, type TriggerPointer, type UbiquitousLanguage, type UbiquitousLanguageDictionary, type User, _default as default };

package/dist/index.js

@@ -863,13 +863,16 @@ var copyDir = async (catalogDir, source, target, filter) => {
   });
   import_node_fs.default.rmSync(tmpDirectory, { recursive: true });
 };
-var buildMessagePointer = (message) => {
+var buildMessagePointer = (message, options = {}) => {
   const pointer = {
     id: message.id,
     version: message.version
   };
   if (message.fields) pointer.fields = message.fields;
   if (message.group) pointer.group = message.group;
+  if (options.includeTriggers && message.triggers) {
+    pointer.triggers = message.triggers.map((trigger) => ({ ...trigger }));
+  }
   return pointer;
 };
 var uniqueVersions = (messages) => {
@@ -1419,7 +1422,7 @@ var addMessageToService = (directory) => async (id, direction, event, version) =
         return;
       }
     }
-    service.receives.push(buildMessagePointer(event));
+    service.receives.push(buildMessagePointer(event, { includeTriggers: true }));
   } else {
     throw new Error(`Direction ${direction} is invalid, only 'receives' and 'sends' are supported`);
   }
@@ -1701,7 +1704,7 @@ var addMessageToAgent = (directory) => async (id, direction, message, version) =
         return;
       }
     }
-    agent.receives.push(buildMessagePointer(message));
+    agent.receives.push(buildMessagePointer(message, { includeTriggers: true }));
   } else {
     throw new Error(`Direction ${direction} is invalid, only 'receives' and 'sends' are supported`);
   }
@@ -1961,7 +1964,7 @@ var addMessageToDomain = (directory) => async (id, direction, message, version)
         return;
       }
     }
-    domain.receives.push(buildMessagePointer(message));
+    domain.receives.push(buildMessagePointer(message, { includeTriggers: true }));
   } else {
     throw new Error(`Direction ${direction} is invalid, only 'receives' and 'sends' are supported`);
   }
@@ -2057,9 +2060,10 @@ var getMessageBySchemaPath = (directory) => async (path9, options) => {
   }
 };
 var getProducersAndConsumersForMessage = (directory) => async (id, version, options) => {
-  const [services = [], agents = []] = await Promise.all([
+  const [services = [], agents = [], domains = []] = await Promise.all([
     getServices(directory)({ latestOnly: options?.latestOnly ?? true }),
-    getAgents(directory)({ latestOnly: options?.latestOnly ?? true })
+    getAgents(directory)({ latestOnly: options?.latestOnly ?? true }),
+    getDomains(directory)({ latestOnly: options?.latestOnly ?? true })
   ]);
   const message = await getResource(directory, id, version, { type: "message" });
   const isMessageLatestVersion = await isLatestVersion(directory, id, version);
@@ -2068,7 +2072,7 @@ var getProducersAndConsumersForMessage = (directory) => async (id, version, opti
   }
   const producers = [];
   const consumers = [];
-  for (const participant of [...services, ...agents]) {
+  for (const participant of [...services, ...agents, ...domains]) {
     const participantPublishesMessage = participant.sends?.some((_message) => {
       if (_message.version) {
         const isParticipantUsingSemverRange = (0, import_semver5.validRange)(_message.version);