@eventcatalog/sdk 2.8.1 → 2.8.3

package/dist/index.d.mts

@@ -151,19 +151,7 @@ declare const _default: (path: string) => {
         id: string;
         version?: string;
     }, options?: {
-        path
-        /**
-         * 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
-         */
-        ? /**
-         * 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
-         */: string;
+        path?: string;
         format?: "md" | "mdx";
         override?: boolean;
     }) => Promise<void>;
@@ -573,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.
      *
@@ -987,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)
@@ -1033,8 +1048,8 @@ declare const _default: (path: string) => {
         format?: "md" | "mdx";
     }) => Promise<void>;
     /**
-     * Returns a container from EventCatalog
-     * @param id - The id of the container to retrieve
+     * 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
      */

package/dist/index.d.ts

@@ -151,19 +151,7 @@ declare const _default: (path: string) => {
         id: string;
         version?: string;
     }, options?: {
-        path
-        /**
-         * 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
-         */
-        ? /**
-         * 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
-         */: string;
+        path?: string;
         format?: "md" | "mdx";
         override?: boolean;
     }) => Promise<void>;
@@ -573,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.
      *
@@ -987,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)
@@ -1033,8 +1048,8 @@ declare const _default: (path: string) => {
         format?: "md" | "mdx";
     }) => Promise<void>;
     /**
-     * Returns a container from EventCatalog
-     * @param id - The id of the container to retrieve
+     * 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
      */

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"));
@@ -1155,6 +1191,17 @@ var writeContainerToService = (directory) => async (container, service, options
   await writeResource(directory, { ...container }, { ...options, path: pathForContainer, type: "container" });
 };
 
+// src/data-stores.ts
+var getDataStore = getContainer;
+var getDataStores = getContainers;
+var writeDataStore = writeContainer;
+var versionDataStore = versionContainer;
+var rmDataStore = rmContainer;
+var rmDataStoreById = rmContainerById;
+var dataStoreHasVersion = containerHasVersion;
+var addFileToDataStore = addFileToContainer;
+var writeDataStoreToService = writeContainerToService;
+
 // src/index.ts
 var index_default = (path5) => {
   return {
@@ -1596,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.
      *
@@ -1991,42 +2055,42 @@ var index_default = (path5) => {
      * @param options - Optional options to write the data store
      *
      */
-    writeDataStore: writeContainer((0, import_node_path17.join)(path5, "containers")),
+    writeDataStore: writeDataStore((0, import_node_path17.join)(path5, "containers")),
     /**
-     * Returns a container from EventCatalog
-     * @param id - The id of the container to retrieve
+     * 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: getContainer((0, import_node_path17.join)(path5)),
+    getDataStore: getDataStore((0, import_node_path17.join)(path5)),
     /**
      * Returns all data stores from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
      * @returns Container[]|Undefined
      */
-    getDataStores: getContainers((0, import_node_path17.join)(path5)),
+    getDataStores: getDataStores((0, import_node_path17.join)(path5)),
     /**
      * Version a data store by its id
      * @param id - The id of the data store to version
      */
-    versionDataStore: versionContainer((0, import_node_path17.join)(path5, "containers")),
+    versionDataStore: versionDataStore((0, import_node_path17.join)(path5, "containers")),
     /**
      * Remove a data store by its path
      * @param path - The path to the data store to remove
      */
-    rmDataStore: rmContainer((0, import_node_path17.join)(path5, "containers")),
+    rmDataStore: rmDataStore((0, import_node_path17.join)(path5, "containers")),
     /**
      * Remove a data store by its id
      * @param id - The id of the data store to remove
      */
-    rmDataStoreById: rmContainerById((0, import_node_path17.join)(path5)),
+    rmDataStoreById: rmDataStoreById((0, import_node_path17.join)(path5)),
     /**
      * 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: containerHasVersion((0, import_node_path17.join)(path5)),
+    dataStoreHasVersion: dataStoreHasVersion((0, import_node_path17.join)(path5)),
     /**
      * Adds a file to a data store by its id
      * @param id - The id of the data store to add the file to
@@ -2034,14 +2098,14 @@ var index_default = (path5) => {
      * @param version - Optional version of the data store to add the file to
      * @returns
      */
-    addFileToDataStore: addFileToContainer((0, import_node_path17.join)(path5)),
+    addFileToDataStore: addFileToDataStore((0, import_node_path17.join)(path5)),
     /**
      * 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: writeContainerToService((0, import_node_path17.join)(path5))
+    writeDataStoreToService: writeDataStoreToService((0, import_node_path17.join)(path5))
   };
 };
 //# sourceMappingURL=index.js.map