@eventcatalog/sdk 2.11.0 → 2.12.1

package/dist/index.js

@@ -33,7 +33,7 @@ __export(src_exports, {
   default: () => src_default
 });
 module.exports = __toCommonJS(src_exports);
-var import_node_path19 = require("path");
+var import_node_path20 = require("path");
 
 // src/events.ts
 var import_promises2 = __toESM(require("fs/promises"));
@@ -1312,6 +1312,29 @@ var dataProductHasVersion = (directory) => async (id, version) => {
 };
 var addFileToDataProduct = (directory) => async (id, file, version) => addFileToResource(directory, id, file, version);
 
+// src/diagrams.ts
+var import_promises13 = __toESM(require("fs/promises"));
+var import_node_path19 = require("path");
+var getDiagram = (directory) => async (id, version) => getResource(directory, id, version, { type: "diagram" });
+var getDiagrams = (directory) => async (options) => getResources(directory, { type: "diagrams", latestOnly: options?.latestOnly });
+var writeDiagram = (directory) => async (diagram, options = {
+  path: "",
+  override: false,
+  format: "mdx"
+}) => writeResource(directory, { ...diagram }, { ...options, type: "diagram" });
+var rmDiagram = (directory) => async (path6) => {
+  await import_promises13.default.rm((0, import_node_path19.join)(directory, path6), { recursive: true });
+};
+var rmDiagramById = (directory) => async (id, version, persistFiles) => {
+  await rmResourceById(directory, id, version, { type: "diagram", persistFiles });
+};
+var versionDiagram = (directory) => async (id) => versionResource(directory, id);
+var diagramHasVersion = (directory) => async (id, version) => {
+  const file = await findFileById(directory, id, version);
+  return !!file;
+};
+var addFileToDiagram = (directory) => async (id, file, version) => addFileToResource(directory, id, file, version, { type: "diagram" });
+
 // src/index.ts
 var src_default = (path6) => {
   return {
@@ -1321,13 +1344,13 @@ var src_default = (path6) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Event|Undefined
      */
-    getEvent: getEvent((0, import_node_path19.join)(path6)),
+    getEvent: getEvent((0, import_node_path20.join)(path6)),
     /**
      * 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_path19.join)(path6)),
+    getEvents: getEvents((0, import_node_path20.join)(path6)),
     /**
      * Adds an event to EventCatalog
      *
@@ -1335,7 +1358,7 @@ var src_default = (path6) => {
      * @param options - Optional options to write the event
      *
      */
-    writeEvent: writeEvent((0, import_node_path19.join)(path6, "events")),
+    writeEvent: writeEvent((0, import_node_path20.join)(path6, "events")),
     /**
      * Adds an event to a service in EventCatalog
      *
@@ -1344,26 +1367,26 @@ var src_default = (path6) => {
      * @param options - Optional options to write the event
      *
      */
-    writeEventToService: writeEventToService((0, import_node_path19.join)(path6)),
+    writeEventToService: writeEventToService((0, import_node_path20.join)(path6)),
     /**
      * 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_path19.join)(path6, "events")),
+    rmEvent: rmEvent((0, import_node_path20.join)(path6, "events")),
     /**
      * Remove an event by an Event id
      *
      * @param id - The id of the event you want to remove
      *
      */
-    rmEventById: rmEventById((0, import_node_path19.join)(path6)),
+    rmEventById: rmEventById((0, import_node_path20.join)(path6)),
     /**
      * Moves a given event id to the version directory
      * @param directory
      */
-    versionEvent: versionEvent((0, import_node_path19.join)(path6)),
+    versionEvent: versionEvent((0, import_node_path20.join)(path6)),
     /**
      * Adds a file to the given event
      * @param id - The id of the event to add the file to
@@ -1371,7 +1394,7 @@ var src_default = (path6) => {
      * @param version - Optional version of the event to add the file to
      * @returns
      */
-    addFileToEvent: addFileToEvent((0, import_node_path19.join)(path6)),
+    addFileToEvent: addFileToEvent((0, import_node_path20.join)(path6)),
     /**
      * Adds a schema to the given event
      * @param id - The id of the event to add the schema to
@@ -1379,14 +1402,14 @@ var src_default = (path6) => {
      * @param version - Optional version of the event to add the schema to
      * @returns
      */
-    addSchemaToEvent: addSchemaToEvent((0, import_node_path19.join)(path6)),
+    addSchemaToEvent: addSchemaToEvent((0, import_node_path20.join)(path6)),
     /**
      * 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_path19.join)(path6)),
+    eventHasVersion: eventHasVersion((0, import_node_path20.join)(path6)),
     /**
      * ================================
      *            Commands
@@ -1398,13 +1421,13 @@ var src_default = (path6) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Command|Undefined
      */
-    getCommand: getCommand((0, import_node_path19.join)(path6)),
+    getCommand: getCommand((0, import_node_path20.join)(path6)),
     /**
      * 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_path19.join)(path6)),
+    getCommands: getCommands((0, import_node_path20.join)(path6)),
     /**
      * Adds an command to EventCatalog
      *
@@ -1412,7 +1435,7 @@ var src_default = (path6) => {
      * @param options - Optional options to write the command
      *
      */
-    writeCommand: writeCommand((0, import_node_path19.join)(path6, "commands")),
+    writeCommand: writeCommand((0, import_node_path20.join)(path6, "commands")),
     /**
      * Adds a command to a service in EventCatalog
      *
@@ -1421,26 +1444,26 @@ var src_default = (path6) => {
      * @param options - Optional options to write the command
      *
      */
-    writeCommandToService: writeCommandToService((0, import_node_path19.join)(path6)),
+    writeCommandToService: writeCommandToService((0, import_node_path20.join)(path6)),
     /**
      * 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_path19.join)(path6, "commands")),
+    rmCommand: rmCommand((0, import_node_path20.join)(path6, "commands")),
     /**
      * Remove an command by an Event id
      *
      * @param id - The id of the command you want to remove
      *
      */
-    rmCommandById: rmCommandById((0, import_node_path19.join)(path6)),
+    rmCommandById: rmCommandById((0, import_node_path20.join)(path6)),
     /**
      * Moves a given command id to the version directory
      * @param directory
      */
-    versionCommand: versionCommand((0, import_node_path19.join)(path6)),
+    versionCommand: versionCommand((0, import_node_path20.join)(path6)),
     /**
      * Adds a file to the given command
      * @param id - The id of the command to add the file to
@@ -1448,7 +1471,7 @@ var src_default = (path6) => {
      * @param version - Optional version of the command to add the file to
      * @returns
      */
-    addFileToCommand: addFileToCommand((0, import_node_path19.join)(path6)),
+    addFileToCommand: addFileToCommand((0, import_node_path20.join)(path6)),
     /**
      * Adds a schema to the given command
      * @param id - The id of the command to add the schema to
@@ -1456,14 +1479,14 @@ var src_default = (path6) => {
      * @param version - Optional version of the command to add the schema to
      * @returns
      */
-    addSchemaToCommand: addSchemaToCommand((0, import_node_path19.join)(path6)),
+    addSchemaToCommand: addSchemaToCommand((0, import_node_path20.join)(path6)),
     /**
      * 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_path19.join)(path6)),
+    commandHasVersion: commandHasVersion((0, import_node_path20.join)(path6)),
     /**
      * ================================
      *            Queries
@@ -1475,13 +1498,13 @@ var src_default = (path6) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Query|Undefined
      */
-    getQuery: getQuery((0, import_node_path19.join)(path6)),
+    getQuery: getQuery((0, import_node_path20.join)(path6)),
     /**
      * 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_path19.join)(path6)),
+    getQueries: getQueries((0, import_node_path20.join)(path6)),
     /**
      * Adds a query to EventCatalog
      *
@@ -1489,7 +1512,7 @@ var src_default = (path6) => {
      * @param options - Optional options to write the event
      *
      */
-    writeQuery: writeQuery((0, import_node_path19.join)(path6, "queries")),
+    writeQuery: writeQuery((0, import_node_path20.join)(path6, "queries")),
     /**
      * Adds a query to a service in EventCatalog
      *
@@ -1498,26 +1521,26 @@ var src_default = (path6) => {
      * @param options - Optional options to write the query
      *
      */
-    writeQueryToService: writeQueryToService((0, import_node_path19.join)(path6)),
+    writeQueryToService: writeQueryToService((0, import_node_path20.join)(path6)),
     /**
      * 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_path19.join)(path6, "queries")),
+    rmQuery: rmQuery((0, import_node_path20.join)(path6, "queries")),
     /**
      * Remove a query by a Query id
      *
      * @param id - The id of the query you want to remove
      *
      */
-    rmQueryById: rmQueryById((0, import_node_path19.join)(path6)),
+    rmQueryById: rmQueryById((0, import_node_path20.join)(path6)),
     /**
      * Moves a given query id to the version directory
      * @param directory
      */
-    versionQuery: versionQuery((0, import_node_path19.join)(path6)),
+    versionQuery: versionQuery((0, import_node_path20.join)(path6)),
     /**
      * Adds a file to the given query
      * @param id - The id of the query to add the file to
@@ -1525,7 +1548,7 @@ var src_default = (path6) => {
      * @param version - Optional version of the query to add the file to
      * @returns
      */
-    addFileToQuery: addFileToQuery((0, import_node_path19.join)(path6)),
+    addFileToQuery: addFileToQuery((0, import_node_path20.join)(path6)),
     /**
      * Adds a schema to the given query
      * @param id - The id of the query to add the schema to
@@ -1533,14 +1556,14 @@ var src_default = (path6) => {
      * @param version - Optional version of the query to add the schema to
      * @returns
      */
-    addSchemaToQuery: addSchemaToQuery((0, import_node_path19.join)(path6)),
+    addSchemaToQuery: addSchemaToQuery((0, import_node_path20.join)(path6)),
     /**
      * 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_path19.join)(path6)),
+    queryHasVersion: queryHasVersion((0, import_node_path20.join)(path6)),
     /**
      * ================================
      *            Channels
@@ -1552,13 +1575,13 @@ var src_default = (path6) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Channel|Undefined
      */
-    getChannel: getChannel((0, import_node_path19.join)(path6)),
+    getChannel: getChannel((0, import_node_path20.join)(path6)),
     /**
      * 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_path19.join)(path6)),
+    getChannels: getChannels((0, import_node_path20.join)(path6)),
     /**
      * Adds an channel to EventCatalog
      *
@@ -1566,33 +1589,33 @@ var src_default = (path6) => {
      * @param options - Optional options to write the channel
      *
      */
-    writeChannel: writeChannel((0, import_node_path19.join)(path6, "channels")),
+    writeChannel: writeChannel((0, import_node_path20.join)(path6, "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_path19.join)(path6, "channels")),
+    rmChannel: rmChannel((0, import_node_path20.join)(path6, "channels")),
     /**
      * Remove an channel by an Event id
      *
      * @param id - The id of the channel you want to remove
      *
      */
-    rmChannelById: rmChannelById((0, import_node_path19.join)(path6)),
+    rmChannelById: rmChannelById((0, import_node_path20.join)(path6)),
     /**
      * Moves a given channel id to the version directory
      * @param directory
      */
-    versionChannel: versionChannel((0, import_node_path19.join)(path6)),
+    versionChannel: versionChannel((0, import_node_path20.join)(path6)),
     /**
      * 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_path19.join)(path6)),
+    channelHasVersion: channelHasVersion((0, import_node_path20.join)(path6)),
     /**
      * Add a channel to an event
      *
@@ -1609,7 +1632,7 @@ var src_default = (path6) => {
      *
      * ```
      */
-    addEventToChannel: addMessageToChannel((0, import_node_path19.join)(path6), "events"),
+    addEventToChannel: addMessageToChannel((0, import_node_path20.join)(path6), "events"),
     /**
      * Add a channel to an command
      *
@@ -1626,7 +1649,7 @@ var src_default = (path6) => {
      *
      * ```
      */
-    addCommandToChannel: addMessageToChannel((0, import_node_path19.join)(path6), "commands"),
+    addCommandToChannel: addMessageToChannel((0, import_node_path20.join)(path6), "commands"),
     /**
      * Add a channel to an query
      *
@@ -1643,7 +1666,7 @@ var src_default = (path6) => {
      *
      * ```
      */
-    addQueryToChannel: addMessageToChannel((0, import_node_path19.join)(path6), "queries"),
+    addQueryToChannel: addMessageToChannel((0, import_node_path20.join)(path6), "queries"),
     /**
      * ================================
      *            SERVICES
@@ -1656,14 +1679,14 @@ var src_default = (path6) => {
      * @param options - Optional options to write the event
      *
      */
-    writeService: writeService((0, import_node_path19.join)(path6, "services")),
+    writeService: writeService((0, import_node_path20.join)(path6, "services")),
     /**
      * Adds a versioned service to EventCatalog
      *
      * @param service - The service to write
      *
      */
-    writeVersionedService: writeVersionedService((0, import_node_path19.join)(path6, "services")),
+    writeVersionedService: writeVersionedService((0, import_node_path20.join)(path6, "services")),
     /**
      * Adds a service to a domain in EventCatalog
      *
@@ -1672,45 +1695,45 @@ var src_default = (path6) => {
      * @param options - Optional options to write the event
      *
      */
-    writeServiceToDomain: writeServiceToDomain((0, import_node_path19.join)(path6, "domains")),
+    writeServiceToDomain: writeServiceToDomain((0, import_node_path20.join)(path6, "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_path19.join)(path6)),
+    getService: getService((0, import_node_path20.join)(path6)),
     /**
      * Returns a service from EventCatalog by it's path.
      * @param path - The path to the service to retrieve
      * @returns Service|Undefined
      */
-    getServiceByPath: getServiceByPath((0, import_node_path19.join)(path6)),
+    getServiceByPath: getServiceByPath((0, import_node_path20.join)(path6)),
     /**
      * 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_path19.join)(path6)),
+    getServices: getServices((0, import_node_path20.join)(path6)),
     /**
      * Moves a given service id to the version directory
      * @param directory
      */
-    versionService: versionService((0, import_node_path19.join)(path6)),
+    versionService: versionService((0, import_node_path20.join)(path6)),
     /**
      * 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_path19.join)(path6, "services")),
+    rmService: rmService((0, import_node_path20.join)(path6, "services")),
     /**
      * Remove an service by an service id
      *
      * @param id - The id of the service you want to remove
      *
      */
-    rmServiceById: rmServiceById((0, import_node_path19.join)(path6)),
+    rmServiceById: rmServiceById((0, import_node_path20.join)(path6)),
     /**
      * Adds a file to the given service
      * @param id - The id of the service to add the file to
@@ -1718,21 +1741,21 @@ var src_default = (path6) => {
      * @param version - Optional version of the service to add the file to
      * @returns
      */
-    addFileToService: addFileToService((0, import_node_path19.join)(path6)),
+    addFileToService: addFileToService((0, import_node_path20.join)(path6)),
     /**
      * 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_path19.join)(path6)),
+    getSpecificationFilesForService: getSpecificationFilesForService((0, import_node_path20.join)(path6)),
     /**
      * 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_path19.join)(path6)),
+    serviceHasVersion: serviceHasVersion((0, import_node_path20.join)(path6)),
     /**
      * Add an event to a service by it's id.
      *
@@ -1752,7 +1775,7 @@ var src_default = (path6) => {
      *
      * ```
      */
-    addEventToService: addMessageToService((0, import_node_path19.join)(path6)),
+    addEventToService: addMessageToService((0, import_node_path20.join)(path6)),
     /**
      * Add a data store to a service by it's id.
      *
@@ -1769,7 +1792,7 @@ var src_default = (path6) => {
      *
      * ```
      */
-    addDataStoreToService: addDataStoreToService((0, import_node_path19.join)(path6)),
+    addDataStoreToService: addDataStoreToService((0, import_node_path20.join)(path6)),
     /**
      * Add a command to a service by it's id.
      *
@@ -1789,7 +1812,7 @@ var src_default = (path6) => {
      *
      * ```
      */
-    addCommandToService: addMessageToService((0, import_node_path19.join)(path6)),
+    addCommandToService: addMessageToService((0, import_node_path20.join)(path6)),
     /**
      * Add a query to a service by it's id.
      *
@@ -1809,7 +1832,7 @@ var src_default = (path6) => {
      *
      * ```
      */
-    addQueryToService: addMessageToService((0, import_node_path19.join)(path6)),
+    addQueryToService: addMessageToService((0, import_node_path20.join)(path6)),
     /**
      * Add an entity to a service by its id.
      *
@@ -1827,7 +1850,7 @@ var src_default = (path6) => {
      *
      * ```
      */
-    addEntityToService: addEntityToService((0, import_node_path19.join)(path6)),
+    addEntityToService: addEntityToService((0, import_node_path20.join)(path6)),
     /**
      * Check to see if a service exists by it's path.
      *
@@ -1844,13 +1867,13 @@ var src_default = (path6) => {
      * @param path - The path to the service to check
      * @returns boolean
      */
-    isService: isService((0, import_node_path19.join)(path6)),
+    isService: isService((0, import_node_path20.join)(path6)),
     /**
      * Converts a file to a service.
      * @param file - The file to convert to a service.
      * @returns The service.
      */
-    toService: toService((0, import_node_path19.join)(path6)),
+    toService: toService((0, import_node_path20.join)(path6)),
     /**
      * ================================
      *            Domains
@@ -1863,39 +1886,39 @@ var src_default = (path6) => {
      * @param options - Optional options to write the event
      *
      */
-    writeDomain: writeDomain((0, import_node_path19.join)(path6, "domains")),
+    writeDomain: writeDomain((0, import_node_path20.join)(path6, "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_path19.join)(path6, "domains")),
+    getDomain: getDomain((0, import_node_path20.join)(path6, "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_path19.join)(path6)),
+    getDomains: getDomains((0, import_node_path20.join)(path6)),
     /**
      * Moves a given domain id to the version directory
      * @param directory
      */
-    versionDomain: versionDomain((0, import_node_path19.join)(path6, "domains")),
+    versionDomain: versionDomain((0, import_node_path20.join)(path6, "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_path19.join)(path6, "domains")),
+    rmDomain: rmDomain((0, import_node_path20.join)(path6, "domains")),
     /**
      * Remove an service by an domain id
      *
      * @param id - The id of the domain you want to remove
      *
      */
-    rmDomainById: rmDomainById((0, import_node_path19.join)(path6, "domains")),
+    rmDomainById: rmDomainById((0, import_node_path20.join)(path6, "domains")),
     /**
      * Adds a file to the given domain
      * @param id - The id of the domain to add the file to
@@ -1903,28 +1926,28 @@ var src_default = (path6) => {
      * @param version - Optional version of the domain to add the file to
      * @returns
      */
-    addFileToDomain: addFileToDomain((0, import_node_path19.join)(path6, "domains")),
+    addFileToDomain: addFileToDomain((0, import_node_path20.join)(path6, "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_path19.join)(path6, "domains")),
+    addUbiquitousLanguageToDomain: addUbiquitousLanguageToDomain((0, import_node_path20.join)(path6, "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_path19.join)(path6, "domains")),
+    getUbiquitousLanguageFromDomain: getUbiquitousLanguageFromDomain((0, import_node_path20.join)(path6, "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_path19.join)(path6)),
+    domainHasVersion: domainHasVersion((0, import_node_path20.join)(path6)),
     /**
      * Adds a given service to a domain
      * @param id - The id of the domain
@@ -1932,7 +1955,7 @@ var src_default = (path6) => {
      * @param version - (Optional) The version of the domain to add the service to
      * @returns
      */
-    addServiceToDomain: addServiceToDomain((0, import_node_path19.join)(path6, "domains")),
+    addServiceToDomain: addServiceToDomain((0, import_node_path20.join)(path6, "domains")),
     /**
      * Adds a given subdomain to a domain
      * @param id - The id of the domain
@@ -1940,7 +1963,7 @@ var src_default = (path6) => {
      * @param version - (Optional) The version of the domain to add the subdomain to
      * @returns
      */
-    addSubDomainToDomain: addSubDomainToDomain((0, import_node_path19.join)(path6, "domains")),
+    addSubDomainToDomain: addSubDomainToDomain((0, import_node_path20.join)(path6, "domains")),
     /**
      * Adds an entity to a domain
      * @param id - The id of the domain
@@ -1948,7 +1971,7 @@ var src_default = (path6) => {
      * @param version - (Optional) The version of the domain to add the entity to
      * @returns
      */
-    addEntityToDomain: addEntityToDomain((0, import_node_path19.join)(path6, "domains")),
+    addEntityToDomain: addEntityToDomain((0, import_node_path20.join)(path6, "domains")),
     /**
      * Add an event to a domain by its id.
      *
@@ -1966,7 +1989,7 @@ var src_default = (path6) => {
      *
      * ```
      */
-    addEventToDomain: addMessageToDomain((0, import_node_path19.join)(path6, "domains")),
+    addEventToDomain: addMessageToDomain((0, import_node_path20.join)(path6, "domains")),
     /**
      * Add a command to a domain by its id.
      *
@@ -1984,7 +2007,7 @@ var src_default = (path6) => {
      *
      * ```
      */
-    addCommandToDomain: addMessageToDomain((0, import_node_path19.join)(path6, "domains")),
+    addCommandToDomain: addMessageToDomain((0, import_node_path20.join)(path6, "domains")),
     /**
      * Add a query to a domain by its id.
      *
@@ -2002,7 +2025,7 @@ var src_default = (path6) => {
      *
      * ```
      */
-    addQueryToDomain: addMessageToDomain((0, import_node_path19.join)(path6, "domains")),
+    addQueryToDomain: addMessageToDomain((0, import_node_path20.join)(path6, "domains")),
     /**
      * ================================
      *            Teams
@@ -2015,25 +2038,25 @@ var src_default = (path6) => {
      * @param options - Optional options to write the team
      *
      */
-    writeTeam: writeTeam((0, import_node_path19.join)(path6, "teams")),
+    writeTeam: writeTeam((0, import_node_path20.join)(path6, "teams")),
     /**
      * Returns a team from EventCatalog
      * @param id - The id of the team to retrieve
      * @returns Team|Undefined
      */
-    getTeam: getTeam((0, import_node_path19.join)(path6, "teams")),
+    getTeam: getTeam((0, import_node_path20.join)(path6, "teams")),
     /**
      * Returns all teams from EventCatalog
      * @returns Team[]|Undefined
      */
-    getTeams: getTeams((0, import_node_path19.join)(path6, "teams")),
+    getTeams: getTeams((0, import_node_path20.join)(path6, "teams")),
     /**
      * Remove a team by the team id
      *
      * @param id - The id of the team you want to remove
      *
      */
-    rmTeamById: rmTeamById((0, import_node_path19.join)(path6, "teams")),
+    rmTeamById: rmTeamById((0, import_node_path20.join)(path6, "teams")),
     /**
      * ================================
      *            Users
@@ -2046,25 +2069,25 @@ var src_default = (path6) => {
      * @param options - Optional options to write the user
      *
      */
-    writeUser: writeUser((0, import_node_path19.join)(path6, "users")),
+    writeUser: writeUser((0, import_node_path20.join)(path6, "users")),
     /**
      * Returns a user from EventCatalog
      * @param id - The id of the user to retrieve
      * @returns User|Undefined
      */
-    getUser: getUser((0, import_node_path19.join)(path6, "users")),
+    getUser: getUser((0, import_node_path20.join)(path6, "users")),
     /**
      * Returns all user from EventCatalog
      * @returns User[]|Undefined
      */
-    getUsers: getUsers((0, import_node_path19.join)(path6)),
+    getUsers: getUsers((0, import_node_path20.join)(path6)),
     /**
      * Remove a user by the user id
      *
      * @param id - The id of the user you want to remove
      *
      */
-    rmUserById: rmUserById((0, import_node_path19.join)(path6, "users")),
+    rmUserById: rmUserById((0, import_node_path20.join)(path6, "users")),
     /**
      * ================================
      *            Custom Docs
@@ -2075,32 +2098,32 @@ var src_default = (path6) => {
      * @param path - The path to the custom doc to retrieve
      * @returns CustomDoc|Undefined
      */
-    getCustomDoc: getCustomDoc((0, import_node_path19.join)(path6, "docs")),
+    getCustomDoc: getCustomDoc((0, import_node_path20.join)(path6, "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_path19.join)(path6, "docs")),
+    getCustomDocs: getCustomDocs((0, import_node_path20.join)(path6, "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_path19.join)(path6, "docs")),
+    writeCustomDoc: writeCustomDoc((0, import_node_path20.join)(path6, "docs")),
     /**
      * Removes a custom doc from EventCatalog
      * @param path - The path to the custom doc to remove
      *
      */
-    rmCustomDoc: rmCustomDoc((0, import_node_path19.join)(path6, "docs")),
+    rmCustomDoc: rmCustomDoc((0, import_node_path20.join)(path6, "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_path19.join)(path6)),
+    dumpCatalog: dumpCatalog((0, import_node_path20.join)(path6)),
     /**
      * Returns the event catalog configuration file.
      * The event catalog configuration file is the file that contains the configuration for the event catalog.
@@ -2108,7 +2131,7 @@ var src_default = (path6) => {
      * @param directory - The directory of the catalog.
      * @returns A JSON object with the configuration for the event catalog.
      */
-    getEventCatalogConfigurationFile: getEventCatalogConfigurationFile((0, import_node_path19.join)(path6)),
+    getEventCatalogConfigurationFile: getEventCatalogConfigurationFile((0, import_node_path20.join)(path6)),
     /**
      * ================================
      *            Resources Utils
@@ -2133,33 +2156,33 @@ var src_default = (path6) => {
      * @param path - The path to the message to retrieve
      * @returns Message|Undefined
      */
-    getMessageBySchemaPath: getMessageBySchemaPath((0, import_node_path19.join)(path6)),
+    getMessageBySchemaPath: getMessageBySchemaPath((0, import_node_path20.join)(path6)),
     /**
      * Returns the producers and consumers (services) for a given message
      * @param id - The id of the message to get the producers and consumers for
      * @param version - Optional version of the message
      * @returns { producers: Service[], consumers: Service[] }
      */
-    getProducersAndConsumersForMessage: getProducersAndConsumersForMessage((0, import_node_path19.join)(path6)),
+    getProducersAndConsumersForMessage: getProducersAndConsumersForMessage((0, import_node_path20.join)(path6)),
     /**
      * Returns the consumers of a given schema path
      * @param path - The path to the schema to get the consumers for
      * @returns Service[]
      */
-    getConsumersOfSchema: getConsumersOfSchema((0, import_node_path19.join)(path6)),
+    getConsumersOfSchema: getConsumersOfSchema((0, import_node_path20.join)(path6)),
     /**
      * Returns the producers of a given schema path
      * @param path - The path to the schema to get the producers for
      * @returns Service[]
      */
-    getProducersOfSchema: getProducersOfSchema((0, import_node_path19.join)(path6)),
+    getProducersOfSchema: getProducersOfSchema((0, import_node_path20.join)(path6)),
     /**
      * Returns the owners for a given resource (e.g domain, service, event, command, query, etc.)
      * @param id - The id of the resource to get the owners for
      * @param version - Optional version of the resource
      * @returns { owners: User[] }
      */
-    getOwnersForResource: getOwnersForResource((0, import_node_path19.join)(path6)),
+    getOwnersForResource: getOwnersForResource((0, import_node_path20.join)(path6)),
     /**
      * ================================
      *            Entities
@@ -2171,13 +2194,13 @@ var src_default = (path6) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Entity|Undefined
      */
-    getEntity: getEntity((0, import_node_path19.join)(path6)),
+    getEntity: getEntity((0, import_node_path20.join)(path6)),
     /**
      * Returns all entities from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Entity[]|Undefined
      */
-    getEntities: getEntities((0, import_node_path19.join)(path6)),
+    getEntities: getEntities((0, import_node_path20.join)(path6)),
     /**
      * Adds an entity to EventCatalog
      *
@@ -2185,33 +2208,33 @@ var src_default = (path6) => {
      * @param options - Optional options to write the entity
      *
      */
-    writeEntity: writeEntity((0, import_node_path19.join)(path6, "entities")),
+    writeEntity: writeEntity((0, import_node_path20.join)(path6, "entities")),
     /**
      * Remove an entity from EventCatalog (modeled on the standard POSIX rm utility)
      *
      * @param path - The path to your entity, e.g. `/User`
      *
      */
-    rmEntity: rmEntity((0, import_node_path19.join)(path6, "entities")),
+    rmEntity: rmEntity((0, import_node_path20.join)(path6, "entities")),
     /**
      * Remove an entity by an entity id
      *
      * @param id - The id of the entity you want to remove
      *
      */
-    rmEntityById: rmEntityById((0, import_node_path19.join)(path6)),
+    rmEntityById: rmEntityById((0, import_node_path20.join)(path6)),
     /**
      * Moves a given entity id to the version directory
      * @param id - The id of the entity to version
      */
-    versionEntity: versionEntity((0, import_node_path19.join)(path6)),
+    versionEntity: versionEntity((0, import_node_path20.join)(path6)),
     /**
      * Check to see if an entity version exists
      * @param id - The id of the entity
      * @param version - The version of the entity (supports semver)
      * @returns
      */
-    entityHasVersion: entityHasVersion((0, import_node_path19.join)(path6)),
+    entityHasVersion: entityHasVersion((0, import_node_path20.join)(path6)),
     /**
      * ================================
      *            Data Stores
@@ -2223,42 +2246,42 @@ var src_default = (path6) => {
      * @param options - Optional options to write the data store
      *
      */
-    writeDataStore: writeDataStore((0, import_node_path19.join)(path6, "containers")),
+    writeDataStore: writeDataStore((0, import_node_path20.join)(path6, "containers")),
     /**
      * Returns a data store from EventCatalog
      * @param id - The id of the data store to retrieve
      * @param version - Optional id of the version to get (supports semver)
      * @returns Container|Undefined
      */
-    getDataStore: getDataStore((0, import_node_path19.join)(path6)),
+    getDataStore: getDataStore((0, import_node_path20.join)(path6)),
     /**
      * Returns all data stores from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Container[]|Undefined
      */
-    getDataStores: getDataStores((0, import_node_path19.join)(path6)),
+    getDataStores: getDataStores((0, import_node_path20.join)(path6)),
     /**
      * Version a data store by its id
      * @param id - The id of the data store to version
      */
-    versionDataStore: versionDataStore((0, import_node_path19.join)(path6, "containers")),
+    versionDataStore: versionDataStore((0, import_node_path20.join)(path6, "containers")),
     /**
      * Remove a data store by its path
      * @param path - The path to the data store to remove
      */
-    rmDataStore: rmDataStore((0, import_node_path19.join)(path6, "containers")),
+    rmDataStore: rmDataStore((0, import_node_path20.join)(path6, "containers")),
     /**
      * Remove a data store by its id
      * @param id - The id of the data store to remove
      */
-    rmDataStoreById: rmDataStoreById((0, import_node_path19.join)(path6)),
+    rmDataStoreById: rmDataStoreById((0, import_node_path20.join)(path6)),
     /**
      * Check to see if a data store version exists
      * @param id - The id of the data store
      * @param version - The version of the data store (supports semver)
      * @returns
      */
-    dataStoreHasVersion: dataStoreHasVersion((0, import_node_path19.join)(path6)),
+    dataStoreHasVersion: dataStoreHasVersion((0, import_node_path20.join)(path6)),
     /**
      * Adds a file to a data store by its id
      * @param id - The id of the data store to add the file to
@@ -2266,14 +2289,14 @@ var src_default = (path6) => {
      * @param version - Optional version of the data store to add the file to
      * @returns
      */
-    addFileToDataStore: addFileToDataStore((0, import_node_path19.join)(path6)),
+    addFileToDataStore: addFileToDataStore((0, import_node_path20.join)(path6)),
     /**
      * Writes a data store to a service by its id
      * @param dataStore - The data store to write
      * @param service - The service to write the data store to
      * @returns
      */
-    writeDataStoreToService: writeDataStoreToService((0, import_node_path19.join)(path6)),
+    writeDataStoreToService: writeDataStoreToService((0, import_node_path20.join)(path6)),
     /**
      * ================================
      *            Data Products
@@ -2285,7 +2308,7 @@ var src_default = (path6) => {
      * @param options - Optional options to write the data product
      *
      */
-    writeDataProduct: writeDataProduct((0, import_node_path19.join)(path6, "data-products")),
+    writeDataProduct: writeDataProduct((0, import_node_path20.join)(path6, "data-products")),
     /**
      * Writes a data product to a domain in EventCatalog
      * @param dataProduct - The data product to write
@@ -2293,43 +2316,43 @@ var src_default = (path6) => {
      * @param options - Optional options to write the data product
      *
      */
-    writeDataProductToDomain: writeDataProductToDomain((0, import_node_path19.join)(path6, "domains")),
+    writeDataProductToDomain: writeDataProductToDomain((0, import_node_path20.join)(path6, "domains")),
     /**
      * Returns a data product from EventCatalog
      * @param id - The id of the data product to retrieve
      * @param version - Optional id of the version to get (supports semver)
      * @returns DataProduct|Undefined
      */
-    getDataProduct: getDataProduct((0, import_node_path19.join)(path6)),
+    getDataProduct: getDataProduct((0, import_node_path20.join)(path6)),
     /**
      * Returns all data products from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns DataProduct[]|Undefined
      */
-    getDataProducts: getDataProducts((0, import_node_path19.join)(path6)),
+    getDataProducts: getDataProducts((0, import_node_path20.join)(path6)),
     /**
      * Version a data product by its id
      * @param id - The id of the data product to version
      */
-    versionDataProduct: versionDataProduct((0, import_node_path19.join)(path6)),
+    versionDataProduct: versionDataProduct((0, import_node_path20.join)(path6)),
     /**
      * Remove a data product by its path
      * @param path - The path to the data product to remove
      */
-    rmDataProduct: rmDataProduct((0, import_node_path19.join)(path6, "data-products")),
+    rmDataProduct: rmDataProduct((0, import_node_path20.join)(path6, "data-products")),
     /**
      * Remove a data product by its id
      * @param id - The id of the data product to remove
      * @param version - Optional version of the data product to remove
      */
-    rmDataProductById: rmDataProductById((0, import_node_path19.join)(path6)),
+    rmDataProductById: rmDataProductById((0, import_node_path20.join)(path6)),
     /**
      * Check to see if a data product version exists
      * @param id - The id of the data product
      * @param version - The version of the data product (supports semver)
      * @returns
      */
-    dataProductHasVersion: dataProductHasVersion((0, import_node_path19.join)(path6)),
+    dataProductHasVersion: dataProductHasVersion((0, import_node_path20.join)(path6)),
     /**
      * Adds a file to a data product by its id
      * @param id - The id of the data product to add the file to
@@ -2337,7 +2360,7 @@ var src_default = (path6) => {
      * @param version - Optional version of the data product to add the file to
      * @returns
      */
-    addFileToDataProduct: addFileToDataProduct((0, import_node_path19.join)(path6)),
+    addFileToDataProduct: addFileToDataProduct((0, import_node_path20.join)(path6)),
     /**
      * Adds a data product to a domain
      * @param id - The id of the domain
@@ -2345,7 +2368,67 @@ var src_default = (path6) => {
      * @param version - (Optional) The version of the domain to add the data product to
      * @returns
      */
-    addDataProductToDomain: addDataProductToDomain((0, import_node_path19.join)(path6, "domains"))
+    addDataProductToDomain: addDataProductToDomain((0, import_node_path20.join)(path6, "domains")),
+    /**
+     * ================================
+     *            Diagrams
+     * ================================
+     */
+    /**
+     * Returns a diagram from EventCatalog
+     * @param id - The id of the diagram to retrieve
+     * @param version - Optional id of the version to get (supports semver)
+     * @returns Diagram|Undefined
+     */
+    getDiagram: getDiagram((0, import_node_path20.join)(path6)),
+    /**
+     * Returns all diagrams from EventCatalog
+     * @param latestOnly - optional boolean, set to true to get only latest versions
+     * @returns Diagram[]|Undefined
+     */
+    getDiagrams: getDiagrams((0, import_node_path20.join)(path6)),
+    /**
+     * Adds a diagram to EventCatalog
+     *
+     * @param diagram - The diagram to write
+     * @param options - Optional options to write the diagram
+     *
+     */
+    writeDiagram: writeDiagram((0, import_node_path20.join)(path6, "diagrams")),
+    /**
+     * Remove a diagram from EventCatalog (modeled on the standard POSIX rm utility)
+     *
+     * @param path - The path to your diagram, e.g. `/ArchitectureDiagram`
+     *
+     */
+    rmDiagram: rmDiagram((0, import_node_path20.join)(path6, "diagrams")),
+    /**
+     * Remove a diagram by a diagram id
+     *
+     * @param id - The id of the diagram you want to remove
+     *
+     */
+    rmDiagramById: rmDiagramById((0, import_node_path20.join)(path6)),
+    /**
+     * Moves a given diagram id to the version directory
+     * @param id - The id of the diagram to version
+     */
+    versionDiagram: versionDiagram((0, import_node_path20.join)(path6)),
+    /**
+     * Check to see if a diagram version exists
+     * @param id - The id of the diagram
+     * @param version - The version of the diagram (supports semver)
+     * @returns
+     */
+    diagramHasVersion: diagramHasVersion((0, import_node_path20.join)(path6)),
+    /**
+     * Adds a file to the given diagram
+     * @param id - The id of the diagram to add the file to
+     * @param file - File contents to add including the content and the file name
+     * @param version - Optional version of the diagram to add the file to
+     * @returns
+     */
+    addFileToDiagram: addFileToDiagram((0, import_node_path20.join)(path6))
   };
 };
 //# sourceMappingURL=index.js.map