@eventcatalog/sdk 2.5.4 → 2.6.0

package/dist/index.js

@@ -33,7 +33,7 @@ __export(index_exports, {
   default: () => index_default
 });
 module.exports = __toCommonJS(index_exports);
-var import_node_path12 = require("path");
+var import_node_path13 = require("path");
 
 // src/events.ts
 var import_promises2 = __toESM(require("fs/promises"));
@@ -107,7 +107,8 @@ var readMdxFile = async (path4) => {
   return { ...frontmatter, markdown };
 };
 var searchFilesForId = async (files, id, version) => {
-  const idRegex = new RegExp(`^id:\\s*(['"]|>-)?\\s*${id}['"]?\\s*$`, "m");
+  const escapedId = id.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+  const idRegex = new RegExp(`^id:\\s*(['"]|>-)?\\s*${escapedId}['"]?\\s*$`, "m");
   const versionRegex = new RegExp(`^version:\\s*['"]?${version}['"]?\\s*$`, "m");
   const matches = files.map((file) => {
     const content = import_node_fs.default.readFileSync(file, "utf-8");
@@ -324,6 +325,12 @@ var getFileFromResource = async (catalogDir, id, file, version) => {
 var getVersionedDirectory = (sourceDirectory, version) => {
   return (0, import_path.join)(sourceDirectory, "versioned", version);
 };
+var isLatestVersion = async (catalogDir, id, version) => {
+  const resource = await getResource(catalogDir, id, version);
+  if (!resource) return false;
+  const pathToResource = await getResourcePath(catalogDir, id, version);
+  return !pathToResource?.relativePath.replace(/\\/g, "/").includes("/versioned/");
+};
 
 // src/events.ts
 var getEvent = (directory) => async (id, version, options) => getResource(directory, id, version, { type: "event", ...options });
@@ -665,14 +672,82 @@ var addMessageToChannel = (directory, collection) => async (id, _message, versio
   await writeMessage(pathToResource)(message, { format: extension === ".md" ? "md" : "mdx" });
 };
 
+// src/messages.ts
+var import_node_path8 = require("path");
+var import_gray_matter4 = __toESM(require("gray-matter"));
+var getMessageBySchemaPath = (directory) => async (path4, options) => {
+  const pathToMessage = (0, import_node_path8.dirname)(path4);
+  try {
+    const files = await getFiles(`${pathToMessage}/index.{md,mdx}`);
+    if (!files || files.length === 0) {
+      throw new Error(`No message definition file (index.md or index.mdx) found in directory: ${pathToMessage}`);
+    }
+    const messageFile = files[0];
+    const { data } = import_gray_matter4.default.read(messageFile);
+    const { id, version } = data;
+    if (!id || !version) {
+      throw new Error(`Message definition file at ${messageFile} is missing 'id' or 'version' in its frontmatter.`);
+    }
+    const message = await getResource(directory, id, version, { type: "message", ...options });
+    if (!message) {
+      throw new Error(`Message resource with id '${id}' and version '${version}' not found, as referenced in ${messageFile}.`);
+    }
+    return message;
+  } catch (error) {
+    console.error(`Failed to get message for schema path ${path4}. Error processing directory ${pathToMessage}:`, error);
+    if (error instanceof Error) {
+      error.message = `Failed to retrieve message from ${pathToMessage}: ${error.message}`;
+      throw error;
+    }
+    throw new Error(`Failed to retrieve message from ${pathToMessage} due to an unknown error.`);
+  }
+};
+var getProducersAndConsumersForMessage = (directory) => async (id, version) => {
+  const services = await getServices(directory)({ latestOnly: true });
+  const message = await getResource(directory, id, version, { type: "message" });
+  const isMessageLatestVersion = await isLatestVersion(directory, id, version);
+  if (!message) {
+    throw new Error(`Message resource with id '${id}' and version '${version}' not found.`);
+  }
+  const producers = [];
+  const consumers = [];
+  for (const service of services) {
+    const servicePublishesMessage = service.sends?.some((_message) => {
+      if (_message.version) {
+        return _message.id === message.id && _message.version === message.version;
+      }
+      if (isMessageLatestVersion && _message.id === message.id) {
+        return true;
+      }
+      return false;
+    });
+    const serviceSubscribesToMessage = service.receives?.some((_message) => {
+      if (_message.version) {
+        return _message.id === message.id && _message.version === message.version;
+      }
+      if (isMessageLatestVersion && _message.id === message.id) {
+        return true;
+      }
+      return false;
+    });
+    if (servicePublishesMessage) {
+      producers.push(service);
+    }
+    if (serviceSubscribesToMessage) {
+      consumers.push(service);
+    }
+  }
+  return { producers, consumers };
+};
+
 // src/custom-docs.ts
-var import_node_path8 = __toESM(require("path"));
+var import_node_path9 = __toESM(require("path"));
 var import_node_fs4 = __toESM(require("fs"));
 var import_promises8 = __toESM(require("fs/promises"));
-var import_gray_matter4 = __toESM(require("gray-matter"));
+var import_gray_matter5 = __toESM(require("gray-matter"));
 var import_slugify = __toESM(require("slugify"));
 var getCustomDoc = (directory) => async (filePath) => {
-  const fullPath = import_node_path8.default.join(directory, filePath);
+  const fullPath = import_node_path9.default.join(directory, filePath);
   const fullPathWithExtension = fullPath.endsWith(".mdx") ? fullPath : `${fullPath}.mdx`;
   const fileExists = import_node_fs4.default.existsSync(fullPathWithExtension);
   if (!fileExists) {
@@ -691,26 +766,26 @@ var writeCustomDoc = (directory) => async (customDoc, options = { path: "" }) =>
   const { fileName, ...rest } = customDoc;
   const name = fileName || (0, import_slugify.default)(customDoc.title, { lower: true });
   const withExtension = name.endsWith(".mdx") ? name : `${name}.mdx`;
-  const fullPath = import_node_path8.default.join(directory, options.path || "", withExtension);
-  import_node_fs4.default.mkdirSync(import_node_path8.default.dirname(fullPath), { recursive: true });
-  const document = import_gray_matter4.default.stringify(customDoc.markdown.trim(), rest);
+  const fullPath = import_node_path9.default.join(directory, options.path || "", withExtension);
+  import_node_fs4.default.mkdirSync(import_node_path9.default.dirname(fullPath), { recursive: true });
+  const document = import_gray_matter5.default.stringify(customDoc.markdown.trim(), rest);
   import_node_fs4.default.writeFileSync(fullPath, document);
 };
 var rmCustomDoc = (directory) => async (filePath) => {
   const withExtension = filePath.endsWith(".mdx") ? filePath : `${filePath}.mdx`;
-  await import_promises8.default.rm((0, import_node_path8.join)(directory, withExtension), { recursive: true });
+  await import_promises8.default.rm((0, import_node_path9.join)(directory, withExtension), { recursive: true });
 };
 
 // src/teams.ts
 var import_promises9 = __toESM(require("fs/promises"));
 var import_node_fs5 = __toESM(require("fs"));
-var import_node_path9 = require("path");
-var import_gray_matter5 = __toESM(require("gray-matter"));
+var import_node_path10 = require("path");
+var import_gray_matter6 = __toESM(require("gray-matter"));
 var getTeam = (catalogDir) => async (id) => {
   const files = await getFiles(`${catalogDir}/${id}.{md,mdx}`);
   if (files.length == 0) return void 0;
   const file = files[0];
-  const { data, content } = import_gray_matter5.default.read(file);
+  const { data, content } = import_gray_matter6.default.read(file);
   return {
     ...data,
     id: data.id,
@@ -722,7 +797,7 @@ var getTeams = (catalogDir) => async (options) => {
   const files = await getFiles(`${catalogDir}/teams/*.{md,mdx}`);
   if (files.length === 0) return [];
   return files.map((file) => {
-    const { data, content } = import_gray_matter5.default.read(file);
+    const { data, content } = import_gray_matter6.default.read(file);
     return {
       ...data,
       id: data.id,
@@ -739,23 +814,23 @@ var writeTeam = (catalogDir) => async (team, options = {}) => {
     throw new Error(`Failed to write ${resource.id} (team) as it already exists`);
   }
   const { markdown, ...frontmatter } = resource;
-  const document = import_gray_matter5.default.stringify(markdown, frontmatter);
-  import_node_fs5.default.mkdirSync((0, import_node_path9.join)(catalogDir, ""), { recursive: true });
-  import_node_fs5.default.writeFileSync((0, import_node_path9.join)(catalogDir, "", `${resource.id}.mdx`), document);
+  const document = import_gray_matter6.default.stringify(markdown, frontmatter);
+  import_node_fs5.default.mkdirSync((0, import_node_path10.join)(catalogDir, ""), { recursive: true });
+  import_node_fs5.default.writeFileSync((0, import_node_path10.join)(catalogDir, "", `${resource.id}.mdx`), document);
 };
 var rmTeamById = (catalogDir) => async (id) => {
-  await import_promises9.default.rm((0, import_node_path9.join)(catalogDir, `${id}.mdx`), { recursive: true });
+  await import_promises9.default.rm((0, import_node_path10.join)(catalogDir, `${id}.mdx`), { recursive: true });
 };
 
 // src/users.ts
 var import_node_fs6 = __toESM(require("fs"));
-var import_node_path10 = require("path");
-var import_gray_matter6 = __toESM(require("gray-matter"));
+var import_node_path11 = require("path");
+var import_gray_matter7 = __toESM(require("gray-matter"));
 var getUser = (catalogDir) => async (id) => {
   const files = await getFiles(`${catalogDir}/${id}.{md,mdx}`);
   if (files.length == 0) return void 0;
   const file = files[0];
-  const { data, content } = import_gray_matter6.default.read(file);
+  const { data, content } = import_gray_matter7.default.read(file);
   return {
     ...data,
     id: data.id,
@@ -768,7 +843,7 @@ var getUsers = (catalogDir) => async (options) => {
   const files = await getFiles(`${catalogDir}/users/*.{md,mdx}`);
   if (files.length === 0) return [];
   return files.map((file) => {
-    const { data, content } = import_gray_matter6.default.read(file);
+    const { data, content } = import_gray_matter7.default.read(file);
     return {
       ...data,
       id: data.id,
@@ -786,21 +861,21 @@ var writeUser = (catalogDir) => async (user, options = {}) => {
     throw new Error(`Failed to write ${resource.id} (user) as it already exists`);
   }
   const { markdown, ...frontmatter } = resource;
-  const document = import_gray_matter6.default.stringify(markdown, frontmatter);
-  import_node_fs6.default.mkdirSync((0, import_node_path10.join)(catalogDir, ""), { recursive: true });
-  import_node_fs6.default.writeFileSync((0, import_node_path10.join)(catalogDir, "", `${resource.id}.mdx`), document);
+  const document = import_gray_matter7.default.stringify(markdown, frontmatter);
+  import_node_fs6.default.mkdirSync((0, import_node_path11.join)(catalogDir, ""), { recursive: true });
+  import_node_fs6.default.writeFileSync((0, import_node_path11.join)(catalogDir, "", `${resource.id}.mdx`), document);
 };
 var rmUserById = (catalogDir) => async (id) => {
-  import_node_fs6.default.rmSync((0, import_node_path10.join)(catalogDir, `${id}.mdx`), { recursive: true });
+  import_node_fs6.default.rmSync((0, import_node_path11.join)(catalogDir, `${id}.mdx`), { recursive: true });
 };
 
 // src/eventcatalog.ts
 var import_fs = __toESM(require("fs"));
-var import_node_path11 = __toESM(require("path"));
+var import_node_path12 = __toESM(require("path"));
 var DUMP_VERSION = "0.0.1";
 var getEventCatalogVersion = async (catalogDir) => {
   try {
-    const packageJson = import_fs.default.readFileSync((0, import_node_path11.join)(catalogDir, "package.json"), "utf8");
+    const packageJson = import_fs.default.readFileSync((0, import_node_path12.join)(catalogDir, "package.json"), "utf8");
     const packageJsonObject = JSON.parse(packageJson);
     return packageJsonObject["dependencies"]["@eventcatalog/core"];
   } catch (error) {
@@ -813,7 +888,7 @@ var hydrateResource = async (catalogDir, resources = [], { attachSchema = false
       const resourcePath = await getResourcePath(catalogDir, resource.id, resource.version);
       let schema = "";
       if (resource.schemaPath && resourcePath?.fullPath) {
-        const pathToSchema = import_node_path11.default.join(import_node_path11.default.dirname(resourcePath?.fullPath), resource.schemaPath);
+        const pathToSchema = import_node_path12.default.join(import_node_path12.default.dirname(resourcePath?.fullPath), resource.schemaPath);
         if (import_fs.default.existsSync(pathToSchema)) {
           schema = import_fs.default.readFileSync(pathToSchema, "utf8");
         }
@@ -834,7 +909,7 @@ var filterCollection = (collection, options) => {
 };
 var getEventCatalogConfigurationFile = (directory) => async () => {
   try {
-    const path4 = (0, import_node_path11.join)(directory, "eventcatalog.config.js");
+    const path4 = (0, import_node_path12.join)(directory, "eventcatalog.config.js");
     const configModule = await import(path4);
     return configModule.default;
   } catch (error) {
@@ -900,13 +975,13 @@ var index_default = (path4) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Event|Undefined
      */
-    getEvent: getEvent((0, import_node_path12.join)(path4)),
+    getEvent: getEvent((0, import_node_path13.join)(path4)),
     /**
      * Returns all events from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Event[]|Undefined
      */
-    getEvents: getEvents((0, import_node_path12.join)(path4)),
+    getEvents: getEvents((0, import_node_path13.join)(path4)),
     /**
      * Adds an event to EventCatalog
      *
@@ -914,7 +989,7 @@ var index_default = (path4) => {
      * @param options - Optional options to write the event
      *
      */
-    writeEvent: writeEvent((0, import_node_path12.join)(path4, "events")),
+    writeEvent: writeEvent((0, import_node_path13.join)(path4, "events")),
     /**
      * Adds an event to a service in EventCatalog
      *
@@ -923,26 +998,26 @@ var index_default = (path4) => {
      * @param options - Optional options to write the event
      *
      */
-    writeEventToService: writeEventToService((0, import_node_path12.join)(path4)),
+    writeEventToService: writeEventToService((0, import_node_path13.join)(path4)),
     /**
      * Remove an event to EventCatalog (modeled on the standard POSIX rm utility)
      *
      * @param path - The path to your event, e.g. `/Inventory/InventoryAdjusted`
      *
      */
-    rmEvent: rmEvent((0, import_node_path12.join)(path4, "events")),
+    rmEvent: rmEvent((0, import_node_path13.join)(path4, "events")),
     /**
      * Remove an event by an Event id
      *
      * @param id - The id of the event you want to remove
      *
      */
-    rmEventById: rmEventById((0, import_node_path12.join)(path4)),
+    rmEventById: rmEventById((0, import_node_path13.join)(path4)),
     /**
      * Moves a given event id to the version directory
      * @param directory
      */
-    versionEvent: versionEvent((0, import_node_path12.join)(path4)),
+    versionEvent: versionEvent((0, import_node_path13.join)(path4)),
     /**
      * Adds a file to the given event
      * @param id - The id of the event to add the file to
@@ -950,7 +1025,7 @@ var index_default = (path4) => {
      * @param version - Optional version of the event to add the file to
      * @returns
      */
-    addFileToEvent: addFileToEvent((0, import_node_path12.join)(path4)),
+    addFileToEvent: addFileToEvent((0, import_node_path13.join)(path4)),
     /**
      * Adds a schema to the given event
      * @param id - The id of the event to add the schema to
@@ -958,14 +1033,14 @@ var index_default = (path4) => {
      * @param version - Optional version of the event to add the schema to
      * @returns
      */
-    addSchemaToEvent: addSchemaToEvent((0, import_node_path12.join)(path4)),
+    addSchemaToEvent: addSchemaToEvent((0, import_node_path13.join)(path4)),
     /**
      * Check to see if an event version exists
      * @param id - The id of the event
      * @param version - The version of the event (supports semver)
      * @returns
      */
-    eventHasVersion: eventHasVersion((0, import_node_path12.join)(path4)),
+    eventHasVersion: eventHasVersion((0, import_node_path13.join)(path4)),
     /**
      * ================================
      *            Commands
@@ -977,13 +1052,13 @@ var index_default = (path4) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Command|Undefined
      */
-    getCommand: getCommand((0, import_node_path12.join)(path4)),
+    getCommand: getCommand((0, import_node_path13.join)(path4)),
     /**
      * Returns all commands from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Command[]|Undefined
      */
-    getCommands: getCommands((0, import_node_path12.join)(path4)),
+    getCommands: getCommands((0, import_node_path13.join)(path4)),
     /**
      * Adds an command to EventCatalog
      *
@@ -991,7 +1066,7 @@ var index_default = (path4) => {
      * @param options - Optional options to write the command
      *
      */
-    writeCommand: writeCommand((0, import_node_path12.join)(path4, "commands")),
+    writeCommand: writeCommand((0, import_node_path13.join)(path4, "commands")),
     /**
      * Adds a command to a service in EventCatalog
      *
@@ -1000,26 +1075,26 @@ var index_default = (path4) => {
      * @param options - Optional options to write the command
      *
      */
-    writeCommandToService: writeCommandToService((0, import_node_path12.join)(path4)),
+    writeCommandToService: writeCommandToService((0, import_node_path13.join)(path4)),
     /**
      * Remove an command to EventCatalog (modeled on the standard POSIX rm utility)
      *
      * @param path - The path to your command, e.g. `/Inventory/InventoryAdjusted`
      *
      */
-    rmCommand: rmCommand((0, import_node_path12.join)(path4, "commands")),
+    rmCommand: rmCommand((0, import_node_path13.join)(path4, "commands")),
     /**
      * Remove an command by an Event id
      *
      * @param id - The id of the command you want to remove
      *
      */
-    rmCommandById: rmCommandById((0, import_node_path12.join)(path4)),
+    rmCommandById: rmCommandById((0, import_node_path13.join)(path4)),
     /**
      * Moves a given command id to the version directory
      * @param directory
      */
-    versionCommand: versionCommand((0, import_node_path12.join)(path4)),
+    versionCommand: versionCommand((0, import_node_path13.join)(path4)),
     /**
      * Adds a file to the given command
      * @param id - The id of the command to add the file to
@@ -1027,7 +1102,7 @@ var index_default = (path4) => {
      * @param version - Optional version of the command to add the file to
      * @returns
      */
-    addFileToCommand: addFileToCommand((0, import_node_path12.join)(path4)),
+    addFileToCommand: addFileToCommand((0, import_node_path13.join)(path4)),
     /**
      * Adds a schema to the given command
      * @param id - The id of the command to add the schema to
@@ -1035,14 +1110,14 @@ var index_default = (path4) => {
      * @param version - Optional version of the command to add the schema to
      * @returns
      */
-    addSchemaToCommand: addSchemaToCommand((0, import_node_path12.join)(path4)),
+    addSchemaToCommand: addSchemaToCommand((0, import_node_path13.join)(path4)),
     /**
      * Check to see if a command version exists
      * @param id - The id of the command
      * @param version - The version of the command (supports semver)
      * @returns
      */
-    commandHasVersion: commandHasVersion((0, import_node_path12.join)(path4)),
+    commandHasVersion: commandHasVersion((0, import_node_path13.join)(path4)),
     /**
      * ================================
      *            Queries
@@ -1054,13 +1129,13 @@ var index_default = (path4) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Query|Undefined
      */
-    getQuery: getQuery((0, import_node_path12.join)(path4)),
+    getQuery: getQuery((0, import_node_path13.join)(path4)),
     /**
      * Returns all queries from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Query[]|Undefined
      */
-    getQueries: getQueries((0, import_node_path12.join)(path4)),
+    getQueries: getQueries((0, import_node_path13.join)(path4)),
     /**
      * Adds a query to EventCatalog
      *
@@ -1068,7 +1143,7 @@ var index_default = (path4) => {
      * @param options - Optional options to write the event
      *
      */
-    writeQuery: writeQuery((0, import_node_path12.join)(path4, "queries")),
+    writeQuery: writeQuery((0, import_node_path13.join)(path4, "queries")),
     /**
      * Adds a query to a service in EventCatalog
      *
@@ -1077,26 +1152,26 @@ var index_default = (path4) => {
      * @param options - Optional options to write the query
      *
      */
-    writeQueryToService: writeQueryToService((0, import_node_path12.join)(path4)),
+    writeQueryToService: writeQueryToService((0, import_node_path13.join)(path4)),
     /**
      * Remove an query to EventCatalog (modeled on the standard POSIX rm utility)
      *
      * @param path - The path to your query, e.g. `/Orders/GetOrder`
      *
      */
-    rmQuery: rmQuery((0, import_node_path12.join)(path4, "queries")),
+    rmQuery: rmQuery((0, import_node_path13.join)(path4, "queries")),
     /**
      * Remove a query by a Query id
      *
      * @param id - The id of the query you want to remove
      *
      */
-    rmQueryById: rmQueryById((0, import_node_path12.join)(path4)),
+    rmQueryById: rmQueryById((0, import_node_path13.join)(path4)),
     /**
      * Moves a given query id to the version directory
      * @param directory
      */
-    versionQuery: versionQuery((0, import_node_path12.join)(path4)),
+    versionQuery: versionQuery((0, import_node_path13.join)(path4)),
     /**
      * Adds a file to the given query
      * @param id - The id of the query to add the file to
@@ -1104,7 +1179,7 @@ var index_default = (path4) => {
      * @param version - Optional version of the query to add the file to
      * @returns
      */
-    addFileToQuery: addFileToQuery((0, import_node_path12.join)(path4)),
+    addFileToQuery: addFileToQuery((0, import_node_path13.join)(path4)),
     /**
      * Adds a schema to the given query
      * @param id - The id of the query to add the schema to
@@ -1112,14 +1187,14 @@ var index_default = (path4) => {
      * @param version - Optional version of the query to add the schema to
      * @returns
      */
-    addSchemaToQuery: addSchemaToQuery((0, import_node_path12.join)(path4)),
+    addSchemaToQuery: addSchemaToQuery((0, import_node_path13.join)(path4)),
     /**
      * Check to see if an query version exists
      * @param id - The id of the query
      * @param version - The version of the query (supports semver)
      * @returns
      */
-    queryHasVersion: queryHasVersion((0, import_node_path12.join)(path4)),
+    queryHasVersion: queryHasVersion((0, import_node_path13.join)(path4)),
     /**
      * ================================
      *            Channels
@@ -1131,13 +1206,13 @@ var index_default = (path4) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Channel|Undefined
      */
-    getChannel: getChannel((0, import_node_path12.join)(path4)),
+    getChannel: getChannel((0, import_node_path13.join)(path4)),
     /**
      * Returns all channels from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Channel[]|Undefined
      */
-    getChannels: getChannels((0, import_node_path12.join)(path4)),
+    getChannels: getChannels((0, import_node_path13.join)(path4)),
     /**
      * Adds an channel to EventCatalog
      *
@@ -1145,33 +1220,33 @@ var index_default = (path4) => {
      * @param options - Optional options to write the channel
      *
      */
-    writeChannel: writeChannel((0, import_node_path12.join)(path4, "channels")),
+    writeChannel: writeChannel((0, import_node_path13.join)(path4, "channels")),
     /**
      * Remove an channel to EventCatalog (modeled on the standard POSIX rm utility)
      *
      * @param path - The path to your channel, e.g. `/Inventory/InventoryAdjusted`
      *
      */
-    rmChannel: rmChannel((0, import_node_path12.join)(path4, "channels")),
+    rmChannel: rmChannel((0, import_node_path13.join)(path4, "channels")),
     /**
      * Remove an channel by an Event id
      *
      * @param id - The id of the channel you want to remove
      *
      */
-    rmChannelById: rmChannelById((0, import_node_path12.join)(path4)),
+    rmChannelById: rmChannelById((0, import_node_path13.join)(path4)),
     /**
      * Moves a given channel id to the version directory
      * @param directory
      */
-    versionChannel: versionChannel((0, import_node_path12.join)(path4)),
+    versionChannel: versionChannel((0, import_node_path13.join)(path4)),
     /**
      * Check to see if a channel version exists
      * @param id - The id of the channel
      * @param version - The version of the channel (supports semver)
      * @returns
      */
-    channelHasVersion: channelHasVersion((0, import_node_path12.join)(path4)),
+    channelHasVersion: channelHasVersion((0, import_node_path13.join)(path4)),
     /**
      * Add a channel to an event
      *
@@ -1188,7 +1263,7 @@ var index_default = (path4) => {
      *
      * ```
      */
-    addEventToChannel: addMessageToChannel((0, import_node_path12.join)(path4), "events"),
+    addEventToChannel: addMessageToChannel((0, import_node_path13.join)(path4), "events"),
     /**
      * Add a channel to an command
      *
@@ -1205,7 +1280,7 @@ var index_default = (path4) => {
      *
      * ```
      */
-    addCommandToChannel: addMessageToChannel((0, import_node_path12.join)(path4), "commands"),
+    addCommandToChannel: addMessageToChannel((0, import_node_path13.join)(path4), "commands"),
     /**
      * Add a channel to an query
      *
@@ -1222,7 +1297,7 @@ var index_default = (path4) => {
      *
      * ```
      */
-    addQueryToChannel: addMessageToChannel((0, import_node_path12.join)(path4), "queries"),
+    addQueryToChannel: addMessageToChannel((0, import_node_path13.join)(path4), "queries"),
     /**
      * ================================
      *            SERVICES
@@ -1235,14 +1310,14 @@ var index_default = (path4) => {
      * @param options - Optional options to write the event
      *
      */
-    writeService: writeService((0, import_node_path12.join)(path4, "services")),
+    writeService: writeService((0, import_node_path13.join)(path4, "services")),
     /**
      * Adds a versioned service to EventCatalog
      *
      * @param service - The service to write
      *
      */
-    writeVersionedService: writeVersionedService((0, import_node_path12.join)(path4, "services")),
+    writeVersionedService: writeVersionedService((0, import_node_path13.join)(path4, "services")),
     /**
      * Adds a service to a domain in EventCatalog
      *
@@ -1251,39 +1326,39 @@ var index_default = (path4) => {
      * @param options - Optional options to write the event
      *
      */
-    writeServiceToDomain: writeServiceToDomain((0, import_node_path12.join)(path4, "domains")),
+    writeServiceToDomain: writeServiceToDomain((0, import_node_path13.join)(path4, "domains")),
     /**
      * Returns a service from EventCatalog
      * @param id - The id of the service to retrieve
      * @param version - Optional id of the version to get (supports semver)
      * @returns Service|Undefined
      */
-    getService: getService((0, import_node_path12.join)(path4)),
+    getService: getService((0, import_node_path13.join)(path4)),
     /**
      * Returns all services from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Service[]|Undefined
      */
-    getServices: getServices((0, import_node_path12.join)(path4)),
+    getServices: getServices((0, import_node_path13.join)(path4)),
     /**
      * Moves a given service id to the version directory
      * @param directory
      */
-    versionService: versionService((0, import_node_path12.join)(path4)),
+    versionService: versionService((0, import_node_path13.join)(path4)),
     /**
      * Remove a service from EventCatalog (modeled on the standard POSIX rm utility)
      *
      * @param path - The path to your service, e.g. `/InventoryService`
      *
      */
-    rmService: rmService((0, import_node_path12.join)(path4, "services")),
+    rmService: rmService((0, import_node_path13.join)(path4, "services")),
     /**
      * Remove an service by an service id
      *
      * @param id - The id of the service you want to remove
      *
      */
-    rmServiceById: rmServiceById((0, import_node_path12.join)(path4)),
+    rmServiceById: rmServiceById((0, import_node_path13.join)(path4)),
     /**
      * Adds a file to the given service
      * @param id - The id of the service to add the file to
@@ -1291,21 +1366,21 @@ var index_default = (path4) => {
      * @param version - Optional version of the service to add the file to
      * @returns
      */
-    addFileToService: addFileToService((0, import_node_path12.join)(path4)),
+    addFileToService: addFileToService((0, import_node_path13.join)(path4)),
     /**
      * Returns the specifications for a given service
      * @param id - The id of the service to retrieve the specifications for
      * @param version - Optional version of the service
      * @returns
      */
-    getSpecificationFilesForService: getSpecificationFilesForService((0, import_node_path12.join)(path4)),
+    getSpecificationFilesForService: getSpecificationFilesForService((0, import_node_path13.join)(path4)),
     /**
      * Check to see if a service version exists
      * @param id - The id of the service
      * @param version - The version of the service (supports semver)
      * @returns
      */
-    serviceHasVersion: serviceHasVersion((0, import_node_path12.join)(path4)),
+    serviceHasVersion: serviceHasVersion((0, import_node_path13.join)(path4)),
     /**
      * Add an event to a service by it's id.
      *
@@ -1325,7 +1400,7 @@ var index_default = (path4) => {
      *
      * ```
      */
-    addEventToService: addMessageToService((0, import_node_path12.join)(path4)),
+    addEventToService: addMessageToService((0, import_node_path13.join)(path4)),
     /**
      * Add a command to a service by it's id.
      *
@@ -1345,7 +1420,7 @@ var index_default = (path4) => {
      *
      * ```
      */
-    addCommandToService: addMessageToService((0, import_node_path12.join)(path4)),
+    addCommandToService: addMessageToService((0, import_node_path13.join)(path4)),
     /**
      * Add a query to a service by it's id.
      *
@@ -1365,7 +1440,7 @@ var index_default = (path4) => {
      *
      * ```
      */
-    addQueryToService: addMessageToService((0, import_node_path12.join)(path4)),
+    addQueryToService: addMessageToService((0, import_node_path13.join)(path4)),
     /**
      * ================================
      *            Domains
@@ -1378,39 +1453,39 @@ var index_default = (path4) => {
      * @param options - Optional options to write the event
      *
      */
-    writeDomain: writeDomain((0, import_node_path12.join)(path4, "domains")),
+    writeDomain: writeDomain((0, import_node_path13.join)(path4, "domains")),
     /**
      * Returns a domain from EventCatalog
      * @param id - The id of the domain to retrieve
      * @param version - Optional id of the version to get (supports semver)
      * @returns Domain|Undefined
      */
-    getDomain: getDomain((0, import_node_path12.join)(path4, "domains")),
+    getDomain: getDomain((0, import_node_path13.join)(path4, "domains")),
     /**
      * Returns all domains from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Domain[]|Undefined
      */
-    getDomains: getDomains((0, import_node_path12.join)(path4)),
+    getDomains: getDomains((0, import_node_path13.join)(path4)),
     /**
      * Moves a given domain id to the version directory
      * @param directory
      */
-    versionDomain: versionDomain((0, import_node_path12.join)(path4, "domains")),
+    versionDomain: versionDomain((0, import_node_path13.join)(path4, "domains")),
     /**
      * Remove a domain from EventCatalog (modeled on the standard POSIX rm utility)
      *
      * @param path - The path to your domain, e.g. `/Payment`
      *
      */
-    rmDomain: rmDomain((0, import_node_path12.join)(path4, "domains")),
+    rmDomain: rmDomain((0, import_node_path13.join)(path4, "domains")),
     /**
      * Remove an service by an domain id
      *
      * @param id - The id of the domain you want to remove
      *
      */
-    rmDomainById: rmDomainById((0, import_node_path12.join)(path4, "domains")),
+    rmDomainById: rmDomainById((0, import_node_path13.join)(path4, "domains")),
     /**
      * Adds a file to the given domain
      * @param id - The id of the domain to add the file to
@@ -1418,28 +1493,28 @@ var index_default = (path4) => {
      * @param version - Optional version of the domain to add the file to
      * @returns
      */
-    addFileToDomain: addFileToDomain((0, import_node_path12.join)(path4, "domains")),
+    addFileToDomain: addFileToDomain((0, import_node_path13.join)(path4, "domains")),
     /**
      * Adds an ubiquitous language dictionary to a domain
      * @param id - The id of the domain to add the ubiquitous language to
      * @param ubiquitousLanguageDictionary - The ubiquitous language dictionary to add
      * @param version - Optional version of the domain to add the ubiquitous language to
      */
-    addUbiquitousLanguageToDomain: addUbiquitousLanguageToDomain((0, import_node_path12.join)(path4, "domains")),
+    addUbiquitousLanguageToDomain: addUbiquitousLanguageToDomain((0, import_node_path13.join)(path4, "domains")),
     /**
      * Get the ubiquitous language dictionary from a domain
      * @param id - The id of the domain to get the ubiquitous language from
      * @param version - Optional version of the domain to get the ubiquitous language from
      * @returns
      */
-    getUbiquitousLanguageFromDomain: getUbiquitousLanguageFromDomain((0, import_node_path12.join)(path4, "domains")),
+    getUbiquitousLanguageFromDomain: getUbiquitousLanguageFromDomain((0, import_node_path13.join)(path4, "domains")),
     /**
      * Check to see if a domain version exists
      * @param id - The id of the domain
      * @param version - The version of the domain (supports semver)
      * @returns
      */
-    domainHasVersion: domainHasVersion((0, import_node_path12.join)(path4)),
+    domainHasVersion: domainHasVersion((0, import_node_path13.join)(path4)),
     /**
      * Adds a given service to a domain
      * @param id - The id of the domain
@@ -1447,7 +1522,7 @@ var index_default = (path4) => {
      * @param version - (Optional) The version of the domain to add the service to
      * @returns
      */
-    addServiceToDomain: addServiceToDomain((0, import_node_path12.join)(path4, "domains")),
+    addServiceToDomain: addServiceToDomain((0, import_node_path13.join)(path4, "domains")),
     /**
      * Adds a given subdomain to a domain
      * @param id - The id of the domain
@@ -1455,7 +1530,7 @@ var index_default = (path4) => {
      * @param version - (Optional) The version of the domain to add the subdomain to
      * @returns
      */
-    addSubDomainToDomain: addSubDomainToDomain((0, import_node_path12.join)(path4, "domains")),
+    addSubDomainToDomain: addSubDomainToDomain((0, import_node_path13.join)(path4, "domains")),
     /**
      * ================================
      *            Teams
@@ -1468,25 +1543,25 @@ var index_default = (path4) => {
      * @param options - Optional options to write the team
      *
      */
-    writeTeam: writeTeam((0, import_node_path12.join)(path4, "teams")),
+    writeTeam: writeTeam((0, import_node_path13.join)(path4, "teams")),
     /**
      * Returns a team from EventCatalog
      * @param id - The id of the team to retrieve
      * @returns Team|Undefined
      */
-    getTeam: getTeam((0, import_node_path12.join)(path4, "teams")),
+    getTeam: getTeam((0, import_node_path13.join)(path4, "teams")),
     /**
      * Returns all teams from EventCatalog
      * @returns Team[]|Undefined
      */
-    getTeams: getTeams((0, import_node_path12.join)(path4)),
+    getTeams: getTeams((0, import_node_path13.join)(path4)),
     /**
      * Remove a team by the team id
      *
      * @param id - The id of the team you want to remove
      *
      */
-    rmTeamById: rmTeamById((0, import_node_path12.join)(path4, "teams")),
+    rmTeamById: rmTeamById((0, import_node_path13.join)(path4, "teams")),
     /**
      * ================================
      *            Users
@@ -1499,25 +1574,25 @@ var index_default = (path4) => {
      * @param options - Optional options to write the user
      *
      */
-    writeUser: writeUser((0, import_node_path12.join)(path4, "users")),
+    writeUser: writeUser((0, import_node_path13.join)(path4, "users")),
     /**
      * Returns a user from EventCatalog
      * @param id - The id of the user to retrieve
      * @returns User|Undefined
      */
-    getUser: getUser((0, import_node_path12.join)(path4, "users")),
+    getUser: getUser((0, import_node_path13.join)(path4, "users")),
     /**
      * Returns all user from EventCatalog
      * @returns User[]|Undefined
      */
-    getUsers: getUsers((0, import_node_path12.join)(path4)),
+    getUsers: getUsers((0, import_node_path13.join)(path4)),
     /**
      * Remove a user by the user id
      *
      * @param id - The id of the user you want to remove
      *
      */
-    rmUserById: rmUserById((0, import_node_path12.join)(path4, "users")),
+    rmUserById: rmUserById((0, import_node_path13.join)(path4, "users")),
     /**
      * ================================
      *            Custom Docs
@@ -1528,32 +1603,32 @@ var index_default = (path4) => {
      * @param path - The path to the custom doc to retrieve
      * @returns CustomDoc|Undefined
      */
-    getCustomDoc: getCustomDoc((0, import_node_path12.join)(path4, "docs")),
+    getCustomDoc: getCustomDoc((0, import_node_path13.join)(path4, "docs")),
     /**
      * Returns all custom docs from EventCatalog
      * @param options - Optional options to get custom docs from a specific path
      * @returns CustomDoc[]|Undefined
      */
-    getCustomDocs: getCustomDocs((0, import_node_path12.join)(path4, "docs")),
+    getCustomDocs: getCustomDocs((0, import_node_path13.join)(path4, "docs")),
     /**
      * Writes a custom doc to EventCatalog
      * @param customDoc - The custom doc to write
      * @param options - Optional options to write the custom doc
      *
      */
-    writeCustomDoc: writeCustomDoc((0, import_node_path12.join)(path4, "docs")),
+    writeCustomDoc: writeCustomDoc((0, import_node_path13.join)(path4, "docs")),
     /**
      * Removes a custom doc from EventCatalog
      * @param path - The path to the custom doc to remove
      *
      */
-    rmCustomDoc: rmCustomDoc((0, import_node_path12.join)(path4, "docs")),
+    rmCustomDoc: rmCustomDoc((0, import_node_path13.join)(path4, "docs")),
     /**
      * Dumps the catalog to a JSON file.
      * @param directory - The directory to dump the catalog to
      * @returns A JSON file with the catalog
      */
-    dumpCatalog: dumpCatalog((0, import_node_path12.join)(path4)),
+    dumpCatalog: dumpCatalog((0, import_node_path13.join)(path4)),
     /**
      * Returns the event catalog configuration file.
      * The event catalog configuration file is the file that contains the configuration for the event catalog.
@@ -1561,7 +1636,7 @@ var index_default = (path4) => {
      * @param directory - The directory of the catalog.
      * @returns A JSON object with the configuration for the event catalog.
      */
-    getEventCatalogConfigurationFile: getEventCatalogConfigurationFile((0, import_node_path12.join)(path4)),
+    getEventCatalogConfigurationFile: getEventCatalogConfigurationFile((0, import_node_path13.join)(path4)),
     /**
      * ================================
      *            Resources Utils
@@ -1570,7 +1645,26 @@ var index_default = (path4) => {
     /**
      * Returns the path to a given resource by id and version
      */
-    getResourcePath
+    getResourcePath,
+    /**
+     * ================================
+     *            General Message Utils
+     * ================================
+     */
+    /**
+     * Returns a message from EventCatalog by a given schema path.
+     *
+     * @param path - The path to the message to retrieve
+     * @returns Message|Undefined
+     */
+    getMessageBySchemaPath: getMessageBySchemaPath((0, import_node_path13.join)(path4)),
+    /**
+     * Returns the producers and consumers (services) for a given message
+     * @param id - The id of the message to get the producers and consumers for
+     * @param version - Optional version of the message
+     * @returns { producers: Service[], consumers: Service[] }
+     */
+    getProducersAndConsumersForMessage: getProducersAndConsumersForMessage((0, import_node_path13.join)(path4))
   };
 };
 //# sourceMappingURL=index.js.map