@eventcatalog/sdk 2.17.4 → 2.18.0

package/dist/index.d.mts

@@ -54,12 +54,14 @@ type ResourcePointer = {
 type SendsPointer = {
   id: string;
   version?: string;
+  fields?: string[];
   to?: ChannelPointer[];
 };
 
 type ReceivesPointer = {
   id: string;
   version?: string;
+  fields?: string[];
   from?: ChannelPointer[];
 };
 
@@ -103,6 +105,9 @@ interface MessageDetailsPanelProperty {
   channels?: DetailPanelProperty;
   versions?: DetailPanelProperty;
   repository?: DetailPanelProperty;
+  owners?: DetailPanelProperty;
+  changelog?: DetailPanelProperty;
+  attachments?: DetailPanelProperty;
 }
 
 interface Event extends BaseSchema {
@@ -1047,6 +1052,12 @@ declare const _default: (path: string) => {
     addEventToService: (id: string, direction: string, event: {
         id: string;
         version: string;
+        fields? /**
+         * Remove an channel to EventCatalog (modeled on the standard POSIX rm utility)
+         *
+         * @param path - The path to your channel, e.g. `/Inventory/InventoryAdjusted`
+         *
+         */: string[];
     }, version?: string) => Promise<void>;
     /**
      * Add a data store to a service by it's id.
@@ -1090,6 +1101,12 @@ declare const _default: (path: string) => {
     addCommandToService: (id: string, direction: string, event: {
         id: string;
         version: string;
+        fields? /**
+         * Remove an channel to EventCatalog (modeled on the standard POSIX rm utility)
+         *
+         * @param path - The path to your channel, e.g. `/Inventory/InventoryAdjusted`
+         *
+         */: string[];
     }, version?: string) => Promise<void>;
     /**
      * Add a query to a service by it's id.
@@ -1113,6 +1130,12 @@ declare const _default: (path: string) => {
     addQueryToService: (id: string, direction: string, event: {
         id: string;
         version: string;
+        fields? /**
+         * Remove an channel to EventCatalog (modeled on the standard POSIX rm utility)
+         *
+         * @param path - The path to your channel, e.g. `/Inventory/InventoryAdjusted`
+         *
+         */: string[];
     }, version?: string) => Promise<void>;
     /**
      * Add an entity to a service by its id.
@@ -1297,6 +1320,7 @@ declare const _default: (path: string) => {
     addEventToDomain: (id: string, direction: string, message: {
         id: string;
         version: string;
+        fields?: string[];
     }, version?: string) => Promise<void>;
     /**
      * Add a command to a domain by its id.
@@ -1318,6 +1342,7 @@ declare const _default: (path: string) => {
     addCommandToDomain: (id: string, direction: string, message: {
         id: string;
         version: string;
+        fields?: string[];
     }, version?: string) => Promise<void>;
     /**
      * Add a query to a domain by its id.
@@ -1339,6 +1364,7 @@ declare const _default: (path: string) => {
     addQueryToDomain: (id: string, direction: string, message: {
         id: string;
         version: string;
+        fields?: string[];
     }, version?: string) => Promise<void>;
     /**
      * ================================

package/dist/index.d.ts

@@ -54,12 +54,14 @@ type ResourcePointer = {
 type SendsPointer = {
   id: string;
   version?: string;
+  fields?: string[];
   to?: ChannelPointer[];
 };
 
 type ReceivesPointer = {
   id: string;
   version?: string;
+  fields?: string[];
   from?: ChannelPointer[];
 };
 
@@ -103,6 +105,9 @@ interface MessageDetailsPanelProperty {
   channels?: DetailPanelProperty;
   versions?: DetailPanelProperty;
   repository?: DetailPanelProperty;
+  owners?: DetailPanelProperty;
+  changelog?: DetailPanelProperty;
+  attachments?: DetailPanelProperty;
 }
 
 interface Event extends BaseSchema {
@@ -1047,6 +1052,12 @@ declare const _default: (path: string) => {
     addEventToService: (id: string, direction: string, event: {
         id: string;
         version: string;
+        fields? /**
+         * Remove an channel to EventCatalog (modeled on the standard POSIX rm utility)
+         *
+         * @param path - The path to your channel, e.g. `/Inventory/InventoryAdjusted`
+         *
+         */: string[];
     }, version?: string) => Promise<void>;
     /**
      * Add a data store to a service by it's id.
@@ -1090,6 +1101,12 @@ declare const _default: (path: string) => {
     addCommandToService: (id: string, direction: string, event: {
         id: string;
         version: string;
+        fields? /**
+         * Remove an channel to EventCatalog (modeled on the standard POSIX rm utility)
+         *
+         * @param path - The path to your channel, e.g. `/Inventory/InventoryAdjusted`
+         *
+         */: string[];
     }, version?: string) => Promise<void>;
     /**
      * Add a query to a service by it's id.
@@ -1113,6 +1130,12 @@ declare const _default: (path: string) => {
     addQueryToService: (id: string, direction: string, event: {
         id: string;
         version: string;
+        fields? /**
+         * Remove an channel to EventCatalog (modeled on the standard POSIX rm utility)
+         *
+         * @param path - The path to your channel, e.g. `/Inventory/InventoryAdjusted`
+         *
+         */: string[];
     }, version?: string) => Promise<void>;
     /**
      * Add an entity to a service by its id.
@@ -1297,6 +1320,7 @@ declare const _default: (path: string) => {
     addEventToDomain: (id: string, direction: string, message: {
         id: string;
         version: string;
+        fields?: string[];
     }, version?: string) => Promise<void>;
     /**
      * Add a command to a domain by its id.
@@ -1318,6 +1342,7 @@ declare const _default: (path: string) => {
     addCommandToDomain: (id: string, direction: string, message: {
         id: string;
         version: string;
+        fields?: string[];
     }, version?: string) => Promise<void>;
     /**
      * Add a query to a domain by its id.
@@ -1339,6 +1364,7 @@ declare const _default: (path: string) => {
     addQueryToDomain: (id: string, direction: string, message: {
         id: string;
         version: string;
+        fields?: string[];
     }, version?: string) => Promise<void>;
     /**
      * ================================

package/dist/index.js

@@ -862,6 +862,11 @@ var copyDir = async (catalogDir, source, target, filter) => {
   });
   import_node_fs.default.rmSync(tmpDirectory, { recursive: true });
 };
+var buildMessagePointer = (message) => {
+  const pointer = { id: message.id, version: message.version };
+  if (message.fields) pointer.fields = message.fields;
+  return pointer;
+};
 var uniqueVersions = (messages) => {
   const uniqueSet = /* @__PURE__ */ new Set();
   return messages.filter((message) => {
@@ -1364,7 +1369,7 @@ var addMessageToService = (directory) => async (id, direction, event, version) =
         return;
       }
     }
-    service.sends.push({ id: event.id, version: event.version });
+    service.sends.push(buildMessagePointer(event));
   } else if (direction === "receives") {
     if (service.receives === void 0) {
       service.receives = [];
@@ -1374,7 +1379,7 @@ var addMessageToService = (directory) => async (id, direction, event, version) =
         return;
       }
     }
-    service.receives.push({ id: event.id, version: event.version });
+    service.receives.push(buildMessagePointer(event));
   } else {
     throw new Error(`Direction ${direction} is invalid, only 'receives' and 'sends' are supported`);
   }
@@ -1594,7 +1599,7 @@ var addMessageToDomain = (directory) => async (id, direction, message, version)
         return;
       }
     }
-    domain.sends.push({ id: message.id, version: message.version });
+    domain.sends.push(buildMessagePointer(message));
   } else if (direction === "receives") {
     if (domain.receives === void 0) {
       domain.receives = [];
@@ -1604,7 +1609,7 @@ var addMessageToDomain = (directory) => async (id, direction, message, version)
         return;
       }
     }
-    domain.receives.push({ id: message.id, version: message.version });
+    domain.receives.push(buildMessagePointer(message));
   } else {
     throw new Error(`Direction ${direction} is invalid, only 'receives' and 'sends' are supported`);
   }