@eventcatalog/sdk 2.6.4 → 2.6.6

package/dist/eventcatalog.mjs

@@ -1,6 +1,6 @@
 // src/eventcatalog.ts
 import fs10 from "fs";
-import path3, { join as join14 } from "path";
+import path4, { join as join14 } from "path";
 
 // src/index.ts
 import { join as join13 } from "path";
@@ -24,13 +24,13 @@ var versionExists = async (catalogDir, id, version) => {
 var findFileById = async (catalogDir, id, version) => {
   const files = await getFiles(`${catalogDir}/**/index.{md,mdx}`);
   const matchedFiles = await searchFilesForId(files, id) || [];
-  const latestVersion = matchedFiles.find((path4) => !path4.includes("versioned"));
+  const latestVersion = matchedFiles.find((path5) => !path5.includes("versioned"));
   if (!version) {
     return latestVersion;
   }
-  const parsedFiles = matchedFiles.map((path4) => {
-    const { data } = matter.read(path4);
-    return { ...data, path: path4 };
+  const parsedFiles = matchedFiles.map((path5) => {
+    const { data } = matter.read(path5);
+    return { ...data, path: path5 };
   });
   const semverRange = validRange(version);
   if (semverRange && valid(version)) {
@@ -71,8 +71,8 @@ var getFiles = async (pattern, ignore = "") => {
     );
   }
 };
-var readMdxFile = async (path4) => {
-  const { data } = matter.read(path4);
+var readMdxFile = async (path5) => {
+  const { data } = matter.read(path5);
   const { markdown, ...frontmatter } = data;
   return { ...frontmatter, markdown };
 };
@@ -155,8 +155,8 @@ var writeResource = async (catalogDir, resource, options = {
   versionExistingContent: false,
   format: "mdx"
 }) => {
-  const path4 = options.path || `/${resource.id}`;
-  const fullPath = join2(catalogDir, path4);
+  const path5 = options.path || `/${resource.id}`;
+  const fullPath = join2(catalogDir, path5);
   const format = options.format || "mdx";
   fsSync2.mkdirSync(fullPath, { recursive: true });
   const lockPath = join2(fullPath, `index.${format}`);
@@ -191,10 +191,10 @@ var writeResource = async (catalogDir, resource, options = {
     });
   }
 };
-var getResource = async (catalogDir, id, version, options) => {
+var getResource = async (catalogDir, id, version, options, filePath) => {
   const attachSchema = options?.attachSchema || false;
-  const file = await findFileById(catalogDir, id, version);
-  if (!file) return;
+  const file = filePath || (id ? await findFileById(catalogDir, id, version) : void 0);
+  if (!file || !fsSync2.existsSync(file)) return;
   const { data, content } = matter2.read(file);
   if (attachSchema && data?.schemaPath) {
     const resourceDirectory = dirname2(file);
@@ -222,6 +222,13 @@ var getResourcePath = async (catalogDir, id, version) => {
     directory: dirname2(file.replace(catalogDir, ""))
   };
 };
+var toResource = async (catalogDir, file) => {
+  const { data, content } = matter2.read(file);
+  return {
+    ...data,
+    markdown: content.trim()
+  };
+};
 var getResources = async (catalogDir, {
   type,
   latestOnly = false,
@@ -319,8 +326,8 @@ var writeEventToService = (directory) => async (event, service, options = { path
   pathForEvent = join3(pathForEvent, event.id);
   await writeResource(directory, { ...event }, { ...options, path: pathForEvent, type: "event" });
 };
-var rmEvent = (directory) => async (path4) => {
-  await fs2.rm(join3(directory, path4), { recursive: true });
+var rmEvent = (directory) => async (path5) => {
+  await fs2.rm(join3(directory, path5), { recursive: true });
 };
 var rmEventById = (directory) => async (id, version, persistFiles) => {
   await rmResourceById(directory, id, version, { type: "event", persistFiles });
@@ -355,8 +362,8 @@ var writeCommandToService = (directory) => async (command, service, options = {
   pathForCommand = join4(pathForCommand, command.id);
   await writeResource(directory, { ...command }, { ...options, path: pathForCommand, type: "command" });
 };
-var rmCommand = (directory) => async (path4) => {
-  await fs3.rm(join4(directory, path4), { recursive: true });
+var rmCommand = (directory) => async (path5) => {
+  await fs3.rm(join4(directory, path5), { recursive: true });
 };
 var rmCommandById = (directory) => async (id, version, persistFiles) => rmResourceById(directory, id, version, { type: "command", persistFiles });
 var versionCommand = (directory) => async (id) => versionResource(directory, id);
@@ -389,8 +396,8 @@ var writeQueryToService = (directory) => async (query, service, options = { path
   pathForQuery = join5(pathForQuery, query.id);
   await writeResource(directory, { ...query }, { ...options, path: pathForQuery, type: "query" });
 };
-var rmQuery = (directory) => async (path4) => {
-  await fs4.rm(join5(directory, path4), { recursive: true });
+var rmQuery = (directory) => async (path5) => {
+  await fs4.rm(join5(directory, path5), { recursive: true });
 };
 var rmQueryById = (directory) => async (id, version, persistFiles) => {
   await rmResourceById(directory, id, version, { type: "query", persistFiles });
@@ -407,8 +414,12 @@ var queryHasVersion = (directory) => async (id, version) => {
 
 // src/services.ts
 import fs5 from "fs/promises";
-import { join as join6, dirname as dirname4, extname } from "path";
+import { join as join6, dirname as dirname4, extname, relative as relative2 } from "path";
 var getService = (directory) => async (id, version) => getResource(directory, id, version, { type: "service" });
+var getServiceByPath = (directory) => async (path5) => {
+  const service = await getResource(directory, void 0, void 0, { type: "service" }, path5);
+  return service;
+};
 var getServices = (directory) => async (options) => getResources(directory, {
   type: "services",
   ignore: ["**/events/**", "**/commands/**", "**/queries/**", "**/entities/**", "**/subdomains/**/entities/**"],
@@ -430,8 +441,8 @@ var writeService = (directory) => async (service, options = {
 };
 var writeVersionedService = (directory) => async (service) => {
   const resource = { ...service };
-  const path4 = getVersionedDirectory(service.id, service.version);
-  return await writeService(directory)(resource, { path: path4 });
+  const path5 = getVersionedDirectory(service.id, service.version);
+  return await writeService(directory)(resource, { path: path5 });
 };
 var writeServiceToDomain = (directory) => async (service, domain, options = { path: "", format: "mdx", override: false }) => {
   let pathForService = domain.version && domain.version !== "latest" ? `/${domain.id}/versioned/${domain.version}/services` : `/${domain.id}/services`;
@@ -439,8 +450,8 @@ var writeServiceToDomain = (directory) => async (service, domain, options = { pa
   await writeResource(directory, { ...service }, { ...options, path: pathForService, type: "service" });
 };
 var versionService = (directory) => async (id) => versionResource(directory, id);
-var rmService = (directory) => async (path4) => {
-  await fs5.rm(join6(directory, path4), { recursive: true });
+var rmService = (directory) => async (path5) => {
+  await fs5.rm(join6(directory, path5), { recursive: true });
 };
 var rmServiceById = (directory) => async (id, version, persistFiles) => rmResourceById(directory, id, version, { type: "service", persistFiles });
 var addFileToService = (directory) => async (id, file, version) => addFileToResource(directory, id, file, version);
@@ -495,8 +506,8 @@ var addMessageToService = (directory) => async (id, direction, event, version) =
   if (!existingResource) {
     throw new Error(`Cannot find service ${id} in the catalog`);
   }
-  const path4 = existingResource.split(/[\\/]+services/)[0];
-  const pathToResource = join6(path4, "services");
+  const path5 = existingResource.split(/[\\/]+services/)[0];
+  const pathToResource = join6(path5, "services");
   await rmServiceById(directory)(id, version);
   await writeService(pathToResource)(service, { format: extension === ".md" ? "md" : "mdx" });
 };
@@ -504,6 +515,13 @@ var serviceHasVersion = (directory) => async (id, version) => {
   const file = await findFileById(directory, id, version);
   return !!file;
 };
+var isService = (directory) => async (path5) => {
+  const service = await getServiceByPath(directory)(path5);
+  const relativePath = relative2(directory, path5);
+  const segments = relativePath.split(/[/\\]+/);
+  return !!service && segments.includes("services");
+};
+var toService = (directory) => async (file) => toResource(directory, file);
 
 // src/domains.ts
 import fs6 from "fs/promises";
@@ -532,8 +550,8 @@ var writeDomain = (directory) => async (domain, options = {
   return await writeResource(directory, resource, { ...options, type: "domain" });
 };
 var versionDomain = (directory) => async (id) => versionResource(directory, id);
-var rmDomain = (directory) => async (path4) => {
-  await fs6.rm(join7(directory, path4), { recursive: true });
+var rmDomain = (directory) => async (path5) => {
+  await fs6.rm(join7(directory, path5), { recursive: true });
 };
 var rmDomainById = (directory) => async (id, version, persistFiles) => rmResourceById(directory, id, version, { type: "domain", persistFiles });
 var addFileToDomain = (directory) => async (id, file, version) => addFileToResource(directory, id, file, version);
@@ -594,8 +612,8 @@ import { join as join8, extname as extname2 } from "path";
 var getChannel = (directory) => async (id, version) => getResource(directory, id, version, { type: "channel" });
 var getChannels = (directory) => async (options) => getResources(directory, { type: "channels", ...options });
 var writeChannel = (directory) => async (channel, options = { path: "" }) => writeResource(directory, { ...channel }, { ...options, type: "channel" });
-var rmChannel = (directory) => async (path4) => {
-  await fs7.rm(join8(directory, path4), { recursive: true });
+var rmChannel = (directory) => async (path5) => {
+  await fs7.rm(join8(directory, path5), { recursive: true });
 };
 var rmChannelById = (directory) => async (id, version, persistFiles) => rmResourceById(directory, id, version, { type: "channel", persistFiles });
 var versionChannel = (directory) => async (id) => versionResource(directory, id);
@@ -636,8 +654,8 @@ var addMessageToChannel = (directory, collection) => async (id, _message, versio
   if (!existingResource) {
     throw new Error(`Cannot find message ${id} in the catalog`);
   }
-  const path4 = existingResource.split(`/[\\/]+${collection}`)[0];
-  const pathToResource = join8(path4, collection);
+  const path5 = existingResource.split(`/[\\/]+${collection}`)[0];
+  const pathToResource = join8(path5, collection);
   await rmMessageById(directory)(_message.id, _message.version, true);
   await writeMessage(pathToResource)(message, { format: extension === ".md" ? "md" : "mdx" });
 };
@@ -646,8 +664,8 @@ var addMessageToChannel = (directory, collection) => async (id, _message, versio
 import { dirname as dirname5 } from "path";
 import matter4 from "gray-matter";
 import { satisfies as satisfies3, validRange as validRange2 } from "semver";
-var getMessageBySchemaPath = (directory) => async (path4, options) => {
-  const pathToMessage = dirname5(path4);
+var getMessageBySchemaPath = (directory) => async (path5, options) => {
+  const pathToMessage = dirname5(path5);
   try {
     const files = await getFiles(`${directory}/${pathToMessage}/index.{md,mdx}`);
     if (!files || files.length === 0) {
@@ -665,7 +683,7 @@ var getMessageBySchemaPath = (directory) => async (path4, options) => {
     }
     return message;
   } catch (error) {
-    console.error(`Failed to get message for schema path ${path4}. Error processing directory ${pathToMessage}:`, error);
+    console.error(`Failed to get message for schema path ${path5}. Error processing directory ${pathToMessage}:`, error);
     if (error instanceof Error) {
       error.message = `Failed to retrieve message from ${pathToMessage}: ${error.message}`;
       throw error;
@@ -759,10 +777,16 @@ var rmCustomDoc = (directory) => async (filePath) => {
 
 // src/teams.ts
 import fs9 from "fs/promises";
+import fsSync6 from "fs";
+import { join as join12 } from "path";
+import matter7 from "gray-matter";
+import path3 from "path";
+
+// src/users.ts
 import fsSync5 from "fs";
 import { join as join11 } from "path";
 import matter6 from "gray-matter";
-var getTeam = (catalogDir) => async (id) => {
+var getUser = (catalogDir) => async (id) => {
   const files = await getFiles(`${catalogDir}/${id}.{md,mdx}`);
   if (files.length == 0) return void 0;
   const file = files[0];
@@ -771,11 +795,12 @@ var getTeam = (catalogDir) => async (id) => {
     ...data,
     id: data.id,
     name: data.name,
+    avatarUrl: data.avatarUrl,
     markdown: content.trim()
   };
 };
-var getTeams = (catalogDir) => async (options) => {
-  const files = await getFiles(`${catalogDir}/teams/*.{md,mdx}`);
+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 } = matter6.read(file);
@@ -783,31 +808,29 @@ var getTeams = (catalogDir) => async (options) => {
       ...data,
       id: data.id,
       name: data.name,
+      avatarUrl: data.avatarUrl,
       markdown: content.trim()
     };
   });
 };
-var writeTeam = (catalogDir) => async (team, options = {}) => {
-  const resource = { ...team };
-  const currentTeam = await getTeam(catalogDir)(resource.id);
-  const exists = currentTeam !== void 0;
+var writeUser = (catalogDir) => async (user, options = {}) => {
+  const resource = { ...user };
+  const currentUser = await getUser(catalogDir)(resource.id);
+  const exists = currentUser !== void 0;
   if (exists && !options.override) {
-    throw new Error(`Failed to write ${resource.id} (team) as it already exists`);
+    throw new Error(`Failed to write ${resource.id} (user) as it already exists`);
   }
   const { markdown, ...frontmatter } = resource;
   const document = matter6.stringify(markdown, frontmatter);
   fsSync5.mkdirSync(join11(catalogDir, ""), { recursive: true });
   fsSync5.writeFileSync(join11(catalogDir, "", `${resource.id}.mdx`), document);
 };
-var rmTeamById = (catalogDir) => async (id) => {
-  await fs9.rm(join11(catalogDir, `${id}.mdx`), { recursive: true });
+var rmUserById = (catalogDir) => async (id) => {
+  fsSync5.rmSync(join11(catalogDir, `${id}.mdx`), { recursive: true });
 };
 
-// src/users.ts
-import fsSync6 from "fs";
-import { join as join12 } from "path";
-import matter7 from "gray-matter";
-var getUser = (catalogDir) => async (id) => {
+// src/teams.ts
+var getTeam = (catalogDir) => async (id) => {
   const files = await getFiles(`${catalogDir}/${id}.{md,mdx}`);
   if (files.length == 0) return void 0;
   const file = files[0];
@@ -816,12 +839,11 @@ var getUser = (catalogDir) => async (id) => {
     ...data,
     id: data.id,
     name: data.name,
-    avatarUrl: data.avatarUrl,
     markdown: content.trim()
   };
 };
-var getUsers = (catalogDir) => async (options) => {
-  const files = await getFiles(`${catalogDir}/users/*.{md,mdx}`);
+var getTeams = (catalogDir) => async (options) => {
+  const files = await getFiles(`${catalogDir}/*.{md,mdx}`);
   if (files.length === 0) return [];
   return files.map((file) => {
     const { data, content } = matter7.read(file);
@@ -829,29 +851,46 @@ var getUsers = (catalogDir) => async (options) => {
       ...data,
       id: data.id,
       name: data.name,
-      avatarUrl: data.avatarUrl,
       markdown: content.trim()
     };
   });
 };
-var writeUser = (catalogDir) => async (user, options = {}) => {
-  const resource = { ...user };
-  const currentUser = await getUser(catalogDir)(resource.id);
-  const exists = currentUser !== void 0;
+var writeTeam = (catalogDir) => async (team, options = {}) => {
+  const resource = { ...team };
+  const currentTeam = await getTeam(catalogDir)(resource.id);
+  const exists = currentTeam !== void 0;
   if (exists && !options.override) {
-    throw new Error(`Failed to write ${resource.id} (user) as it already exists`);
+    throw new Error(`Failed to write ${resource.id} (team) as it already exists`);
   }
   const { markdown, ...frontmatter } = resource;
   const document = matter7.stringify(markdown, frontmatter);
   fsSync6.mkdirSync(join12(catalogDir, ""), { recursive: true });
   fsSync6.writeFileSync(join12(catalogDir, "", `${resource.id}.mdx`), document);
 };
-var rmUserById = (catalogDir) => async (id) => {
-  fsSync6.rmSync(join12(catalogDir, `${id}.mdx`), { recursive: true });
+var rmTeamById = (catalogDir) => async (id) => {
+  await fs9.rm(join12(catalogDir, `${id}.mdx`), { recursive: true });
+};
+var getOwnersForResource = (catalogDir) => async (id, version) => {
+  const resource = await getResource(catalogDir, id, version);
+  let owners = [];
+  if (!resource) return [];
+  if (!resource.owners) return [];
+  for (const owner of resource.owners) {
+    const team = await getTeam(path3.join(catalogDir, "teams"))(owner);
+    if (team) {
+      owners.push(team);
+    } else {
+      const user = await getUser(path3.join(catalogDir, "users"))(owner);
+      if (user) {
+        owners.push(user);
+      }
+    }
+  }
+  return owners;
 };
 
 // src/index.ts
-var index_default = (path4) => {
+var index_default = (path5) => {
   return {
     /**
      * Returns an events from EventCatalog
@@ -859,13 +898,13 @@ var index_default = (path4) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Event|Undefined
      */
-    getEvent: getEvent(join13(path4)),
+    getEvent: getEvent(join13(path5)),
     /**
      * Returns all events from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Event[]|Undefined
      */
-    getEvents: getEvents(join13(path4)),
+    getEvents: getEvents(join13(path5)),
     /**
      * Adds an event to EventCatalog
      *
@@ -873,7 +912,7 @@ var index_default = (path4) => {
      * @param options - Optional options to write the event
      *
      */
-    writeEvent: writeEvent(join13(path4, "events")),
+    writeEvent: writeEvent(join13(path5, "events")),
     /**
      * Adds an event to a service in EventCatalog
      *
@@ -882,26 +921,26 @@ var index_default = (path4) => {
      * @param options - Optional options to write the event
      *
      */
-    writeEventToService: writeEventToService(join13(path4)),
+    writeEventToService: writeEventToService(join13(path5)),
     /**
      * 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(join13(path4, "events")),
+    rmEvent: rmEvent(join13(path5, "events")),
     /**
      * Remove an event by an Event id
      *
      * @param id - The id of the event you want to remove
      *
      */
-    rmEventById: rmEventById(join13(path4)),
+    rmEventById: rmEventById(join13(path5)),
     /**
      * Moves a given event id to the version directory
      * @param directory
      */
-    versionEvent: versionEvent(join13(path4)),
+    versionEvent: versionEvent(join13(path5)),
     /**
      * Adds a file to the given event
      * @param id - The id of the event to add the file to
@@ -909,7 +948,7 @@ var index_default = (path4) => {
      * @param version - Optional version of the event to add the file to
      * @returns
      */
-    addFileToEvent: addFileToEvent(join13(path4)),
+    addFileToEvent: addFileToEvent(join13(path5)),
     /**
      * Adds a schema to the given event
      * @param id - The id of the event to add the schema to
@@ -917,14 +956,14 @@ var index_default = (path4) => {
      * @param version - Optional version of the event to add the schema to
      * @returns
      */
-    addSchemaToEvent: addSchemaToEvent(join13(path4)),
+    addSchemaToEvent: addSchemaToEvent(join13(path5)),
     /**
      * 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(join13(path4)),
+    eventHasVersion: eventHasVersion(join13(path5)),
     /**
      * ================================
      *            Commands
@@ -936,13 +975,13 @@ var index_default = (path4) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Command|Undefined
      */
-    getCommand: getCommand(join13(path4)),
+    getCommand: getCommand(join13(path5)),
     /**
      * Returns all commands from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Command[]|Undefined
      */
-    getCommands: getCommands(join13(path4)),
+    getCommands: getCommands(join13(path5)),
     /**
      * Adds an command to EventCatalog
      *
@@ -950,7 +989,7 @@ var index_default = (path4) => {
      * @param options - Optional options to write the command
      *
      */
-    writeCommand: writeCommand(join13(path4, "commands")),
+    writeCommand: writeCommand(join13(path5, "commands")),
     /**
      * Adds a command to a service in EventCatalog
      *
@@ -959,26 +998,26 @@ var index_default = (path4) => {
      * @param options - Optional options to write the command
      *
      */
-    writeCommandToService: writeCommandToService(join13(path4)),
+    writeCommandToService: writeCommandToService(join13(path5)),
     /**
      * 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(join13(path4, "commands")),
+    rmCommand: rmCommand(join13(path5, "commands")),
     /**
      * Remove an command by an Event id
      *
      * @param id - The id of the command you want to remove
      *
      */
-    rmCommandById: rmCommandById(join13(path4)),
+    rmCommandById: rmCommandById(join13(path5)),
     /**
      * Moves a given command id to the version directory
      * @param directory
      */
-    versionCommand: versionCommand(join13(path4)),
+    versionCommand: versionCommand(join13(path5)),
     /**
      * Adds a file to the given command
      * @param id - The id of the command to add the file to
@@ -986,7 +1025,7 @@ var index_default = (path4) => {
      * @param version - Optional version of the command to add the file to
      * @returns
      */
-    addFileToCommand: addFileToCommand(join13(path4)),
+    addFileToCommand: addFileToCommand(join13(path5)),
     /**
      * Adds a schema to the given command
      * @param id - The id of the command to add the schema to
@@ -994,14 +1033,14 @@ var index_default = (path4) => {
      * @param version - Optional version of the command to add the schema to
      * @returns
      */
-    addSchemaToCommand: addSchemaToCommand(join13(path4)),
+    addSchemaToCommand: addSchemaToCommand(join13(path5)),
     /**
      * 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(join13(path4)),
+    commandHasVersion: commandHasVersion(join13(path5)),
     /**
      * ================================
      *            Queries
@@ -1013,13 +1052,13 @@ var index_default = (path4) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Query|Undefined
      */
-    getQuery: getQuery(join13(path4)),
+    getQuery: getQuery(join13(path5)),
     /**
      * Returns all queries from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Query[]|Undefined
      */
-    getQueries: getQueries(join13(path4)),
+    getQueries: getQueries(join13(path5)),
     /**
      * Adds a query to EventCatalog
      *
@@ -1027,7 +1066,7 @@ var index_default = (path4) => {
      * @param options - Optional options to write the event
      *
      */
-    writeQuery: writeQuery(join13(path4, "queries")),
+    writeQuery: writeQuery(join13(path5, "queries")),
     /**
      * Adds a query to a service in EventCatalog
      *
@@ -1036,26 +1075,26 @@ var index_default = (path4) => {
      * @param options - Optional options to write the query
      *
      */
-    writeQueryToService: writeQueryToService(join13(path4)),
+    writeQueryToService: writeQueryToService(join13(path5)),
     /**
      * 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(join13(path4, "queries")),
+    rmQuery: rmQuery(join13(path5, "queries")),
     /**
      * Remove a query by a Query id
      *
      * @param id - The id of the query you want to remove
      *
      */
-    rmQueryById: rmQueryById(join13(path4)),
+    rmQueryById: rmQueryById(join13(path5)),
     /**
      * Moves a given query id to the version directory
      * @param directory
      */
-    versionQuery: versionQuery(join13(path4)),
+    versionQuery: versionQuery(join13(path5)),
     /**
      * Adds a file to the given query
      * @param id - The id of the query to add the file to
@@ -1063,7 +1102,7 @@ var index_default = (path4) => {
      * @param version - Optional version of the query to add the file to
      * @returns
      */
-    addFileToQuery: addFileToQuery(join13(path4)),
+    addFileToQuery: addFileToQuery(join13(path5)),
     /**
      * Adds a schema to the given query
      * @param id - The id of the query to add the schema to
@@ -1071,14 +1110,14 @@ var index_default = (path4) => {
      * @param version - Optional version of the query to add the schema to
      * @returns
      */
-    addSchemaToQuery: addSchemaToQuery(join13(path4)),
+    addSchemaToQuery: addSchemaToQuery(join13(path5)),
     /**
      * 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(join13(path4)),
+    queryHasVersion: queryHasVersion(join13(path5)),
     /**
      * ================================
      *            Channels
@@ -1090,13 +1129,13 @@ var index_default = (path4) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Channel|Undefined
      */
-    getChannel: getChannel(join13(path4)),
+    getChannel: getChannel(join13(path5)),
     /**
      * Returns all channels from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Channel[]|Undefined
      */
-    getChannels: getChannels(join13(path4)),
+    getChannels: getChannels(join13(path5)),
     /**
      * Adds an channel to EventCatalog
      *
@@ -1104,33 +1143,33 @@ var index_default = (path4) => {
      * @param options - Optional options to write the channel
      *
      */
-    writeChannel: writeChannel(join13(path4, "channels")),
+    writeChannel: writeChannel(join13(path5, "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(join13(path4, "channels")),
+    rmChannel: rmChannel(join13(path5, "channels")),
     /**
      * Remove an channel by an Event id
      *
      * @param id - The id of the channel you want to remove
      *
      */
-    rmChannelById: rmChannelById(join13(path4)),
+    rmChannelById: rmChannelById(join13(path5)),
     /**
      * Moves a given channel id to the version directory
      * @param directory
      */
-    versionChannel: versionChannel(join13(path4)),
+    versionChannel: versionChannel(join13(path5)),
     /**
      * 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(join13(path4)),
+    channelHasVersion: channelHasVersion(join13(path5)),
     /**
      * Add a channel to an event
      *
@@ -1147,7 +1186,7 @@ var index_default = (path4) => {
      *
      * ```
      */
-    addEventToChannel: addMessageToChannel(join13(path4), "events"),
+    addEventToChannel: addMessageToChannel(join13(path5), "events"),
     /**
      * Add a channel to an command
      *
@@ -1164,7 +1203,7 @@ var index_default = (path4) => {
      *
      * ```
      */
-    addCommandToChannel: addMessageToChannel(join13(path4), "commands"),
+    addCommandToChannel: addMessageToChannel(join13(path5), "commands"),
     /**
      * Add a channel to an query
      *
@@ -1181,7 +1220,7 @@ var index_default = (path4) => {
      *
      * ```
      */
-    addQueryToChannel: addMessageToChannel(join13(path4), "queries"),
+    addQueryToChannel: addMessageToChannel(join13(path5), "queries"),
     /**
      * ================================
      *            SERVICES
@@ -1194,14 +1233,14 @@ var index_default = (path4) => {
      * @param options - Optional options to write the event
      *
      */
-    writeService: writeService(join13(path4, "services")),
+    writeService: writeService(join13(path5, "services")),
     /**
      * Adds a versioned service to EventCatalog
      *
      * @param service - The service to write
      *
      */
-    writeVersionedService: writeVersionedService(join13(path4, "services")),
+    writeVersionedService: writeVersionedService(join13(path5, "services")),
     /**
      * Adds a service to a domain in EventCatalog
      *
@@ -1210,39 +1249,45 @@ var index_default = (path4) => {
      * @param options - Optional options to write the event
      *
      */
-    writeServiceToDomain: writeServiceToDomain(join13(path4, "domains")),
+    writeServiceToDomain: writeServiceToDomain(join13(path5, "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(join13(path4)),
+    getService: getService(join13(path5)),
+    /**
+     * Returns a service from EventCatalog by it's path.
+     * @param path - The path to the service to retrieve
+     * @returns Service|Undefined
+     */
+    getServiceByPath: getServiceByPath(join13(path5)),
     /**
      * Returns all services from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Service[]|Undefined
      */
-    getServices: getServices(join13(path4)),
+    getServices: getServices(join13(path5)),
     /**
      * Moves a given service id to the version directory
      * @param directory
      */
-    versionService: versionService(join13(path4)),
+    versionService: versionService(join13(path5)),
     /**
      * Remove a service from EventCatalog (modeled on the standard POSIX rm utility)
      *
      * @param path - The path to your service, e.g. `/InventoryService`
      *
      */
-    rmService: rmService(join13(path4, "services")),
+    rmService: rmService(join13(path5, "services")),
     /**
      * Remove an service by an service id
      *
      * @param id - The id of the service you want to remove
      *
      */
-    rmServiceById: rmServiceById(join13(path4)),
+    rmServiceById: rmServiceById(join13(path5)),
     /**
      * Adds a file to the given service
      * @param id - The id of the service to add the file to
@@ -1250,21 +1295,21 @@ var index_default = (path4) => {
      * @param version - Optional version of the service to add the file to
      * @returns
      */
-    addFileToService: addFileToService(join13(path4)),
+    addFileToService: addFileToService(join13(path5)),
     /**
      * 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(join13(path4)),
+    getSpecificationFilesForService: getSpecificationFilesForService(join13(path5)),
     /**
      * 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(join13(path4)),
+    serviceHasVersion: serviceHasVersion(join13(path5)),
     /**
      * Add an event to a service by it's id.
      *
@@ -1284,7 +1329,7 @@ var index_default = (path4) => {
      *
      * ```
      */
-    addEventToService: addMessageToService(join13(path4)),
+    addEventToService: addMessageToService(join13(path5)),
     /**
      * Add a command to a service by it's id.
      *
@@ -1304,7 +1349,7 @@ var index_default = (path4) => {
      *
      * ```
      */
-    addCommandToService: addMessageToService(join13(path4)),
+    addCommandToService: addMessageToService(join13(path5)),
     /**
      * Add a query to a service by it's id.
      *
@@ -1324,7 +1369,30 @@ var index_default = (path4) => {
      *
      * ```
      */
-    addQueryToService: addMessageToService(join13(path4)),
+    addQueryToService: addMessageToService(join13(path5)),
+    /**
+     * Check to see if a service exists by it's path.
+     *
+     * @example
+     * ```ts
+     * import utils from '@eventcatalog/utils';
+     *
+     * const { isService } = utils('/path/to/eventcatalog');
+     *
+     * // returns true if the path is a service
+     * await isService('/services/InventoryService/index.mdx');
+     * ```
+     *
+     * @param path - The path to the service to check
+     * @returns boolean
+     */
+    isService: isService(join13(path5)),
+    /**
+     * Converts a file to a service.
+     * @param file - The file to convert to a service.
+     * @returns The service.
+     */
+    toService: toService(join13(path5)),
     /**
      * ================================
      *            Domains
@@ -1337,39 +1405,39 @@ var index_default = (path4) => {
      * @param options - Optional options to write the event
      *
      */
-    writeDomain: writeDomain(join13(path4, "domains")),
+    writeDomain: writeDomain(join13(path5, "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(join13(path4, "domains")),
+    getDomain: getDomain(join13(path5, "domains")),
     /**
      * Returns all domains from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Domain[]|Undefined
      */
-    getDomains: getDomains(join13(path4)),
+    getDomains: getDomains(join13(path5)),
     /**
      * Moves a given domain id to the version directory
      * @param directory
      */
-    versionDomain: versionDomain(join13(path4, "domains")),
+    versionDomain: versionDomain(join13(path5, "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(join13(path4, "domains")),
+    rmDomain: rmDomain(join13(path5, "domains")),
     /**
      * Remove an service by an domain id
      *
      * @param id - The id of the domain you want to remove
      *
      */
-    rmDomainById: rmDomainById(join13(path4, "domains")),
+    rmDomainById: rmDomainById(join13(path5, "domains")),
     /**
      * Adds a file to the given domain
      * @param id - The id of the domain to add the file to
@@ -1377,28 +1445,28 @@ var index_default = (path4) => {
      * @param version - Optional version of the domain to add the file to
      * @returns
      */
-    addFileToDomain: addFileToDomain(join13(path4, "domains")),
+    addFileToDomain: addFileToDomain(join13(path5, "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(join13(path4, "domains")),
+    addUbiquitousLanguageToDomain: addUbiquitousLanguageToDomain(join13(path5, "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(join13(path4, "domains")),
+    getUbiquitousLanguageFromDomain: getUbiquitousLanguageFromDomain(join13(path5, "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(join13(path4)),
+    domainHasVersion: domainHasVersion(join13(path5)),
     /**
      * Adds a given service to a domain
      * @param id - The id of the domain
@@ -1406,7 +1474,7 @@ var index_default = (path4) => {
      * @param version - (Optional) The version of the domain to add the service to
      * @returns
      */
-    addServiceToDomain: addServiceToDomain(join13(path4, "domains")),
+    addServiceToDomain: addServiceToDomain(join13(path5, "domains")),
     /**
      * Adds a given subdomain to a domain
      * @param id - The id of the domain
@@ -1414,7 +1482,7 @@ var index_default = (path4) => {
      * @param version - (Optional) The version of the domain to add the subdomain to
      * @returns
      */
-    addSubDomainToDomain: addSubDomainToDomain(join13(path4, "domains")),
+    addSubDomainToDomain: addSubDomainToDomain(join13(path5, "domains")),
     /**
      * ================================
      *            Teams
@@ -1427,25 +1495,25 @@ var index_default = (path4) => {
      * @param options - Optional options to write the team
      *
      */
-    writeTeam: writeTeam(join13(path4, "teams")),
+    writeTeam: writeTeam(join13(path5, "teams")),
     /**
      * Returns a team from EventCatalog
      * @param id - The id of the team to retrieve
      * @returns Team|Undefined
      */
-    getTeam: getTeam(join13(path4, "teams")),
+    getTeam: getTeam(join13(path5, "teams")),
     /**
      * Returns all teams from EventCatalog
      * @returns Team[]|Undefined
      */
-    getTeams: getTeams(join13(path4)),
+    getTeams: getTeams(join13(path5, "teams")),
     /**
      * Remove a team by the team id
      *
      * @param id - The id of the team you want to remove
      *
      */
-    rmTeamById: rmTeamById(join13(path4, "teams")),
+    rmTeamById: rmTeamById(join13(path5, "teams")),
     /**
      * ================================
      *            Users
@@ -1458,25 +1526,25 @@ var index_default = (path4) => {
      * @param options - Optional options to write the user
      *
      */
-    writeUser: writeUser(join13(path4, "users")),
+    writeUser: writeUser(join13(path5, "users")),
     /**
      * Returns a user from EventCatalog
      * @param id - The id of the user to retrieve
      * @returns User|Undefined
      */
-    getUser: getUser(join13(path4, "users")),
+    getUser: getUser(join13(path5, "users")),
     /**
      * Returns all user from EventCatalog
      * @returns User[]|Undefined
      */
-    getUsers: getUsers(join13(path4)),
+    getUsers: getUsers(join13(path5)),
     /**
      * Remove a user by the user id
      *
      * @param id - The id of the user you want to remove
      *
      */
-    rmUserById: rmUserById(join13(path4, "users")),
+    rmUserById: rmUserById(join13(path5, "users")),
     /**
      * ================================
      *            Custom Docs
@@ -1487,32 +1555,32 @@ var index_default = (path4) => {
      * @param path - The path to the custom doc to retrieve
      * @returns CustomDoc|Undefined
      */
-    getCustomDoc: getCustomDoc(join13(path4, "docs")),
+    getCustomDoc: getCustomDoc(join13(path5, "docs")),
     /**
      * Returns all custom docs from EventCatalog
      * @param options - Optional options to get custom docs from a specific path
      * @returns CustomDoc[]|Undefined
      */
-    getCustomDocs: getCustomDocs(join13(path4, "docs")),
+    getCustomDocs: getCustomDocs(join13(path5, "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(join13(path4, "docs")),
+    writeCustomDoc: writeCustomDoc(join13(path5, "docs")),
     /**
      * Removes a custom doc from EventCatalog
      * @param path - The path to the custom doc to remove
      *
      */
-    rmCustomDoc: rmCustomDoc(join13(path4, "docs")),
+    rmCustomDoc: rmCustomDoc(join13(path5, "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(join13(path4)),
+    dumpCatalog: dumpCatalog(join13(path5)),
     /**
      * Returns the event catalog configuration file.
      * The event catalog configuration file is the file that contains the configuration for the event catalog.
@@ -1520,7 +1588,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(join13(path4)),
+    getEventCatalogConfigurationFile: getEventCatalogConfigurationFile(join13(path5)),
     /**
      * ================================
      *            Resources Utils
@@ -1541,14 +1609,21 @@ var index_default = (path4) => {
      * @param path - The path to the message to retrieve
      * @returns Message|Undefined
      */
-    getMessageBySchemaPath: getMessageBySchemaPath(join13(path4)),
+    getMessageBySchemaPath: getMessageBySchemaPath(join13(path5)),
     /**
      * 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(join13(path4))
+    getProducersAndConsumersForMessage: getProducersAndConsumersForMessage(join13(path5)),
+    /**
+     * Returns the owners for a given resource (e.g domain, service, event, command, query, etc.)
+     * @param id - The id of the resource to get the owners for
+     * @param version - Optional version of the resource
+     * @returns { owners: User[] }
+     */
+    getOwnersForResource: getOwnersForResource(join13(path5))
   };
 };
 
@@ -1569,7 +1644,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 = path3.join(path3.dirname(resourcePath?.fullPath), resource.schemaPath);
+        const pathToSchema = path4.join(path4.dirname(resourcePath?.fullPath), resource.schemaPath);
         if (fs10.existsSync(pathToSchema)) {
           schema = fs10.readFileSync(pathToSchema, "utf8");
         }
@@ -1590,8 +1665,8 @@ var filterCollection = (collection, options) => {
 };
 var getEventCatalogConfigurationFile = (directory) => async () => {
   try {
-    const path4 = join14(directory, "eventcatalog.config.js");
-    const configModule = await import(path4);
+    const path5 = join14(directory, "eventcatalog.config.js");
+    const configModule = await import(path5);
     return configModule.default;
   } catch (error) {
     console.error("Error getting event catalog configuration file", error);
@@ -1599,7 +1674,7 @@ var getEventCatalogConfigurationFile = (directory) => async () => {
   }
 };
 var dumpCatalog = (directory) => async (options) => {
-  const { getDomains: getDomains2, getServices: getServices2, getEvents: getEvents2, getQueries: getQueries2, getCommands: getCommands2, getChannels: getChannels2, getTeams: getTeams2, getUsers: getUsers2 } = index_default(directory);
+  const { getDomains: getDomains2, getServices: getServices2, getEvents: getEvents2, getQueries: getQueries2, getCommands: getCommands2, getChannels: getChannels2, getTeams: getTeams2, getUsers: getUsers3 } = index_default(directory);
   const { includeMarkdown = true } = options || {};
   const domains = await getDomains2();
   const services = await getServices2();
@@ -1607,7 +1682,7 @@ var dumpCatalog = (directory) => async (options) => {
   const commands = await getCommands2();
   const queries = await getQueries2();
   const teams = await getTeams2();
-  const users = await getUsers2();
+  const users = await getUsers3();
   const channels = await getChannels2();
   const [
     hydratedDomains,