@eventcatalog/sdk 2.0.1 → 2.1.0

package/dist/index.js

@@ -33,7 +33,7 @@ __export(index_exports, {
   default: () => index_default
 });
 module.exports = __toCommonJS(index_exports);
-var import_node_path10 = require("path");
+var import_node_path11 = 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((path) => !path.includes("versioned"));
+  const latestVersion = matchedFiles.find((path2) => !path2.includes("versioned"));
   if (!version) {
     return latestVersion;
   }
-  const parsedFiles = matchedFiles.map((path) => {
-    const { data } = import_gray_matter.default.read(path);
-    return { ...data, path };
+  const parsedFiles = matchedFiles.map((path2) => {
+    const { data } = import_gray_matter.default.read(path2);
+    return { ...data, path: path2 };
   });
   const semverRange = (0, import_semver.validRange)(version);
   if (semverRange && (0, import_semver.valid)(version)) {
@@ -84,6 +84,11 @@ var getFiles = async (pattern, ignore = "") => {
     throw new Error(`Error finding files: ${error}`);
   }
 };
+var readMdxFile = async (path2) => {
+  const { data } = import_gray_matter.default.read(path2);
+  const { markdown, ...frontmatter } = data;
+  return { ...frontmatter, markdown };
+};
 var searchFilesForId = async (files, id, version) => {
   const idRegex = new RegExp(`^id:\\s*(['"]|>-)?\\s*${id}['"]?\\s*$`, "m");
   const versionRegex = new RegExp(`^version:\\s*['"]?${version}['"]?\\s*$`, "m");
@@ -161,8 +166,8 @@ var writeResource = async (catalogDir, resource, options = {
   override: false,
   versionExistingContent: false
 }) => {
-  const path = options.path || `/${resource.id}`;
-  const fullPath = (0, import_path.join)(catalogDir, path);
+  const path2 = options.path || `/${resource.id}`;
+  const fullPath = (0, import_path.join)(catalogDir, path2);
   import_node_fs2.default.mkdirSync(fullPath, { recursive: true });
   const lockPath = (0, import_path.join)(fullPath, "index.mdx");
   if (!import_node_fs2.default.existsSync(lockPath)) {
@@ -205,9 +210,15 @@ var getResource = async (catalogDir, id, version, options) => {
     markdown: content.trim()
   };
 };
-var getResources = async (catalogDir, { type, latestOnly = false, ignore = [] }) => {
+var getResources = async (catalogDir, {
+  type,
+  latestOnly = false,
+  ignore = [],
+  pattern = ""
+}) => {
   const ignoreList = latestOnly ? `**/versioned/**` : "";
-  const files = await getFiles(`${catalogDir}/**/${type}/**/index.{md,mdx}`, [ignoreList, ...ignore]);
+  const filePattern = pattern || `${catalogDir}/**/${type}/**/index.{md,mdx}`;
+  const files = await getFiles(filePattern, [ignoreList, ...ignore]);
   if (files.length === 0) return;
   return files.map((file) => {
     const { data, content } = import_gray_matter2.default.read(file);
@@ -263,8 +274,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 (path) => {
-  await import_promises2.default.rm((0, import_node_path2.join)(directory, path), { recursive: true });
+var rmEvent = (directory) => async (path2) => {
+  await import_promises2.default.rm((0, import_node_path2.join)(directory, path2), { recursive: true });
 };
 var rmEventById = (directory) => async (id, version, persistFiles) => {
   await rmResourceById(directory, id, version, { type: "event", persistFiles });
@@ -290,8 +301,8 @@ var writeCommandToService = (directory) => async (command, service, options = {
   pathForEvent = (0, import_node_path3.join)(pathForEvent, command.id);
   await writeResource(directory, { ...command }, { ...options, path: pathForEvent, type: "command" });
 };
-var rmCommand = (directory) => async (path) => {
-  await import_promises3.default.rm((0, import_node_path3.join)(directory, path), { recursive: true });
+var rmCommand = (directory) => async (path2) => {
+  await import_promises3.default.rm((0, import_node_path3.join)(directory, path2), { recursive: true });
 };
 var rmCommandById = (directory) => async (id, version, persistFiles) => rmResourceById(directory, id, version, { type: "command", persistFiles });
 var versionCommand = (directory) => async (id) => versionResource(directory, id);
@@ -315,8 +326,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 (path) => {
-  await import_promises4.default.rm((0, import_node_path4.join)(directory, path), { recursive: true });
+var rmQuery = (directory) => async (path2) => {
+  await import_promises4.default.rm((0, import_node_path4.join)(directory, path2), { recursive: true });
 };
 var rmQueryById = (directory) => async (id, version, persistFiles) => {
   await rmResourceById(directory, id, version, { type: "query", persistFiles });
@@ -352,8 +363,8 @@ var writeService = (directory) => async (service, options = { path: "" }) => {
 };
 var writeVersionedService = (directory) => async (service) => {
   const resource = { ...service };
-  const path = getVersionedDirectory(service.id, service.version);
-  return await writeService(directory)(resource, { path });
+  const path2 = getVersionedDirectory(service.id, service.version);
+  return await writeService(directory)(resource, { path: path2 });
 };
 var writeServiceToDomain = (directory) => async (service, domain, options = { path: "" }) => {
   let pathForService = domain.version && domain.version !== "latest" ? `/${domain.id}/versioned/${domain.version}/services` : `/${domain.id}/services`;
@@ -361,8 +372,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 (path) => {
-  await import_promises5.default.rm((0, import_node_path5.join)(directory, path), { recursive: true });
+var rmService = (directory) => async (path2) => {
+  await import_promises5.default.rm((0, import_node_path5.join)(directory, path2), { 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);
@@ -415,8 +426,8 @@ var addMessageToService = (directory) => async (id, direction, event, version) =
   if (!existingResource) {
     throw new Error(`Cannot find service ${id} in the catalog`);
   }
-  const path = existingResource.split("/services")[0];
-  const pathToResource = (0, import_node_path5.join)(path, "services");
+  const path2 = existingResource.split("/services")[0];
+  const pathToResource = (0, import_node_path5.join)(path2, "services");
   await rmServiceById(directory)(id, version);
   await writeService(pathToResource)(service);
 };
@@ -442,8 +453,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 (path) => {
-  await import_promises6.default.rm((0, import_node_path6.join)(directory, path), { recursive: true });
+var rmDomain = (directory) => async (path2) => {
+  await import_promises6.default.rm((0, import_node_path6.join)(directory, path2), { 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);
@@ -471,8 +482,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 (path) => {
-  await import_promises7.default.rm((0, import_node_path7.join)(directory, path), { recursive: true });
+var rmChannel = (directory) => async (path2) => {
+  await import_promises7.default.rm((0, import_node_path7.join)(directory, path2), { recursive: true });
 };
 var rmChannelById = (directory) => async (id, version, persistFiles) => rmResourceById(directory, id, version, { type: "channel", persistFiles });
 var versionChannel = (directory) => async (id) => versionResource(directory, id);
@@ -511,22 +522,58 @@ var addMessageToChannel = (directory, collection) => async (id, _message, versio
   if (!existingResource) {
     throw new Error(`Cannot find message ${id} in the catalog`);
   }
-  const path = existingResource.split(`/${collection}`)[0];
-  const pathToResource = (0, import_node_path7.join)(path, collection);
+  const path2 = existingResource.split(`/${collection}`)[0];
+  const pathToResource = (0, import_node_path7.join)(path2, collection);
   await rmMessageById(directory)(_message.id, _message.version, true);
   await writeMessage(pathToResource)(message);
 };
 
-// src/teams.ts
-var import_promises8 = __toESM(require("fs/promises"));
+// src/custom-docs.ts
+var import_node_path8 = __toESM(require("path"));
 var import_node_fs3 = __toESM(require("fs"));
-var import_node_path8 = require("path");
+var import_promises8 = __toESM(require("fs/promises"));
 var import_gray_matter3 = __toESM(require("gray-matter"));
+var import_slugify = __toESM(require("slugify"));
+var getCustomDoc = (directory) => async (filePath) => {
+  const fullPath = import_node_path8.default.join(directory, filePath);
+  const fullPathWithExtension = fullPath.endsWith(".mdx") ? fullPath : `${fullPath}.mdx`;
+  const fileExists = import_node_fs3.default.existsSync(fullPathWithExtension);
+  if (!fileExists) {
+    return void 0;
+  }
+  return readMdxFile(fullPathWithExtension);
+};
+var getCustomDocs = (directory) => async (options) => {
+  if (options?.path) {
+    const pattern = `${directory}/${options.path}/**/*.{md,mdx}`;
+    return getResources(directory, { type: "docs", pattern });
+  }
+  return getResources(directory, { type: "docs", pattern: `${directory}/**/*.{md,mdx}` });
+};
+var writeCustomDoc = (directory) => async (customDoc, options = { path: "" }) => {
+  const { fileName, ...rest } = customDoc;
+  const name = fileName || (0, import_slugify.default)(customDoc.title, { lower: true });
+  const withExtension = name.endsWith(".mdx") ? name : `${name}.mdx`;
+  const fullPath = import_node_path8.default.join(directory, options.path || "", withExtension);
+  import_node_fs3.default.mkdirSync(import_node_path8.default.dirname(fullPath), { recursive: true });
+  const document = import_gray_matter3.default.stringify(customDoc.markdown.trim(), rest);
+  import_node_fs3.default.writeFileSync(fullPath, document);
+};
+var rmCustomDoc = (directory) => async (filePath) => {
+  const withExtension = filePath.endsWith(".mdx") ? filePath : `${filePath}.mdx`;
+  await import_promises8.default.rm((0, import_node_path8.join)(directory, withExtension), { recursive: true });
+};
+
+// src/teams.ts
+var import_promises9 = __toESM(require("fs/promises"));
+var import_node_fs4 = __toESM(require("fs"));
+var import_node_path9 = require("path");
+var import_gray_matter4 = __toESM(require("gray-matter"));
 var getTeam = (catalogDir) => async (id) => {
   const files = await getFiles(`${catalogDir}/${id}.md`);
   if (files.length == 0) return void 0;
   const file = files[0];
-  const { data, content } = import_gray_matter3.default.read(file);
+  const { data, content } = import_gray_matter4.default.read(file);
   return {
     ...data,
     id: data.id,
@@ -538,7 +585,7 @@ var getTeams = (catalogDir) => async (options) => {
   const files = await getFiles(`${catalogDir}/teams/*.md`);
   if (files.length === 0) return [];
   return files.map((file) => {
-    const { data, content } = import_gray_matter3.default.read(file);
+    const { data, content } = import_gray_matter4.default.read(file);
     return {
       ...data,
       id: data.id,
@@ -555,23 +602,23 @@ var writeTeam = (catalogDir) => async (team, options = {}) => {
     throw new Error(`Failed to write ${resource.id} (team) as it already exists`);
   }
   const { markdown, ...frontmatter } = resource;
-  const document = import_gray_matter3.default.stringify(markdown, frontmatter);
-  import_node_fs3.default.mkdirSync((0, import_node_path8.join)(catalogDir, ""), { recursive: true });
-  import_node_fs3.default.writeFileSync((0, import_node_path8.join)(catalogDir, "", `${resource.id}.md`), document);
+  const document = import_gray_matter4.default.stringify(markdown, frontmatter);
+  import_node_fs4.default.mkdirSync((0, import_node_path9.join)(catalogDir, ""), { recursive: true });
+  import_node_fs4.default.writeFileSync((0, import_node_path9.join)(catalogDir, "", `${resource.id}.md`), document);
 };
 var rmTeamById = (catalogDir) => async (id) => {
-  await import_promises8.default.rm((0, import_node_path8.join)(catalogDir, `${id}.md`), { recursive: true });
+  await import_promises9.default.rm((0, import_node_path9.join)(catalogDir, `${id}.md`), { recursive: true });
 };
 
 // src/users.ts
-var import_node_fs4 = __toESM(require("fs"));
-var import_node_path9 = require("path");
-var import_gray_matter4 = __toESM(require("gray-matter"));
+var import_node_fs5 = __toESM(require("fs"));
+var import_node_path10 = require("path");
+var import_gray_matter5 = __toESM(require("gray-matter"));
 var getUser = (catalogDir) => async (id) => {
   const files = await getFiles(`${catalogDir}/${id}.md`);
   if (files.length == 0) return void 0;
   const file = files[0];
-  const { data, content } = import_gray_matter4.default.read(file);
+  const { data, content } = import_gray_matter5.default.read(file);
   return {
     ...data,
     id: data.id,
@@ -584,7 +631,7 @@ var getUsers = (catalogDir) => async (options) => {
   const files = await getFiles(`${catalogDir}/users/*.md`);
   if (files.length === 0) return [];
   return files.map((file) => {
-    const { data, content } = import_gray_matter4.default.read(file);
+    const { data, content } = import_gray_matter5.default.read(file);
     return {
       ...data,
       id: data.id,
@@ -602,16 +649,16 @@ var writeUser = (catalogDir) => async (user, options = {}) => {
     throw new Error(`Failed to write ${resource.id} (user) as it already exists`);
   }
   const { markdown, ...frontmatter } = resource;
-  const document = import_gray_matter4.default.stringify(markdown, frontmatter);
-  import_node_fs4.default.mkdirSync((0, import_node_path9.join)(catalogDir, ""), { recursive: true });
-  import_node_fs4.default.writeFileSync((0, import_node_path9.join)(catalogDir, "", `${resource.id}.md`), document);
+  const document = import_gray_matter5.default.stringify(markdown, frontmatter);
+  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}.md`), document);
 };
 var rmUserById = (catalogDir) => async (id) => {
-  import_node_fs4.default.rmSync((0, import_node_path9.join)(catalogDir, `${id}.md`), { recursive: true });
+  import_node_fs5.default.rmSync((0, import_node_path10.join)(catalogDir, `${id}.md`), { recursive: true });
 };
 
 // src/index.ts
-var index_default = (path) => {
+var index_default = (path2) => {
   return {
     /**
      * Returns an events from EventCatalog
@@ -619,13 +666,13 @@ var index_default = (path) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Event|Undefined
      */
-    getEvent: getEvent((0, import_node_path10.join)(path)),
+    getEvent: getEvent((0, import_node_path11.join)(path2)),
     /**
      * 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_path10.join)(path)),
+    getEvents: getEvents((0, import_node_path11.join)(path2)),
     /**
      * Adds an event to EventCatalog
      *
@@ -633,7 +680,7 @@ var index_default = (path) => {
      * @param options - Optional options to write the event
      *
      */
-    writeEvent: writeEvent((0, import_node_path10.join)(path, "events")),
+    writeEvent: writeEvent((0, import_node_path11.join)(path2, "events")),
     /**
      * Adds an event to a service in EventCatalog
      *
@@ -642,26 +689,26 @@ var index_default = (path) => {
      * @param options - Optional options to write the event
      *
      */
-    writeEventToService: writeEventToService((0, import_node_path10.join)(path, "services")),
+    writeEventToService: writeEventToService((0, import_node_path11.join)(path2, "services")),
     /**
      * 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_path10.join)(path, "events")),
+    rmEvent: rmEvent((0, import_node_path11.join)(path2, "events")),
     /**
      * Remove an event by an Event id
      *
      * @param id - The id of the event you want to remove
      *
      */
-    rmEventById: rmEventById((0, import_node_path10.join)(path)),
+    rmEventById: rmEventById((0, import_node_path11.join)(path2)),
     /**
      * Moves a given event id to the version directory
      * @param directory
      */
-    versionEvent: versionEvent((0, import_node_path10.join)(path)),
+    versionEvent: versionEvent((0, import_node_path11.join)(path2)),
     /**
      * Adds a file to the given event
      * @param id - The id of the event to add the file to
@@ -669,7 +716,7 @@ var index_default = (path) => {
      * @param version - Optional version of the event to add the file to
      * @returns
      */
-    addFileToEvent: addFileToEvent((0, import_node_path10.join)(path)),
+    addFileToEvent: addFileToEvent((0, import_node_path11.join)(path2)),
     /**
      * Adds a schema to the given event
      * @param id - The id of the event to add the schema to
@@ -677,14 +724,14 @@ var index_default = (path) => {
      * @param version - Optional version of the event to add the schema to
      * @returns
      */
-    addSchemaToEvent: addSchemaToEvent((0, import_node_path10.join)(path)),
+    addSchemaToEvent: addSchemaToEvent((0, import_node_path11.join)(path2)),
     /**
      * 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_path10.join)(path)),
+    eventHasVersion: eventHasVersion((0, import_node_path11.join)(path2)),
     /**
      * ================================
      *            Commands
@@ -696,13 +743,13 @@ var index_default = (path) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Command|Undefined
      */
-    getCommand: getCommand((0, import_node_path10.join)(path)),
+    getCommand: getCommand((0, import_node_path11.join)(path2)),
     /**
      * 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_path10.join)(path)),
+    getCommands: getCommands((0, import_node_path11.join)(path2)),
     /**
      * Adds an command to EventCatalog
      *
@@ -710,7 +757,7 @@ var index_default = (path) => {
      * @param options - Optional options to write the command
      *
      */
-    writeCommand: writeCommand((0, import_node_path10.join)(path, "commands")),
+    writeCommand: writeCommand((0, import_node_path11.join)(path2, "commands")),
     /**
      * Adds a command to a service in EventCatalog
      *
@@ -719,26 +766,26 @@ var index_default = (path) => {
      * @param options - Optional options to write the command
      *
      */
-    writeCommandToService: writeCommandToService((0, import_node_path10.join)(path, "services")),
+    writeCommandToService: writeCommandToService((0, import_node_path11.join)(path2, "services")),
     /**
      * 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_path10.join)(path, "commands")),
+    rmCommand: rmCommand((0, import_node_path11.join)(path2, "commands")),
     /**
      * Remove an command by an Event id
      *
      * @param id - The id of the command you want to remove
      *
      */
-    rmCommandById: rmCommandById((0, import_node_path10.join)(path)),
+    rmCommandById: rmCommandById((0, import_node_path11.join)(path2)),
     /**
      * Moves a given command id to the version directory
      * @param directory
      */
-    versionCommand: versionCommand((0, import_node_path10.join)(path)),
+    versionCommand: versionCommand((0, import_node_path11.join)(path2)),
     /**
      * Adds a file to the given command
      * @param id - The id of the command to add the file to
@@ -746,7 +793,7 @@ var index_default = (path) => {
      * @param version - Optional version of the command to add the file to
      * @returns
      */
-    addFileToCommand: addFileToCommand((0, import_node_path10.join)(path)),
+    addFileToCommand: addFileToCommand((0, import_node_path11.join)(path2)),
     /**
      * Adds a schema to the given command
      * @param id - The id of the command to add the schema to
@@ -754,14 +801,14 @@ var index_default = (path) => {
      * @param version - Optional version of the command to add the schema to
      * @returns
      */
-    addSchemaToCommand: addSchemaToCommand((0, import_node_path10.join)(path)),
+    addSchemaToCommand: addSchemaToCommand((0, import_node_path11.join)(path2)),
     /**
      * 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_path10.join)(path)),
+    commandHasVersion: commandHasVersion((0, import_node_path11.join)(path2)),
     /**
      * ================================
      *            Queries
@@ -773,13 +820,13 @@ var index_default = (path) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Query|Undefined
      */
-    getQuery: getQuery((0, import_node_path10.join)(path)),
+    getQuery: getQuery((0, import_node_path11.join)(path2)),
     /**
      * 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_path10.join)(path)),
+    getQueries: getQueries((0, import_node_path11.join)(path2)),
     /**
      * Adds a query to EventCatalog
      *
@@ -787,7 +834,7 @@ var index_default = (path) => {
      * @param options - Optional options to write the event
      *
      */
-    writeQuery: writeQuery((0, import_node_path10.join)(path, "queries")),
+    writeQuery: writeQuery((0, import_node_path11.join)(path2, "queries")),
     /**
      * Adds a query to a service in EventCatalog
      *
@@ -796,26 +843,26 @@ var index_default = (path) => {
      * @param options - Optional options to write the query
      *
      */
-    writeQueryToService: writeQueryToService((0, import_node_path10.join)(path, "services")),
+    writeQueryToService: writeQueryToService((0, import_node_path11.join)(path2, "services")),
     /**
      * 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_path10.join)(path, "queries")),
+    rmQuery: rmQuery((0, import_node_path11.join)(path2, "queries")),
     /**
      * Remove a query by a Query id
      *
      * @param id - The id of the query you want to remove
      *
      */
-    rmQueryById: rmQueryById((0, import_node_path10.join)(path)),
+    rmQueryById: rmQueryById((0, import_node_path11.join)(path2)),
     /**
      * Moves a given query id to the version directory
      * @param directory
      */
-    versionQuery: versionQuery((0, import_node_path10.join)(path)),
+    versionQuery: versionQuery((0, import_node_path11.join)(path2)),
     /**
      * Adds a file to the given query
      * @param id - The id of the query to add the file to
@@ -823,7 +870,7 @@ var index_default = (path) => {
      * @param version - Optional version of the query to add the file to
      * @returns
      */
-    addFileToQuery: addFileToQuery((0, import_node_path10.join)(path)),
+    addFileToQuery: addFileToQuery((0, import_node_path11.join)(path2)),
     /**
      * Adds a schema to the given query
      * @param id - The id of the query to add the schema to
@@ -831,14 +878,14 @@ var index_default = (path) => {
      * @param version - Optional version of the query to add the schema to
      * @returns
      */
-    addSchemaToQuery: addSchemaToQuery((0, import_node_path10.join)(path)),
+    addSchemaToQuery: addSchemaToQuery((0, import_node_path11.join)(path2)),
     /**
      * 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_path10.join)(path)),
+    queryHasVersion: queryHasVersion((0, import_node_path11.join)(path2)),
     /**
      * ================================
      *            Channels
@@ -850,13 +897,13 @@ var index_default = (path) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Channel|Undefined
      */
-    getChannel: getChannel((0, import_node_path10.join)(path)),
+    getChannel: getChannel((0, import_node_path11.join)(path2)),
     /**
      * 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_path10.join)(path)),
+    getChannels: getChannels((0, import_node_path11.join)(path2)),
     /**
      * Adds an channel to EventCatalog
      *
@@ -864,33 +911,33 @@ var index_default = (path) => {
      * @param options - Optional options to write the channel
      *
      */
-    writeChannel: writeChannel((0, import_node_path10.join)(path, "channels")),
+    writeChannel: writeChannel((0, import_node_path11.join)(path2, "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_path10.join)(path, "channels")),
+    rmChannel: rmChannel((0, import_node_path11.join)(path2, "channels")),
     /**
      * Remove an channel by an Event id
      *
      * @param id - The id of the channel you want to remove
      *
      */
-    rmChannelById: rmChannelById((0, import_node_path10.join)(path)),
+    rmChannelById: rmChannelById((0, import_node_path11.join)(path2)),
     /**
      * Moves a given channel id to the version directory
      * @param directory
      */
-    versionChannel: versionChannel((0, import_node_path10.join)(path)),
+    versionChannel: versionChannel((0, import_node_path11.join)(path2)),
     /**
      * 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_path10.join)(path)),
+    channelHasVersion: channelHasVersion((0, import_node_path11.join)(path2)),
     /**
      * Add a channel to an event
      *
@@ -907,7 +954,7 @@ var index_default = (path) => {
      *
      * ```
      */
-    addEventToChannel: addMessageToChannel((0, import_node_path10.join)(path), "events"),
+    addEventToChannel: addMessageToChannel((0, import_node_path11.join)(path2), "events"),
     /**
      * Add a channel to an command
      *
@@ -924,7 +971,7 @@ var index_default = (path) => {
      *
      * ```
      */
-    addCommandToChannel: addMessageToChannel((0, import_node_path10.join)(path), "commands"),
+    addCommandToChannel: addMessageToChannel((0, import_node_path11.join)(path2), "commands"),
     /**
      * Add a channel to an query
      *
@@ -941,7 +988,7 @@ var index_default = (path) => {
      *
      * ```
      */
-    addQueryToChannel: addMessageToChannel((0, import_node_path10.join)(path), "queries"),
+    addQueryToChannel: addMessageToChannel((0, import_node_path11.join)(path2), "queries"),
     /**
      * ================================
      *            SERVICES
@@ -954,14 +1001,14 @@ var index_default = (path) => {
      * @param options - Optional options to write the event
      *
      */
-    writeService: writeService((0, import_node_path10.join)(path, "services")),
+    writeService: writeService((0, import_node_path11.join)(path2, "services")),
     /**
      * Adds a versioned service to EventCatalog
      *
      * @param service - The service to write
      *
      */
-    writeVersionedService: writeVersionedService((0, import_node_path10.join)(path, "services")),
+    writeVersionedService: writeVersionedService((0, import_node_path11.join)(path2, "services")),
     /**
      * Adds a service to a domain in EventCatalog
      *
@@ -970,39 +1017,39 @@ var index_default = (path) => {
      * @param options - Optional options to write the event
      *
      */
-    writeServiceToDomain: writeServiceToDomain((0, import_node_path10.join)(path, "domains")),
+    writeServiceToDomain: writeServiceToDomain((0, import_node_path11.join)(path2, "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_path10.join)(path)),
+    getService: getService((0, import_node_path11.join)(path2)),
     /**
      * 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_path10.join)(path)),
+    getServices: getServices((0, import_node_path11.join)(path2)),
     /**
      * Moves a given service id to the version directory
      * @param directory
      */
-    versionService: versionService((0, import_node_path10.join)(path)),
+    versionService: versionService((0, import_node_path11.join)(path2)),
     /**
      * 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_path10.join)(path, "services")),
+    rmService: rmService((0, import_node_path11.join)(path2, "services")),
     /**
      * Remove an service by an service id
      *
      * @param id - The id of the service you want to remove
      *
      */
-    rmServiceById: rmServiceById((0, import_node_path10.join)(path)),
+    rmServiceById: rmServiceById((0, import_node_path11.join)(path2)),
     /**
      * Adds a file to the given service
      * @param id - The id of the service to add the file to
@@ -1010,21 +1057,21 @@ var index_default = (path) => {
      * @param version - Optional version of the service to add the file to
      * @returns
      */
-    addFileToService: addFileToService((0, import_node_path10.join)(path)),
+    addFileToService: addFileToService((0, import_node_path11.join)(path2)),
     /**
      * 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_path10.join)(path)),
+    getSpecificationFilesForService: getSpecificationFilesForService((0, import_node_path11.join)(path2)),
     /**
      * 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_path10.join)(path)),
+    serviceHasVersion: serviceHasVersion((0, import_node_path11.join)(path2)),
     /**
      * Add an event to a service by it's id.
      *
@@ -1044,7 +1091,7 @@ var index_default = (path) => {
      *
      * ```
      */
-    addEventToService: addMessageToService((0, import_node_path10.join)(path)),
+    addEventToService: addMessageToService((0, import_node_path11.join)(path2)),
     /**
      * Add a command to a service by it's id.
      *
@@ -1064,7 +1111,7 @@ var index_default = (path) => {
      *
      * ```
      */
-    addCommandToService: addMessageToService((0, import_node_path10.join)(path)),
+    addCommandToService: addMessageToService((0, import_node_path11.join)(path2)),
     /**
      * Add a query to a service by it's id.
      *
@@ -1084,7 +1131,7 @@ var index_default = (path) => {
      *
      * ```
      */
-    addQueryToService: addMessageToService((0, import_node_path10.join)(path)),
+    addQueryToService: addMessageToService((0, import_node_path11.join)(path2)),
     /**
      * ================================
      *            Domains
@@ -1097,39 +1144,39 @@ var index_default = (path) => {
      * @param options - Optional options to write the event
      *
      */
-    writeDomain: writeDomain((0, import_node_path10.join)(path, "domains")),
+    writeDomain: writeDomain((0, import_node_path11.join)(path2, "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_path10.join)(path, "domains")),
+    getDomain: getDomain((0, import_node_path11.join)(path2, "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_path10.join)(path)),
+    getDomains: getDomains((0, import_node_path11.join)(path2)),
     /**
      * Moves a given domain id to the version directory
      * @param directory
      */
-    versionDomain: versionDomain((0, import_node_path10.join)(path, "domains")),
+    versionDomain: versionDomain((0, import_node_path11.join)(path2, "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_path10.join)(path, "domains")),
+    rmDomain: rmDomain((0, import_node_path11.join)(path2, "domains")),
     /**
      * Remove an service by an domain id
      *
      * @param id - The id of the domain you want to remove
      *
      */
-    rmDomainById: rmDomainById((0, import_node_path10.join)(path, "domains")),
+    rmDomainById: rmDomainById((0, import_node_path11.join)(path2, "domains")),
     /**
      * Adds a file to the given domain
      * @param id - The id of the domain to add the file to
@@ -1137,14 +1184,14 @@ var index_default = (path) => {
      * @param version - Optional version of the domain to add the file to
      * @returns
      */
-    addFileToDomain: addFileToDomain((0, import_node_path10.join)(path, "domains")),
+    addFileToDomain: addFileToDomain((0, import_node_path11.join)(path2, "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_path10.join)(path)),
+    domainHasVersion: domainHasVersion((0, import_node_path11.join)(path2)),
     /**
      * Adds a given service to a domain
      * @param id - The id of the domain
@@ -1152,7 +1199,7 @@ var index_default = (path) => {
      * @param version - (Optional) The version of the domain to add the service to
      * @returns
      */
-    addServiceToDomain: addServiceToDomain((0, import_node_path10.join)(path, "domains")),
+    addServiceToDomain: addServiceToDomain((0, import_node_path11.join)(path2, "domains")),
     /**
      * ================================
      *            Teams
@@ -1165,25 +1212,25 @@ var index_default = (path) => {
      * @param options - Optional options to write the team
      *
      */
-    writeTeam: writeTeam((0, import_node_path10.join)(path, "teams")),
+    writeTeam: writeTeam((0, import_node_path11.join)(path2, "teams")),
     /**
      * Returns a team from EventCatalog
      * @param id - The id of the team to retrieve
      * @returns Team|Undefined
      */
-    getTeam: getTeam((0, import_node_path10.join)(path, "teams")),
+    getTeam: getTeam((0, import_node_path11.join)(path2, "teams")),
     /**
      * Returns all teams from EventCatalog
      * @returns Team[]|Undefined
      */
-    getTeams: getTeams((0, import_node_path10.join)(path)),
+    getTeams: getTeams((0, import_node_path11.join)(path2)),
     /**
      * Remove a team by the team id
      *
      * @param id - The id of the team you want to remove
      *
      */
-    rmTeamById: rmTeamById((0, import_node_path10.join)(path, "teams")),
+    rmTeamById: rmTeamById((0, import_node_path11.join)(path2, "teams")),
     /**
      * ================================
      *            Users
@@ -1196,25 +1243,55 @@ var index_default = (path) => {
      * @param options - Optional options to write the user
      *
      */
-    writeUser: writeUser((0, import_node_path10.join)(path, "users")),
+    writeUser: writeUser((0, import_node_path11.join)(path2, "users")),
     /**
      * Returns a user from EventCatalog
      * @param id - The id of the user to retrieve
      * @returns User|Undefined
      */
-    getUser: getUser((0, import_node_path10.join)(path, "users")),
+    getUser: getUser((0, import_node_path11.join)(path2, "users")),
     /**
      * Returns all user from EventCatalog
      * @returns User[]|Undefined
      */
-    getUsers: getUsers((0, import_node_path10.join)(path)),
+    getUsers: getUsers((0, import_node_path11.join)(path2)),
     /**
      * Remove a user by the user id
      *
      * @param id - The id of the user you want to remove
      *
      */
-    rmUserById: rmUserById((0, import_node_path10.join)(path, "users"))
+    rmUserById: rmUserById((0, import_node_path11.join)(path2, "users")),
+    /**
+     * ================================
+     *            Custom Docs
+     * ================================
+     */
+    /**
+     * Returns a custom doc from EventCatalog
+     * @param path - The path to the custom doc to retrieve
+     * @returns CustomDoc|Undefined
+     */
+    getCustomDoc: getCustomDoc((0, import_node_path11.join)(path2, "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)(path2, "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)(path2, "docs")),
+    /**
+     * Removes a custom doc from EventCatalog
+     * @param path - The path to the custom doc to remove
+     *
+     */
+    rmCustomDoc: rmCustomDoc((0, import_node_path11.join)(path2, "docs"))
   };
 };
 //# sourceMappingURL=index.js.map