@eventcatalog/sdk 2.6.9 → 2.7.0

package/dist/eventcatalog.js

@@ -35,10 +35,10 @@ __export(eventcatalog_exports, {
 });
 module.exports = __toCommonJS(eventcatalog_exports);
 var import_fs = __toESM(require("fs"));
-var import_node_path14 = __toESM(require("path"));
+var import_node_path15 = __toESM(require("path"));
 
 // src/index.ts
-var import_node_path13 = require("path");
+var import_node_path14 = require("path");
 
 // src/events.ts
 var import_promises2 = __toESM(require("fs/promises"));
@@ -557,6 +557,28 @@ var isService = (directory) => async (path5) => {
   return !!service && segments.includes("services");
 };
 var toService = (directory) => async (file) => toResource(directory, file);
+var addEntityToService = (directory) => async (id, entity, version) => {
+  let service = await getService(directory)(id, version);
+  const servicePath = await getResourcePath(directory, id, version);
+  const extension = (0, import_node_path5.extname)(servicePath?.fullPath || "");
+  if (service.entities === void 0) {
+    service.entities = [];
+  }
+  for (let i = 0; i < service.entities.length; i++) {
+    if (service.entities[i].id === entity.id && service.entities[i].version === entity.version) {
+      return;
+    }
+  }
+  service.entities.push({ id: entity.id, version: entity.version });
+  const existingResource = await findFileById(directory, id, version);
+  if (!existingResource) {
+    throw new Error(`Cannot find service ${id} in the catalog`);
+  }
+  const path5 = existingResource.split(/[\\/]+services/)[0];
+  const pathToResource = (0, import_node_path5.join)(path5, "services");
+  await rmServiceById(directory)(id, version);
+  await writeService(pathToResource)(service, { format: extension === ".md" ? "md" : "mdx" });
+};
 
 // src/domains.ts
 var import_promises6 = __toESM(require("fs/promises"));
@@ -640,6 +662,21 @@ var addSubDomainToDomain = (directory) => async (id, subDomain, version) => {
   await rmDomainById(directory)(id, version, true);
   await writeDomain(directory)(domain, { format: extension === ".md" ? "md" : "mdx" });
 };
+var addEntityToDomain = (directory) => async (id, entity, version) => {
+  let domain = await getDomain(directory)(id, version);
+  const domainPath = await getResourcePath(directory, id, version);
+  const extension = import_node_path6.default.extname(domainPath?.fullPath || "");
+  if (domain.entities === void 0) {
+    domain.entities = [];
+  }
+  const entityExistsInList = domain.entities.some((e) => e.id === entity.id && e.version === entity.version);
+  if (entityExistsInList) {
+    return;
+  }
+  domain.entities.push(entity);
+  await rmDomainById(directory)(id, version, true);
+  await writeDomain(directory)(domain, { format: extension === ".md" ? "md" : "mdx" });
+};
 
 // src/channels.ts
 var import_promises7 = __toESM(require("fs/promises"));
@@ -941,6 +978,28 @@ var getOwnersForResource = (catalogDir) => async (id, version) => {
   return owners;
 };
 
+// src/entities.ts
+var import_promises10 = __toESM(require("fs/promises"));
+var import_node_path13 = require("path");
+var getEntity = (directory) => async (id, version) => getResource(directory, id, version, { type: "entity" });
+var getEntities = (directory) => async (options) => getResources(directory, { type: "entities", latestOnly: options?.latestOnly });
+var writeEntity = (directory) => async (entity, options = {
+  path: "",
+  override: false,
+  format: "mdx"
+}) => writeResource(directory, { ...entity }, { ...options, type: "entity" });
+var rmEntity = (directory) => async (path5) => {
+  await import_promises10.default.rm((0, import_node_path13.join)(directory, path5), { recursive: true });
+};
+var rmEntityById = (directory) => async (id, version, persistFiles) => {
+  await rmResourceById(directory, id, version, { type: "entity", persistFiles });
+};
+var versionEntity = (directory) => async (id) => versionResource(directory, id);
+var entityHasVersion = (directory) => async (id, version) => {
+  const file = await findFileById(directory, id, version);
+  return !!file;
+};
+
 // src/index.ts
 var index_default = (path5) => {
   return {
@@ -950,13 +1009,13 @@ var index_default = (path5) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Event|Undefined
      */
-    getEvent: getEvent((0, import_node_path13.join)(path5)),
+    getEvent: getEvent((0, import_node_path14.join)(path5)),
     /**
      * 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_path13.join)(path5)),
+    getEvents: getEvents((0, import_node_path14.join)(path5)),
     /**
      * Adds an event to EventCatalog
      *
@@ -964,7 +1023,7 @@ var index_default = (path5) => {
      * @param options - Optional options to write the event
      *
      */
-    writeEvent: writeEvent((0, import_node_path13.join)(path5, "events")),
+    writeEvent: writeEvent((0, import_node_path14.join)(path5, "events")),
     /**
      * Adds an event to a service in EventCatalog
      *
@@ -973,26 +1032,26 @@ var index_default = (path5) => {
      * @param options - Optional options to write the event
      *
      */
-    writeEventToService: writeEventToService((0, import_node_path13.join)(path5)),
+    writeEventToService: writeEventToService((0, import_node_path14.join)(path5)),
     /**
      * 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_path13.join)(path5, "events")),
+    rmEvent: rmEvent((0, import_node_path14.join)(path5, "events")),
     /**
      * Remove an event by an Event id
      *
      * @param id - The id of the event you want to remove
      *
      */
-    rmEventById: rmEventById((0, import_node_path13.join)(path5)),
+    rmEventById: rmEventById((0, import_node_path14.join)(path5)),
     /**
      * Moves a given event id to the version directory
      * @param directory
      */
-    versionEvent: versionEvent((0, import_node_path13.join)(path5)),
+    versionEvent: versionEvent((0, import_node_path14.join)(path5)),
     /**
      * Adds a file to the given event
      * @param id - The id of the event to add the file to
@@ -1000,7 +1059,7 @@ var index_default = (path5) => {
      * @param version - Optional version of the event to add the file to
      * @returns
      */
-    addFileToEvent: addFileToEvent((0, import_node_path13.join)(path5)),
+    addFileToEvent: addFileToEvent((0, import_node_path14.join)(path5)),
     /**
      * Adds a schema to the given event
      * @param id - The id of the event to add the schema to
@@ -1008,14 +1067,14 @@ var index_default = (path5) => {
      * @param version - Optional version of the event to add the schema to
      * @returns
      */
-    addSchemaToEvent: addSchemaToEvent((0, import_node_path13.join)(path5)),
+    addSchemaToEvent: addSchemaToEvent((0, import_node_path14.join)(path5)),
     /**
      * 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_path13.join)(path5)),
+    eventHasVersion: eventHasVersion((0, import_node_path14.join)(path5)),
     /**
      * ================================
      *            Commands
@@ -1027,13 +1086,13 @@ var index_default = (path5) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Command|Undefined
      */
-    getCommand: getCommand((0, import_node_path13.join)(path5)),
+    getCommand: getCommand((0, import_node_path14.join)(path5)),
     /**
      * 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_path13.join)(path5)),
+    getCommands: getCommands((0, import_node_path14.join)(path5)),
     /**
      * Adds an command to EventCatalog
      *
@@ -1041,7 +1100,7 @@ var index_default = (path5) => {
      * @param options - Optional options to write the command
      *
      */
-    writeCommand: writeCommand((0, import_node_path13.join)(path5, "commands")),
+    writeCommand: writeCommand((0, import_node_path14.join)(path5, "commands")),
     /**
      * Adds a command to a service in EventCatalog
      *
@@ -1050,26 +1109,26 @@ var index_default = (path5) => {
      * @param options - Optional options to write the command
      *
      */
-    writeCommandToService: writeCommandToService((0, import_node_path13.join)(path5)),
+    writeCommandToService: writeCommandToService((0, import_node_path14.join)(path5)),
     /**
      * 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_path13.join)(path5, "commands")),
+    rmCommand: rmCommand((0, import_node_path14.join)(path5, "commands")),
     /**
      * Remove an command by an Event id
      *
      * @param id - The id of the command you want to remove
      *
      */
-    rmCommandById: rmCommandById((0, import_node_path13.join)(path5)),
+    rmCommandById: rmCommandById((0, import_node_path14.join)(path5)),
     /**
      * Moves a given command id to the version directory
      * @param directory
      */
-    versionCommand: versionCommand((0, import_node_path13.join)(path5)),
+    versionCommand: versionCommand((0, import_node_path14.join)(path5)),
     /**
      * Adds a file to the given command
      * @param id - The id of the command to add the file to
@@ -1077,7 +1136,7 @@ var index_default = (path5) => {
      * @param version - Optional version of the command to add the file to
      * @returns
      */
-    addFileToCommand: addFileToCommand((0, import_node_path13.join)(path5)),
+    addFileToCommand: addFileToCommand((0, import_node_path14.join)(path5)),
     /**
      * Adds a schema to the given command
      * @param id - The id of the command to add the schema to
@@ -1085,14 +1144,14 @@ var index_default = (path5) => {
      * @param version - Optional version of the command to add the schema to
      * @returns
      */
-    addSchemaToCommand: addSchemaToCommand((0, import_node_path13.join)(path5)),
+    addSchemaToCommand: addSchemaToCommand((0, import_node_path14.join)(path5)),
     /**
      * 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_path13.join)(path5)),
+    commandHasVersion: commandHasVersion((0, import_node_path14.join)(path5)),
     /**
      * ================================
      *            Queries
@@ -1104,13 +1163,13 @@ var index_default = (path5) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Query|Undefined
      */
-    getQuery: getQuery((0, import_node_path13.join)(path5)),
+    getQuery: getQuery((0, import_node_path14.join)(path5)),
     /**
      * 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_path13.join)(path5)),
+    getQueries: getQueries((0, import_node_path14.join)(path5)),
     /**
      * Adds a query to EventCatalog
      *
@@ -1118,7 +1177,7 @@ var index_default = (path5) => {
      * @param options - Optional options to write the event
      *
      */
-    writeQuery: writeQuery((0, import_node_path13.join)(path5, "queries")),
+    writeQuery: writeQuery((0, import_node_path14.join)(path5, "queries")),
     /**
      * Adds a query to a service in EventCatalog
      *
@@ -1127,26 +1186,26 @@ var index_default = (path5) => {
      * @param options - Optional options to write the query
      *
      */
-    writeQueryToService: writeQueryToService((0, import_node_path13.join)(path5)),
+    writeQueryToService: writeQueryToService((0, import_node_path14.join)(path5)),
     /**
      * 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_path13.join)(path5, "queries")),
+    rmQuery: rmQuery((0, import_node_path14.join)(path5, "queries")),
     /**
      * Remove a query by a Query id
      *
      * @param id - The id of the query you want to remove
      *
      */
-    rmQueryById: rmQueryById((0, import_node_path13.join)(path5)),
+    rmQueryById: rmQueryById((0, import_node_path14.join)(path5)),
     /**
      * Moves a given query id to the version directory
      * @param directory
      */
-    versionQuery: versionQuery((0, import_node_path13.join)(path5)),
+    versionQuery: versionQuery((0, import_node_path14.join)(path5)),
     /**
      * Adds a file to the given query
      * @param id - The id of the query to add the file to
@@ -1154,7 +1213,7 @@ var index_default = (path5) => {
      * @param version - Optional version of the query to add the file to
      * @returns
      */
-    addFileToQuery: addFileToQuery((0, import_node_path13.join)(path5)),
+    addFileToQuery: addFileToQuery((0, import_node_path14.join)(path5)),
     /**
      * Adds a schema to the given query
      * @param id - The id of the query to add the schema to
@@ -1162,14 +1221,14 @@ var index_default = (path5) => {
      * @param version - Optional version of the query to add the schema to
      * @returns
      */
-    addSchemaToQuery: addSchemaToQuery((0, import_node_path13.join)(path5)),
+    addSchemaToQuery: addSchemaToQuery((0, import_node_path14.join)(path5)),
     /**
      * 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_path13.join)(path5)),
+    queryHasVersion: queryHasVersion((0, import_node_path14.join)(path5)),
     /**
      * ================================
      *            Channels
@@ -1181,13 +1240,13 @@ var index_default = (path5) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Channel|Undefined
      */
-    getChannel: getChannel((0, import_node_path13.join)(path5)),
+    getChannel: getChannel((0, import_node_path14.join)(path5)),
     /**
      * 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_path13.join)(path5)),
+    getChannels: getChannels((0, import_node_path14.join)(path5)),
     /**
      * Adds an channel to EventCatalog
      *
@@ -1195,33 +1254,33 @@ var index_default = (path5) => {
      * @param options - Optional options to write the channel
      *
      */
-    writeChannel: writeChannel((0, import_node_path13.join)(path5, "channels")),
+    writeChannel: writeChannel((0, import_node_path14.join)(path5, "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_path13.join)(path5, "channels")),
+    rmChannel: rmChannel((0, import_node_path14.join)(path5, "channels")),
     /**
      * Remove an channel by an Event id
      *
      * @param id - The id of the channel you want to remove
      *
      */
-    rmChannelById: rmChannelById((0, import_node_path13.join)(path5)),
+    rmChannelById: rmChannelById((0, import_node_path14.join)(path5)),
     /**
      * Moves a given channel id to the version directory
      * @param directory
      */
-    versionChannel: versionChannel((0, import_node_path13.join)(path5)),
+    versionChannel: versionChannel((0, import_node_path14.join)(path5)),
     /**
      * 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_path13.join)(path5)),
+    channelHasVersion: channelHasVersion((0, import_node_path14.join)(path5)),
     /**
      * Add a channel to an event
      *
@@ -1238,7 +1297,7 @@ var index_default = (path5) => {
      *
      * ```
      */
-    addEventToChannel: addMessageToChannel((0, import_node_path13.join)(path5), "events"),
+    addEventToChannel: addMessageToChannel((0, import_node_path14.join)(path5), "events"),
     /**
      * Add a channel to an command
      *
@@ -1255,7 +1314,7 @@ var index_default = (path5) => {
      *
      * ```
      */
-    addCommandToChannel: addMessageToChannel((0, import_node_path13.join)(path5), "commands"),
+    addCommandToChannel: addMessageToChannel((0, import_node_path14.join)(path5), "commands"),
     /**
      * Add a channel to an query
      *
@@ -1272,7 +1331,7 @@ var index_default = (path5) => {
      *
      * ```
      */
-    addQueryToChannel: addMessageToChannel((0, import_node_path13.join)(path5), "queries"),
+    addQueryToChannel: addMessageToChannel((0, import_node_path14.join)(path5), "queries"),
     /**
      * ================================
      *            SERVICES
@@ -1285,14 +1344,14 @@ var index_default = (path5) => {
      * @param options - Optional options to write the event
      *
      */
-    writeService: writeService((0, import_node_path13.join)(path5, "services")),
+    writeService: writeService((0, import_node_path14.join)(path5, "services")),
     /**
      * Adds a versioned service to EventCatalog
      *
      * @param service - The service to write
      *
      */
-    writeVersionedService: writeVersionedService((0, import_node_path13.join)(path5, "services")),
+    writeVersionedService: writeVersionedService((0, import_node_path14.join)(path5, "services")),
     /**
      * Adds a service to a domain in EventCatalog
      *
@@ -1301,45 +1360,45 @@ var index_default = (path5) => {
      * @param options - Optional options to write the event
      *
      */
-    writeServiceToDomain: writeServiceToDomain((0, import_node_path13.join)(path5, "domains")),
+    writeServiceToDomain: writeServiceToDomain((0, import_node_path14.join)(path5, "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_path13.join)(path5)),
+    getService: getService((0, import_node_path14.join)(path5)),
     /**
      * 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_path13.join)(path5)),
+    getServiceByPath: getServiceByPath((0, import_node_path14.join)(path5)),
     /**
      * 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_path13.join)(path5)),
+    getServices: getServices((0, import_node_path14.join)(path5)),
     /**
      * Moves a given service id to the version directory
      * @param directory
      */
-    versionService: versionService((0, import_node_path13.join)(path5)),
+    versionService: versionService((0, import_node_path14.join)(path5)),
     /**
      * 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_path13.join)(path5, "services")),
+    rmService: rmService((0, import_node_path14.join)(path5, "services")),
     /**
      * Remove an service by an service id
      *
      * @param id - The id of the service you want to remove
      *
      */
-    rmServiceById: rmServiceById((0, import_node_path13.join)(path5)),
+    rmServiceById: rmServiceById((0, import_node_path14.join)(path5)),
     /**
      * Adds a file to the given service
      * @param id - The id of the service to add the file to
@@ -1347,21 +1406,21 @@ var index_default = (path5) => {
      * @param version - Optional version of the service to add the file to
      * @returns
      */
-    addFileToService: addFileToService((0, import_node_path13.join)(path5)),
+    addFileToService: addFileToService((0, import_node_path14.join)(path5)),
     /**
      * 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_path13.join)(path5)),
+    getSpecificationFilesForService: getSpecificationFilesForService((0, import_node_path14.join)(path5)),
     /**
      * 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_path13.join)(path5)),
+    serviceHasVersion: serviceHasVersion((0, import_node_path14.join)(path5)),
     /**
      * Add an event to a service by it's id.
      *
@@ -1381,7 +1440,7 @@ var index_default = (path5) => {
      *
      * ```
      */
-    addEventToService: addMessageToService((0, import_node_path13.join)(path5)),
+    addEventToService: addMessageToService((0, import_node_path14.join)(path5)),
     /**
      * Add a command to a service by it's id.
      *
@@ -1401,7 +1460,7 @@ var index_default = (path5) => {
      *
      * ```
      */
-    addCommandToService: addMessageToService((0, import_node_path13.join)(path5)),
+    addCommandToService: addMessageToService((0, import_node_path14.join)(path5)),
     /**
      * Add a query to a service by it's id.
      *
@@ -1421,7 +1480,25 @@ var index_default = (path5) => {
      *
      * ```
      */
-    addQueryToService: addMessageToService((0, import_node_path13.join)(path5)),
+    addQueryToService: addMessageToService((0, import_node_path14.join)(path5)),
+    /**
+     * Add an entity to a service by its id.
+     *
+     * @example
+     * ```ts
+     * import utils from '@eventcatalog/utils';
+     *
+     * const { addEntityToService } = utils('/path/to/eventcatalog');
+     *
+     * // adds a new entity (User) to the InventoryService
+     * await addEntityToService('InventoryService', { id: 'User', version: '1.0.0' });
+     *
+     * // adds a new entity (Product) to a specific version of the InventoryService
+     * await addEntityToService('InventoryService', { id: 'Product', version: '1.0.0' }, '2.0.0');
+     *
+     * ```
+     */
+    addEntityToService: addEntityToService((0, import_node_path14.join)(path5)),
     /**
      * Check to see if a service exists by it's path.
      *
@@ -1438,13 +1515,13 @@ var index_default = (path5) => {
      * @param path - The path to the service to check
      * @returns boolean
      */
-    isService: isService((0, import_node_path13.join)(path5)),
+    isService: isService((0, import_node_path14.join)(path5)),
     /**
      * Converts a file to a service.
      * @param file - The file to convert to a service.
      * @returns The service.
      */
-    toService: toService((0, import_node_path13.join)(path5)),
+    toService: toService((0, import_node_path14.join)(path5)),
     /**
      * ================================
      *            Domains
@@ -1457,39 +1534,39 @@ var index_default = (path5) => {
      * @param options - Optional options to write the event
      *
      */
-    writeDomain: writeDomain((0, import_node_path13.join)(path5, "domains")),
+    writeDomain: writeDomain((0, import_node_path14.join)(path5, "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_path13.join)(path5, "domains")),
+    getDomain: getDomain((0, import_node_path14.join)(path5, "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_path13.join)(path5)),
+    getDomains: getDomains((0, import_node_path14.join)(path5)),
     /**
      * Moves a given domain id to the version directory
      * @param directory
      */
-    versionDomain: versionDomain((0, import_node_path13.join)(path5, "domains")),
+    versionDomain: versionDomain((0, import_node_path14.join)(path5, "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_path13.join)(path5, "domains")),
+    rmDomain: rmDomain((0, import_node_path14.join)(path5, "domains")),
     /**
      * Remove an service by an domain id
      *
      * @param id - The id of the domain you want to remove
      *
      */
-    rmDomainById: rmDomainById((0, import_node_path13.join)(path5, "domains")),
+    rmDomainById: rmDomainById((0, import_node_path14.join)(path5, "domains")),
     /**
      * Adds a file to the given domain
      * @param id - The id of the domain to add the file to
@@ -1497,28 +1574,28 @@ var index_default = (path5) => {
      * @param version - Optional version of the domain to add the file to
      * @returns
      */
-    addFileToDomain: addFileToDomain((0, import_node_path13.join)(path5, "domains")),
+    addFileToDomain: addFileToDomain((0, import_node_path14.join)(path5, "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_path13.join)(path5, "domains")),
+    addUbiquitousLanguageToDomain: addUbiquitousLanguageToDomain((0, import_node_path14.join)(path5, "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_path13.join)(path5, "domains")),
+    getUbiquitousLanguageFromDomain: getUbiquitousLanguageFromDomain((0, import_node_path14.join)(path5, "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_path13.join)(path5)),
+    domainHasVersion: domainHasVersion((0, import_node_path14.join)(path5)),
     /**
      * Adds a given service to a domain
      * @param id - The id of the domain
@@ -1526,7 +1603,7 @@ var index_default = (path5) => {
      * @param version - (Optional) The version of the domain to add the service to
      * @returns
      */
-    addServiceToDomain: addServiceToDomain((0, import_node_path13.join)(path5, "domains")),
+    addServiceToDomain: addServiceToDomain((0, import_node_path14.join)(path5, "domains")),
     /**
      * Adds a given subdomain to a domain
      * @param id - The id of the domain
@@ -1534,7 +1611,15 @@ var index_default = (path5) => {
      * @param version - (Optional) The version of the domain to add the subdomain to
      * @returns
      */
-    addSubDomainToDomain: addSubDomainToDomain((0, import_node_path13.join)(path5, "domains")),
+    addSubDomainToDomain: addSubDomainToDomain((0, import_node_path14.join)(path5, "domains")),
+    /**
+     * Adds an entity to a domain
+     * @param id - The id of the domain
+     * @param entity - The id and version of the entity to add
+     * @param version - (Optional) The version of the domain to add the entity to
+     * @returns
+     */
+    addEntityToDomain: addEntityToDomain((0, import_node_path14.join)(path5, "domains")),
     /**
      * ================================
      *            Teams
@@ -1547,25 +1632,25 @@ var index_default = (path5) => {
      * @param options - Optional options to write the team
      *
      */
-    writeTeam: writeTeam((0, import_node_path13.join)(path5, "teams")),
+    writeTeam: writeTeam((0, import_node_path14.join)(path5, "teams")),
     /**
      * Returns a team from EventCatalog
      * @param id - The id of the team to retrieve
      * @returns Team|Undefined
      */
-    getTeam: getTeam((0, import_node_path13.join)(path5, "teams")),
+    getTeam: getTeam((0, import_node_path14.join)(path5, "teams")),
     /**
      * Returns all teams from EventCatalog
      * @returns Team[]|Undefined
      */
-    getTeams: getTeams((0, import_node_path13.join)(path5, "teams")),
+    getTeams: getTeams((0, import_node_path14.join)(path5, "teams")),
     /**
      * Remove a team by the team id
      *
      * @param id - The id of the team you want to remove
      *
      */
-    rmTeamById: rmTeamById((0, import_node_path13.join)(path5, "teams")),
+    rmTeamById: rmTeamById((0, import_node_path14.join)(path5, "teams")),
     /**
      * ================================
      *            Users
@@ -1578,25 +1663,25 @@ var index_default = (path5) => {
      * @param options - Optional options to write the user
      *
      */
-    writeUser: writeUser((0, import_node_path13.join)(path5, "users")),
+    writeUser: writeUser((0, import_node_path14.join)(path5, "users")),
     /**
      * Returns a user from EventCatalog
      * @param id - The id of the user to retrieve
      * @returns User|Undefined
      */
-    getUser: getUser((0, import_node_path13.join)(path5, "users")),
+    getUser: getUser((0, import_node_path14.join)(path5, "users")),
     /**
      * Returns all user from EventCatalog
      * @returns User[]|Undefined
      */
-    getUsers: getUsers((0, import_node_path13.join)(path5)),
+    getUsers: getUsers((0, import_node_path14.join)(path5)),
     /**
      * Remove a user by the user id
      *
      * @param id - The id of the user you want to remove
      *
      */
-    rmUserById: rmUserById((0, import_node_path13.join)(path5, "users")),
+    rmUserById: rmUserById((0, import_node_path14.join)(path5, "users")),
     /**
      * ================================
      *            Custom Docs
@@ -1607,32 +1692,32 @@ var index_default = (path5) => {
      * @param path - The path to the custom doc to retrieve
      * @returns CustomDoc|Undefined
      */
-    getCustomDoc: getCustomDoc((0, import_node_path13.join)(path5, "docs")),
+    getCustomDoc: getCustomDoc((0, import_node_path14.join)(path5, "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_path13.join)(path5, "docs")),
+    getCustomDocs: getCustomDocs((0, import_node_path14.join)(path5, "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_path13.join)(path5, "docs")),
+    writeCustomDoc: writeCustomDoc((0, import_node_path14.join)(path5, "docs")),
     /**
      * Removes a custom doc from EventCatalog
      * @param path - The path to the custom doc to remove
      *
      */
-    rmCustomDoc: rmCustomDoc((0, import_node_path13.join)(path5, "docs")),
+    rmCustomDoc: rmCustomDoc((0, import_node_path14.join)(path5, "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_path13.join)(path5)),
+    dumpCatalog: dumpCatalog((0, import_node_path14.join)(path5)),
     /**
      * Returns the event catalog configuration file.
      * The event catalog configuration file is the file that contains the configuration for the event catalog.
@@ -1640,7 +1725,7 @@ var index_default = (path5) => {
      * @param directory - The directory of the catalog.
      * @returns A JSON object with the configuration for the event catalog.
      */
-    getEventCatalogConfigurationFile: getEventCatalogConfigurationFile((0, import_node_path13.join)(path5)),
+    getEventCatalogConfigurationFile: getEventCatalogConfigurationFile((0, import_node_path14.join)(path5)),
     /**
      * ================================
      *            Resources Utils
@@ -1661,33 +1746,85 @@ var index_default = (path5) => {
      * @param path - The path to the message to retrieve
      * @returns Message|Undefined
      */
-    getMessageBySchemaPath: getMessageBySchemaPath((0, import_node_path13.join)(path5)),
+    getMessageBySchemaPath: getMessageBySchemaPath((0, import_node_path14.join)(path5)),
     /**
      * 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_path13.join)(path5)),
+    getProducersAndConsumersForMessage: getProducersAndConsumersForMessage((0, import_node_path14.join)(path5)),
     /**
      * 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_path13.join)(path5)),
+    getConsumersOfSchema: getConsumersOfSchema((0, import_node_path14.join)(path5)),
     /**
      * 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_path13.join)(path5)),
+    getProducersOfSchema: getProducersOfSchema((0, import_node_path14.join)(path5)),
     /**
      * 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_path13.join)(path5))
+    getOwnersForResource: getOwnersForResource((0, import_node_path14.join)(path5)),
+    /**
+     * ================================
+     *            Entities
+     * ================================
+     */
+    /**
+     * Returns an entity from EventCatalog
+     * @param id - The id of the entity to retrieve
+     * @param version - Optional id of the version to get (supports semver)
+     * @returns Entity|Undefined
+     */
+    getEntity: getEntity((0, import_node_path14.join)(path5)),
+    /**
+     * 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_path14.join)(path5)),
+    /**
+     * Adds an entity to EventCatalog
+     *
+     * @param entity - The entity to write
+     * @param options - Optional options to write the entity
+     *
+     */
+    writeEntity: writeEntity((0, import_node_path14.join)(path5, "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_path14.join)(path5, "entities")),
+    /**
+     * Remove an entity by an entity id
+     *
+     * @param id - The id of the entity you want to remove
+     *
+     */
+    rmEntityById: rmEntityById((0, import_node_path14.join)(path5)),
+    /**
+     * Moves a given entity id to the version directory
+     * @param id - The id of the entity to version
+     */
+    versionEntity: versionEntity((0, import_node_path14.join)(path5)),
+    /**
+     * 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_path14.join)(path5))
   };
 };
 
@@ -1695,7 +1832,7 @@ var index_default = (path5) => {
 var DUMP_VERSION = "0.0.1";
 var getEventCatalogVersion = async (catalogDir) => {
   try {
-    const packageJson = import_fs.default.readFileSync((0, import_node_path14.join)(catalogDir, "package.json"), "utf8");
+    const packageJson = import_fs.default.readFileSync((0, import_node_path15.join)(catalogDir, "package.json"), "utf8");
     const packageJsonObject = JSON.parse(packageJson);
     return packageJsonObject["dependencies"]["@eventcatalog/core"];
   } catch (error) {
@@ -1708,7 +1845,7 @@ var hydrateResource = async (catalogDir, resources = [], { attachSchema = false
       const resourcePath = await getResourcePath(catalogDir, resource.id, resource.version);
       let schema = "";
       if (resource.schemaPath && resourcePath?.fullPath) {
-        const pathToSchema = import_node_path14.default.join(import_node_path14.default.dirname(resourcePath?.fullPath), resource.schemaPath);
+        const pathToSchema = import_node_path15.default.join(import_node_path15.default.dirname(resourcePath?.fullPath), resource.schemaPath);
         if (import_fs.default.existsSync(pathToSchema)) {
           schema = import_fs.default.readFileSync(pathToSchema, "utf8");
         }
@@ -1729,7 +1866,7 @@ var filterCollection = (collection, options) => {
 };
 var getEventCatalogConfigurationFile = (directory) => async () => {
   try {
-    const path5 = (0, import_node_path14.join)(directory, "eventcatalog.config.js");
+    const path5 = (0, import_node_path15.join)(directory, "eventcatalog.config.js");
     const configModule = await import(path5);
     return configModule.default;
   } catch (error) {