@eventcatalog/sdk 2.8.2 → 2.8.4

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";
@@ -909,6 +919,10 @@ declare const _default: (path: string) => {
         relativePath: string;
         directory: string;
     } | undefined>;
+    /**
+     * Returns the folder name of a given resource
+     */
+    getResourceFolderName: (catalogDir: string, id: string, version?: string) => Promise<string | undefined>;
     /**
      * ================================
      *            General Message Utils