@eventcatalog/sdk 2.8.2 → 2.8.3

package/dist/index.d.mts

@@ -135,12 +135,7 @@ declare const _default: (path: string) => {
      */
     writeCommand: (command: Command, options?: {
         path?: string;
-        override? /**
-         * Remove an event by an Event id
-         *
-         * @param id - The id of the event you want to remove
-         *
-         */: boolean;
+        override?: boolean;
         versionExistingContent?: boolean;
         format?: "md" | "mdx";
     }) => Promise<void>;
@@ -566,6 +561,26 @@ declare const _default: (path: string) => {
         id: string;
         version: string;
     }, version?: string) => Promise<void>;
+    /**
+     * Add a data store to a service by it's id.
+     *
+     * Optionally specify a version to add the data store to a specific version of the service.
+     *
+     * @example
+     * ```ts
+     * import utils from '@eventcatalog/utils';
+     *
+     * const { addDataStoreToService } = utils('/path/to/eventcatalog');
+     *
+     * // adds a new data store (orders-db) that the InventoryService will write to
+     * await addDataStoreToService('InventoryService', 'writesTo', { id: 'orders-db', version: '2.0.0' });
+     *
+     * ```
+     */
+    addDataStoreToService: (id: string, operation: "writesTo" | "readsFrom", dataStore: {
+        id: string;
+        version: string;
+    }, version?: string) => Promise<void>;
     /**
      * Add a command to a service by it's id.
      *
@@ -669,12 +684,7 @@ declare const _default: (path: string) => {
      *
      */
     writeDomain: (domain: Domain, options?: {
-        path? /**
-         * Remove an event to EventCatalog (modeled on the standard POSIX rm utility)
-         *
-         * @param path - The path to your event, e.g. `/Inventory/InventoryAdjusted`
-         *
-         */: string;
+        path?: string;
         override?: boolean;
         versionExistingContent?: boolean;
         format?: "md" | "mdx";
@@ -985,7 +995,14 @@ declare const _default: (path: string) => {
         path?: string;
         override?: boolean;
         versionExistingContent?: boolean;
-        format?: "md" | "mdx";
+        format? /**
+         * Adds an event to a service in EventCatalog
+         *
+         * @param event - The event to write to the service
+         * @param service - The service and it's id to write to the event to
+         * @param options - Optional options to write the event
+         *
+         */: "md" | "mdx";
     }) => Promise<void>;
     /**
      * Remove an entity from EventCatalog (modeled on the standard POSIX rm utility)

package/dist/index.d.ts

@@ -135,12 +135,7 @@ declare const _default: (path: string) => {
      */
     writeCommand: (command: Command, options?: {
         path?: string;
-        override? /**
-         * Remove an event by an Event id
-         *
-         * @param id - The id of the event you want to remove
-         *
-         */: boolean;
+        override?: boolean;
         versionExistingContent?: boolean;
         format?: "md" | "mdx";
     }) => Promise<void>;
@@ -566,6 +561,26 @@ declare const _default: (path: string) => {
         id: string;
         version: string;
     }, version?: string) => Promise<void>;
+    /**
+     * Add a data store to a service by it's id.
+     *
+     * Optionally specify a version to add the data store to a specific version of the service.
+     *
+     * @example
+     * ```ts
+     * import utils from '@eventcatalog/utils';
+     *
+     * const { addDataStoreToService } = utils('/path/to/eventcatalog');
+     *
+     * // adds a new data store (orders-db) that the InventoryService will write to
+     * await addDataStoreToService('InventoryService', 'writesTo', { id: 'orders-db', version: '2.0.0' });
+     *
+     * ```
+     */
+    addDataStoreToService: (id: string, operation: "writesTo" | "readsFrom", dataStore: {
+        id: string;
+        version: string;
+    }, version?: string) => Promise<void>;
     /**
      * Add a command to a service by it's id.
      *
@@ -669,12 +684,7 @@ declare const _default: (path: string) => {
      *
      */
     writeDomain: (domain: Domain, options?: {
-        path? /**
-         * Remove an event to EventCatalog (modeled on the standard POSIX rm utility)
-         *
-         * @param path - The path to your event, e.g. `/Inventory/InventoryAdjusted`
-         *
-         */: string;
+        path?: string;
         override?: boolean;
         versionExistingContent?: boolean;
         format?: "md" | "mdx";
@@ -985,7 +995,14 @@ declare const _default: (path: string) => {
         path?: string;
         override?: boolean;
         versionExistingContent?: boolean;
-        format?: "md" | "mdx";
+        format? /**
+         * Adds an event to a service in EventCatalog
+         *
+         * @param event - The event to write to the service
+         * @param service - The service and it's id to write to the event to
+         * @param options - Optional options to write the event
+         *
+         */: "md" | "mdx";
     }) => Promise<void>;
     /**
      * Remove an entity from EventCatalog (modeled on the standard POSIX rm utility)

package/dist/index.js

@@ -605,6 +605,42 @@ var addEntityToService = (directory) => async (id, entity, version) => {
   await rmServiceById(directory)(id, version);
   await writeService(pathToResource)(service, { format: extension === ".md" ? "md" : "mdx" });
 };
+var addDataStoreToService = (directory) => async (id, operation, dataStore, version) => {
+  let service = await getService(directory)(id, version);
+  const servicePath = await getResourcePath(directory, id, version);
+  const extension = (0, import_node_path6.extname)(servicePath?.fullPath || "");
+  if (operation === "writesTo") {
+    if (service.writesTo === void 0) {
+      service.writesTo = [];
+    }
+    for (let i = 0; i < service.writesTo.length; i++) {
+      if (service.writesTo[i].id === dataStore.id && service.writesTo[i].version === dataStore.version) {
+        return;
+      }
+    }
+    service.writesTo.push({ id: dataStore.id, version: dataStore.version });
+  } else if (operation === "readsFrom") {
+    if (service.readsFrom === void 0) {
+      service.readsFrom = [];
+    }
+    for (let i = 0; i < service.readsFrom.length; i++) {
+      if (service.readsFrom[i].id === dataStore.id && service.readsFrom[i].version === dataStore.version) {
+        return;
+      }
+    }
+    service.readsFrom.push({ id: dataStore.id, version: dataStore.version });
+  } else {
+    throw new Error(`Operation ${operation} is invalid, only 'writesTo' and 'readsFrom' are supported`);
+  }
+  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_path6.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"));
@@ -1607,6 +1643,23 @@ var index_default = (path5) => {
      * ```
      */
     addEventToService: addMessageToService((0, import_node_path17.join)(path5)),
+    /**
+     * Add a data store to a service by it's id.
+     *
+     * Optionally specify a version to add the data store to a specific version of the service.
+     *
+     * @example
+     * ```ts
+     * import utils from '@eventcatalog/utils';
+     *
+     * const { addDataStoreToService } = utils('/path/to/eventcatalog');
+     *
+     * // adds a new data store (orders-db) that the InventoryService will write to
+     * await addDataStoreToService('InventoryService', 'writesTo', { id: 'orders-db', version: '2.0.0' });
+     *
+     * ```
+     */
+    addDataStoreToService: addDataStoreToService((0, import_node_path17.join)(path5)),
     /**
      * Add a command to a service by it's id.
      *