@eventcatalog/sdk 2.17.4 → 2.18.1

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,25 @@ declare const _default: (path: string) => {
     addEventToDomain: (id: string, direction: string, message: {
         id: string;
         version: string;
+        fields? /**
+         * Add an event to a service by it's id.
+         *
+         * Optionally specify a version to add the event to a specific version of the service.
+         *
+         * @example
+         * ```ts
+         * import utils from '@eventcatalog/utils';
+         *
+         * const { addEventToService } = utils('/path/to/eventcatalog');
+         *
+         * // adds a new event (InventoryUpdatedEvent) that the InventoryService will send
+         * await addEventToService('InventoryService', 'sends', { event: 'InventoryUpdatedEvent', version: '2.0.0' });
+         *
+         * // adds a new event (OrderComplete) that the InventoryService will receive
+         * await addEventToService('InventoryService', 'receives', { event: 'OrderComplete', version: '2.0.0' });
+         *
+         * ```
+         */: string[];
     }, version?: string) => Promise<void>;
     /**
      * Add a command to a domain by its id.
@@ -1318,6 +1360,25 @@ declare const _default: (path: string) => {
     addCommandToDomain: (id: string, direction: string, message: {
         id: string;
         version: string;
+        fields? /**
+         * Add an event to a service by it's id.
+         *
+         * Optionally specify a version to add the event to a specific version of the service.
+         *
+         * @example
+         * ```ts
+         * import utils from '@eventcatalog/utils';
+         *
+         * const { addEventToService } = utils('/path/to/eventcatalog');
+         *
+         * // adds a new event (InventoryUpdatedEvent) that the InventoryService will send
+         * await addEventToService('InventoryService', 'sends', { event: 'InventoryUpdatedEvent', version: '2.0.0' });
+         *
+         * // adds a new event (OrderComplete) that the InventoryService will receive
+         * await addEventToService('InventoryService', 'receives', { event: 'OrderComplete', version: '2.0.0' });
+         *
+         * ```
+         */: string[];
     }, version?: string) => Promise<void>;
     /**
      * Add a query to a domain by its id.
@@ -1339,6 +1400,25 @@ declare const _default: (path: string) => {
     addQueryToDomain: (id: string, direction: string, message: {
         id: string;
         version: string;
+        fields? /**
+         * Add an event to a service by it's id.
+         *
+         * Optionally specify a version to add the event to a specific version of the service.
+         *
+         * @example
+         * ```ts
+         * import utils from '@eventcatalog/utils';
+         *
+         * const { addEventToService } = utils('/path/to/eventcatalog');
+         *
+         * // adds a new event (InventoryUpdatedEvent) that the InventoryService will send
+         * await addEventToService('InventoryService', 'sends', { event: 'InventoryUpdatedEvent', version: '2.0.0' });
+         *
+         * // adds a new event (OrderComplete) that the InventoryService will receive
+         * await addEventToService('InventoryService', 'receives', { event: 'OrderComplete', version: '2.0.0' });
+         *
+         * ```
+         */: 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,25 @@ declare const _default: (path: string) => {
     addEventToDomain: (id: string, direction: string, message: {
         id: string;
         version: string;
+        fields? /**
+         * Add an event to a service by it's id.
+         *
+         * Optionally specify a version to add the event to a specific version of the service.
+         *
+         * @example
+         * ```ts
+         * import utils from '@eventcatalog/utils';
+         *
+         * const { addEventToService } = utils('/path/to/eventcatalog');
+         *
+         * // adds a new event (InventoryUpdatedEvent) that the InventoryService will send
+         * await addEventToService('InventoryService', 'sends', { event: 'InventoryUpdatedEvent', version: '2.0.0' });
+         *
+         * // adds a new event (OrderComplete) that the InventoryService will receive
+         * await addEventToService('InventoryService', 'receives', { event: 'OrderComplete', version: '2.0.0' });
+         *
+         * ```
+         */: string[];
     }, version?: string) => Promise<void>;
     /**
      * Add a command to a domain by its id.
@@ -1318,6 +1360,25 @@ declare const _default: (path: string) => {
     addCommandToDomain: (id: string, direction: string, message: {
         id: string;
         version: string;
+        fields? /**
+         * Add an event to a service by it's id.
+         *
+         * Optionally specify a version to add the event to a specific version of the service.
+         *
+         * @example
+         * ```ts
+         * import utils from '@eventcatalog/utils';
+         *
+         * const { addEventToService } = utils('/path/to/eventcatalog');
+         *
+         * // adds a new event (InventoryUpdatedEvent) that the InventoryService will send
+         * await addEventToService('InventoryService', 'sends', { event: 'InventoryUpdatedEvent', version: '2.0.0' });
+         *
+         * // adds a new event (OrderComplete) that the InventoryService will receive
+         * await addEventToService('InventoryService', 'receives', { event: 'OrderComplete', version: '2.0.0' });
+         *
+         * ```
+         */: string[];
     }, version?: string) => Promise<void>;
     /**
      * Add a query to a domain by its id.
@@ -1339,6 +1400,25 @@ declare const _default: (path: string) => {
     addQueryToDomain: (id: string, direction: string, message: {
         id: string;
         version: string;
+        fields? /**
+         * Add an event to a service by it's id.
+         *
+         * Optionally specify a version to add the event to a specific version of the service.
+         *
+         * @example
+         * ```ts
+         * import utils from '@eventcatalog/utils';
+         *
+         * const { addEventToService } = utils('/path/to/eventcatalog');
+         *
+         * // adds a new event (InventoryUpdatedEvent) that the InventoryService will send
+         * await addEventToService('InventoryService', 'sends', { event: 'InventoryUpdatedEvent', version: '2.0.0' });
+         *
+         * // adds a new event (OrderComplete) that the InventoryService will receive
+         * await addEventToService('InventoryService', 'receives', { event: 'OrderComplete', version: '2.0.0' });
+         *
+         * ```
+         */: 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`);
   }
@@ -1462,6 +1467,14 @@ var import_promises6 = __toESM(require("fs/promises"));
 var import_node_path8 = __toESM(require("path"));
 var import_node_fs3 = __toESM(require("fs"));
 var import_gray_matter3 = __toESM(require("gray-matter"));
+var resolveDomainWriteDirectory = async (directory, id, version) => {
+  const existingResource = await findFileById(directory, id, version);
+  if (!existingResource) return directory;
+  const normalizedPath = existingResource.replace(/\\/g, "/");
+  const lastDomainsIndex = normalizedPath.lastIndexOf("/domains/");
+  if (lastDomainsIndex === -1) return directory;
+  return existingResource.substring(0, lastDomainsIndex + "/domains".length);
+};
 var getDomain = (directory) => async (id, version) => getResource(directory, id, version, { type: "domain" });
 var getDomains = (directory) => async (options) => getResources(directory, {
   type: "domains",
@@ -1531,8 +1544,9 @@ var addServiceToDomain = (directory) => async (id, service, version) => {
     return;
   }
   domain.services.push(service);
+  const writeDir = await resolveDomainWriteDirectory(directory, id, version);
   await rmDomainById(directory)(id, version, true);
-  await writeDomain(directory)(domain, { format: extension === ".md" ? "md" : "mdx" });
+  await writeDomain(writeDir)(domain, { format: extension === ".md" ? "md" : "mdx" });
 };
 var addSubDomainToDomain = (directory) => async (id, subDomain, version) => {
   let domain = await getDomain(directory)(id, version);
@@ -1546,8 +1560,9 @@ var addSubDomainToDomain = (directory) => async (id, subDomain, version) => {
     return;
   }
   domain.domains.push(subDomain);
+  const writeDir = await resolveDomainWriteDirectory(directory, id, version);
   await rmDomainById(directory)(id, version, true);
-  await writeDomain(directory)(domain, { format: extension === ".md" ? "md" : "mdx" });
+  await writeDomain(writeDir)(domain, { format: extension === ".md" ? "md" : "mdx" });
 };
 var addEntityToDomain = (directory) => async (id, entity, version) => {
   let domain = await getDomain(directory)(id, version);
@@ -1561,8 +1576,9 @@ var addEntityToDomain = (directory) => async (id, entity, version) => {
     return;
   }
   domain.entities.push(entity);
+  const writeDir = await resolveDomainWriteDirectory(directory, id, version);
   await rmDomainById(directory)(id, version, true);
-  await writeDomain(directory)(domain, { format: extension === ".md" ? "md" : "mdx" });
+  await writeDomain(writeDir)(domain, { format: extension === ".md" ? "md" : "mdx" });
 };
 var addDataProductToDomain = (directory) => async (id, dataProduct, version) => {
   let domain = await getDomain(directory)(id, version);
@@ -1578,8 +1594,9 @@ var addDataProductToDomain = (directory) => async (id, dataProduct, version) =>
     return;
   }
   domain.dataProducts.push(dataProduct);
+  const writeDir = await resolveDomainWriteDirectory(directory, id, version);
   await rmDomainById(directory)(id, version, true);
-  await writeDomain(directory)(domain, { format: extension === ".md" ? "md" : "mdx" });
+  await writeDomain(writeDir)(domain, { format: extension === ".md" ? "md" : "mdx" });
 };
 var addMessageToDomain = (directory) => async (id, direction, message, version) => {
   let domain = await getDomain(directory)(id, version);
@@ -1594,7 +1611,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,19 +1621,13 @@ 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`);
   }
-  const existingResource = await findFileById(directory, id, version);
-  if (!existingResource) {
-    throw new Error(`Cannot find domain ${id} in the catalog`);
-  }
-  const normalizedPath = existingResource.replace(/\\/g, "/");
-  const lastDomainsIndex = normalizedPath.lastIndexOf("/domains/");
-  const pathToResource = existingResource.substring(0, lastDomainsIndex + "/domains".length);
+  const writeDir = await resolveDomainWriteDirectory(directory, id, version);
   await rmDomainById(directory)(id, version, true);
-  await writeDomain(pathToResource)(domain, { format: extension === ".md" ? "md" : "mdx" });
+  await writeDomain(writeDir)(domain, { format: extension === ".md" ? "md" : "mdx" });
 };
 
 // src/channels.ts