@eventcatalog/sdk 2.6.8 → 2.7.0

package/dist/eventcatalog.mjs

@@ -1,9 +1,9 @@
 // src/eventcatalog.ts
-import fs10 from "fs";
-import path4, { join as join14 } from "path";
+import fs11 from "fs";
+import path4, { join as join15 } from "path";
 
 // src/index.ts
-import { join as join13 } from "path";
+import { join as join14 } from "path";
 
 // src/events.ts
 import fs2 from "fs/promises";
@@ -522,6 +522,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 = 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 = join6(path5, "services");
+  await rmServiceById(directory)(id, version);
+  await writeService(pathToResource)(service, { format: extension === ".md" ? "md" : "mdx" });
+};
 
 // src/domains.ts
 import fs6 from "fs/promises";
@@ -605,6 +627,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 = path.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
 import fs7 from "fs/promises";
@@ -906,6 +943,28 @@ var getOwnersForResource = (catalogDir) => async (id, version) => {
   return owners;
 };
 
+// src/entities.ts
+import fs10 from "fs/promises";
+import { join as join13 } from "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 fs10.rm(join13(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 {
@@ -915,13 +974,13 @@ var index_default = (path5) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Event|Undefined
      */
-    getEvent: getEvent(join13(path5)),
+    getEvent: getEvent(join14(path5)),
     /**
      * Returns all events from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Event[]|Undefined
      */
-    getEvents: getEvents(join13(path5)),
+    getEvents: getEvents(join14(path5)),
     /**
      * Adds an event to EventCatalog
      *
@@ -929,7 +988,7 @@ var index_default = (path5) => {
      * @param options - Optional options to write the event
      *
      */
-    writeEvent: writeEvent(join13(path5, "events")),
+    writeEvent: writeEvent(join14(path5, "events")),
     /**
      * Adds an event to a service in EventCatalog
      *
@@ -938,26 +997,26 @@ var index_default = (path5) => {
      * @param options - Optional options to write the event
      *
      */
-    writeEventToService: writeEventToService(join13(path5)),
+    writeEventToService: writeEventToService(join14(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(join13(path5, "events")),
+    rmEvent: rmEvent(join14(path5, "events")),
     /**
      * Remove an event by an Event id
      *
      * @param id - The id of the event you want to remove
      *
      */
-    rmEventById: rmEventById(join13(path5)),
+    rmEventById: rmEventById(join14(path5)),
     /**
      * Moves a given event id to the version directory
      * @param directory
      */
-    versionEvent: versionEvent(join13(path5)),
+    versionEvent: versionEvent(join14(path5)),
     /**
      * Adds a file to the given event
      * @param id - The id of the event to add the file to
@@ -965,7 +1024,7 @@ var index_default = (path5) => {
      * @param version - Optional version of the event to add the file to
      * @returns
      */
-    addFileToEvent: addFileToEvent(join13(path5)),
+    addFileToEvent: addFileToEvent(join14(path5)),
     /**
      * Adds a schema to the given event
      * @param id - The id of the event to add the schema to
@@ -973,14 +1032,14 @@ var index_default = (path5) => {
      * @param version - Optional version of the event to add the schema to
      * @returns
      */
-    addSchemaToEvent: addSchemaToEvent(join13(path5)),
+    addSchemaToEvent: addSchemaToEvent(join14(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(join13(path5)),
+    eventHasVersion: eventHasVersion(join14(path5)),
     /**
      * ================================
      *            Commands
@@ -992,13 +1051,13 @@ var index_default = (path5) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Command|Undefined
      */
-    getCommand: getCommand(join13(path5)),
+    getCommand: getCommand(join14(path5)),
     /**
      * Returns all commands from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Command[]|Undefined
      */
-    getCommands: getCommands(join13(path5)),
+    getCommands: getCommands(join14(path5)),
     /**
      * Adds an command to EventCatalog
      *
@@ -1006,7 +1065,7 @@ var index_default = (path5) => {
      * @param options - Optional options to write the command
      *
      */
-    writeCommand: writeCommand(join13(path5, "commands")),
+    writeCommand: writeCommand(join14(path5, "commands")),
     /**
      * Adds a command to a service in EventCatalog
      *
@@ -1015,26 +1074,26 @@ var index_default = (path5) => {
      * @param options - Optional options to write the command
      *
      */
-    writeCommandToService: writeCommandToService(join13(path5)),
+    writeCommandToService: writeCommandToService(join14(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(join13(path5, "commands")),
+    rmCommand: rmCommand(join14(path5, "commands")),
     /**
      * Remove an command by an Event id
      *
      * @param id - The id of the command you want to remove
      *
      */
-    rmCommandById: rmCommandById(join13(path5)),
+    rmCommandById: rmCommandById(join14(path5)),
     /**
      * Moves a given command id to the version directory
      * @param directory
      */
-    versionCommand: versionCommand(join13(path5)),
+    versionCommand: versionCommand(join14(path5)),
     /**
      * Adds a file to the given command
      * @param id - The id of the command to add the file to
@@ -1042,7 +1101,7 @@ var index_default = (path5) => {
      * @param version - Optional version of the command to add the file to
      * @returns
      */
-    addFileToCommand: addFileToCommand(join13(path5)),
+    addFileToCommand: addFileToCommand(join14(path5)),
     /**
      * Adds a schema to the given command
      * @param id - The id of the command to add the schema to
@@ -1050,14 +1109,14 @@ var index_default = (path5) => {
      * @param version - Optional version of the command to add the schema to
      * @returns
      */
-    addSchemaToCommand: addSchemaToCommand(join13(path5)),
+    addSchemaToCommand: addSchemaToCommand(join14(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(join13(path5)),
+    commandHasVersion: commandHasVersion(join14(path5)),
     /**
      * ================================
      *            Queries
@@ -1069,13 +1128,13 @@ var index_default = (path5) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Query|Undefined
      */
-    getQuery: getQuery(join13(path5)),
+    getQuery: getQuery(join14(path5)),
     /**
      * Returns all queries from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Query[]|Undefined
      */
-    getQueries: getQueries(join13(path5)),
+    getQueries: getQueries(join14(path5)),
     /**
      * Adds a query to EventCatalog
      *
@@ -1083,7 +1142,7 @@ var index_default = (path5) => {
      * @param options - Optional options to write the event
      *
      */
-    writeQuery: writeQuery(join13(path5, "queries")),
+    writeQuery: writeQuery(join14(path5, "queries")),
     /**
      * Adds a query to a service in EventCatalog
      *
@@ -1092,26 +1151,26 @@ var index_default = (path5) => {
      * @param options - Optional options to write the query
      *
      */
-    writeQueryToService: writeQueryToService(join13(path5)),
+    writeQueryToService: writeQueryToService(join14(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(join13(path5, "queries")),
+    rmQuery: rmQuery(join14(path5, "queries")),
     /**
      * Remove a query by a Query id
      *
      * @param id - The id of the query you want to remove
      *
      */
-    rmQueryById: rmQueryById(join13(path5)),
+    rmQueryById: rmQueryById(join14(path5)),
     /**
      * Moves a given query id to the version directory
      * @param directory
      */
-    versionQuery: versionQuery(join13(path5)),
+    versionQuery: versionQuery(join14(path5)),
     /**
      * Adds a file to the given query
      * @param id - The id of the query to add the file to
@@ -1119,7 +1178,7 @@ var index_default = (path5) => {
      * @param version - Optional version of the query to add the file to
      * @returns
      */
-    addFileToQuery: addFileToQuery(join13(path5)),
+    addFileToQuery: addFileToQuery(join14(path5)),
     /**
      * Adds a schema to the given query
      * @param id - The id of the query to add the schema to
@@ -1127,14 +1186,14 @@ var index_default = (path5) => {
      * @param version - Optional version of the query to add the schema to
      * @returns
      */
-    addSchemaToQuery: addSchemaToQuery(join13(path5)),
+    addSchemaToQuery: addSchemaToQuery(join14(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(join13(path5)),
+    queryHasVersion: queryHasVersion(join14(path5)),
     /**
      * ================================
      *            Channels
@@ -1146,13 +1205,13 @@ var index_default = (path5) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Channel|Undefined
      */
-    getChannel: getChannel(join13(path5)),
+    getChannel: getChannel(join14(path5)),
     /**
      * Returns all channels from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Channel[]|Undefined
      */
-    getChannels: getChannels(join13(path5)),
+    getChannels: getChannels(join14(path5)),
     /**
      * Adds an channel to EventCatalog
      *
@@ -1160,33 +1219,33 @@ var index_default = (path5) => {
      * @param options - Optional options to write the channel
      *
      */
-    writeChannel: writeChannel(join13(path5, "channels")),
+    writeChannel: writeChannel(join14(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(join13(path5, "channels")),
+    rmChannel: rmChannel(join14(path5, "channels")),
     /**
      * Remove an channel by an Event id
      *
      * @param id - The id of the channel you want to remove
      *
      */
-    rmChannelById: rmChannelById(join13(path5)),
+    rmChannelById: rmChannelById(join14(path5)),
     /**
      * Moves a given channel id to the version directory
      * @param directory
      */
-    versionChannel: versionChannel(join13(path5)),
+    versionChannel: versionChannel(join14(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(join13(path5)),
+    channelHasVersion: channelHasVersion(join14(path5)),
     /**
      * Add a channel to an event
      *
@@ -1203,7 +1262,7 @@ var index_default = (path5) => {
      *
      * ```
      */
-    addEventToChannel: addMessageToChannel(join13(path5), "events"),
+    addEventToChannel: addMessageToChannel(join14(path5), "events"),
     /**
      * Add a channel to an command
      *
@@ -1220,7 +1279,7 @@ var index_default = (path5) => {
      *
      * ```
      */
-    addCommandToChannel: addMessageToChannel(join13(path5), "commands"),
+    addCommandToChannel: addMessageToChannel(join14(path5), "commands"),
     /**
      * Add a channel to an query
      *
@@ -1237,7 +1296,7 @@ var index_default = (path5) => {
      *
      * ```
      */
-    addQueryToChannel: addMessageToChannel(join13(path5), "queries"),
+    addQueryToChannel: addMessageToChannel(join14(path5), "queries"),
     /**
      * ================================
      *            SERVICES
@@ -1250,14 +1309,14 @@ var index_default = (path5) => {
      * @param options - Optional options to write the event
      *
      */
-    writeService: writeService(join13(path5, "services")),
+    writeService: writeService(join14(path5, "services")),
     /**
      * Adds a versioned service to EventCatalog
      *
      * @param service - The service to write
      *
      */
-    writeVersionedService: writeVersionedService(join13(path5, "services")),
+    writeVersionedService: writeVersionedService(join14(path5, "services")),
     /**
      * Adds a service to a domain in EventCatalog
      *
@@ -1266,45 +1325,45 @@ var index_default = (path5) => {
      * @param options - Optional options to write the event
      *
      */
-    writeServiceToDomain: writeServiceToDomain(join13(path5, "domains")),
+    writeServiceToDomain: writeServiceToDomain(join14(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(join13(path5)),
+    getService: getService(join14(path5)),
     /**
      * Returns a service from EventCatalog by it's path.
      * @param path - The path to the service to retrieve
      * @returns Service|Undefined
      */
-    getServiceByPath: getServiceByPath(join13(path5)),
+    getServiceByPath: getServiceByPath(join14(path5)),
     /**
      * Returns all services from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Service[]|Undefined
      */
-    getServices: getServices(join13(path5)),
+    getServices: getServices(join14(path5)),
     /**
      * Moves a given service id to the version directory
      * @param directory
      */
-    versionService: versionService(join13(path5)),
+    versionService: versionService(join14(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(join13(path5, "services")),
+    rmService: rmService(join14(path5, "services")),
     /**
      * Remove an service by an service id
      *
      * @param id - The id of the service you want to remove
      *
      */
-    rmServiceById: rmServiceById(join13(path5)),
+    rmServiceById: rmServiceById(join14(path5)),
     /**
      * Adds a file to the given service
      * @param id - The id of the service to add the file to
@@ -1312,21 +1371,21 @@ var index_default = (path5) => {
      * @param version - Optional version of the service to add the file to
      * @returns
      */
-    addFileToService: addFileToService(join13(path5)),
+    addFileToService: addFileToService(join14(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(join13(path5)),
+    getSpecificationFilesForService: getSpecificationFilesForService(join14(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(join13(path5)),
+    serviceHasVersion: serviceHasVersion(join14(path5)),
     /**
      * Add an event to a service by it's id.
      *
@@ -1346,7 +1405,7 @@ var index_default = (path5) => {
      *
      * ```
      */
-    addEventToService: addMessageToService(join13(path5)),
+    addEventToService: addMessageToService(join14(path5)),
     /**
      * Add a command to a service by it's id.
      *
@@ -1366,7 +1425,7 @@ var index_default = (path5) => {
      *
      * ```
      */
-    addCommandToService: addMessageToService(join13(path5)),
+    addCommandToService: addMessageToService(join14(path5)),
     /**
      * Add a query to a service by it's id.
      *
@@ -1386,7 +1445,25 @@ var index_default = (path5) => {
      *
      * ```
      */
-    addQueryToService: addMessageToService(join13(path5)),
+    addQueryToService: addMessageToService(join14(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(join14(path5)),
     /**
      * Check to see if a service exists by it's path.
      *
@@ -1403,13 +1480,13 @@ var index_default = (path5) => {
      * @param path - The path to the service to check
      * @returns boolean
      */
-    isService: isService(join13(path5)),
+    isService: isService(join14(path5)),
     /**
      * Converts a file to a service.
      * @param file - The file to convert to a service.
      * @returns The service.
      */
-    toService: toService(join13(path5)),
+    toService: toService(join14(path5)),
     /**
      * ================================
      *            Domains
@@ -1422,39 +1499,39 @@ var index_default = (path5) => {
      * @param options - Optional options to write the event
      *
      */
-    writeDomain: writeDomain(join13(path5, "domains")),
+    writeDomain: writeDomain(join14(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(join13(path5, "domains")),
+    getDomain: getDomain(join14(path5, "domains")),
     /**
      * Returns all domains from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Domain[]|Undefined
      */
-    getDomains: getDomains(join13(path5)),
+    getDomains: getDomains(join14(path5)),
     /**
      * Moves a given domain id to the version directory
      * @param directory
      */
-    versionDomain: versionDomain(join13(path5, "domains")),
+    versionDomain: versionDomain(join14(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(join13(path5, "domains")),
+    rmDomain: rmDomain(join14(path5, "domains")),
     /**
      * Remove an service by an domain id
      *
      * @param id - The id of the domain you want to remove
      *
      */
-    rmDomainById: rmDomainById(join13(path5, "domains")),
+    rmDomainById: rmDomainById(join14(path5, "domains")),
     /**
      * Adds a file to the given domain
      * @param id - The id of the domain to add the file to
@@ -1462,28 +1539,28 @@ var index_default = (path5) => {
      * @param version - Optional version of the domain to add the file to
      * @returns
      */
-    addFileToDomain: addFileToDomain(join13(path5, "domains")),
+    addFileToDomain: addFileToDomain(join14(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(join13(path5, "domains")),
+    addUbiquitousLanguageToDomain: addUbiquitousLanguageToDomain(join14(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(join13(path5, "domains")),
+    getUbiquitousLanguageFromDomain: getUbiquitousLanguageFromDomain(join14(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(join13(path5)),
+    domainHasVersion: domainHasVersion(join14(path5)),
     /**
      * Adds a given service to a domain
      * @param id - The id of the domain
@@ -1491,7 +1568,7 @@ var index_default = (path5) => {
      * @param version - (Optional) The version of the domain to add the service to
      * @returns
      */
-    addServiceToDomain: addServiceToDomain(join13(path5, "domains")),
+    addServiceToDomain: addServiceToDomain(join14(path5, "domains")),
     /**
      * Adds a given subdomain to a domain
      * @param id - The id of the domain
@@ -1499,7 +1576,15 @@ var index_default = (path5) => {
      * @param version - (Optional) The version of the domain to add the subdomain to
      * @returns
      */
-    addSubDomainToDomain: addSubDomainToDomain(join13(path5, "domains")),
+    addSubDomainToDomain: addSubDomainToDomain(join14(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(join14(path5, "domains")),
     /**
      * ================================
      *            Teams
@@ -1512,25 +1597,25 @@ var index_default = (path5) => {
      * @param options - Optional options to write the team
      *
      */
-    writeTeam: writeTeam(join13(path5, "teams")),
+    writeTeam: writeTeam(join14(path5, "teams")),
     /**
      * Returns a team from EventCatalog
      * @param id - The id of the team to retrieve
      * @returns Team|Undefined
      */
-    getTeam: getTeam(join13(path5, "teams")),
+    getTeam: getTeam(join14(path5, "teams")),
     /**
      * Returns all teams from EventCatalog
      * @returns Team[]|Undefined
      */
-    getTeams: getTeams(join13(path5, "teams")),
+    getTeams: getTeams(join14(path5, "teams")),
     /**
      * Remove a team by the team id
      *
      * @param id - The id of the team you want to remove
      *
      */
-    rmTeamById: rmTeamById(join13(path5, "teams")),
+    rmTeamById: rmTeamById(join14(path5, "teams")),
     /**
      * ================================
      *            Users
@@ -1543,25 +1628,25 @@ var index_default = (path5) => {
      * @param options - Optional options to write the user
      *
      */
-    writeUser: writeUser(join13(path5, "users")),
+    writeUser: writeUser(join14(path5, "users")),
     /**
      * Returns a user from EventCatalog
      * @param id - The id of the user to retrieve
      * @returns User|Undefined
      */
-    getUser: getUser(join13(path5, "users")),
+    getUser: getUser(join14(path5, "users")),
     /**
      * Returns all user from EventCatalog
      * @returns User[]|Undefined
      */
-    getUsers: getUsers(join13(path5)),
+    getUsers: getUsers(join14(path5)),
     /**
      * Remove a user by the user id
      *
      * @param id - The id of the user you want to remove
      *
      */
-    rmUserById: rmUserById(join13(path5, "users")),
+    rmUserById: rmUserById(join14(path5, "users")),
     /**
      * ================================
      *            Custom Docs
@@ -1572,32 +1657,32 @@ var index_default = (path5) => {
      * @param path - The path to the custom doc to retrieve
      * @returns CustomDoc|Undefined
      */
-    getCustomDoc: getCustomDoc(join13(path5, "docs")),
+    getCustomDoc: getCustomDoc(join14(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(join13(path5, "docs")),
+    getCustomDocs: getCustomDocs(join14(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(join13(path5, "docs")),
+    writeCustomDoc: writeCustomDoc(join14(path5, "docs")),
     /**
      * Removes a custom doc from EventCatalog
      * @param path - The path to the custom doc to remove
      *
      */
-    rmCustomDoc: rmCustomDoc(join13(path5, "docs")),
+    rmCustomDoc: rmCustomDoc(join14(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(join13(path5)),
+    dumpCatalog: dumpCatalog(join14(path5)),
     /**
      * Returns the event catalog configuration file.
      * The event catalog configuration file is the file that contains the configuration for the event catalog.
@@ -1605,7 +1690,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(join13(path5)),
+    getEventCatalogConfigurationFile: getEventCatalogConfigurationFile(join14(path5)),
     /**
      * ================================
      *            Resources Utils
@@ -1626,33 +1711,85 @@ var index_default = (path5) => {
      * @param path - The path to the message to retrieve
      * @returns Message|Undefined
      */
-    getMessageBySchemaPath: getMessageBySchemaPath(join13(path5)),
+    getMessageBySchemaPath: getMessageBySchemaPath(join14(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(join13(path5)),
+    getProducersAndConsumersForMessage: getProducersAndConsumersForMessage(join14(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(join13(path5)),
+    getConsumersOfSchema: getConsumersOfSchema(join14(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(join13(path5)),
+    getProducersOfSchema: getProducersOfSchema(join14(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(join13(path5))
+    getOwnersForResource: getOwnersForResource(join14(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(join14(path5)),
+    /**
+     * Returns all entities from EventCatalog
+     * @param latestOnly - optional boolean, set to true to get only latest versions
+     * @returns Entity[]|Undefined
+     */
+    getEntities: getEntities(join14(path5)),
+    /**
+     * Adds an entity to EventCatalog
+     *
+     * @param entity - The entity to write
+     * @param options - Optional options to write the entity
+     *
+     */
+    writeEntity: writeEntity(join14(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(join14(path5, "entities")),
+    /**
+     * Remove an entity by an entity id
+     *
+     * @param id - The id of the entity you want to remove
+     *
+     */
+    rmEntityById: rmEntityById(join14(path5)),
+    /**
+     * Moves a given entity id to the version directory
+     * @param id - The id of the entity to version
+     */
+    versionEntity: versionEntity(join14(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(join14(path5))
   };
 };
 
@@ -1660,7 +1797,7 @@ var index_default = (path5) => {
 var DUMP_VERSION = "0.0.1";
 var getEventCatalogVersion = async (catalogDir) => {
   try {
-    const packageJson = fs10.readFileSync(join14(catalogDir, "package.json"), "utf8");
+    const packageJson = fs11.readFileSync(join15(catalogDir, "package.json"), "utf8");
     const packageJsonObject = JSON.parse(packageJson);
     return packageJsonObject["dependencies"]["@eventcatalog/core"];
   } catch (error) {
@@ -1674,8 +1811,8 @@ var hydrateResource = async (catalogDir, resources = [], { attachSchema = false
       let schema = "";
       if (resource.schemaPath && resourcePath?.fullPath) {
         const pathToSchema = path4.join(path4.dirname(resourcePath?.fullPath), resource.schemaPath);
-        if (fs10.existsSync(pathToSchema)) {
-          schema = fs10.readFileSync(pathToSchema, "utf8");
+        if (fs11.existsSync(pathToSchema)) {
+          schema = fs11.readFileSync(pathToSchema, "utf8");
         }
       }
       const eventcatalog = schema ? { directory: resourcePath?.directory, schema } : { directory: resourcePath?.directory };
@@ -1694,7 +1831,7 @@ var filterCollection = (collection, options) => {
 };
 var getEventCatalogConfigurationFile = (directory) => async () => {
   try {
-    const path5 = join14(directory, "eventcatalog.config.js");
+    const path5 = join15(directory, "eventcatalog.config.js");
     const configModule = await import(path5);
     return configModule.default;
   } catch (error) {