@eventcatalog/sdk 2.15.1 → 2.17.0

package/dist/index.mjs

@@ -794,8 +794,8 @@ var getFiles = async (pattern, ignore = "") => {
     );
   }
 };
-var readMdxFile = async (path6) => {
-  const { data } = matter.read(path6);
+var readMdxFile = async (path8) => {
+  const { data } = matter.read(path8);
   const { markdown, ...frontmatter } = data;
   return { ...frontmatter, markdown };
 };
@@ -889,8 +889,8 @@ var writeResource = async (catalogDir, resource, options = {
   versionExistingContent: false,
   format: "mdx"
 }) => {
-  const path6 = options.path || `/${resource.id}`;
-  const fullPath = join2(catalogDir, path6);
+  const path8 = options.path || `/${resource.id}`;
+  const fullPath = join2(catalogDir, path8);
   const format = options.format || "mdx";
   fsSync2.mkdirSync(fullPath, { recursive: true });
   const lockPath = join2(fullPath, `index.${format}`);
@@ -1024,16 +1024,16 @@ var rmResourceById = async (catalogDir, id, version, options) => {
   }
   invalidateFileCache();
 };
-var waitForFileRemoval = async (path6, maxRetries = 50, delay = 10) => {
+var waitForFileRemoval = async (path8, maxRetries = 50, delay = 10) => {
   for (let i = 0; i < maxRetries; i++) {
     try {
-      await fs.access(path6);
+      await fs.access(path8);
       await new Promise((resolve2) => setTimeout(resolve2, delay));
     } catch (error) {
       return;
     }
   }
-  throw new Error(`File/directory ${path6} was not removed after ${maxRetries} attempts`);
+  throw new Error(`File/directory ${path8} was not removed after ${maxRetries} attempts`);
 };
 var addFileToResource = async (catalogDir, id, file, version, options) => {
   let pathToResource;
@@ -1086,8 +1086,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 (path6) => {
-  await fs2.rm(join3(directory, path6), { recursive: true });
+var rmEvent = (directory) => async (path8) => {
+  await fs2.rm(join3(directory, path8), { recursive: true });
   invalidateFileCache();
 };
 var rmEventById = (directory) => async (id, version, persistFiles) => {
@@ -1123,8 +1123,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 (path6) => {
-  await fs3.rm(join4(directory, path6), { recursive: true });
+var rmCommand = (directory) => async (path8) => {
+  await fs3.rm(join4(directory, path8), { recursive: true });
   invalidateFileCache();
 };
 var rmCommandById = (directory) => async (id, version, persistFiles) => rmResourceById(directory, id, version, { type: "command", persistFiles });
@@ -1158,8 +1158,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 (path6) => {
-  await fs4.rm(join5(directory, path6), { recursive: true });
+var rmQuery = (directory) => async (path8) => {
+  await fs4.rm(join5(directory, path8), { recursive: true });
   invalidateFileCache();
 };
 var rmQueryById = (directory) => async (id, version, persistFiles) => {
@@ -1179,8 +1179,8 @@ var queryHasVersion = (directory) => async (id, version) => {
 import fs5 from "fs/promises";
 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 (path6) => {
-  const service = await getResource(directory, void 0, void 0, { type: "service" }, path6);
+var getServiceByPath = (directory) => async (path8) => {
+  const service = await getResource(directory, void 0, void 0, { type: "service" }, path8);
   return service;
 };
 var getServices = (directory) => async (options) => getResources(directory, {
@@ -1215,8 +1215,8 @@ var writeService = (directory) => async (service, options = {
 };
 var writeVersionedService = (directory) => async (service) => {
   const resource = { ...service };
-  const path6 = getVersionedDirectory(service.id, service.version);
-  return await writeService(directory)(resource, { path: path6 });
+  const path8 = getVersionedDirectory(service.id, service.version);
+  return await writeService(directory)(resource, { path: path8 });
 };
 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`;
@@ -1224,8 +1224,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 (path6) => {
-  await fs5.rm(join6(directory, path6), { recursive: true });
+var rmService = (directory) => async (path8) => {
+  await fs5.rm(join6(directory, path8), { recursive: true });
   invalidateFileCache();
 };
 var rmServiceById = (directory) => async (id, version, persistFiles) => {
@@ -1290,8 +1290,8 @@ var addMessageToService = (directory) => async (id, direction, event, version) =
   if (!existingResource) {
     throw new Error(`Cannot find service ${id} in the catalog`);
   }
-  const path6 = existingResource.split(/[\\/]+services/)[0];
-  const pathToResource = join6(path6, "services");
+  const path8 = existingResource.split(/[\\/]+services/)[0];
+  const pathToResource = join6(path8, "services");
   await rmServiceById(directory)(id, version);
   await writeService(pathToResource)(service, { format: extension === ".md" ? "md" : "mdx" });
 };
@@ -1299,9 +1299,9 @@ var serviceHasVersion = (directory) => async (id, version) => {
   const file = await findFileById(directory, id, version);
   return !!file;
 };
-var isService = (directory) => async (path6) => {
-  const service = await getServiceByPath(directory)(path6);
-  const relativePath = relative2(directory, path6);
+var isService = (directory) => async (path8) => {
+  const service = await getServiceByPath(directory)(path8);
+  const relativePath = relative2(directory, path8);
   const segments = relativePath.split(/[/\\]+/);
   return !!service && segments.includes("services");
 };
@@ -1323,8 +1323,8 @@ var addEntityToService = (directory) => async (id, entity, version) => {
   if (!existingResource) {
     throw new Error(`Cannot find service ${id} in the catalog`);
   }
-  const path6 = existingResource.split(/[\\/]+services/)[0];
-  const pathToResource = join6(path6, "services");
+  const path8 = existingResource.split(/[\\/]+services/)[0];
+  const pathToResource = join6(path8, "services");
   await rmServiceById(directory)(id, version);
   await writeService(pathToResource)(service, { format: extension === ".md" ? "md" : "mdx" });
 };
@@ -1359,8 +1359,8 @@ var addDataStoreToService = (directory) => async (id, operation, dataStore, vers
   if (!existingResource) {
     throw new Error(`Cannot find service ${id} in the catalog`);
   }
-  const path6 = existingResource.split(/[\\/]+services/)[0];
-  const pathToResource = join6(path6, "services");
+  const path8 = existingResource.split(/[\\/]+services/)[0];
+  const pathToResource = join6(path8, "services");
   await rmServiceById(directory)(id, version);
   await writeService(pathToResource)(service, { format: extension === ".md" ? "md" : "mdx" });
 };
@@ -1401,8 +1401,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 (path6) => {
-  await fs6.rm(join7(directory, path6), { recursive: true });
+var rmDomain = (directory) => async (path8) => {
+  await fs6.rm(join7(directory, path8), { recursive: true });
   invalidateFileCache();
 };
 var rmDomainById = (directory) => async (id, version, persistFiles) => rmResourceById(directory, id, version, { type: "domain", persistFiles });
@@ -1533,8 +1533,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 (path6) => {
-  await fs7.rm(join8(directory, path6), { recursive: true });
+var rmChannel = (directory) => async (path8) => {
+  await fs7.rm(join8(directory, path8), { recursive: true });
   invalidateFileCache();
 };
 var rmChannelById = (directory) => async (id, version, persistFiles) => rmResourceById(directory, id, version, { type: "channel", persistFiles });
@@ -1576,8 +1576,8 @@ var addMessageToChannel = (directory, collection) => async (id, _message, versio
   if (!existingResource) {
     throw new Error(`Cannot find message ${id} in the catalog`);
   }
-  const path6 = existingResource.split(`/[\\/]+${collection}`)[0];
-  const pathToResource = join8(path6, collection);
+  const path8 = existingResource.split(`/[\\/]+${collection}`)[0];
+  const pathToResource = join8(path8, collection);
   await rmMessageById(directory)(_message.id, _message.version, true);
   await writeMessage(pathToResource)(message, { format: extension === ".md" ? "md" : "mdx" });
 };
@@ -1586,8 +1586,8 @@ var addMessageToChannel = (directory, collection) => async (id, _message, versio
 import { dirname as dirname5 } from "path";
 import matter4 from "gray-matter";
 import { satisfies as satisfies4, validRange as validRange3 } from "semver";
-var getMessageBySchemaPath = (directory) => async (path6, options) => {
-  const pathToMessage = dirname5(path6);
+var getMessageBySchemaPath = (directory) => async (path8, options) => {
+  const pathToMessage = dirname5(path8);
   try {
     const files = await getFiles(`${directory}/${pathToMessage}/index.{md,mdx}`);
     if (!files || files.length === 0) {
@@ -1659,18 +1659,18 @@ var getProducersAndConsumersForMessage = (directory) => async (id, version, opti
   }
   return { producers, consumers };
 };
-var getConsumersOfSchema = (directory) => async (path6) => {
+var getConsumersOfSchema = (directory) => async (path8) => {
   try {
-    const message = await getMessageBySchemaPath(directory)(path6);
+    const message = await getMessageBySchemaPath(directory)(path8);
     const { consumers } = await getProducersAndConsumersForMessage(directory)(message.id, message.version);
     return consumers;
   } catch (error) {
     return [];
   }
 };
-var getProducersOfSchema = (directory) => async (path6) => {
+var getProducersOfSchema = (directory) => async (path8) => {
   try {
-    const message = await getMessageBySchemaPath(directory)(path6);
+    const message = await getMessageBySchemaPath(directory)(path8);
     const { producers } = await getProducersAndConsumersForMessage(directory)(message.id, message.version);
     return producers;
   } catch (error) {
@@ -1874,8 +1874,8 @@ var filterCollection = (collection, options) => {
 };
 var getEventCatalogConfigurationFile = (directory) => async () => {
   try {
-    const path6 = join13(directory, "eventcatalog.config.js");
-    const configModule = await import(path6);
+    const path8 = join13(directory, "eventcatalog.config.js");
+    const configModule = await import(path8);
     return configModule.default;
   } catch (error) {
     console.error("Error getting event catalog configuration file", error);
@@ -1931,8 +1931,407 @@ var dumpCatalog = (directory) => async (options) => {
   };
 };
 
+// src/snapshots.ts
+import fs11 from "fs";
+import path6 from "path";
+import { execSync } from "child_process";
+import { compare } from "semver";
+
+// src/snapshot-diff.ts
+var stableStringify = (value) => {
+  if (value === null || value === void 0 || typeof value !== "object") {
+    return JSON.stringify(value);
+  }
+  if (Array.isArray(value)) {
+    return "[" + value.map(stableStringify).join(",") + "]";
+  }
+  const sorted = Object.keys(value).sort().map((key) => JSON.stringify(key) + ":" + stableStringify(value[key]));
+  return "{" + sorted.join(",") + "}";
+};
+var flattenResources = (snapshot) => {
+  const resources = [];
+  const addResources = (items, type) => {
+    for (const item of items) {
+      resources.push({
+        resourceId: item.id,
+        version: item.version,
+        type,
+        data: item
+      });
+    }
+  };
+  addResources(snapshot.resources.domains, "domain");
+  addResources(snapshot.resources.services, "service");
+  addResources(snapshot.resources.messages.events, "event");
+  addResources(snapshot.resources.messages.commands, "command");
+  addResources(snapshot.resources.messages.queries, "query");
+  addResources(snapshot.resources.channels, "channel");
+  return resources;
+};
+var EXCLUDED_FIELDS = /* @__PURE__ */ new Set(["markdown", "_eventcatalog"]);
+var getComparableFields = (data) => {
+  const result = {};
+  for (const [key, value] of Object.entries(data)) {
+    if (!EXCLUDED_FIELDS.has(key)) {
+      result[key] = value;
+    }
+  }
+  return result;
+};
+var findChangedFields = (dataA, dataB) => {
+  const fieldsA = getComparableFields(dataA);
+  const fieldsB = getComparableFields(dataB);
+  const allKeys = /* @__PURE__ */ new Set([...Object.keys(fieldsA), ...Object.keys(fieldsB)]);
+  const changed = [];
+  for (const key of allKeys) {
+    if (stableStringify(fieldsA[key] ?? null) !== stableStringify(fieldsB[key] ?? null)) {
+      changed.push(key);
+    }
+  }
+  return changed;
+};
+var resourceKey = (r) => `${r.resourceId}@${r.version}`;
+var idTypeKey = (r) => `${r.resourceId}:${r.type}`;
+var computeResourceDiff = (snapshotA, snapshotB) => {
+  const resourcesA = flattenResources(snapshotA);
+  const resourcesB = flattenResources(snapshotB);
+  const mapA = /* @__PURE__ */ new Map();
+  const byIdA = /* @__PURE__ */ new Map();
+  for (const r of resourcesA) {
+    mapA.set(resourceKey(r), r);
+    byIdA.set(idTypeKey(r), r);
+  }
+  const mapB = /* @__PURE__ */ new Map();
+  const byIdB = /* @__PURE__ */ new Map();
+  for (const r of resourcesB) {
+    mapB.set(resourceKey(r), r);
+    byIdB.set(idTypeKey(r), r);
+  }
+  const changes = [];
+  const handledIds = /* @__PURE__ */ new Set();
+  for (const resource of resourcesB) {
+    const key = resourceKey(resource);
+    if (!mapA.has(key)) {
+      const idKey = idTypeKey(resource);
+      const oldResource = byIdA.get(idKey);
+      if (oldResource && oldResource.version !== resource.version && !handledIds.has(idKey)) {
+        const changedFields = findChangedFields(oldResource.data, resource.data);
+        changes.push({
+          resourceId: resource.resourceId,
+          version: resource.version,
+          type: resource.type,
+          changeType: "versioned",
+          previousVersion: oldResource.version,
+          newVersion: resource.version,
+          changedFields: changedFields.length > 0 ? changedFields : void 0
+        });
+        handledIds.add(idKey);
+      } else if (!handledIds.has(idKey)) {
+        changes.push({
+          resourceId: resource.resourceId,
+          version: resource.version,
+          type: resource.type,
+          changeType: "added"
+        });
+      }
+    }
+  }
+  for (const resource of resourcesA) {
+    const key = resourceKey(resource);
+    if (!mapB.has(key)) {
+      const idKey = idTypeKey(resource);
+      if (!handledIds.has(idKey)) {
+        changes.push({
+          resourceId: resource.resourceId,
+          version: resource.version,
+          type: resource.type,
+          changeType: "removed"
+        });
+      }
+    }
+  }
+  for (const resourceB of resourcesB) {
+    const key = resourceKey(resourceB);
+    const resourceA = mapA.get(key);
+    if (resourceA) {
+      const changedFields = findChangedFields(resourceA.data, resourceB.data);
+      if (changedFields.length > 0) {
+        changes.push({
+          resourceId: resourceB.resourceId,
+          version: resourceB.version,
+          type: resourceB.type,
+          changeType: "modified",
+          changedFields
+        });
+      }
+    }
+  }
+  return changes;
+};
+var getRelationshipKey = (serviceId, resourceId, resourceVersion, direction) => {
+  return `${serviceId}:${direction}:${resourceId}@${resourceVersion || "latest"}`;
+};
+var extractRelationships = (snapshot) => {
+  const relationships = /* @__PURE__ */ new Map();
+  for (const service of snapshot.resources.services) {
+    for (const direction of ["sends", "receives"]) {
+      const pointers = service[direction] || [];
+      for (const pointer of pointers) {
+        const key = getRelationshipKey(service.id, pointer.id, pointer.version, direction);
+        relationships.set(key, {
+          serviceId: service.id,
+          serviceVersion: service.version,
+          resourceId: pointer.id,
+          resourceVersion: pointer.version,
+          direction
+        });
+      }
+    }
+  }
+  return relationships;
+};
+var computeRelationshipDiff = (snapshotA, snapshotB) => {
+  const relsA = extractRelationships(snapshotA);
+  const relsB = extractRelationships(snapshotB);
+  const changes = [];
+  for (const [key, rel] of relsB) {
+    if (!relsA.has(key)) {
+      changes.push({ ...rel, changeType: "added" });
+    }
+  }
+  for (const [key, rel] of relsA) {
+    if (!relsB.has(key)) {
+      changes.push({ ...rel, changeType: "removed" });
+    }
+  }
+  return changes;
+};
+
+// src/snapshots.ts
+var SNAPSHOT_VERSION = "1.0.0";
+var getEventCatalogVersion2 = (catalogDir) => {
+  try {
+    const packageJson = fs11.readFileSync(path6.join(catalogDir, "package.json"), "utf8");
+    const packageJsonObject = JSON.parse(packageJson);
+    return packageJsonObject["dependencies"]?.["@eventcatalog/core"] ?? "unknown";
+  } catch {
+    return "unknown";
+  }
+};
+var pickCoreFields = (resource) => {
+  const picked = { id: resource.id, version: resource.version, name: resource.name };
+  if (resource.sends) picked.sends = resource.sends;
+  if (resource.receives) picked.receives = resource.receives;
+  if (resource.deprecated) picked.deprecated = resource.deprecated;
+  if (resource.owners) picked.owners = resource.owners;
+  return picked;
+};
+var deduplicateByLatestVersion = (resources) => {
+  const seen = /* @__PURE__ */ new Map();
+  for (const r of resources) {
+    const existing = seen.get(r.id);
+    if (!existing || compare(r.version, existing.version) > 0) {
+      seen.set(r.id, r);
+    }
+  }
+  return Array.from(seen.values());
+};
+var stripToCore = (resources) => {
+  if (!resources || resources.length === 0) return [];
+  return deduplicateByLatestVersion(resources).map(pickCoreFields);
+};
+var detectGitInfo = (catalogDir) => {
+  try {
+    const opts = { cwd: catalogDir, encoding: "utf8", stdio: "pipe" };
+    const branch = execSync("git rev-parse --abbrev-ref HEAD", opts).trim();
+    const commit = execSync("git rev-parse --short HEAD", opts).trim();
+    const status = execSync("git status --porcelain", opts).trim();
+    return { branch, commit, dirty: status.length > 0 };
+  } catch {
+    return void 0;
+  }
+};
+var createSnapshot = (directory) => {
+  return async (options) => {
+    const { label, outputDir, git } = options || {};
+    const sdk = src_default(directory);
+    const [domains, services, events, commands, queries, channels] = await Promise.all([
+      sdk.getDomains(),
+      sdk.getServices(),
+      sdk.getEvents(),
+      sdk.getCommands(),
+      sdk.getQueries(),
+      sdk.getChannels()
+    ]);
+    const snapshotDomains = stripToCore(domains);
+    const snapshotServices = stripToCore(services);
+    const snapshotEvents = stripToCore(events);
+    const snapshotCommands = stripToCore(commands);
+    const snapshotQueries = stripToCore(queries);
+    const snapshotChannels = stripToCore(channels);
+    const snapshotLabel = label || (/* @__PURE__ */ new Date()).toISOString().replace(/[:.]/g, "-");
+    const gitInfo = git || detectGitInfo(directory);
+    const snapshot = {
+      snapshotVersion: SNAPSHOT_VERSION,
+      catalogVersion: getEventCatalogVersion2(directory),
+      label: snapshotLabel,
+      createdAt: (/* @__PURE__ */ new Date()).toISOString(),
+      ...gitInfo ? { git: gitInfo } : {},
+      resources: {
+        domains: snapshotDomains,
+        services: snapshotServices,
+        messages: {
+          events: snapshotEvents,
+          commands: snapshotCommands,
+          queries: snapshotQueries
+        },
+        channels: snapshotChannels
+      }
+    };
+    const snapshotsDir = outputDir || path6.join(directory, ".snapshots");
+    fs11.mkdirSync(snapshotsDir, { recursive: true });
+    const fileName = `${snapshotLabel}.snapshot.json`;
+    const filePath = path6.join(snapshotsDir, fileName);
+    fs11.writeFileSync(filePath, JSON.stringify(snapshot));
+    return { filePath, snapshot };
+  };
+};
+var diffSnapshots = (directory) => async (snapshotAPath, snapshotBPath) => {
+  const snapshotA = JSON.parse(fs11.readFileSync(snapshotAPath, "utf-8"));
+  const snapshotB = JSON.parse(fs11.readFileSync(snapshotBPath, "utf-8"));
+  const resourceChanges = computeResourceDiff(snapshotA, snapshotB);
+  const relationshipChanges = computeRelationshipDiff(snapshotA, snapshotB);
+  const resourceCounts = { added: 0, removed: 0, modified: 0, versioned: 0 };
+  for (const r of resourceChanges) resourceCounts[r.changeType]++;
+  const relCounts = { added: 0, removed: 0 };
+  for (const r of relationshipChanges) relCounts[r.changeType]++;
+  return {
+    snapshotA: { label: snapshotA.label, createdAt: snapshotA.createdAt },
+    snapshotB: { label: snapshotB.label, createdAt: snapshotB.createdAt },
+    summary: {
+      totalChanges: resourceChanges.length + relationshipChanges.length,
+      resourcesAdded: resourceCounts.added,
+      resourcesRemoved: resourceCounts.removed,
+      resourcesModified: resourceCounts.modified,
+      resourcesVersioned: resourceCounts.versioned,
+      relationshipsAdded: relCounts.added,
+      relationshipsRemoved: relCounts.removed
+    },
+    resources: resourceChanges,
+    relationships: relationshipChanges
+  };
+};
+var listSnapshots = (directory) => async () => {
+  const snapshotsDir = path6.join(directory, ".snapshots");
+  if (!fs11.existsSync(snapshotsDir)) return [];
+  const files = fs11.readdirSync(snapshotsDir).filter((f) => f.endsWith(".snapshot.json"));
+  const snapshots = [];
+  for (const file of files) {
+    try {
+      const filePath = path6.join(snapshotsDir, file);
+      const content = JSON.parse(fs11.readFileSync(filePath, "utf-8"));
+      snapshots.push({
+        label: content.label,
+        createdAt: content.createdAt,
+        filePath,
+        ...content.git ? { git: content.git } : {}
+      });
+    } catch {
+    }
+  }
+  return snapshots.sort((a, b) => a.createdAt.localeCompare(b.createdAt));
+};
+
+// src/changelogs.ts
+import path7, { dirname as dirname6 } from "path";
+import fsSync7 from "fs";
+import fs12 from "fs/promises";
+import matter8 from "gray-matter";
+var writeChangelog = (catalogDir) => async (id, changelog, options = {}) => {
+  const { version, format = "mdx" } = options;
+  const resourceFile = await findFileById(catalogDir, id, version);
+  if (!resourceFile) {
+    throw new Error(`No resource found with id: ${id}${version ? ` and version: ${version}` : ""}`);
+  }
+  const resourceDir = dirname6(resourceFile);
+  const changelogPath = path7.join(resourceDir, `changelog.${format}`);
+  const { markdown, ...frontmatter } = changelog;
+  const fm = { ...frontmatter };
+  if (fm.createdAt instanceof Date) {
+    fm.createdAt = fm.createdAt;
+  }
+  if (!fm.badges || fm.badges.length === 0) {
+    delete fm.badges;
+  }
+  fsSync7.mkdirSync(resourceDir, { recursive: true });
+  const document = matter8.stringify(markdown.trim(), fm);
+  fsSync7.writeFileSync(changelogPath, document);
+  invalidateFileCache();
+};
+var appendChangelog = (catalogDir) => async (id, changelog, options = {}) => {
+  const { version, format = "mdx" } = options;
+  const resourceFile = await findFileById(catalogDir, id, version);
+  if (!resourceFile) {
+    throw new Error(`No resource found with id: ${id}${version ? ` and version: ${version}` : ""}`);
+  }
+  const resourceDir = dirname6(resourceFile);
+  const mdxPath = path7.join(resourceDir, "changelog.mdx");
+  const mdPath = path7.join(resourceDir, "changelog.md");
+  const existingPath = fsSync7.existsSync(mdxPath) ? mdxPath : fsSync7.existsSync(mdPath) ? mdPath : void 0;
+  if (!existingPath) {
+    return writeChangelog(catalogDir)(id, changelog, options);
+  }
+  const existing = matter8.read(existingPath);
+  const existingContent = existing.content.trim();
+  const newEntry = changelog.markdown.trim();
+  const combined = `${newEntry}
+
+---
+
+${existingContent}`;
+  const fm = { ...existing.data };
+  fm.createdAt = changelog.createdAt;
+  if (changelog.badges && changelog.badges.length > 0) {
+    fm.badges = changelog.badges;
+  } else {
+    delete fm.badges;
+  }
+  const document = matter8.stringify(combined, fm);
+  fsSync7.writeFileSync(existingPath, document);
+  invalidateFileCache();
+};
+var getChangelog = (catalogDir) => async (id, options = {}) => {
+  const { version } = options;
+  const resourceFile = await findFileById(catalogDir, id, version);
+  if (!resourceFile) return void 0;
+  const resourceDir = dirname6(resourceFile);
+  const mdxPath = path7.join(resourceDir, "changelog.mdx");
+  const mdPath = path7.join(resourceDir, "changelog.md");
+  const changelogPath = fsSync7.existsSync(mdxPath) ? mdxPath : fsSync7.existsSync(mdPath) ? mdPath : void 0;
+  if (!changelogPath) return void 0;
+  const { data, content } = matter8.read(changelogPath);
+  return { ...data, markdown: content.trim() };
+};
+var rmChangelog = (catalogDir) => async (id, options = {}) => {
+  const { version } = options;
+  const resourceFile = await findFileById(catalogDir, id, version);
+  if (!resourceFile) {
+    throw new Error(`No resource found with id: ${id}${version ? ` and version: ${version}` : ""}`);
+  }
+  const resourceDir = dirname6(resourceFile);
+  const mdxPath = path7.join(resourceDir, "changelog.mdx");
+  const mdPath = path7.join(resourceDir, "changelog.md");
+  if (fsSync7.existsSync(mdxPath)) {
+    await fs12.rm(mdxPath);
+  }
+  if (fsSync7.existsSync(mdPath)) {
+    await fs12.rm(mdPath);
+  }
+  invalidateFileCache();
+};
+
 // src/entities.ts
-import fs11 from "fs/promises";
+import fs13 from "fs/promises";
 import { join as join14 } from "path";
 var getEntity = (directory) => async (id, version) => getResource(directory, id, version, { type: "entity" });
 var getEntities = (directory) => async (options) => getResources(directory, { type: "entities", latestOnly: options?.latestOnly });
@@ -1941,8 +2340,8 @@ var writeEntity = (directory) => async (entity, options = {
   override: false,
   format: "mdx"
 }) => writeResource(directory, { ...entity }, { ...options, type: "entity" });
-var rmEntity = (directory) => async (path6) => {
-  await fs11.rm(join14(directory, path6), { recursive: true });
+var rmEntity = (directory) => async (path8) => {
+  await fs13.rm(join14(directory, path8), { recursive: true });
   invalidateFileCache();
 };
 var rmEntityById = (directory) => async (id, version, persistFiles) => {
@@ -1955,7 +2354,7 @@ var entityHasVersion = (directory) => async (id, version) => {
 };
 
 // src/containers.ts
-import fs12 from "fs/promises";
+import fs14 from "fs/promises";
 import { join as join15 } from "path";
 var getContainer = (directory) => async (id, version) => getResource(directory, id, version, { type: "container" });
 var getContainers = (directory) => async (options) => getResources(directory, { type: "containers", latestOnly: options?.latestOnly });
@@ -1965,8 +2364,8 @@ var writeContainer = (directory) => async (data, options = {
   format: "mdx"
 }) => writeResource(directory, { ...data }, { ...options, type: "container" });
 var versionContainer = (directory) => async (id) => versionResource(directory, id);
-var rmContainer = (directory) => async (path6) => {
-  await fs12.rm(join15(directory, path6), { recursive: true });
+var rmContainer = (directory) => async (path8) => {
+  await fs14.rm(join15(directory, path8), { recursive: true });
   invalidateFileCache();
 };
 var rmContainerById = (directory) => async (id, version, persistFiles) => {
@@ -1999,7 +2398,7 @@ var addFileToDataStore = addFileToContainer;
 var writeDataStoreToService = writeContainerToService;
 
 // src/data-products.ts
-import fs13 from "fs/promises";
+import fs15 from "fs/promises";
 import { join as join16 } from "path";
 var getDataProduct = (directory) => async (id, version) => getResource(directory, id, version, { type: "data-product" });
 var getDataProducts = (directory) => async (options) => getResources(directory, { type: "data-products", latestOnly: options?.latestOnly });
@@ -2013,8 +2412,8 @@ var writeDataProductToDomain = (directory) => async (dataProduct, domain, option
   pathForDataProduct = join16(pathForDataProduct, dataProduct.id);
   await writeResource(directory, { ...dataProduct }, { ...options, path: pathForDataProduct, type: "data-product" });
 };
-var rmDataProduct = (directory) => async (path6) => {
-  await fs13.rm(join16(directory, path6), { recursive: true });
+var rmDataProduct = (directory) => async (path8) => {
+  await fs15.rm(join16(directory, path8), { recursive: true });
   invalidateFileCache();
 };
 var rmDataProductById = (directory) => async (id, version, persistFiles) => {
@@ -2028,7 +2427,7 @@ var dataProductHasVersion = (directory) => async (id, version) => {
 var addFileToDataProduct = (directory) => async (id, file, version) => addFileToResource(directory, id, file, version);
 
 // src/diagrams.ts
-import fs14 from "fs/promises";
+import fs16 from "fs/promises";
 import { join as join17 } from "path";
 var getDiagram = (directory) => async (id, version) => getResource(directory, id, version, { type: "diagram" });
 var getDiagrams = (directory) => async (options) => getResources(directory, { type: "diagrams", latestOnly: options?.latestOnly });
@@ -2037,8 +2436,8 @@ var writeDiagram = (directory) => async (diagram, options = {
   override: false,
   format: "mdx"
 }) => writeResource(directory, { ...diagram }, { ...options, type: "diagram" });
-var rmDiagram = (directory) => async (path6) => {
-  await fs14.rm(join17(directory, path6), { recursive: true });
+var rmDiagram = (directory) => async (path8) => {
+  await fs16.rm(join17(directory, path8), { recursive: true });
   invalidateFileCache();
 };
 var rmDiagramById = (directory) => async (id, version, persistFiles) => {
@@ -2052,7 +2451,7 @@ var diagramHasVersion = (directory) => async (id, version) => {
 var addFileToDiagram = (directory) => async (id, file, version) => addFileToResource(directory, id, file, version, { type: "diagram" });
 
 // src/index.ts
-var src_default = (path6) => {
+var src_default = (path8) => {
   return {
     /**
      * Returns an events from EventCatalog
@@ -2060,13 +2459,13 @@ var src_default = (path6) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Event|Undefined
      */
-    getEvent: getEvent(join18(path6)),
+    getEvent: getEvent(join18(path8)),
     /**
      * Returns all events from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Event[]|Undefined
      */
-    getEvents: getEvents(join18(path6)),
+    getEvents: getEvents(join18(path8)),
     /**
      * Adds an event to EventCatalog
      *
@@ -2074,7 +2473,7 @@ var src_default = (path6) => {
      * @param options - Optional options to write the event
      *
      */
-    writeEvent: writeEvent(join18(path6, "events")),
+    writeEvent: writeEvent(join18(path8, "events")),
     /**
      * Adds an event to a service in EventCatalog
      *
@@ -2083,26 +2482,26 @@ var src_default = (path6) => {
      * @param options - Optional options to write the event
      *
      */
-    writeEventToService: writeEventToService(join18(path6)),
+    writeEventToService: writeEventToService(join18(path8)),
     /**
      * 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(join18(path6, "events")),
+    rmEvent: rmEvent(join18(path8, "events")),
     /**
      * Remove an event by an Event id
      *
      * @param id - The id of the event you want to remove
      *
      */
-    rmEventById: rmEventById(join18(path6)),
+    rmEventById: rmEventById(join18(path8)),
     /**
      * Moves a given event id to the version directory
      * @param directory
      */
-    versionEvent: versionEvent(join18(path6)),
+    versionEvent: versionEvent(join18(path8)),
     /**
      * Adds a file to the given event
      * @param id - The id of the event to add the file to
@@ -2110,7 +2509,7 @@ var src_default = (path6) => {
      * @param version - Optional version of the event to add the file to
      * @returns
      */
-    addFileToEvent: addFileToEvent(join18(path6)),
+    addFileToEvent: addFileToEvent(join18(path8)),
     /**
      * Adds a schema to the given event
      * @param id - The id of the event to add the schema to
@@ -2118,14 +2517,14 @@ var src_default = (path6) => {
      * @param version - Optional version of the event to add the schema to
      * @returns
      */
-    addSchemaToEvent: addSchemaToEvent(join18(path6)),
+    addSchemaToEvent: addSchemaToEvent(join18(path8)),
     /**
      * 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(join18(path6)),
+    eventHasVersion: eventHasVersion(join18(path8)),
     /**
      * ================================
      *            Commands
@@ -2137,13 +2536,13 @@ var src_default = (path6) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Command|Undefined
      */
-    getCommand: getCommand(join18(path6)),
+    getCommand: getCommand(join18(path8)),
     /**
      * Returns all commands from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Command[]|Undefined
      */
-    getCommands: getCommands(join18(path6)),
+    getCommands: getCommands(join18(path8)),
     /**
      * Adds an command to EventCatalog
      *
@@ -2151,7 +2550,7 @@ var src_default = (path6) => {
      * @param options - Optional options to write the command
      *
      */
-    writeCommand: writeCommand(join18(path6, "commands")),
+    writeCommand: writeCommand(join18(path8, "commands")),
     /**
      * Adds a command to a service in EventCatalog
      *
@@ -2160,26 +2559,26 @@ var src_default = (path6) => {
      * @param options - Optional options to write the command
      *
      */
-    writeCommandToService: writeCommandToService(join18(path6)),
+    writeCommandToService: writeCommandToService(join18(path8)),
     /**
      * 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(join18(path6, "commands")),
+    rmCommand: rmCommand(join18(path8, "commands")),
     /**
      * Remove an command by an Event id
      *
      * @param id - The id of the command you want to remove
      *
      */
-    rmCommandById: rmCommandById(join18(path6)),
+    rmCommandById: rmCommandById(join18(path8)),
     /**
      * Moves a given command id to the version directory
      * @param directory
      */
-    versionCommand: versionCommand(join18(path6)),
+    versionCommand: versionCommand(join18(path8)),
     /**
      * Adds a file to the given command
      * @param id - The id of the command to add the file to
@@ -2187,7 +2586,7 @@ var src_default = (path6) => {
      * @param version - Optional version of the command to add the file to
      * @returns
      */
-    addFileToCommand: addFileToCommand(join18(path6)),
+    addFileToCommand: addFileToCommand(join18(path8)),
     /**
      * Adds a schema to the given command
      * @param id - The id of the command to add the schema to
@@ -2195,14 +2594,14 @@ var src_default = (path6) => {
      * @param version - Optional version of the command to add the schema to
      * @returns
      */
-    addSchemaToCommand: addSchemaToCommand(join18(path6)),
+    addSchemaToCommand: addSchemaToCommand(join18(path8)),
     /**
      * 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(join18(path6)),
+    commandHasVersion: commandHasVersion(join18(path8)),
     /**
      * ================================
      *            Queries
@@ -2214,13 +2613,13 @@ var src_default = (path6) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Query|Undefined
      */
-    getQuery: getQuery(join18(path6)),
+    getQuery: getQuery(join18(path8)),
     /**
      * Returns all queries from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Query[]|Undefined
      */
-    getQueries: getQueries(join18(path6)),
+    getQueries: getQueries(join18(path8)),
     /**
      * Adds a query to EventCatalog
      *
@@ -2228,7 +2627,7 @@ var src_default = (path6) => {
      * @param options - Optional options to write the event
      *
      */
-    writeQuery: writeQuery(join18(path6, "queries")),
+    writeQuery: writeQuery(join18(path8, "queries")),
     /**
      * Adds a query to a service in EventCatalog
      *
@@ -2237,26 +2636,26 @@ var src_default = (path6) => {
      * @param options - Optional options to write the query
      *
      */
-    writeQueryToService: writeQueryToService(join18(path6)),
+    writeQueryToService: writeQueryToService(join18(path8)),
     /**
      * 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(join18(path6, "queries")),
+    rmQuery: rmQuery(join18(path8, "queries")),
     /**
      * Remove a query by a Query id
      *
      * @param id - The id of the query you want to remove
      *
      */
-    rmQueryById: rmQueryById(join18(path6)),
+    rmQueryById: rmQueryById(join18(path8)),
     /**
      * Moves a given query id to the version directory
      * @param directory
      */
-    versionQuery: versionQuery(join18(path6)),
+    versionQuery: versionQuery(join18(path8)),
     /**
      * Adds a file to the given query
      * @param id - The id of the query to add the file to
@@ -2264,7 +2663,7 @@ var src_default = (path6) => {
      * @param version - Optional version of the query to add the file to
      * @returns
      */
-    addFileToQuery: addFileToQuery(join18(path6)),
+    addFileToQuery: addFileToQuery(join18(path8)),
     /**
      * Adds a schema to the given query
      * @param id - The id of the query to add the schema to
@@ -2272,14 +2671,14 @@ var src_default = (path6) => {
      * @param version - Optional version of the query to add the schema to
      * @returns
      */
-    addSchemaToQuery: addSchemaToQuery(join18(path6)),
+    addSchemaToQuery: addSchemaToQuery(join18(path8)),
     /**
      * 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(join18(path6)),
+    queryHasVersion: queryHasVersion(join18(path8)),
     /**
      * ================================
      *            Channels
@@ -2291,13 +2690,13 @@ var src_default = (path6) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Channel|Undefined
      */
-    getChannel: getChannel(join18(path6)),
+    getChannel: getChannel(join18(path8)),
     /**
      * Returns all channels from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Channel[]|Undefined
      */
-    getChannels: getChannels(join18(path6)),
+    getChannels: getChannels(join18(path8)),
     /**
      * Adds an channel to EventCatalog
      *
@@ -2305,33 +2704,33 @@ var src_default = (path6) => {
      * @param options - Optional options to write the channel
      *
      */
-    writeChannel: writeChannel(join18(path6, "channels")),
+    writeChannel: writeChannel(join18(path8, "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(join18(path6, "channels")),
+    rmChannel: rmChannel(join18(path8, "channels")),
     /**
      * Remove an channel by an Event id
      *
      * @param id - The id of the channel you want to remove
      *
      */
-    rmChannelById: rmChannelById(join18(path6)),
+    rmChannelById: rmChannelById(join18(path8)),
     /**
      * Moves a given channel id to the version directory
      * @param directory
      */
-    versionChannel: versionChannel(join18(path6)),
+    versionChannel: versionChannel(join18(path8)),
     /**
      * 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(join18(path6)),
+    channelHasVersion: channelHasVersion(join18(path8)),
     /**
      * Add a channel to an event
      *
@@ -2348,7 +2747,7 @@ var src_default = (path6) => {
      *
      * ```
      */
-    addEventToChannel: addMessageToChannel(join18(path6), "events"),
+    addEventToChannel: addMessageToChannel(join18(path8), "events"),
     /**
      * Add a channel to an command
      *
@@ -2365,7 +2764,7 @@ var src_default = (path6) => {
      *
      * ```
      */
-    addCommandToChannel: addMessageToChannel(join18(path6), "commands"),
+    addCommandToChannel: addMessageToChannel(join18(path8), "commands"),
     /**
      * Add a channel to an query
      *
@@ -2382,7 +2781,7 @@ var src_default = (path6) => {
      *
      * ```
      */
-    addQueryToChannel: addMessageToChannel(join18(path6), "queries"),
+    addQueryToChannel: addMessageToChannel(join18(path8), "queries"),
     /**
      * ================================
      *            SERVICES
@@ -2395,14 +2794,14 @@ var src_default = (path6) => {
      * @param options - Optional options to write the event
      *
      */
-    writeService: writeService(join18(path6, "services")),
+    writeService: writeService(join18(path8, "services")),
     /**
      * Adds a versioned service to EventCatalog
      *
      * @param service - The service to write
      *
      */
-    writeVersionedService: writeVersionedService(join18(path6, "services")),
+    writeVersionedService: writeVersionedService(join18(path8, "services")),
     /**
      * Adds a service to a domain in EventCatalog
      *
@@ -2411,45 +2810,45 @@ var src_default = (path6) => {
      * @param options - Optional options to write the event
      *
      */
-    writeServiceToDomain: writeServiceToDomain(join18(path6, "domains")),
+    writeServiceToDomain: writeServiceToDomain(join18(path8, "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(join18(path6)),
+    getService: getService(join18(path8)),
     /**
      * Returns a service from EventCatalog by it's path.
      * @param path - The path to the service to retrieve
      * @returns Service|Undefined
      */
-    getServiceByPath: getServiceByPath(join18(path6)),
+    getServiceByPath: getServiceByPath(join18(path8)),
     /**
      * Returns all services from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Service[]|Undefined
      */
-    getServices: getServices(join18(path6)),
+    getServices: getServices(join18(path8)),
     /**
      * Moves a given service id to the version directory
      * @param directory
      */
-    versionService: versionService(join18(path6)),
+    versionService: versionService(join18(path8)),
     /**
      * Remove a service from EventCatalog (modeled on the standard POSIX rm utility)
      *
      * @param path - The path to your service, e.g. `/InventoryService`
      *
      */
-    rmService: rmService(join18(path6, "services")),
+    rmService: rmService(join18(path8, "services")),
     /**
      * Remove an service by an service id
      *
      * @param id - The id of the service you want to remove
      *
      */
-    rmServiceById: rmServiceById(join18(path6)),
+    rmServiceById: rmServiceById(join18(path8)),
     /**
      * Adds a file to the given service
      * @param id - The id of the service to add the file to
@@ -2457,21 +2856,21 @@ var src_default = (path6) => {
      * @param version - Optional version of the service to add the file to
      * @returns
      */
-    addFileToService: addFileToService(join18(path6)),
+    addFileToService: addFileToService(join18(path8)),
     /**
      * 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(join18(path6)),
+    getSpecificationFilesForService: getSpecificationFilesForService(join18(path8)),
     /**
      * 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(join18(path6)),
+    serviceHasVersion: serviceHasVersion(join18(path8)),
     /**
      * Add an event to a service by it's id.
      *
@@ -2491,7 +2890,7 @@ var src_default = (path6) => {
      *
      * ```
      */
-    addEventToService: addMessageToService(join18(path6)),
+    addEventToService: addMessageToService(join18(path8)),
     /**
      * Add a data store to a service by it's id.
      *
@@ -2508,7 +2907,7 @@ var src_default = (path6) => {
      *
      * ```
      */
-    addDataStoreToService: addDataStoreToService(join18(path6)),
+    addDataStoreToService: addDataStoreToService(join18(path8)),
     /**
      * Add a command to a service by it's id.
      *
@@ -2528,7 +2927,7 @@ var src_default = (path6) => {
      *
      * ```
      */
-    addCommandToService: addMessageToService(join18(path6)),
+    addCommandToService: addMessageToService(join18(path8)),
     /**
      * Add a query to a service by it's id.
      *
@@ -2548,7 +2947,7 @@ var src_default = (path6) => {
      *
      * ```
      */
-    addQueryToService: addMessageToService(join18(path6)),
+    addQueryToService: addMessageToService(join18(path8)),
     /**
      * Add an entity to a service by its id.
      *
@@ -2566,7 +2965,7 @@ var src_default = (path6) => {
      *
      * ```
      */
-    addEntityToService: addEntityToService(join18(path6)),
+    addEntityToService: addEntityToService(join18(path8)),
     /**
      * Check to see if a service exists by it's path.
      *
@@ -2583,13 +2982,13 @@ var src_default = (path6) => {
      * @param path - The path to the service to check
      * @returns boolean
      */
-    isService: isService(join18(path6)),
+    isService: isService(join18(path8)),
     /**
      * Converts a file to a service.
      * @param file - The file to convert to a service.
      * @returns The service.
      */
-    toService: toService(join18(path6)),
+    toService: toService(join18(path8)),
     /**
      * ================================
      *            Domains
@@ -2602,39 +3001,39 @@ var src_default = (path6) => {
      * @param options - Optional options to write the event
      *
      */
-    writeDomain: writeDomain(join18(path6, "domains")),
+    writeDomain: writeDomain(join18(path8, "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(join18(path6, "domains")),
+    getDomain: getDomain(join18(path8, "domains")),
     /**
      * Returns all domains from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Domain[]|Undefined
      */
-    getDomains: getDomains(join18(path6)),
+    getDomains: getDomains(join18(path8)),
     /**
      * Moves a given domain id to the version directory
      * @param directory
      */
-    versionDomain: versionDomain(join18(path6, "domains")),
+    versionDomain: versionDomain(join18(path8, "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(join18(path6, "domains")),
+    rmDomain: rmDomain(join18(path8, "domains")),
     /**
      * Remove an service by an domain id
      *
      * @param id - The id of the domain you want to remove
      *
      */
-    rmDomainById: rmDomainById(join18(path6, "domains")),
+    rmDomainById: rmDomainById(join18(path8, "domains")),
     /**
      * Adds a file to the given domain
      * @param id - The id of the domain to add the file to
@@ -2642,28 +3041,28 @@ var src_default = (path6) => {
      * @param version - Optional version of the domain to add the file to
      * @returns
      */
-    addFileToDomain: addFileToDomain(join18(path6, "domains")),
+    addFileToDomain: addFileToDomain(join18(path8, "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(join18(path6, "domains")),
+    addUbiquitousLanguageToDomain: addUbiquitousLanguageToDomain(join18(path8, "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(join18(path6, "domains")),
+    getUbiquitousLanguageFromDomain: getUbiquitousLanguageFromDomain(join18(path8, "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(join18(path6)),
+    domainHasVersion: domainHasVersion(join18(path8)),
     /**
      * Adds a given service to a domain
      * @param id - The id of the domain
@@ -2671,7 +3070,7 @@ var src_default = (path6) => {
      * @param version - (Optional) The version of the domain to add the service to
      * @returns
      */
-    addServiceToDomain: addServiceToDomain(join18(path6, "domains")),
+    addServiceToDomain: addServiceToDomain(join18(path8, "domains")),
     /**
      * Adds a given subdomain to a domain
      * @param id - The id of the domain
@@ -2679,7 +3078,7 @@ var src_default = (path6) => {
      * @param version - (Optional) The version of the domain to add the subdomain to
      * @returns
      */
-    addSubDomainToDomain: addSubDomainToDomain(join18(path6, "domains")),
+    addSubDomainToDomain: addSubDomainToDomain(join18(path8, "domains")),
     /**
      * Adds an entity to a domain
      * @param id - The id of the domain
@@ -2687,7 +3086,7 @@ var src_default = (path6) => {
      * @param version - (Optional) The version of the domain to add the entity to
      * @returns
      */
-    addEntityToDomain: addEntityToDomain(join18(path6, "domains")),
+    addEntityToDomain: addEntityToDomain(join18(path8, "domains")),
     /**
      * Add an event to a domain by its id.
      *
@@ -2705,7 +3104,7 @@ var src_default = (path6) => {
      *
      * ```
      */
-    addEventToDomain: addMessageToDomain(join18(path6, "domains")),
+    addEventToDomain: addMessageToDomain(join18(path8, "domains")),
     /**
      * Add a command to a domain by its id.
      *
@@ -2723,7 +3122,7 @@ var src_default = (path6) => {
      *
      * ```
      */
-    addCommandToDomain: addMessageToDomain(join18(path6, "domains")),
+    addCommandToDomain: addMessageToDomain(join18(path8, "domains")),
     /**
      * Add a query to a domain by its id.
      *
@@ -2741,7 +3140,7 @@ var src_default = (path6) => {
      *
      * ```
      */
-    addQueryToDomain: addMessageToDomain(join18(path6, "domains")),
+    addQueryToDomain: addMessageToDomain(join18(path8, "domains")),
     /**
      * ================================
      *            Teams
@@ -2754,25 +3153,25 @@ var src_default = (path6) => {
      * @param options - Optional options to write the team
      *
      */
-    writeTeam: writeTeam(join18(path6, "teams")),
+    writeTeam: writeTeam(join18(path8, "teams")),
     /**
      * Returns a team from EventCatalog
      * @param id - The id of the team to retrieve
      * @returns Team|Undefined
      */
-    getTeam: getTeam(join18(path6, "teams")),
+    getTeam: getTeam(join18(path8, "teams")),
     /**
      * Returns all teams from EventCatalog
      * @returns Team[]|Undefined
      */
-    getTeams: getTeams(join18(path6, "teams")),
+    getTeams: getTeams(join18(path8, "teams")),
     /**
      * Remove a team by the team id
      *
      * @param id - The id of the team you want to remove
      *
      */
-    rmTeamById: rmTeamById(join18(path6, "teams")),
+    rmTeamById: rmTeamById(join18(path8, "teams")),
     /**
      * ================================
      *            Users
@@ -2785,25 +3184,25 @@ var src_default = (path6) => {
      * @param options - Optional options to write the user
      *
      */
-    writeUser: writeUser(join18(path6, "users")),
+    writeUser: writeUser(join18(path8, "users")),
     /**
      * Returns a user from EventCatalog
      * @param id - The id of the user to retrieve
      * @returns User|Undefined
      */
-    getUser: getUser(join18(path6, "users")),
+    getUser: getUser(join18(path8, "users")),
     /**
      * Returns all user from EventCatalog
      * @returns User[]|Undefined
      */
-    getUsers: getUsers(join18(path6)),
+    getUsers: getUsers(join18(path8)),
     /**
      * Remove a user by the user id
      *
      * @param id - The id of the user you want to remove
      *
      */
-    rmUserById: rmUserById(join18(path6, "users")),
+    rmUserById: rmUserById(join18(path8, "users")),
     /**
      * ================================
      *            Custom Docs
@@ -2814,32 +3213,32 @@ var src_default = (path6) => {
      * @param path - The path to the custom doc to retrieve
      * @returns CustomDoc|Undefined
      */
-    getCustomDoc: getCustomDoc(join18(path6, "docs")),
+    getCustomDoc: getCustomDoc(join18(path8, "docs")),
     /**
      * Returns all custom docs from EventCatalog
      * @param options - Optional options to get custom docs from a specific path
      * @returns CustomDoc[]|Undefined
      */
-    getCustomDocs: getCustomDocs(join18(path6, "docs")),
+    getCustomDocs: getCustomDocs(join18(path8, "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(join18(path6, "docs")),
+    writeCustomDoc: writeCustomDoc(join18(path8, "docs")),
     /**
      * Removes a custom doc from EventCatalog
      * @param path - The path to the custom doc to remove
      *
      */
-    rmCustomDoc: rmCustomDoc(join18(path6, "docs")),
+    rmCustomDoc: rmCustomDoc(join18(path8, "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(join18(path6)),
+    dumpCatalog: dumpCatalog(join18(path8)),
     /**
      * Returns the event catalog configuration file.
      * The event catalog configuration file is the file that contains the configuration for the event catalog.
@@ -2847,7 +3246,47 @@ var src_default = (path6) => {
      * @param directory - The directory of the catalog.
      * @returns A JSON object with the configuration for the event catalog.
      */
-    getEventCatalogConfigurationFile: getEventCatalogConfigurationFile(join18(path6)),
+    getEventCatalogConfigurationFile: getEventCatalogConfigurationFile(join18(path8)),
+    /**
+     * ================================
+     *            Changelogs
+     * ================================
+     */
+    /**
+     * Writes a changelog entry to a resource in EventCatalog
+     *
+     * @param id - The id of the resource to write the changelog to
+     * @param changelog - The changelog entry to write
+     * @param options - Optional options (version, format)
+     *
+     */
+    writeChangelog: writeChangelog(join18(path8)),
+    /**
+     * Appends a changelog entry to an existing changelog for a resource.
+     * If no changelog exists, one is created.
+     *
+     * @param id - The id of the resource to append the changelog to
+     * @param changelog - The changelog entry to append
+     * @param options - Optional options (version, format)
+     *
+     */
+    appendChangelog: appendChangelog(join18(path8)),
+    /**
+     * Returns the changelog for a resource in EventCatalog
+     *
+     * @param id - The id of the resource to get the changelog for
+     * @param options - Optional options (version)
+     * @returns Changelog|Undefined
+     */
+    getChangelog: getChangelog(join18(path8)),
+    /**
+     * Removes the changelog for a resource in EventCatalog
+     *
+     * @param id - The id of the resource to remove the changelog from
+     * @param options - Optional options (version)
+     *
+     */
+    rmChangelog: rmChangelog(join18(path8)),
     /**
      * ================================
      *            Resources Utils
@@ -2872,33 +3311,33 @@ var src_default = (path6) => {
      * @param path - The path to the message to retrieve
      * @returns Message|Undefined
      */
-    getMessageBySchemaPath: getMessageBySchemaPath(join18(path6)),
+    getMessageBySchemaPath: getMessageBySchemaPath(join18(path8)),
     /**
      * 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(join18(path6)),
+    getProducersAndConsumersForMessage: getProducersAndConsumersForMessage(join18(path8)),
     /**
      * Returns the consumers of a given schema path
      * @param path - The path to the schema to get the consumers for
      * @returns Service[]
      */
-    getConsumersOfSchema: getConsumersOfSchema(join18(path6)),
+    getConsumersOfSchema: getConsumersOfSchema(join18(path8)),
     /**
      * Returns the producers of a given schema path
      * @param path - The path to the schema to get the producers for
      * @returns Service[]
      */
-    getProducersOfSchema: getProducersOfSchema(join18(path6)),
+    getProducersOfSchema: getProducersOfSchema(join18(path8)),
     /**
      * 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(join18(path6)),
+    getOwnersForResource: getOwnersForResource(join18(path8)),
     /**
      * ================================
      *            Entities
@@ -2910,13 +3349,13 @@ var src_default = (path6) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Entity|Undefined
      */
-    getEntity: getEntity(join18(path6)),
+    getEntity: getEntity(join18(path8)),
     /**
      * Returns all entities from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Entity[]|Undefined
      */
-    getEntities: getEntities(join18(path6)),
+    getEntities: getEntities(join18(path8)),
     /**
      * Adds an entity to EventCatalog
      *
@@ -2924,33 +3363,33 @@ var src_default = (path6) => {
      * @param options - Optional options to write the entity
      *
      */
-    writeEntity: writeEntity(join18(path6, "entities")),
+    writeEntity: writeEntity(join18(path8, "entities")),
     /**
      * Remove an entity from EventCatalog (modeled on the standard POSIX rm utility)
      *
      * @param path - The path to your entity, e.g. `/User`
      *
      */
-    rmEntity: rmEntity(join18(path6, "entities")),
+    rmEntity: rmEntity(join18(path8, "entities")),
     /**
      * Remove an entity by an entity id
      *
      * @param id - The id of the entity you want to remove
      *
      */
-    rmEntityById: rmEntityById(join18(path6)),
+    rmEntityById: rmEntityById(join18(path8)),
     /**
      * Moves a given entity id to the version directory
      * @param id - The id of the entity to version
      */
-    versionEntity: versionEntity(join18(path6)),
+    versionEntity: versionEntity(join18(path8)),
     /**
      * Check to see if an entity version exists
      * @param id - The id of the entity
      * @param version - The version of the entity (supports semver)
      * @returns
      */
-    entityHasVersion: entityHasVersion(join18(path6)),
+    entityHasVersion: entityHasVersion(join18(path8)),
     /**
      * ================================
      *            Data Stores
@@ -2962,42 +3401,42 @@ var src_default = (path6) => {
      * @param options - Optional options to write the data store
      *
      */
-    writeDataStore: writeDataStore(join18(path6, "containers")),
+    writeDataStore: writeDataStore(join18(path8, "containers")),
     /**
      * Returns a data store from EventCatalog
      * @param id - The id of the data store to retrieve
      * @param version - Optional id of the version to get (supports semver)
      * @returns Container|Undefined
      */
-    getDataStore: getDataStore(join18(path6)),
+    getDataStore: getDataStore(join18(path8)),
     /**
      * Returns all data stores from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Container[]|Undefined
      */
-    getDataStores: getDataStores(join18(path6)),
+    getDataStores: getDataStores(join18(path8)),
     /**
      * Version a data store by its id
      * @param id - The id of the data store to version
      */
-    versionDataStore: versionDataStore(join18(path6, "containers")),
+    versionDataStore: versionDataStore(join18(path8, "containers")),
     /**
      * Remove a data store by its path
      * @param path - The path to the data store to remove
      */
-    rmDataStore: rmDataStore(join18(path6, "containers")),
+    rmDataStore: rmDataStore(join18(path8, "containers")),
     /**
      * Remove a data store by its id
      * @param id - The id of the data store to remove
      */
-    rmDataStoreById: rmDataStoreById(join18(path6)),
+    rmDataStoreById: rmDataStoreById(join18(path8)),
     /**
      * Check to see if a data store version exists
      * @param id - The id of the data store
      * @param version - The version of the data store (supports semver)
      * @returns
      */
-    dataStoreHasVersion: dataStoreHasVersion(join18(path6)),
+    dataStoreHasVersion: dataStoreHasVersion(join18(path8)),
     /**
      * Adds a file to a data store by its id
      * @param id - The id of the data store to add the file to
@@ -3005,14 +3444,14 @@ var src_default = (path6) => {
      * @param version - Optional version of the data store to add the file to
      * @returns
      */
-    addFileToDataStore: addFileToDataStore(join18(path6)),
+    addFileToDataStore: addFileToDataStore(join18(path8)),
     /**
      * Writes a data store to a service by its id
      * @param dataStore - The data store to write
      * @param service - The service to write the data store to
      * @returns
      */
-    writeDataStoreToService: writeDataStoreToService(join18(path6)),
+    writeDataStoreToService: writeDataStoreToService(join18(path8)),
     /**
      * ================================
      *            Data Products
@@ -3024,7 +3463,7 @@ var src_default = (path6) => {
      * @param options - Optional options to write the data product
      *
      */
-    writeDataProduct: writeDataProduct(join18(path6, "data-products")),
+    writeDataProduct: writeDataProduct(join18(path8, "data-products")),
     /**
      * Writes a data product to a domain in EventCatalog
      * @param dataProduct - The data product to write
@@ -3032,43 +3471,43 @@ var src_default = (path6) => {
      * @param options - Optional options to write the data product
      *
      */
-    writeDataProductToDomain: writeDataProductToDomain(join18(path6, "domains")),
+    writeDataProductToDomain: writeDataProductToDomain(join18(path8, "domains")),
     /**
      * Returns a data product from EventCatalog
      * @param id - The id of the data product to retrieve
      * @param version - Optional id of the version to get (supports semver)
      * @returns DataProduct|Undefined
      */
-    getDataProduct: getDataProduct(join18(path6)),
+    getDataProduct: getDataProduct(join18(path8)),
     /**
      * Returns all data products from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns DataProduct[]|Undefined
      */
-    getDataProducts: getDataProducts(join18(path6)),
+    getDataProducts: getDataProducts(join18(path8)),
     /**
      * Version a data product by its id
      * @param id - The id of the data product to version
      */
-    versionDataProduct: versionDataProduct(join18(path6)),
+    versionDataProduct: versionDataProduct(join18(path8)),
     /**
      * Remove a data product by its path
      * @param path - The path to the data product to remove
      */
-    rmDataProduct: rmDataProduct(join18(path6, "data-products")),
+    rmDataProduct: rmDataProduct(join18(path8, "data-products")),
     /**
      * Remove a data product by its id
      * @param id - The id of the data product to remove
      * @param version - Optional version of the data product to remove
      */
-    rmDataProductById: rmDataProductById(join18(path6)),
+    rmDataProductById: rmDataProductById(join18(path8)),
     /**
      * Check to see if a data product version exists
      * @param id - The id of the data product
      * @param version - The version of the data product (supports semver)
      * @returns
      */
-    dataProductHasVersion: dataProductHasVersion(join18(path6)),
+    dataProductHasVersion: dataProductHasVersion(join18(path8)),
     /**
      * Adds a file to a data product by its id
      * @param id - The id of the data product to add the file to
@@ -3076,7 +3515,7 @@ var src_default = (path6) => {
      * @param version - Optional version of the data product to add the file to
      * @returns
      */
-    addFileToDataProduct: addFileToDataProduct(join18(path6)),
+    addFileToDataProduct: addFileToDataProduct(join18(path8)),
     /**
      * Adds a data product to a domain
      * @param id - The id of the domain
@@ -3084,7 +3523,7 @@ var src_default = (path6) => {
      * @param version - (Optional) The version of the domain to add the data product to
      * @returns
      */
-    addDataProductToDomain: addDataProductToDomain(join18(path6, "domains")),
+    addDataProductToDomain: addDataProductToDomain(join18(path8, "domains")),
     /**
      * ================================
      *            Diagrams
@@ -3096,13 +3535,13 @@ var src_default = (path6) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Diagram|Undefined
      */
-    getDiagram: getDiagram(join18(path6)),
+    getDiagram: getDiagram(join18(path8)),
     /**
      * Returns all diagrams from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Diagram[]|Undefined
      */
-    getDiagrams: getDiagrams(join18(path6)),
+    getDiagrams: getDiagrams(join18(path8)),
     /**
      * Adds a diagram to EventCatalog
      *
@@ -3110,33 +3549,33 @@ var src_default = (path6) => {
      * @param options - Optional options to write the diagram
      *
      */
-    writeDiagram: writeDiagram(join18(path6, "diagrams")),
+    writeDiagram: writeDiagram(join18(path8, "diagrams")),
     /**
      * Remove a diagram from EventCatalog (modeled on the standard POSIX rm utility)
      *
      * @param path - The path to your diagram, e.g. `/ArchitectureDiagram`
      *
      */
-    rmDiagram: rmDiagram(join18(path6, "diagrams")),
+    rmDiagram: rmDiagram(join18(path8, "diagrams")),
     /**
      * Remove a diagram by a diagram id
      *
      * @param id - The id of the diagram you want to remove
      *
      */
-    rmDiagramById: rmDiagramById(join18(path6)),
+    rmDiagramById: rmDiagramById(join18(path8)),
     /**
      * Moves a given diagram id to the version directory
      * @param id - The id of the diagram to version
      */
-    versionDiagram: versionDiagram(join18(path6)),
+    versionDiagram: versionDiagram(join18(path8)),
     /**
      * Check to see if a diagram version exists
      * @param id - The id of the diagram
      * @param version - The version of the diagram (supports semver)
      * @returns
      */
-    diagramHasVersion: diagramHasVersion(join18(path6)),
+    diagramHasVersion: diagramHasVersion(join18(path8)),
     /**
      * Adds a file to the given diagram
      * @param id - The id of the diagram to add the file to
@@ -3144,7 +3583,7 @@ var src_default = (path6) => {
      * @param version - Optional version of the diagram to add the file to
      * @returns
      */
-    addFileToDiagram: addFileToDiagram(join18(path6)),
+    addFileToDiagram: addFileToDiagram(join18(path8)),
     /**
      * ================================
      *            DSL
@@ -3163,18 +3602,21 @@ var src_default = (path6) => {
      * const dsl = await sdk.toDSL(services, { type: 'service', hydrate: true });
      * ```
      */
-    toDSL: toDSL(join18(path6), {
-      getEvent: getEvent(join18(path6)),
-      getCommand: getCommand(join18(path6)),
-      getQuery: getQuery(join18(path6)),
-      getService: getService(join18(path6)),
-      getServices: getServices(join18(path6)),
-      getDomain: getDomain(join18(path6, "domains")),
-      getChannel: getChannel(join18(path6)),
-      getChannels: getChannels(join18(path6)),
-      getContainer: getDataStore(join18(path6)),
-      getTeam: getTeam(join18(path6, "teams")),
-      getUser: getUser(join18(path6, "users"))
+    createSnapshot: createSnapshot(join18(path8)),
+    diffSnapshots: diffSnapshots(join18(path8)),
+    listSnapshots: listSnapshots(join18(path8)),
+    toDSL: toDSL(join18(path8), {
+      getEvent: getEvent(join18(path8)),
+      getCommand: getCommand(join18(path8)),
+      getQuery: getQuery(join18(path8)),
+      getService: getService(join18(path8)),
+      getServices: getServices(join18(path8)),
+      getDomain: getDomain(join18(path8, "domains")),
+      getChannel: getChannel(join18(path8)),
+      getChannels: getChannels(join18(path8)),
+      getContainer: getDataStore(join18(path8)),
+      getTeam: getTeam(join18(path8, "teams")),
+      getUser: getUser(join18(path8, "users"))
     })
   };
 };