@eventcatalog/sdk 2.2.1 → 2.2.2

package/dist/eventcatalog.js

@@ -0,0 +1,1445 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/eventcatalog.ts
+var eventcatalog_exports = {};
+__export(eventcatalog_exports, {
+  dumpCatalog: () => dumpCatalog
+});
+module.exports = __toCommonJS(eventcatalog_exports);
+var import_fs = __toESM(require("fs"));
+var import_node_path12 = __toESM(require("path"));
+
+// src/index.ts
+var import_node_path11 = require("path");
+
+// src/events.ts
+var import_promises2 = __toESM(require("fs/promises"));
+var import_node_path2 = require("path");
+
+// src/internal/utils.ts
+var import_glob = require("glob");
+var import_node_fs = __toESM(require("fs"));
+var import_fs_extra = require("fs-extra");
+var import_node_path = require("path");
+var import_gray_matter = __toESM(require("gray-matter"));
+var import_semver = require("semver");
+var versionExists = async (catalogDir, id, version) => {
+  const files = await getFiles(`${catalogDir}/**/index.{md,mdx}`);
+  const matchedFiles = await searchFilesForId(files, id, version) || [];
+  return matchedFiles.length > 0;
+};
+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"));
+  if (!version) {
+    return latestVersion;
+  }
+  const parsedFiles = matchedFiles.map((path4) => {
+    const { data } = import_gray_matter.default.read(path4);
+    return { ...data, path: path4 };
+  });
+  const semverRange = (0, import_semver.validRange)(version);
+  if (semverRange && (0, import_semver.valid)(version)) {
+    const match2 = parsedFiles.filter((c) => (0, import_semver.satisfies)(c.version, semverRange));
+    return match2.length > 0 ? match2[0].path : void 0;
+  }
+  const sorted = parsedFiles.sort((a, b) => {
+    return a.version.localeCompare(b.version);
+  });
+  const match = sorted.length > 0 ? [sorted[sorted.length - 1]] : [];
+  if (match.length > 0) {
+    return match[0].path;
+  }
+};
+var getFiles = async (pattern, ignore = "") => {
+  try {
+    const ignoreList = Array.isArray(ignore) ? ignore : [ignore];
+    const files = (0, import_glob.globSync)(pattern, { ignore: ["node_modules/**", ...ignoreList] });
+    return files;
+  } catch (error) {
+    throw new Error(`Error finding files: ${error}`);
+  }
+};
+var readMdxFile = async (path4) => {
+  const { data } = import_gray_matter.default.read(path4);
+  const { markdown, ...frontmatter } = data;
+  return { ...frontmatter, markdown };
+};
+var searchFilesForId = async (files, id, version) => {
+  const idRegex = new RegExp(`^id:\\s*(['"]|>-)?\\s*${id}['"]?\\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");
+    const hasIdMatch = content.match(idRegex);
+    if (version && !content.match(versionRegex)) {
+      return void 0;
+    }
+    if (hasIdMatch) {
+      return file;
+    }
+  });
+  return matches.filter(Boolean).filter((file) => file !== void 0);
+};
+var copyDir = async (catalogDir, source, target, filter) => {
+  const tmpDirectory = (0, import_node_path.join)(catalogDir, "tmp");
+  import_node_fs.default.mkdirSync(tmpDirectory, { recursive: true });
+  await (0, import_fs_extra.copy)(source, tmpDirectory, {
+    overwrite: true,
+    filter
+  });
+  await (0, import_fs_extra.copy)(tmpDirectory, target, {
+    overwrite: true,
+    filter
+  });
+  import_node_fs.default.rmSync(tmpDirectory, { recursive: true });
+};
+var uniqueVersions = (messages) => {
+  const uniqueSet = /* @__PURE__ */ new Set();
+  return messages.filter((message) => {
+    const key = `${message.id}-${message.version}`;
+    if (!uniqueSet.has(key)) {
+      uniqueSet.add(key);
+      return true;
+    }
+    return false;
+  });
+};
+
+// src/internal/resources.ts
+var import_path = require("path");
+var import_gray_matter2 = __toESM(require("gray-matter"));
+var import_promises = __toESM(require("fs/promises"));
+var import_node_fs2 = __toESM(require("fs"));
+var import_semver2 = require("semver");
+var import_proper_lockfile = require("proper-lockfile");
+var versionResource = async (catalogDir, id) => {
+  const files = await getFiles(`${catalogDir}/**/index.{md,mdx}`);
+  const matchedFiles = await searchFilesForId(files, id);
+  if (matchedFiles.length === 0) {
+    throw new Error(`No resource found with id: ${id}`);
+  }
+  const file = matchedFiles[0];
+  const sourceDirectory = (0, import_path.dirname)(file);
+  const { data: { version = "0.0.1" } = {} } = import_gray_matter2.default.read(file);
+  const targetDirectory = getVersionedDirectory(sourceDirectory, version);
+  import_node_fs2.default.mkdirSync(targetDirectory, { recursive: true });
+  await copyDir(catalogDir, sourceDirectory, targetDirectory, (src) => {
+    return !src.includes("versioned");
+  });
+  await import_promises.default.readdir(sourceDirectory).then(async (resourceFiles) => {
+    await Promise.all(
+      resourceFiles.map(async (file2) => {
+        if (file2 !== "versioned") {
+          import_node_fs2.default.rmSync((0, import_path.join)(sourceDirectory, file2), { recursive: true });
+        }
+      })
+    );
+  });
+};
+var writeResource = async (catalogDir, resource, options = {
+  path: "",
+  type: "",
+  override: false,
+  versionExistingContent: false
+}) => {
+  const path4 = options.path || `/${resource.id}`;
+  const fullPath = (0, import_path.join)(catalogDir, path4);
+  import_node_fs2.default.mkdirSync(fullPath, { recursive: true });
+  const lockPath = (0, import_path.join)(fullPath, "index.mdx");
+  if (!import_node_fs2.default.existsSync(lockPath)) {
+    import_node_fs2.default.writeFileSync(lockPath, "");
+  }
+  try {
+    await (0, import_proper_lockfile.lock)(lockPath, {
+      retries: 5,
+      stale: 1e4
+      // 10 seconds
+    });
+    const exists = await versionExists(catalogDir, resource.id, resource.version);
+    if (exists && !options.override) {
+      throw new Error(`Failed to write ${resource.id} (${options.type}) as the version ${resource.version} already exists`);
+    }
+    const { markdown, ...frontmatter } = resource;
+    if (options.versionExistingContent && !exists) {
+      const currentResource = await getResource(catalogDir, resource.id);
+      if (currentResource) {
+        if ((0, import_semver2.satisfies)(resource.version, `>${currentResource.version}`)) {
+          await versionResource(catalogDir, resource.id);
+        } else {
+          throw new Error(`New version ${resource.version} is not greater than current version ${currentResource.version}`);
+        }
+      }
+    }
+    const document = import_gray_matter2.default.stringify(markdown.trim(), frontmatter);
+    import_node_fs2.default.writeFileSync(lockPath, document);
+  } finally {
+    await (0, import_proper_lockfile.unlock)(lockPath).catch(() => {
+    });
+  }
+};
+var getResource = async (catalogDir, id, version, options) => {
+  const file = await findFileById(catalogDir, id, version);
+  if (!file) return;
+  const { data, content } = import_gray_matter2.default.read(file);
+  return {
+    ...data,
+    markdown: content.trim()
+  };
+};
+var getResourcePath = async (catalogDir, id, version) => {
+  const file = await findFileById(catalogDir, id, version);
+  if (!file) return;
+  return {
+    fullPath: file,
+    relativePath: file.replace(catalogDir, ""),
+    directory: (0, import_path.dirname)(file.replace(catalogDir, ""))
+  };
+};
+var getResources = async (catalogDir, {
+  type,
+  latestOnly = false,
+  ignore = [],
+  pattern = ""
+}) => {
+  const ignoreList = latestOnly ? `**/versioned/**` : "";
+  const filePattern = pattern || `${catalogDir}/**/${type}/**/index.{md,mdx}`;
+  const files = await getFiles(filePattern, [ignoreList, ...ignore]);
+  if (files.length === 0) return;
+  return files.map((file) => {
+    const { data, content } = import_gray_matter2.default.read(file);
+    return {
+      ...data,
+      markdown: content.trim()
+    };
+  });
+};
+var rmResourceById = async (catalogDir, id, version, options) => {
+  const files = await getFiles(`${catalogDir}/**/index.{md,mdx}`);
+  const matchedFiles = await searchFilesForId(files, id, version);
+  if (matchedFiles.length === 0) {
+    throw new Error(`No ${options?.type || "resource"} found with id: ${id}`);
+  }
+  if (options?.persistFiles) {
+    await Promise.all(
+      matchedFiles.map(async (file) => {
+        await import_promises.default.rm(file, { recursive: true });
+      })
+    );
+  } else {
+    await Promise.all(
+      matchedFiles.map(async (file) => {
+        const directory = (0, import_path.dirname)(file);
+        await import_promises.default.rm(directory, { recursive: true, force: true });
+      })
+    );
+  }
+};
+var addFileToResource = async (catalogDir, id, file, version) => {
+  const pathToResource = await findFileById(catalogDir, id, version);
+  if (!pathToResource) throw new Error("Cannot find directory to write file to");
+  import_node_fs2.default.writeFileSync((0, import_path.join)((0, import_path.dirname)(pathToResource), file.fileName), file.content);
+};
+var getFileFromResource = async (catalogDir, id, file, version) => {
+  const pathToResource = await findFileById(catalogDir, id, version);
+  if (!pathToResource) throw new Error("Cannot find directory of resource");
+  const exists = await import_promises.default.access((0, import_path.join)((0, import_path.dirname)(pathToResource), file.fileName)).then(() => true).catch(() => false);
+  if (!exists) throw new Error(`File ${file.fileName} does not exist in resource ${id} v(${version})`);
+  return import_node_fs2.default.readFileSync((0, import_path.join)((0, import_path.dirname)(pathToResource), file.fileName), "utf-8");
+};
+var getVersionedDirectory = (sourceDirectory, version) => {
+  return (0, import_path.join)(sourceDirectory, "versioned", version);
+};
+
+// src/events.ts
+var getEvent = (directory) => async (id, version) => getResource(directory, id, version, { type: "event" });
+var getEvents = (directory) => async (options) => getResources(directory, { type: "events", ...options });
+var writeEvent = (directory) => async (event, options = { path: "", override: false }) => writeResource(directory, { ...event }, { ...options, type: "event" });
+var writeEventToService = (directory) => async (event, service, options = { path: "" }) => {
+  const resourcePath = await getResourcePath(directory, service.id, service.version);
+  if (!resourcePath) {
+    throw new Error("Service not found");
+  }
+  let pathForEvent = service.version && service.version !== "latest" ? `${resourcePath.directory}/versioned/${service.version}/events` : `${resourcePath.directory}/events`;
+  pathForEvent = (0, import_node_path2.join)(pathForEvent, event.id);
+  await writeResource(directory, { ...event }, { ...options, path: pathForEvent, type: "event" });
+};
+var rmEvent = (directory) => async (path4) => {
+  await import_promises2.default.rm((0, import_node_path2.join)(directory, path4), { recursive: true });
+};
+var rmEventById = (directory) => async (id, version, persistFiles) => {
+  await rmResourceById(directory, id, version, { type: "event", persistFiles });
+};
+var versionEvent = (directory) => async (id) => versionResource(directory, id);
+var addFileToEvent = (directory) => async (id, file, version) => addFileToResource(directory, id, file, version);
+var addSchemaToEvent = (directory) => async (id, schema, version) => {
+  await addFileToEvent(directory)(id, { content: schema.schema, fileName: schema.fileName }, version);
+};
+var eventHasVersion = (directory) => async (id, version) => {
+  const file = await findFileById(directory, id, version);
+  return !!file;
+};
+
+// src/commands.ts
+var import_promises3 = __toESM(require("fs/promises"));
+var import_node_path3 = require("path");
+var getCommand = (directory) => async (id, version) => getResource(directory, id, version, { type: "command" });
+var getCommands = (directory) => async (options) => getResources(directory, { type: "commands", ...options });
+var writeCommand = (directory) => async (command, options = { path: "" }) => writeResource(directory, { ...command }, { ...options, type: "command" });
+var writeCommandToService = (directory) => async (command, service, options = { path: "" }) => {
+  const resourcePath = await getResourcePath(directory, service.id, service.version);
+  if (!resourcePath) {
+    throw new Error("Service not found");
+  }
+  let pathForCommand = service.version && service.version !== "latest" ? `${resourcePath.directory}/versioned/${service.version}/commands` : `${resourcePath.directory}/commands`;
+  pathForCommand = (0, import_node_path3.join)(pathForCommand, command.id);
+  await writeResource(directory, { ...command }, { ...options, path: pathForCommand, type: "command" });
+};
+var rmCommand = (directory) => async (path4) => {
+  await import_promises3.default.rm((0, import_node_path3.join)(directory, path4), { recursive: true });
+};
+var rmCommandById = (directory) => async (id, version, persistFiles) => rmResourceById(directory, id, version, { type: "command", persistFiles });
+var versionCommand = (directory) => async (id) => versionResource(directory, id);
+var addFileToCommand = (directory) => async (id, file, version) => addFileToResource(directory, id, file, version);
+var addSchemaToCommand = (directory) => async (id, schema, version) => {
+  await addFileToCommand(directory)(id, { content: schema.schema, fileName: schema.fileName }, version);
+};
+var commandHasVersion = (directory) => async (id, version) => {
+  const file = await findFileById(directory, id, version);
+  return !!file;
+};
+
+// src/queries.ts
+var import_promises4 = __toESM(require("fs/promises"));
+var import_node_path4 = require("path");
+var getQuery = (directory) => async (id, version) => getResource(directory, id, version, { type: "query" });
+var writeQuery = (directory) => async (query, options = { path: "" }) => writeResource(directory, { ...query }, { ...options, type: "query" });
+var getQueries = (directory) => async (options) => getResources(directory, { type: "queries", ...options });
+var writeQueryToService = (directory) => async (query, service, options = { path: "" }) => {
+  const resourcePath = await getResourcePath(directory, service.id, service.version);
+  if (!resourcePath) {
+    throw new Error("Service not found");
+  }
+  let pathForQuery = service.version && service.version !== "latest" ? `${resourcePath.directory}/versioned/${service.version}/queries` : `${resourcePath.directory}/queries`;
+  pathForQuery = (0, import_node_path4.join)(pathForQuery, query.id);
+  await writeResource(directory, { ...query }, { ...options, path: pathForQuery, type: "query" });
+};
+var rmQuery = (directory) => async (path4) => {
+  await import_promises4.default.rm((0, import_node_path4.join)(directory, path4), { recursive: true });
+};
+var rmQueryById = (directory) => async (id, version, persistFiles) => {
+  await rmResourceById(directory, id, version, { type: "query", persistFiles });
+};
+var versionQuery = (directory) => async (id) => versionResource(directory, id);
+var addFileToQuery = (directory) => async (id, file, version) => addFileToResource(directory, id, file, version);
+var addSchemaToQuery = (directory) => async (id, schema, version) => {
+  await addFileToQuery(directory)(id, { content: schema.schema, fileName: schema.fileName }, version);
+};
+var queryHasVersion = (directory) => async (id, version) => {
+  const file = await findFileById(directory, id, version);
+  return !!file;
+};
+
+// src/services.ts
+var import_promises5 = __toESM(require("fs/promises"));
+var import_node_path5 = require("path");
+var getService = (directory) => async (id, version) => getResource(directory, id, version, { type: "service" });
+var getServices = (directory) => async (options) => getResources(directory, {
+  type: "services",
+  ignore: ["**/events/**", "**/commands/**", "**/queries/**"],
+  ...options
+});
+var writeService = (directory) => async (service, options = { path: "" }) => {
+  const resource = { ...service };
+  if (Array.isArray(service.sends)) {
+    resource.sends = uniqueVersions(service.sends);
+  }
+  if (Array.isArray(service.receives)) {
+    resource.receives = uniqueVersions(service.receives);
+  }
+  return await writeResource(directory, resource, { ...options, type: "service" });
+};
+var writeVersionedService = (directory) => async (service) => {
+  const resource = { ...service };
+  const path4 = getVersionedDirectory(service.id, service.version);
+  return await writeService(directory)(resource, { path: path4 });
+};
+var writeServiceToDomain = (directory) => async (service, domain, options = { path: "" }) => {
+  let pathForService = domain.version && domain.version !== "latest" ? `/${domain.id}/versioned/${domain.version}/services` : `/${domain.id}/services`;
+  pathForService = (0, import_node_path5.join)(pathForService, service.id);
+  await writeResource(directory, { ...service }, { ...options, path: pathForService, type: "service" });
+};
+var versionService = (directory) => async (id) => versionResource(directory, id);
+var rmService = (directory) => async (path4) => {
+  await import_promises5.default.rm((0, import_node_path5.join)(directory, path4), { 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);
+var getSpecificationFilesForService = (directory) => async (id, version) => {
+  let service = await getService(directory)(id, version);
+  const filePathToService = await findFileById(directory, id, version);
+  if (!filePathToService) throw new Error("Cannot find directory of service");
+  let specs = [];
+  if (service.specifications) {
+    const serviceSpecifications = service.specifications;
+    const specificationFiles = Object.keys(serviceSpecifications);
+    const getSpecs = specificationFiles.map(async (specFile) => {
+      const fileName = serviceSpecifications[specFile];
+      if (!fileName) {
+        throw new Error(`Specification file name for ${specFile} is undefined`);
+      }
+      const rawFile = await getFileFromResource(directory, id, { fileName }, version);
+      return { key: specFile, content: rawFile, fileName, path: (0, import_node_path5.join)((0, import_node_path5.dirname)(filePathToService), fileName) };
+    });
+    specs = await Promise.all(getSpecs);
+  }
+  return specs;
+};
+var addMessageToService = (directory) => async (id, direction, event, version) => {
+  let service = await getService(directory)(id, version);
+  if (direction === "sends") {
+    if (service.sends === void 0) {
+      service.sends = [];
+    }
+    for (let i = 0; i < service.sends.length; i++) {
+      if (service.sends[i].id === event.id && service.sends[i].version === event.version) {
+        return;
+      }
+    }
+    service.sends.push({ id: event.id, version: event.version });
+  } else if (direction === "receives") {
+    if (service.receives === void 0) {
+      service.receives = [];
+    }
+    for (let i = 0; i < service.receives.length; i++) {
+      if (service.receives[i].id === event.id && service.receives[i].version === event.version) {
+        return;
+      }
+    }
+    service.receives.push({ id: event.id, version: event.version });
+  } 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 service ${id} in the catalog`);
+  }
+  const path4 = existingResource.split("/services")[0];
+  const pathToResource = (0, import_node_path5.join)(path4, "services");
+  await rmServiceById(directory)(id, version);
+  await writeService(pathToResource)(service);
+};
+var serviceHasVersion = (directory) => async (id, version) => {
+  const file = await findFileById(directory, id, version);
+  return !!file;
+};
+
+// src/domains.ts
+var import_promises6 = __toESM(require("fs/promises"));
+var import_node_path6 = __toESM(require("path"));
+var import_node_fs3 = __toESM(require("fs"));
+var import_gray_matter3 = __toESM(require("gray-matter"));
+var getDomain = (directory) => async (id, version) => getResource(directory, id, version, { type: "domain" });
+var getDomains = (directory) => async (options) => getResources(directory, {
+  type: "domains",
+  ignore: ["**/services/**", "**/events/**", "**/commands/**", "**/queries/**", "**/flows/**"],
+  ...options
+});
+var writeDomain = (directory) => async (domain, options = { path: "" }) => {
+  const resource = { ...domain };
+  if (Array.isArray(domain.services)) {
+    resource.services = uniqueVersions(domain.services);
+  }
+  return await writeResource(directory, resource, { ...options, type: "domain" });
+};
+var versionDomain = (directory) => async (id) => versionResource(directory, id);
+var rmDomain = (directory) => async (path4) => {
+  await import_promises6.default.rm((0, import_node_path6.join)(directory, path4), { 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);
+var addUbiquitousLanguageToDomain = (directory) => async (id, ubiquitousLanguageDictionary, version) => {
+  const content = import_gray_matter3.default.stringify("", {
+    ...ubiquitousLanguageDictionary
+  });
+  await addFileToResource(directory, id, { content, fileName: "ubiquitous-language.mdx" }, version);
+};
+var getUbiquitousLanguageFromDomain = (directory) => async (id, version) => {
+  const pathToDomain = await findFileById(directory, id, version) || "";
+  const pathToUbiquitousLanguage = import_node_path6.default.join(import_node_path6.default.dirname(pathToDomain), "ubiquitous-language.mdx");
+  const fileExists = import_node_fs3.default.existsSync(pathToUbiquitousLanguage);
+  if (!fileExists) {
+    return void 0;
+  }
+  const content = await readMdxFile(pathToUbiquitousLanguage);
+  return content;
+};
+var domainHasVersion = (directory) => async (id, version) => {
+  const file = await findFileById(directory, id, version);
+  return !!file;
+};
+var addServiceToDomain = (directory) => async (id, service, version) => {
+  let domain = await getDomain(directory)(id, version);
+  if (domain.services === void 0) {
+    domain.services = [];
+  }
+  const serviceExistsInList = domain.services.some((s) => s.id === service.id && s.version === service.version);
+  if (serviceExistsInList) {
+    return;
+  }
+  domain.services.push(service);
+  await rmDomainById(directory)(id, version, true);
+  await writeDomain(directory)(domain);
+};
+
+// src/channels.ts
+var import_promises7 = __toESM(require("fs/promises"));
+var import_node_path7 = require("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 import_promises7.default.rm((0, import_node_path7.join)(directory, path4), { recursive: true });
+};
+var rmChannelById = (directory) => async (id, version, persistFiles) => rmResourceById(directory, id, version, { type: "channel", persistFiles });
+var versionChannel = (directory) => async (id) => versionResource(directory, id);
+var channelHasVersion = (directory) => async (id, version) => {
+  const file = await findFileById(directory, id, version);
+  return !!file;
+};
+var addMessageToChannel = (directory, collection) => async (id, _message, version) => {
+  let channel = await getChannel(directory)(id, version);
+  const functions = {
+    events: {
+      getMessage: getEvent,
+      rmMessageById: rmEventById,
+      writeMessage: writeEvent
+    },
+    commands: {
+      getMessage: getCommand,
+      rmMessageById: rmCommandById,
+      writeMessage: writeCommand
+    },
+    queries: {
+      getMessage: getQuery,
+      rmMessageById: rmQueryById,
+      writeMessage: writeQuery
+    }
+  };
+  const { getMessage, rmMessageById, writeMessage } = functions[collection];
+  const message = await getMessage(directory)(_message.id, _message.version);
+  if (!message) throw new Error(`Message ${_message.id} with version ${_message.version} not found`);
+  if (message.channels === void 0) {
+    message.channels = [];
+  }
+  const channelInfo = { id, version: channel.version, ..._message.parameters && { parameters: _message.parameters } };
+  message.channels.push(channelInfo);
+  const existingResource = await findFileById(directory, _message.id, _message.version);
+  if (!existingResource) {
+    throw new Error(`Cannot find message ${id} in the catalog`);
+  }
+  const path4 = existingResource.split(`/${collection}`)[0];
+  const pathToResource = (0, import_node_path7.join)(path4, collection);
+  await rmMessageById(directory)(_message.id, _message.version, true);
+  await writeMessage(pathToResource)(message);
+};
+
+// src/custom-docs.ts
+var import_node_path8 = __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_slugify = __toESM(require("slugify"));
+var getCustomDoc = (directory) => async (filePath) => {
+  const fullPath = import_node_path8.default.join(directory, filePath);
+  const fullPathWithExtension = fullPath.endsWith(".mdx") ? fullPath : `${fullPath}.mdx`;
+  const fileExists = import_node_fs4.default.existsSync(fullPathWithExtension);
+  if (!fileExists) {
+    return void 0;
+  }
+  return readMdxFile(fullPathWithExtension);
+};
+var getCustomDocs = (directory) => async (options) => {
+  if (options?.path) {
+    const pattern = `${directory}/${options.path}/**/*.{md,mdx}`;
+    return getResources(directory, { type: "docs", pattern });
+  }
+  return getResources(directory, { type: "docs", pattern: `${directory}/**/*.{md,mdx}` });
+};
+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);
+  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 });
+};
+
+// 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 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);
+  return {
+    ...data,
+    id: data.id,
+    name: data.name,
+    markdown: content.trim()
+  };
+};
+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);
+    return {
+      ...data,
+      id: data.id,
+      name: data.name,
+      markdown: content.trim()
+    };
+  });
+};
+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} (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);
+};
+var rmTeamById = (catalogDir) => async (id) => {
+  await import_promises9.default.rm((0, import_node_path9.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 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);
+  return {
+    ...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}`);
+  if (files.length === 0) return [];
+  return files.map((file) => {
+    const { data, content } = import_gray_matter6.default.read(file);
+    return {
+      ...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;
+  if (exists && !options.override) {
+    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);
+};
+var rmUserById = (catalogDir) => async (id) => {
+  import_node_fs6.default.rmSync((0, import_node_path10.join)(catalogDir, `${id}.mdx`), { recursive: true });
+};
+
+// src/index.ts
+var index_default = (path4) => {
+  return {
+    /**
+     * Returns an events from EventCatalog
+     * @param id - The id of the event to retrieve
+     * @param version - Optional id of the version to get (supports semver)
+     * @returns Event|Undefined
+     */
+    getEvent: getEvent((0, import_node_path11.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_path11.join)(path4)),
+    /**
+     * Adds an event to EventCatalog
+     *
+     * @param event - The event to write
+     * @param options - Optional options to write the event
+     *
+     */
+    writeEvent: writeEvent((0, import_node_path11.join)(path4, "events")),
+    /**
+     * Adds an event to a service in EventCatalog
+     *
+     * @param event - The event to write to the service
+     * @param service - The service and it's id to write to the event to
+     * @param options - Optional options to write the event
+     *
+     */
+    writeEventToService: writeEventToService((0, import_node_path11.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_path11.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_path11.join)(path4)),
+    /**
+     * Moves a given event id to the version directory
+     * @param directory
+     */
+    versionEvent: versionEvent((0, import_node_path11.join)(path4)),
+    /**
+     * Adds a file to the given event
+     * @param id - The id of the event to add the file to
+     * @param file - File contents to add including the content and the file name
+     * @param version - Optional version of the event to add the file to
+     * @returns
+     */
+    addFileToEvent: addFileToEvent((0, import_node_path11.join)(path4)),
+    /**
+     * Adds a schema to the given event
+     * @param id - The id of the event to add the schema to
+     * @param schema - Schema contents to add including the content and the file name
+     * @param version - Optional version of the event to add the schema to
+     * @returns
+     */
+    addSchemaToEvent: addSchemaToEvent((0, import_node_path11.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_path11.join)(path4)),
+    /**
+     * ================================
+     *            Commands
+     * ================================
+     */
+    /**
+     * Returns a command from EventCatalog
+     * @param id - The id of the command to retrieve
+     * @param version - Optional id of the version to get (supports semver)
+     * @returns Command|Undefined
+     */
+    getCommand: getCommand((0, import_node_path11.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_path11.join)(path4)),
+    /**
+     * Adds an command to EventCatalog
+     *
+     * @param command - The command to write
+     * @param options - Optional options to write the command
+     *
+     */
+    writeCommand: writeCommand((0, import_node_path11.join)(path4, "commands")),
+    /**
+     * Adds a command to a service in EventCatalog
+     *
+     * @param command - The command to write to the service
+     * @param service - The service and it's id to write to the command to
+     * @param options - Optional options to write the command
+     *
+     */
+    writeCommandToService: writeCommandToService((0, import_node_path11.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_path11.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_path11.join)(path4)),
+    /**
+     * Moves a given command id to the version directory
+     * @param directory
+     */
+    versionCommand: versionCommand((0, import_node_path11.join)(path4)),
+    /**
+     * Adds a file to the given command
+     * @param id - The id of the command to add the file to
+     * @param file - File contents to add including the content and the file name
+     * @param version - Optional version of the command to add the file to
+     * @returns
+     */
+    addFileToCommand: addFileToCommand((0, import_node_path11.join)(path4)),
+    /**
+     * Adds a schema to the given command
+     * @param id - The id of the command to add the schema to
+     * @param schema - Schema contents to add including the content and the file name
+     * @param version - Optional version of the command to add the schema to
+     * @returns
+     */
+    addSchemaToCommand: addSchemaToCommand((0, import_node_path11.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_path11.join)(path4)),
+    /**
+     * ================================
+     *            Queries
+     * ================================
+     */
+    /**
+     * Returns a query from EventCatalog
+     * @param id - The id of the query to retrieve
+     * @param version - Optional id of the version to get (supports semver)
+     * @returns Query|Undefined
+     */
+    getQuery: getQuery((0, import_node_path11.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_path11.join)(path4)),
+    /**
+     * Adds a query to EventCatalog
+     *
+     * @param query - The query to write
+     * @param options - Optional options to write the event
+     *
+     */
+    writeQuery: writeQuery((0, import_node_path11.join)(path4, "queries")),
+    /**
+     * Adds a query to a service in EventCatalog
+     *
+     * @param query - The query to write to the service
+     * @param service - The service and it's id to write to the query to
+     * @param options - Optional options to write the query
+     *
+     */
+    writeQueryToService: writeQueryToService((0, import_node_path11.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_path11.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_path11.join)(path4)),
+    /**
+     * Moves a given query id to the version directory
+     * @param directory
+     */
+    versionQuery: versionQuery((0, import_node_path11.join)(path4)),
+    /**
+     * Adds a file to the given query
+     * @param id - The id of the query to add the file to
+     * @param file - File contents to add including the content and the file name
+     * @param version - Optional version of the query to add the file to
+     * @returns
+     */
+    addFileToQuery: addFileToQuery((0, import_node_path11.join)(path4)),
+    /**
+     * Adds a schema to the given query
+     * @param id - The id of the query to add the schema to
+     * @param schema - Schema contents to add including the content and the file name
+     * @param version - Optional version of the query to add the schema to
+     * @returns
+     */
+    addSchemaToQuery: addSchemaToQuery((0, import_node_path11.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_path11.join)(path4)),
+    /**
+     * ================================
+     *            Channels
+     * ================================
+     */
+    /**
+     * Returns a channel from EventCatalog
+     * @param id - The id of the channel to retrieve
+     * @param version - Optional id of the version to get (supports semver)
+     * @returns Channel|Undefined
+     */
+    getChannel: getChannel((0, import_node_path11.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_path11.join)(path4)),
+    /**
+     * Adds an channel to EventCatalog
+     *
+     * @param command - The channel to write
+     * @param options - Optional options to write the channel
+     *
+     */
+    writeChannel: writeChannel((0, import_node_path11.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_path11.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_path11.join)(path4)),
+    /**
+     * Moves a given channel id to the version directory
+     * @param directory
+     */
+    versionChannel: versionChannel((0, import_node_path11.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_path11.join)(path4)),
+    /**
+     * Add a channel to an event
+     *
+     * Optionally specify a version to add the channel to a specific version of the event.
+     *
+     * @example
+     * ```ts
+     * import utils from '@eventcatalog/utils';
+     *
+     * const { addEventToChannel } = utils('/path/to/eventcatalog');
+     *
+     * // adds a new event (InventoryUpdatedEvent) to the inventory.{env}.events channel
+     * await addEventToChannel('inventory.{env}.events channel', { id: 'InventoryUpdatedEvent', version: '2.0.0', parameters: { env: 'dev' } });
+     *
+     * ```
+     */
+    addEventToChannel: addMessageToChannel((0, import_node_path11.join)(path4), "events"),
+    /**
+     * Add a channel to an command
+     *
+     * Optionally specify a version to add the channel to a specific version of the command.
+     *
+     * @example
+     * ```ts
+     * import utils from '@eventcatalog/utils';
+     *
+     * const { addCommandToChannel } = utils('/path/to/eventcatalog');
+     *
+     * // adds a new command (UpdateInventory) to the inventory.{env}.events channel
+     * await addCommandToChannel('inventory.{env}.events channel', { id: 'UpdateInventory', version: '2.0.0', parameters: { env: 'dev' } });
+     *
+     * ```
+     */
+    addCommandToChannel: addMessageToChannel((0, import_node_path11.join)(path4), "commands"),
+    /**
+     * Add a channel to an query
+     *
+     * Optionally specify a version to add the channel to a specific version of the query.
+     *
+     * @example
+     * ```ts
+     * import utils from '@eventcatalog/utils';
+     *
+     * const { addQueryToChannel } = utils('/path/to/eventcatalog');
+     *
+     * // adds a new query (GetInventory) to the inventory.{env}.events channel
+     * await addQueryToChannel('inventory.{env}.events channel', { id: 'GetInventory', version: '2.0.0', parameters: { env: 'dev' } });
+     *
+     * ```
+     */
+    addQueryToChannel: addMessageToChannel((0, import_node_path11.join)(path4), "queries"),
+    /**
+     * ================================
+     *            SERVICES
+     * ================================
+     */
+    /**
+     * Adds a service to EventCatalog
+     *
+     * @param service - The service to write
+     * @param options - Optional options to write the event
+     *
+     */
+    writeService: writeService((0, import_node_path11.join)(path4, "services")),
+    /**
+     * Adds a versioned service to EventCatalog
+     *
+     * @param service - The service to write
+     *
+     */
+    writeVersionedService: writeVersionedService((0, import_node_path11.join)(path4, "services")),
+    /**
+     * Adds a service to a domain in EventCatalog
+     *
+     * @param service - The service to write
+     * @param domain - The domain to add the service to
+     * @param options - Optional options to write the event
+     *
+     */
+    writeServiceToDomain: writeServiceToDomain((0, import_node_path11.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_path11.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_path11.join)(path4)),
+    /**
+     * Moves a given service id to the version directory
+     * @param directory
+     */
+    versionService: versionService((0, import_node_path11.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_path11.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_path11.join)(path4)),
+    /**
+     * Adds a file to the given service
+     * @param id - The id of the service to add the file to
+     * @param file - File contents to add including the content and the file name
+     * @param version - Optional version of the service to add the file to
+     * @returns
+     */
+    addFileToService: addFileToService((0, import_node_path11.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_path11.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_path11.join)(path4)),
+    /**
+     * 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' });
+     *
+     * ```
+     */
+    addEventToService: addMessageToService((0, import_node_path11.join)(path4)),
+    /**
+     * Add a command 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 { addCommandToService } = utils('/path/to/eventcatalog');
+     *
+     * // adds a new command (UpdateInventoryCommand) that the InventoryService will send
+     * await addCommandToService('InventoryService', 'sends', { command: 'UpdateInventoryCommand', version: '2.0.0' });
+     *
+     * // adds a new command (VerifyInventory) that the InventoryService will receive
+     * await addCommandToService('InventoryService', 'receives', { command: 'VerifyInventory', version: '2.0.0' });
+     *
+     * ```
+     */
+    addCommandToService: addMessageToService((0, import_node_path11.join)(path4)),
+    /**
+     * Add a query 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 { addQueryToService } = utils('/path/to/eventcatalog');
+     *
+     * // adds a new query (UpdateInventory) that the InventoryService will send
+     * await addQueryToService('InventoryService', 'sends', { command: 'UpdateInventory', version: '2.0.0' });
+     *
+     * // adds a new command (VerifyInventory) that the InventoryService will receive
+     * await addQueryToService('InventoryService', 'receives', { command: 'VerifyInventory', version: '2.0.0' });
+     *
+     * ```
+     */
+    addQueryToService: addMessageToService((0, import_node_path11.join)(path4)),
+    /**
+     * ================================
+     *            Domains
+     * ================================
+     */
+    /**
+     * Adds a domain to EventCatalog
+     *
+     * @param domain - The domain to write
+     * @param options - Optional options to write the event
+     *
+     */
+    writeDomain: writeDomain((0, import_node_path11.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_path11.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_path11.join)(path4)),
+    /**
+     * Moves a given domain id to the version directory
+     * @param directory
+     */
+    versionDomain: versionDomain((0, import_node_path11.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_path11.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_path11.join)(path4, "domains")),
+    /**
+     * Adds a file to the given domain
+     * @param id - The id of the domain to add the file to
+     * @param file - File contents to add including the content and the file name
+     * @param version - Optional version of the domain to add the file to
+     * @returns
+     */
+    addFileToDomain: addFileToDomain((0, import_node_path11.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_path11.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_path11.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_path11.join)(path4)),
+    /**
+     * Adds a given service to a domain
+     * @param id - The id of the domain
+     * @param service - The id and version of the service to add
+     * @param version - (Optional) The version of the domain to add the service to
+     * @returns
+     */
+    addServiceToDomain: addServiceToDomain((0, import_node_path11.join)(path4, "domains")),
+    /**
+     * ================================
+     *            Teams
+     * ================================
+     */
+    /**
+     * Adds a team to EventCatalog
+     *
+     * @param team - The team to write
+     * @param options - Optional options to write the team
+     *
+     */
+    writeTeam: writeTeam((0, import_node_path11.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_path11.join)(path4, "teams")),
+    /**
+     * Returns all teams from EventCatalog
+     * @returns Team[]|Undefined
+     */
+    getTeams: getTeams((0, import_node_path11.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_path11.join)(path4, "teams")),
+    /**
+     * ================================
+     *            Users
+     * ================================
+     */
+    /**
+     * Adds a user to EventCatalog
+     *
+     * @param user - The user to write
+     * @param options - Optional options to write the user
+     *
+     */
+    writeUser: writeUser((0, import_node_path11.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_path11.join)(path4, "users")),
+    /**
+     * Returns all user from EventCatalog
+     * @returns User[]|Undefined
+     */
+    getUsers: getUsers((0, import_node_path11.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_path11.join)(path4, "users")),
+    /**
+     * ================================
+     *            Custom Docs
+     * ================================
+     */
+    /**
+     * Returns a custom doc from EventCatalog
+     * @param path - The path to the custom doc to retrieve
+     * @returns CustomDoc|Undefined
+     */
+    getCustomDoc: getCustomDoc((0, import_node_path11.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_path11.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_path11.join)(path4, "docs")),
+    /**
+     * Removes a custom doc from EventCatalog
+     * @param path - The path to the custom doc to remove
+     *
+     */
+    rmCustomDoc: rmCustomDoc((0, import_node_path11.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_path11.join)(path4))
+  };
+};
+
+// src/eventcatalog.ts
+var DUMP_VERSION = "0.0.1";
+var getEventCatalogVersion = async (catalogDir) => {
+  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"];
+};
+var hydrateResource = async (catalogDir, resources, { attachSchema = false } = {}) => {
+  return await Promise.all(
+    resources.map(async (resource) => {
+      const resourcePath = await getResourcePath(catalogDir, resource.id, resource.version);
+      let schema = "";
+      if (resource.schemaPath && resourcePath?.fullPath) {
+        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");
+        }
+      }
+      const eventcatalog = schema ? { directory: resourcePath?.directory, schema } : { directory: resourcePath?.directory };
+      return {
+        ...resource,
+        _eventcatalog: eventcatalog
+      };
+    })
+  );
+};
+var filterCollection = (collection, options) => {
+  return collection.map((item) => ({
+    ...item,
+    markdown: options?.includeMarkdown ? item.markdown : void 0
+  }));
+};
+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 { includeMarkdown = true } = options || {};
+  const domains = await getDomains2();
+  const services = await getServices2();
+  const events = await getEvents2();
+  const commands = await getCommands2();
+  const queries = await getQueries2();
+  const teams = await getTeams2();
+  const users = await getUsers2();
+  const channels = await getChannels2();
+  const [
+    hydratedDomains,
+    hydratedServices,
+    hydratedEvents,
+    hydratedQueries,
+    hydratedCommands,
+    hydratedTeams,
+    hydratedUsers,
+    hydratedChannels
+  ] = await Promise.all([
+    hydrateResource(directory, domains),
+    hydrateResource(directory, services),
+    hydrateResource(directory, events),
+    hydrateResource(directory, queries),
+    hydrateResource(directory, commands),
+    hydrateResource(directory, teams),
+    hydrateResource(directory, users),
+    hydrateResource(directory, channels)
+  ]);
+  return {
+    version: DUMP_VERSION,
+    catalogVersion: await getEventCatalogVersion(directory),
+    createdAt: (/* @__PURE__ */ new Date()).toISOString(),
+    resources: {
+      domains: filterCollection(hydratedDomains, { includeMarkdown }),
+      services: filterCollection(hydratedServices, { includeMarkdown }),
+      messages: {
+        events: filterCollection(hydratedEvents, { includeMarkdown }),
+        queries: filterCollection(hydratedQueries, { includeMarkdown }),
+        commands: filterCollection(hydratedCommands, { includeMarkdown })
+      },
+      teams: filterCollection(hydratedTeams, { includeMarkdown }),
+      users: filterCollection(hydratedUsers, { includeMarkdown }),
+      channels: filterCollection(hydratedChannels, { includeMarkdown })
+    }
+  };
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  dumpCatalog
+});
+//# sourceMappingURL=eventcatalog.js.map