@eventcatalog/sdk 2.2.0 → 2.2.2

package/dist/index.mjs

@@ -1,5 +1,5 @@
 // src/index.ts
-import { join as join12 } from "node:path";
+import { join as join13 } from "node:path";
 
 // src/events.ts
 import fs2 from "node:fs/promises";
@@ -20,13 +20,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 } = matter.read(path3);
-    return { ...data, path: path3 };
+  const parsedFiles = matchedFiles.map((path4) => {
+    const { data } = matter.read(path4);
+    return { ...data, path: path4 };
   });
   const semverRange = validRange(version);
   if (semverRange && valid(version)) {
@@ -50,8 +50,8 @@ var getFiles = async (pattern, ignore = "") => {
     throw new Error(`Error finding files: ${error}`);
   }
 };
-var readMdxFile = async (path3) => {
-  const { data } = matter.read(path3);
+var readMdxFile = async (path4) => {
+  const { data } = matter.read(path4);
   const { markdown, ...frontmatter } = data;
   return { ...frontmatter, markdown };
 };
@@ -132,8 +132,8 @@ var writeResource = async (catalogDir, resource, options = {
   override: false,
   versionExistingContent: false
 }) => {
-  const path3 = options.path || `/${resource.id}`;
-  const fullPath = join2(catalogDir, path3);
+  const path4 = options.path || `/${resource.id}`;
+  const fullPath = join2(catalogDir, path4);
   fsSync2.mkdirSync(fullPath, { recursive: true });
   const lockPath = join2(fullPath, "index.mdx");
   if (!fsSync2.existsSync(lockPath)) {
@@ -253,8 +253,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 (path3) => {
-  await fs2.rm(join3(directory, path3), { recursive: true });
+var rmEvent = (directory) => async (path4) => {
+  await fs2.rm(join3(directory, path4), { recursive: true });
 };
 var rmEventById = (directory) => async (id, version, persistFiles) => {
   await rmResourceById(directory, id, version, { type: "event", persistFiles });
@@ -284,8 +284,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 (path3) => {
-  await fs3.rm(join4(directory, path3), { recursive: true });
+var rmCommand = (directory) => async (path4) => {
+  await fs3.rm(join4(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);
@@ -313,8 +313,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 (path3) => {
-  await fs4.rm(join5(directory, path3), { recursive: true });
+var rmQuery = (directory) => async (path4) => {
+  await fs4.rm(join5(directory, path4), { recursive: true });
 };
 var rmQueryById = (directory) => async (id, version, persistFiles) => {
   await rmResourceById(directory, id, version, { type: "query", persistFiles });
@@ -350,8 +350,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`;
@@ -359,8 +359,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 fs5.rm(join6(directory, path3), { recursive: true });
+var rmService = (directory) => async (path4) => {
+  await fs5.rm(join6(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);
@@ -413,8 +413,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 = join6(path3, "services");
+  const path4 = existingResource.split("/services")[0];
+  const pathToResource = join6(path4, "services");
   await rmServiceById(directory)(id, version);
   await writeService(pathToResource)(service);
 };
@@ -442,8 +442,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 fs6.rm(join7(directory, path3), { recursive: true });
+var rmDomain = (directory) => async (path4) => {
+  await fs6.rm(join7(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);
@@ -487,8 +487,8 @@ import { join as join8 } from "node: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 fs7.rm(join8(directory, path3), { recursive: true });
+var rmChannel = (directory) => async (path4) => {
+  await fs7.rm(join8(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);
@@ -527,20 +527,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 = join8(path3, collection);
+  const path4 = existingResource.split(`/${collection}`)[0];
+  const pathToResource = join8(path4, collection);
   await rmMessageById(directory)(_message.id, _message.version, true);
   await writeMessage(pathToResource)(message);
 };
 
-// src/custom-docs.ts
+// src/eventcatalog.ts
+import fs8 from "fs";
 import path2, { join as join9 } from "node:path";
+var DUMP_VERSION = "0.0.1";
+var getEventCatalogVersion = async (catalogDir) => {
+  const packageJson = fs8.readFileSync(join9(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 = path2.join(path2.dirname(resourcePath?.fullPath), resource.schemaPath);
+        if (fs8.existsSync(pathToSchema)) {
+          schema = fs8.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
+import path3, { join as join10 } from "node:path";
 import fsSync4 from "node:fs";
-import fs8 from "node:fs/promises";
+import fs9 from "node:fs/promises";
 import matter4 from "gray-matter";
 import slugify from "slugify";
 var getCustomDoc = (directory) => async (filePath) => {
-  const fullPath = path2.join(directory, filePath);
+  const fullPath = path3.join(directory, filePath);
   const fullPathWithExtension = fullPath.endsWith(".mdx") ? fullPath : `${fullPath}.mdx`;
   const fileExists = fsSync4.existsSync(fullPathWithExtension);
   if (!fileExists) {
@@ -559,23 +642,23 @@ var writeCustomDoc = (directory) => async (customDoc, options = { path: "" }) =>
   const { fileName, ...rest } = customDoc;
   const name = fileName || slugify(customDoc.title, { lower: true });
   const withExtension = name.endsWith(".mdx") ? name : `${name}.mdx`;
-  const fullPath = path2.join(directory, options.path || "", withExtension);
-  fsSync4.mkdirSync(path2.dirname(fullPath), { recursive: true });
+  const fullPath = path3.join(directory, options.path || "", withExtension);
+  fsSync4.mkdirSync(path3.dirname(fullPath), { recursive: true });
   const document = matter4.stringify(customDoc.markdown.trim(), rest);
   fsSync4.writeFileSync(fullPath, document);
 };
 var rmCustomDoc = (directory) => async (filePath) => {
   const withExtension = filePath.endsWith(".mdx") ? filePath : `${filePath}.mdx`;
-  await fs8.rm(join9(directory, withExtension), { recursive: true });
+  await fs9.rm(join10(directory, withExtension), { recursive: true });
 };
 
 // src/teams.ts
-import fs9 from "node:fs/promises";
+import fs10 from "node:fs/promises";
 import fsSync5 from "node:fs";
-import { join as join10 } from "node:path";
+import { join as join11 } from "node:path";
 import matter5 from "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 } = matter5.read(file);
@@ -587,7 +670,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 } = matter5.read(file);
@@ -608,19 +691,19 @@ var writeTeam = (catalogDir) => async (team, options = {}) => {
   }
   const { markdown, ...frontmatter } = resource;
   const document = matter5.stringify(markdown, frontmatter);
-  fsSync5.mkdirSync(join10(catalogDir, ""), { recursive: true });
-  fsSync5.writeFileSync(join10(catalogDir, "", `${resource.id}.md`), document);
+  fsSync5.mkdirSync(join11(catalogDir, ""), { recursive: true });
+  fsSync5.writeFileSync(join11(catalogDir, "", `${resource.id}.mdx`), document);
 };
 var rmTeamById = (catalogDir) => async (id) => {
-  await fs9.rm(join10(catalogDir, `${id}.md`), { recursive: true });
+  await fs10.rm(join11(catalogDir, `${id}.mdx`), { recursive: true });
 };
 
 // src/users.ts
 import fsSync6 from "node:fs";
-import { join as join11 } from "node:path";
+import { join as join12 } from "node:path";
 import matter6 from "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 } = matter6.read(file);
@@ -633,7 +716,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 } = matter6.read(file);
@@ -655,15 +738,15 @@ var writeUser = (catalogDir) => async (user, options = {}) => {
   }
   const { markdown, ...frontmatter } = resource;
   const document = matter6.stringify(markdown, frontmatter);
-  fsSync6.mkdirSync(join11(catalogDir, ""), { recursive: true });
-  fsSync6.writeFileSync(join11(catalogDir, "", `${resource.id}.md`), document);
+  fsSync6.mkdirSync(join12(catalogDir, ""), { recursive: true });
+  fsSync6.writeFileSync(join12(catalogDir, "", `${resource.id}.mdx`), document);
 };
 var rmUserById = (catalogDir) => async (id) => {
-  fsSync6.rmSync(join11(catalogDir, `${id}.md`), { recursive: true });
+  fsSync6.rmSync(join12(catalogDir, `${id}.mdx`), { recursive: true });
 };
 
 // src/index.ts
-var index_default = (path3) => {
+var index_default = (path4) => {
   return {
     /**
      * Returns an events from EventCatalog
@@ -671,13 +754,13 @@ var index_default = (path3) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Event|Undefined
      */
-    getEvent: getEvent(join12(path3)),
+    getEvent: getEvent(join13(path4)),
     /**
      * Returns all events from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Event[]|Undefined
      */
-    getEvents: getEvents(join12(path3)),
+    getEvents: getEvents(join13(path4)),
     /**
      * Adds an event to EventCatalog
      *
@@ -685,7 +768,7 @@ var index_default = (path3) => {
      * @param options - Optional options to write the event
      *
      */
-    writeEvent: writeEvent(join12(path3, "events")),
+    writeEvent: writeEvent(join13(path4, "events")),
     /**
      * Adds an event to a service in EventCatalog
      *
@@ -694,26 +777,26 @@ var index_default = (path3) => {
      * @param options - Optional options to write the event
      *
      */
-    writeEventToService: writeEventToService(join12(path3)),
+    writeEventToService: writeEventToService(join13(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(join12(path3, "events")),
+    rmEvent: rmEvent(join13(path4, "events")),
     /**
      * Remove an event by an Event id
      *
      * @param id - The id of the event you want to remove
      *
      */
-    rmEventById: rmEventById(join12(path3)),
+    rmEventById: rmEventById(join13(path4)),
     /**
      * Moves a given event id to the version directory
      * @param directory
      */
-    versionEvent: versionEvent(join12(path3)),
+    versionEvent: versionEvent(join13(path4)),
     /**
      * Adds a file to the given event
      * @param id - The id of the event to add the file to
@@ -721,7 +804,7 @@ var index_default = (path3) => {
      * @param version - Optional version of the event to add the file to
      * @returns
      */
-    addFileToEvent: addFileToEvent(join12(path3)),
+    addFileToEvent: addFileToEvent(join13(path4)),
     /**
      * Adds a schema to the given event
      * @param id - The id of the event to add the schema to
@@ -729,14 +812,14 @@ var index_default = (path3) => {
      * @param version - Optional version of the event to add the schema to
      * @returns
      */
-    addSchemaToEvent: addSchemaToEvent(join12(path3)),
+    addSchemaToEvent: addSchemaToEvent(join13(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(join12(path3)),
+    eventHasVersion: eventHasVersion(join13(path4)),
     /**
      * ================================
      *            Commands
@@ -748,13 +831,13 @@ var index_default = (path3) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Command|Undefined
      */
-    getCommand: getCommand(join12(path3)),
+    getCommand: getCommand(join13(path4)),
     /**
      * Returns all commands from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Command[]|Undefined
      */
-    getCommands: getCommands(join12(path3)),
+    getCommands: getCommands(join13(path4)),
     /**
      * Adds an command to EventCatalog
      *
@@ -762,7 +845,7 @@ var index_default = (path3) => {
      * @param options - Optional options to write the command
      *
      */
-    writeCommand: writeCommand(join12(path3, "commands")),
+    writeCommand: writeCommand(join13(path4, "commands")),
     /**
      * Adds a command to a service in EventCatalog
      *
@@ -771,26 +854,26 @@ var index_default = (path3) => {
      * @param options - Optional options to write the command
      *
      */
-    writeCommandToService: writeCommandToService(join12(path3)),
+    writeCommandToService: writeCommandToService(join13(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(join12(path3, "commands")),
+    rmCommand: rmCommand(join13(path4, "commands")),
     /**
      * Remove an command by an Event id
      *
      * @param id - The id of the command you want to remove
      *
      */
-    rmCommandById: rmCommandById(join12(path3)),
+    rmCommandById: rmCommandById(join13(path4)),
     /**
      * Moves a given command id to the version directory
      * @param directory
      */
-    versionCommand: versionCommand(join12(path3)),
+    versionCommand: versionCommand(join13(path4)),
     /**
      * Adds a file to the given command
      * @param id - The id of the command to add the file to
@@ -798,7 +881,7 @@ var index_default = (path3) => {
      * @param version - Optional version of the command to add the file to
      * @returns
      */
-    addFileToCommand: addFileToCommand(join12(path3)),
+    addFileToCommand: addFileToCommand(join13(path4)),
     /**
      * Adds a schema to the given command
      * @param id - The id of the command to add the schema to
@@ -806,14 +889,14 @@ var index_default = (path3) => {
      * @param version - Optional version of the command to add the schema to
      * @returns
      */
-    addSchemaToCommand: addSchemaToCommand(join12(path3)),
+    addSchemaToCommand: addSchemaToCommand(join13(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(join12(path3)),
+    commandHasVersion: commandHasVersion(join13(path4)),
     /**
      * ================================
      *            Queries
@@ -825,13 +908,13 @@ var index_default = (path3) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Query|Undefined
      */
-    getQuery: getQuery(join12(path3)),
+    getQuery: getQuery(join13(path4)),
     /**
      * Returns all queries from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Query[]|Undefined
      */
-    getQueries: getQueries(join12(path3)),
+    getQueries: getQueries(join13(path4)),
     /**
      * Adds a query to EventCatalog
      *
@@ -839,7 +922,7 @@ var index_default = (path3) => {
      * @param options - Optional options to write the event
      *
      */
-    writeQuery: writeQuery(join12(path3, "queries")),
+    writeQuery: writeQuery(join13(path4, "queries")),
     /**
      * Adds a query to a service in EventCatalog
      *
@@ -848,26 +931,26 @@ var index_default = (path3) => {
      * @param options - Optional options to write the query
      *
      */
-    writeQueryToService: writeQueryToService(join12(path3)),
+    writeQueryToService: writeQueryToService(join13(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(join12(path3, "queries")),
+    rmQuery: rmQuery(join13(path4, "queries")),
     /**
      * Remove a query by a Query id
      *
      * @param id - The id of the query you want to remove
      *
      */
-    rmQueryById: rmQueryById(join12(path3)),
+    rmQueryById: rmQueryById(join13(path4)),
     /**
      * Moves a given query id to the version directory
      * @param directory
      */
-    versionQuery: versionQuery(join12(path3)),
+    versionQuery: versionQuery(join13(path4)),
     /**
      * Adds a file to the given query
      * @param id - The id of the query to add the file to
@@ -875,7 +958,7 @@ var index_default = (path3) => {
      * @param version - Optional version of the query to add the file to
      * @returns
      */
-    addFileToQuery: addFileToQuery(join12(path3)),
+    addFileToQuery: addFileToQuery(join13(path4)),
     /**
      * Adds a schema to the given query
      * @param id - The id of the query to add the schema to
@@ -883,14 +966,14 @@ var index_default = (path3) => {
      * @param version - Optional version of the query to add the schema to
      * @returns
      */
-    addSchemaToQuery: addSchemaToQuery(join12(path3)),
+    addSchemaToQuery: addSchemaToQuery(join13(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(join12(path3)),
+    queryHasVersion: queryHasVersion(join13(path4)),
     /**
      * ================================
      *            Channels
@@ -902,13 +985,13 @@ var index_default = (path3) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Channel|Undefined
      */
-    getChannel: getChannel(join12(path3)),
+    getChannel: getChannel(join13(path4)),
     /**
      * Returns all channels from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Channel[]|Undefined
      */
-    getChannels: getChannels(join12(path3)),
+    getChannels: getChannels(join13(path4)),
     /**
      * Adds an channel to EventCatalog
      *
@@ -916,33 +999,33 @@ var index_default = (path3) => {
      * @param options - Optional options to write the channel
      *
      */
-    writeChannel: writeChannel(join12(path3, "channels")),
+    writeChannel: writeChannel(join13(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(join12(path3, "channels")),
+    rmChannel: rmChannel(join13(path4, "channels")),
     /**
      * Remove an channel by an Event id
      *
      * @param id - The id of the channel you want to remove
      *
      */
-    rmChannelById: rmChannelById(join12(path3)),
+    rmChannelById: rmChannelById(join13(path4)),
     /**
      * Moves a given channel id to the version directory
      * @param directory
      */
-    versionChannel: versionChannel(join12(path3)),
+    versionChannel: versionChannel(join13(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(join12(path3)),
+    channelHasVersion: channelHasVersion(join13(path4)),
     /**
      * Add a channel to an event
      *
@@ -959,7 +1042,7 @@ var index_default = (path3) => {
      *
      * ```
      */
-    addEventToChannel: addMessageToChannel(join12(path3), "events"),
+    addEventToChannel: addMessageToChannel(join13(path4), "events"),
     /**
      * Add a channel to an command
      *
@@ -976,7 +1059,7 @@ var index_default = (path3) => {
      *
      * ```
      */
-    addCommandToChannel: addMessageToChannel(join12(path3), "commands"),
+    addCommandToChannel: addMessageToChannel(join13(path4), "commands"),
     /**
      * Add a channel to an query
      *
@@ -993,7 +1076,7 @@ var index_default = (path3) => {
      *
      * ```
      */
-    addQueryToChannel: addMessageToChannel(join12(path3), "queries"),
+    addQueryToChannel: addMessageToChannel(join13(path4), "queries"),
     /**
      * ================================
      *            SERVICES
@@ -1006,14 +1089,14 @@ var index_default = (path3) => {
      * @param options - Optional options to write the event
      *
      */
-    writeService: writeService(join12(path3, "services")),
+    writeService: writeService(join13(path4, "services")),
     /**
      * Adds a versioned service to EventCatalog
      *
      * @param service - The service to write
      *
      */
-    writeVersionedService: writeVersionedService(join12(path3, "services")),
+    writeVersionedService: writeVersionedService(join13(path4, "services")),
     /**
      * Adds a service to a domain in EventCatalog
      *
@@ -1022,39 +1105,39 @@ var index_default = (path3) => {
      * @param options - Optional options to write the event
      *
      */
-    writeServiceToDomain: writeServiceToDomain(join12(path3, "domains")),
+    writeServiceToDomain: writeServiceToDomain(join13(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(join12(path3)),
+    getService: getService(join13(path4)),
     /**
      * Returns all services from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Service[]|Undefined
      */
-    getServices: getServices(join12(path3)),
+    getServices: getServices(join13(path4)),
     /**
      * Moves a given service id to the version directory
      * @param directory
      */
-    versionService: versionService(join12(path3)),
+    versionService: versionService(join13(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(join12(path3, "services")),
+    rmService: rmService(join13(path4, "services")),
     /**
      * Remove an service by an service id
      *
      * @param id - The id of the service you want to remove
      *
      */
-    rmServiceById: rmServiceById(join12(path3)),
+    rmServiceById: rmServiceById(join13(path4)),
     /**
      * Adds a file to the given service
      * @param id - The id of the service to add the file to
@@ -1062,21 +1145,21 @@ var index_default = (path3) => {
      * @param version - Optional version of the service to add the file to
      * @returns
      */
-    addFileToService: addFileToService(join12(path3)),
+    addFileToService: addFileToService(join13(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(join12(path3)),
+    getSpecificationFilesForService: getSpecificationFilesForService(join13(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(join12(path3)),
+    serviceHasVersion: serviceHasVersion(join13(path4)),
     /**
      * Add an event to a service by it's id.
      *
@@ -1096,7 +1179,7 @@ var index_default = (path3) => {
      *
      * ```
      */
-    addEventToService: addMessageToService(join12(path3)),
+    addEventToService: addMessageToService(join13(path4)),
     /**
      * Add a command to a service by it's id.
      *
@@ -1116,7 +1199,7 @@ var index_default = (path3) => {
      *
      * ```
      */
-    addCommandToService: addMessageToService(join12(path3)),
+    addCommandToService: addMessageToService(join13(path4)),
     /**
      * Add a query to a service by it's id.
      *
@@ -1136,7 +1219,7 @@ var index_default = (path3) => {
      *
      * ```
      */
-    addQueryToService: addMessageToService(join12(path3)),
+    addQueryToService: addMessageToService(join13(path4)),
     /**
      * ================================
      *            Domains
@@ -1149,39 +1232,39 @@ var index_default = (path3) => {
      * @param options - Optional options to write the event
      *
      */
-    writeDomain: writeDomain(join12(path3, "domains")),
+    writeDomain: writeDomain(join13(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(join12(path3, "domains")),
+    getDomain: getDomain(join13(path4, "domains")),
     /**
      * Returns all domains from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Domain[]|Undefined
      */
-    getDomains: getDomains(join12(path3)),
+    getDomains: getDomains(join13(path4)),
     /**
      * Moves a given domain id to the version directory
      * @param directory
      */
-    versionDomain: versionDomain(join12(path3, "domains")),
+    versionDomain: versionDomain(join13(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(join12(path3, "domains")),
+    rmDomain: rmDomain(join13(path4, "domains")),
     /**
      * Remove an service by an domain id
      *
      * @param id - The id of the domain you want to remove
      *
      */
-    rmDomainById: rmDomainById(join12(path3, "domains")),
+    rmDomainById: rmDomainById(join13(path4, "domains")),
     /**
      * Adds a file to the given domain
      * @param id - The id of the domain to add the file to
@@ -1189,28 +1272,28 @@ var index_default = (path3) => {
      * @param version - Optional version of the domain to add the file to
      * @returns
      */
-    addFileToDomain: addFileToDomain(join12(path3, "domains")),
+    addFileToDomain: addFileToDomain(join13(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(join12(path3, "domains")),
+    addUbiquitousLanguageToDomain: addUbiquitousLanguageToDomain(join13(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(join12(path3, "domains")),
+    getUbiquitousLanguageFromDomain: getUbiquitousLanguageFromDomain(join13(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(join12(path3)),
+    domainHasVersion: domainHasVersion(join13(path4)),
     /**
      * Adds a given service to a domain
      * @param id - The id of the domain
@@ -1218,7 +1301,7 @@ var index_default = (path3) => {
      * @param version - (Optional) The version of the domain to add the service to
      * @returns
      */
-    addServiceToDomain: addServiceToDomain(join12(path3, "domains")),
+    addServiceToDomain: addServiceToDomain(join13(path4, "domains")),
     /**
      * ================================
      *            Teams
@@ -1231,25 +1314,25 @@ var index_default = (path3) => {
      * @param options - Optional options to write the team
      *
      */
-    writeTeam: writeTeam(join12(path3, "teams")),
+    writeTeam: writeTeam(join13(path4, "teams")),
     /**
      * Returns a team from EventCatalog
      * @param id - The id of the team to retrieve
      * @returns Team|Undefined
      */
-    getTeam: getTeam(join12(path3, "teams")),
+    getTeam: getTeam(join13(path4, "teams")),
     /**
      * Returns all teams from EventCatalog
      * @returns Team[]|Undefined
      */
-    getTeams: getTeams(join12(path3)),
+    getTeams: getTeams(join13(path4)),
     /**
      * Remove a team by the team id
      *
      * @param id - The id of the team you want to remove
      *
      */
-    rmTeamById: rmTeamById(join12(path3, "teams")),
+    rmTeamById: rmTeamById(join13(path4, "teams")),
     /**
      * ================================
      *            Users
@@ -1262,25 +1345,25 @@ var index_default = (path3) => {
      * @param options - Optional options to write the user
      *
      */
-    writeUser: writeUser(join12(path3, "users")),
+    writeUser: writeUser(join13(path4, "users")),
     /**
      * Returns a user from EventCatalog
      * @param id - The id of the user to retrieve
      * @returns User|Undefined
      */
-    getUser: getUser(join12(path3, "users")),
+    getUser: getUser(join13(path4, "users")),
     /**
      * Returns all user from EventCatalog
      * @returns User[]|Undefined
      */
-    getUsers: getUsers(join12(path3)),
+    getUsers: getUsers(join13(path4)),
     /**
      * Remove a user by the user id
      *
      * @param id - The id of the user you want to remove
      *
      */
-    rmUserById: rmUserById(join12(path3, "users")),
+    rmUserById: rmUserById(join13(path4, "users")),
     /**
      * ================================
      *            Custom Docs
@@ -1291,26 +1374,32 @@ var index_default = (path3) => {
      * @param path - The path to the custom doc to retrieve
      * @returns CustomDoc|Undefined
      */
-    getCustomDoc: getCustomDoc(join12(path3, "docs")),
+    getCustomDoc: getCustomDoc(join13(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(join12(path3, "docs")),
+    getCustomDocs: getCustomDocs(join13(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(join12(path3, "docs")),
+    writeCustomDoc: writeCustomDoc(join13(path4, "docs")),
     /**
      * Removes a custom doc from EventCatalog
      * @param path - The path to the custom doc to remove
      *
      */
-    rmCustomDoc: rmCustomDoc(join12(path3, "docs"))
+    rmCustomDoc: rmCustomDoc(join13(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(join13(path4))
   };
 };
 export {