@eventcatalog/sdk 2.2.0 → 2.2.2

package/dist/index.js

@@ -33,7 +33,7 @@ __export(index_exports, {
   default: () => index_default
 });
 module.exports = __toCommonJS(index_exports);
-var import_node_path11 = require("path");
+var import_node_path12 = require("path");
 
 // src/events.ts
 var import_promises2 = __toESM(require("fs/promises"));
@@ -54,13 +54,13 @@ var versionExists = async (catalogDir, id, version) => {
 var findFileById = async (catalogDir, id, version) => {
   const files = await getFiles(`${catalogDir}/**/index.{md,mdx}`);
   const matchedFiles = await searchFilesForId(files, id) || [];
-  const latestVersion = matchedFiles.find((path3) => !path3.includes("versioned"));
+  const latestVersion = matchedFiles.find((path4) => !path4.includes("versioned"));
   if (!version) {
     return latestVersion;
   }
-  const parsedFiles = matchedFiles.map((path3) => {
-    const { data } = import_gray_matter.default.read(path3);
-    return { ...data, path: path3 };
+  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)) {
@@ -84,8 +84,8 @@ var getFiles = async (pattern, ignore = "") => {
     throw new Error(`Error finding files: ${error}`);
   }
 };
-var readMdxFile = async (path3) => {
-  const { data } = import_gray_matter.default.read(path3);
+var readMdxFile = async (path4) => {
+  const { data } = import_gray_matter.default.read(path4);
   const { markdown, ...frontmatter } = data;
   return { ...frontmatter, markdown };
 };
@@ -166,8 +166,8 @@ var writeResource = async (catalogDir, resource, options = {
   override: false,
   versionExistingContent: false
 }) => {
-  const path3 = options.path || `/${resource.id}`;
-  const fullPath = (0, import_path.join)(catalogDir, path3);
+  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)) {
@@ -287,8 +287,8 @@ var writeEventToService = (directory) => async (event, service, options = { path
   pathForEvent = (0, import_node_path2.join)(pathForEvent, event.id);
   await writeResource(directory, { ...event }, { ...options, path: pathForEvent, type: "event" });
 };
-var rmEvent = (directory) => async (path3) => {
-  await import_promises2.default.rm((0, import_node_path2.join)(directory, path3), { recursive: true });
+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 });
@@ -318,8 +318,8 @@ var writeCommandToService = (directory) => async (command, service, options = {
   pathForCommand = (0, import_node_path3.join)(pathForCommand, command.id);
   await writeResource(directory, { ...command }, { ...options, path: pathForCommand, type: "command" });
 };
-var rmCommand = (directory) => async (path3) => {
-  await import_promises3.default.rm((0, import_node_path3.join)(directory, path3), { recursive: true });
+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);
@@ -347,8 +347,8 @@ var writeQueryToService = (directory) => async (query, service, options = { path
   pathForQuery = (0, import_node_path4.join)(pathForQuery, query.id);
   await writeResource(directory, { ...query }, { ...options, path: pathForQuery, type: "query" });
 };
-var rmQuery = (directory) => async (path3) => {
-  await import_promises4.default.rm((0, import_node_path4.join)(directory, path3), { recursive: true });
+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 });
@@ -384,8 +384,8 @@ var writeService = (directory) => async (service, options = { path: "" }) => {
 };
 var writeVersionedService = (directory) => async (service) => {
   const resource = { ...service };
-  const path3 = getVersionedDirectory(service.id, service.version);
-  return await writeService(directory)(resource, { path: path3 });
+  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`;
@@ -393,8 +393,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 (path3) => {
-  await import_promises5.default.rm((0, import_node_path5.join)(directory, path3), { recursive: true });
+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);
@@ -447,8 +447,8 @@ var addMessageToService = (directory) => async (id, direction, event, version) =
   if (!existingResource) {
     throw new Error(`Cannot find service ${id} in the catalog`);
   }
-  const path3 = existingResource.split("/services")[0];
-  const pathToResource = (0, import_node_path5.join)(path3, "services");
+  const path4 = existingResource.split("/services")[0];
+  const pathToResource = (0, import_node_path5.join)(path4, "services");
   await rmServiceById(directory)(id, version);
   await writeService(pathToResource)(service);
 };
@@ -476,8 +476,8 @@ var writeDomain = (directory) => async (domain, options = { path: "" }) => {
   return await writeResource(directory, resource, { ...options, type: "domain" });
 };
 var versionDomain = (directory) => async (id) => versionResource(directory, id);
-var rmDomain = (directory) => async (path3) => {
-  await import_promises6.default.rm((0, import_node_path6.join)(directory, path3), { recursive: true });
+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);
@@ -521,8 +521,8 @@ 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 (path3) => {
-  await import_promises7.default.rm((0, import_node_path7.join)(directory, path3), { recursive: true });
+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);
@@ -561,20 +561,103 @@ var addMessageToChannel = (directory, collection) => async (id, _message, versio
   if (!existingResource) {
     throw new Error(`Cannot find message ${id} in the catalog`);
   }
-  const path3 = existingResource.split(`/${collection}`)[0];
-  const pathToResource = (0, import_node_path7.join)(path3, collection);
+  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
+// src/eventcatalog.ts
+var import_fs = __toESM(require("fs"));
 var import_node_path8 = __toESM(require("path"));
+var DUMP_VERSION = "0.0.1";
+var getEventCatalogVersion = async (catalogDir) => {
+  const packageJson = import_fs.default.readFileSync((0, import_node_path8.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_path8.default.join(import_node_path8.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 })
+    }
+  };
+};
+
+// src/custom-docs.ts
+var import_node_path9 = __toESM(require("path"));
 var import_node_fs4 = __toESM(require("fs"));
 var import_promises8 = __toESM(require("fs/promises"));
 var import_gray_matter4 = __toESM(require("gray-matter"));
 var import_slugify = __toESM(require("slugify"));
 var getCustomDoc = (directory) => async (filePath) => {
-  const fullPath = import_node_path8.default.join(directory, filePath);
+  const fullPath = import_node_path9.default.join(directory, filePath);
   const fullPathWithExtension = fullPath.endsWith(".mdx") ? fullPath : `${fullPath}.mdx`;
   const fileExists = import_node_fs4.default.existsSync(fullPathWithExtension);
   if (!fileExists) {
@@ -593,23 +676,23 @@ 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 fullPath = import_node_path9.default.join(directory, options.path || "", withExtension);
+  import_node_fs4.default.mkdirSync(import_node_path9.default.dirname(fullPath), { recursive: true });
   const document = import_gray_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 });
+  await import_promises8.default.rm((0, import_node_path9.join)(directory, withExtension), { recursive: true });
 };
 
 // src/teams.ts
 var import_promises9 = __toESM(require("fs/promises"));
 var import_node_fs5 = __toESM(require("fs"));
-var import_node_path9 = require("path");
+var import_node_path10 = require("path");
 var import_gray_matter5 = __toESM(require("gray-matter"));
 var getTeam = (catalogDir) => async (id) => {
-  const files = await getFiles(`${catalogDir}/${id}.md`);
+  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);
@@ -621,7 +704,7 @@ var getTeam = (catalogDir) => async (id) => {
   };
 };
 var getTeams = (catalogDir) => async (options) => {
-  const files = await getFiles(`${catalogDir}/teams/*.md`);
+  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);
@@ -642,19 +725,19 @@ var writeTeam = (catalogDir) => async (team, options = {}) => {
   }
   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}.md`), document);
+  import_node_fs5.default.mkdirSync((0, import_node_path10.join)(catalogDir, ""), { recursive: true });
+  import_node_fs5.default.writeFileSync((0, import_node_path10.join)(catalogDir, "", `${resource.id}.mdx`), document);
 };
 var rmTeamById = (catalogDir) => async (id) => {
-  await import_promises9.default.rm((0, import_node_path9.join)(catalogDir, `${id}.md`), { recursive: true });
+  await import_promises9.default.rm((0, import_node_path10.join)(catalogDir, `${id}.mdx`), { recursive: true });
 };
 
 // src/users.ts
 var import_node_fs6 = __toESM(require("fs"));
-var import_node_path10 = require("path");
+var import_node_path11 = require("path");
 var import_gray_matter6 = __toESM(require("gray-matter"));
 var getUser = (catalogDir) => async (id) => {
-  const files = await getFiles(`${catalogDir}/${id}.md`);
+  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);
@@ -667,7 +750,7 @@ var getUser = (catalogDir) => async (id) => {
   };
 };
 var getUsers = (catalogDir) => async (options) => {
-  const files = await getFiles(`${catalogDir}/users/*.md`);
+  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);
@@ -689,15 +772,15 @@ var writeUser = (catalogDir) => async (user, options = {}) => {
   }
   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}.md`), document);
+  import_node_fs6.default.mkdirSync((0, import_node_path11.join)(catalogDir, ""), { recursive: true });
+  import_node_fs6.default.writeFileSync((0, import_node_path11.join)(catalogDir, "", `${resource.id}.mdx`), document);
 };
 var rmUserById = (catalogDir) => async (id) => {
-  import_node_fs6.default.rmSync((0, import_node_path10.join)(catalogDir, `${id}.md`), { recursive: true });
+  import_node_fs6.default.rmSync((0, import_node_path11.join)(catalogDir, `${id}.mdx`), { recursive: true });
 };
 
 // src/index.ts
-var index_default = (path3) => {
+var index_default = (path4) => {
   return {
     /**
      * Returns an events from EventCatalog
@@ -705,13 +788,13 @@ var index_default = (path3) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Event|Undefined
      */
-    getEvent: getEvent((0, import_node_path11.join)(path3)),
+    getEvent: getEvent((0, import_node_path12.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)(path3)),
+    getEvents: getEvents((0, import_node_path12.join)(path4)),
     /**
      * Adds an event to EventCatalog
      *
@@ -719,7 +802,7 @@ var index_default = (path3) => {
      * @param options - Optional options to write the event
      *
      */
-    writeEvent: writeEvent((0, import_node_path11.join)(path3, "events")),
+    writeEvent: writeEvent((0, import_node_path12.join)(path4, "events")),
     /**
      * Adds an event to a service in EventCatalog
      *
@@ -728,26 +811,26 @@ var index_default = (path3) => {
      * @param options - Optional options to write the event
      *
      */
-    writeEventToService: writeEventToService((0, import_node_path11.join)(path3)),
+    writeEventToService: writeEventToService((0, import_node_path12.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)(path3, "events")),
+    rmEvent: rmEvent((0, import_node_path12.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)(path3)),
+    rmEventById: rmEventById((0, import_node_path12.join)(path4)),
     /**
      * Moves a given event id to the version directory
      * @param directory
      */
-    versionEvent: versionEvent((0, import_node_path11.join)(path3)),
+    versionEvent: versionEvent((0, import_node_path12.join)(path4)),
     /**
      * Adds a file to the given event
      * @param id - The id of the event to add the file to
@@ -755,7 +838,7 @@ var index_default = (path3) => {
      * @param version - Optional version of the event to add the file to
      * @returns
      */
-    addFileToEvent: addFileToEvent((0, import_node_path11.join)(path3)),
+    addFileToEvent: addFileToEvent((0, import_node_path12.join)(path4)),
     /**
      * Adds a schema to the given event
      * @param id - The id of the event to add the schema to
@@ -763,14 +846,14 @@ var index_default = (path3) => {
      * @param version - Optional version of the event to add the schema to
      * @returns
      */
-    addSchemaToEvent: addSchemaToEvent((0, import_node_path11.join)(path3)),
+    addSchemaToEvent: addSchemaToEvent((0, import_node_path12.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)(path3)),
+    eventHasVersion: eventHasVersion((0, import_node_path12.join)(path4)),
     /**
      * ================================
      *            Commands
@@ -782,13 +865,13 @@ var index_default = (path3) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Command|Undefined
      */
-    getCommand: getCommand((0, import_node_path11.join)(path3)),
+    getCommand: getCommand((0, import_node_path12.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)(path3)),
+    getCommands: getCommands((0, import_node_path12.join)(path4)),
     /**
      * Adds an command to EventCatalog
      *
@@ -796,7 +879,7 @@ var index_default = (path3) => {
      * @param options - Optional options to write the command
      *
      */
-    writeCommand: writeCommand((0, import_node_path11.join)(path3, "commands")),
+    writeCommand: writeCommand((0, import_node_path12.join)(path4, "commands")),
     /**
      * Adds a command to a service in EventCatalog
      *
@@ -805,26 +888,26 @@ var index_default = (path3) => {
      * @param options - Optional options to write the command
      *
      */
-    writeCommandToService: writeCommandToService((0, import_node_path11.join)(path3)),
+    writeCommandToService: writeCommandToService((0, import_node_path12.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)(path3, "commands")),
+    rmCommand: rmCommand((0, import_node_path12.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)(path3)),
+    rmCommandById: rmCommandById((0, import_node_path12.join)(path4)),
     /**
      * Moves a given command id to the version directory
      * @param directory
      */
-    versionCommand: versionCommand((0, import_node_path11.join)(path3)),
+    versionCommand: versionCommand((0, import_node_path12.join)(path4)),
     /**
      * Adds a file to the given command
      * @param id - The id of the command to add the file to
@@ -832,7 +915,7 @@ var index_default = (path3) => {
      * @param version - Optional version of the command to add the file to
      * @returns
      */
-    addFileToCommand: addFileToCommand((0, import_node_path11.join)(path3)),
+    addFileToCommand: addFileToCommand((0, import_node_path12.join)(path4)),
     /**
      * Adds a schema to the given command
      * @param id - The id of the command to add the schema to
@@ -840,14 +923,14 @@ var index_default = (path3) => {
      * @param version - Optional version of the command to add the schema to
      * @returns
      */
-    addSchemaToCommand: addSchemaToCommand((0, import_node_path11.join)(path3)),
+    addSchemaToCommand: addSchemaToCommand((0, import_node_path12.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)(path3)),
+    commandHasVersion: commandHasVersion((0, import_node_path12.join)(path4)),
     /**
      * ================================
      *            Queries
@@ -859,13 +942,13 @@ var index_default = (path3) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Query|Undefined
      */
-    getQuery: getQuery((0, import_node_path11.join)(path3)),
+    getQuery: getQuery((0, import_node_path12.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)(path3)),
+    getQueries: getQueries((0, import_node_path12.join)(path4)),
     /**
      * Adds a query to EventCatalog
      *
@@ -873,7 +956,7 @@ var index_default = (path3) => {
      * @param options - Optional options to write the event
      *
      */
-    writeQuery: writeQuery((0, import_node_path11.join)(path3, "queries")),
+    writeQuery: writeQuery((0, import_node_path12.join)(path4, "queries")),
     /**
      * Adds a query to a service in EventCatalog
      *
@@ -882,26 +965,26 @@ var index_default = (path3) => {
      * @param options - Optional options to write the query
      *
      */
-    writeQueryToService: writeQueryToService((0, import_node_path11.join)(path3)),
+    writeQueryToService: writeQueryToService((0, import_node_path12.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)(path3, "queries")),
+    rmQuery: rmQuery((0, import_node_path12.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)(path3)),
+    rmQueryById: rmQueryById((0, import_node_path12.join)(path4)),
     /**
      * Moves a given query id to the version directory
      * @param directory
      */
-    versionQuery: versionQuery((0, import_node_path11.join)(path3)),
+    versionQuery: versionQuery((0, import_node_path12.join)(path4)),
     /**
      * Adds a file to the given query
      * @param id - The id of the query to add the file to
@@ -909,7 +992,7 @@ var index_default = (path3) => {
      * @param version - Optional version of the query to add the file to
      * @returns
      */
-    addFileToQuery: addFileToQuery((0, import_node_path11.join)(path3)),
+    addFileToQuery: addFileToQuery((0, import_node_path12.join)(path4)),
     /**
      * Adds a schema to the given query
      * @param id - The id of the query to add the schema to
@@ -917,14 +1000,14 @@ var index_default = (path3) => {
      * @param version - Optional version of the query to add the schema to
      * @returns
      */
-    addSchemaToQuery: addSchemaToQuery((0, import_node_path11.join)(path3)),
+    addSchemaToQuery: addSchemaToQuery((0, import_node_path12.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)(path3)),
+    queryHasVersion: queryHasVersion((0, import_node_path12.join)(path4)),
     /**
      * ================================
      *            Channels
@@ -936,13 +1019,13 @@ var index_default = (path3) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Channel|Undefined
      */
-    getChannel: getChannel((0, import_node_path11.join)(path3)),
+    getChannel: getChannel((0, import_node_path12.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)(path3)),
+    getChannels: getChannels((0, import_node_path12.join)(path4)),
     /**
      * Adds an channel to EventCatalog
      *
@@ -950,33 +1033,33 @@ var index_default = (path3) => {
      * @param options - Optional options to write the channel
      *
      */
-    writeChannel: writeChannel((0, import_node_path11.join)(path3, "channels")),
+    writeChannel: writeChannel((0, import_node_path12.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)(path3, "channels")),
+    rmChannel: rmChannel((0, import_node_path12.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)(path3)),
+    rmChannelById: rmChannelById((0, import_node_path12.join)(path4)),
     /**
      * Moves a given channel id to the version directory
      * @param directory
      */
-    versionChannel: versionChannel((0, import_node_path11.join)(path3)),
+    versionChannel: versionChannel((0, import_node_path12.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)(path3)),
+    channelHasVersion: channelHasVersion((0, import_node_path12.join)(path4)),
     /**
      * Add a channel to an event
      *
@@ -993,7 +1076,7 @@ var index_default = (path3) => {
      *
      * ```
      */
-    addEventToChannel: addMessageToChannel((0, import_node_path11.join)(path3), "events"),
+    addEventToChannel: addMessageToChannel((0, import_node_path12.join)(path4), "events"),
     /**
      * Add a channel to an command
      *
@@ -1010,7 +1093,7 @@ var index_default = (path3) => {
      *
      * ```
      */
-    addCommandToChannel: addMessageToChannel((0, import_node_path11.join)(path3), "commands"),
+    addCommandToChannel: addMessageToChannel((0, import_node_path12.join)(path4), "commands"),
     /**
      * Add a channel to an query
      *
@@ -1027,7 +1110,7 @@ var index_default = (path3) => {
      *
      * ```
      */
-    addQueryToChannel: addMessageToChannel((0, import_node_path11.join)(path3), "queries"),
+    addQueryToChannel: addMessageToChannel((0, import_node_path12.join)(path4), "queries"),
     /**
      * ================================
      *            SERVICES
@@ -1040,14 +1123,14 @@ var index_default = (path3) => {
      * @param options - Optional options to write the event
      *
      */
-    writeService: writeService((0, import_node_path11.join)(path3, "services")),
+    writeService: writeService((0, import_node_path12.join)(path4, "services")),
     /**
      * Adds a versioned service to EventCatalog
      *
      * @param service - The service to write
      *
      */
-    writeVersionedService: writeVersionedService((0, import_node_path11.join)(path3, "services")),
+    writeVersionedService: writeVersionedService((0, import_node_path12.join)(path4, "services")),
     /**
      * Adds a service to a domain in EventCatalog
      *
@@ -1056,39 +1139,39 @@ var index_default = (path3) => {
      * @param options - Optional options to write the event
      *
      */
-    writeServiceToDomain: writeServiceToDomain((0, import_node_path11.join)(path3, "domains")),
+    writeServiceToDomain: writeServiceToDomain((0, import_node_path12.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)(path3)),
+    getService: getService((0, import_node_path12.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)(path3)),
+    getServices: getServices((0, import_node_path12.join)(path4)),
     /**
      * Moves a given service id to the version directory
      * @param directory
      */
-    versionService: versionService((0, import_node_path11.join)(path3)),
+    versionService: versionService((0, import_node_path12.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)(path3, "services")),
+    rmService: rmService((0, import_node_path12.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)(path3)),
+    rmServiceById: rmServiceById((0, import_node_path12.join)(path4)),
     /**
      * Adds a file to the given service
      * @param id - The id of the service to add the file to
@@ -1096,21 +1179,21 @@ var index_default = (path3) => {
      * @param version - Optional version of the service to add the file to
      * @returns
      */
-    addFileToService: addFileToService((0, import_node_path11.join)(path3)),
+    addFileToService: addFileToService((0, import_node_path12.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)(path3)),
+    getSpecificationFilesForService: getSpecificationFilesForService((0, import_node_path12.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)(path3)),
+    serviceHasVersion: serviceHasVersion((0, import_node_path12.join)(path4)),
     /**
      * Add an event to a service by it's id.
      *
@@ -1130,7 +1213,7 @@ var index_default = (path3) => {
      *
      * ```
      */
-    addEventToService: addMessageToService((0, import_node_path11.join)(path3)),
+    addEventToService: addMessageToService((0, import_node_path12.join)(path4)),
     /**
      * Add a command to a service by it's id.
      *
@@ -1150,7 +1233,7 @@ var index_default = (path3) => {
      *
      * ```
      */
-    addCommandToService: addMessageToService((0, import_node_path11.join)(path3)),
+    addCommandToService: addMessageToService((0, import_node_path12.join)(path4)),
     /**
      * Add a query to a service by it's id.
      *
@@ -1170,7 +1253,7 @@ var index_default = (path3) => {
      *
      * ```
      */
-    addQueryToService: addMessageToService((0, import_node_path11.join)(path3)),
+    addQueryToService: addMessageToService((0, import_node_path12.join)(path4)),
     /**
      * ================================
      *            Domains
@@ -1183,39 +1266,39 @@ var index_default = (path3) => {
      * @param options - Optional options to write the event
      *
      */
-    writeDomain: writeDomain((0, import_node_path11.join)(path3, "domains")),
+    writeDomain: writeDomain((0, import_node_path12.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)(path3, "domains")),
+    getDomain: getDomain((0, import_node_path12.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)(path3)),
+    getDomains: getDomains((0, import_node_path12.join)(path4)),
     /**
      * Moves a given domain id to the version directory
      * @param directory
      */
-    versionDomain: versionDomain((0, import_node_path11.join)(path3, "domains")),
+    versionDomain: versionDomain((0, import_node_path12.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)(path3, "domains")),
+    rmDomain: rmDomain((0, import_node_path12.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)(path3, "domains")),
+    rmDomainById: rmDomainById((0, import_node_path12.join)(path4, "domains")),
     /**
      * Adds a file to the given domain
      * @param id - The id of the domain to add the file to
@@ -1223,28 +1306,28 @@ var index_default = (path3) => {
      * @param version - Optional version of the domain to add the file to
      * @returns
      */
-    addFileToDomain: addFileToDomain((0, import_node_path11.join)(path3, "domains")),
+    addFileToDomain: addFileToDomain((0, import_node_path12.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)(path3, "domains")),
+    addUbiquitousLanguageToDomain: addUbiquitousLanguageToDomain((0, import_node_path12.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)(path3, "domains")),
+    getUbiquitousLanguageFromDomain: getUbiquitousLanguageFromDomain((0, import_node_path12.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)(path3)),
+    domainHasVersion: domainHasVersion((0, import_node_path12.join)(path4)),
     /**
      * Adds a given service to a domain
      * @param id - The id of the domain
@@ -1252,7 +1335,7 @@ var index_default = (path3) => {
      * @param version - (Optional) The version of the domain to add the service to
      * @returns
      */
-    addServiceToDomain: addServiceToDomain((0, import_node_path11.join)(path3, "domains")),
+    addServiceToDomain: addServiceToDomain((0, import_node_path12.join)(path4, "domains")),
     /**
      * ================================
      *            Teams
@@ -1265,25 +1348,25 @@ var index_default = (path3) => {
      * @param options - Optional options to write the team
      *
      */
-    writeTeam: writeTeam((0, import_node_path11.join)(path3, "teams")),
+    writeTeam: writeTeam((0, import_node_path12.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)(path3, "teams")),
+    getTeam: getTeam((0, import_node_path12.join)(path4, "teams")),
     /**
      * Returns all teams from EventCatalog
      * @returns Team[]|Undefined
      */
-    getTeams: getTeams((0, import_node_path11.join)(path3)),
+    getTeams: getTeams((0, import_node_path12.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)(path3, "teams")),
+    rmTeamById: rmTeamById((0, import_node_path12.join)(path4, "teams")),
     /**
      * ================================
      *            Users
@@ -1296,25 +1379,25 @@ var index_default = (path3) => {
      * @param options - Optional options to write the user
      *
      */
-    writeUser: writeUser((0, import_node_path11.join)(path3, "users")),
+    writeUser: writeUser((0, import_node_path12.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)(path3, "users")),
+    getUser: getUser((0, import_node_path12.join)(path4, "users")),
     /**
      * Returns all user from EventCatalog
      * @returns User[]|Undefined
      */
-    getUsers: getUsers((0, import_node_path11.join)(path3)),
+    getUsers: getUsers((0, import_node_path12.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)(path3, "users")),
+    rmUserById: rmUserById((0, import_node_path12.join)(path4, "users")),
     /**
      * ================================
      *            Custom Docs
@@ -1325,26 +1408,32 @@ var index_default = (path3) => {
      * @param path - The path to the custom doc to retrieve
      * @returns CustomDoc|Undefined
      */
-    getCustomDoc: getCustomDoc((0, import_node_path11.join)(path3, "docs")),
+    getCustomDoc: getCustomDoc((0, import_node_path12.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)(path3, "docs")),
+    getCustomDocs: getCustomDocs((0, import_node_path12.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)(path3, "docs")),
+    writeCustomDoc: writeCustomDoc((0, import_node_path12.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)(path3, "docs"))
+    rmCustomDoc: rmCustomDoc((0, import_node_path12.join)(path4, "docs")),
+    /**
+     * Dumps the catalog to a JSON file.
+     * @param directory - The directory to dump the catalog to
+     * @returns A JSON file with the catalog
+     */
+    dumpCatalog: dumpCatalog((0, import_node_path12.join)(path4))
   };
 };
 //# sourceMappingURL=index.js.map