@eventcatalog/sdk 2.8.1 → 2.8.2

package/dist/index.d.mts

@@ -135,7 +135,12 @@ declare const _default: (path: string) => {
      */
     writeCommand: (command: Command, options?: {
         path?: string;
-        override?: boolean;
+        override? /**
+         * Remove an event by an Event id
+         *
+         * @param id - The id of the event you want to remove
+         *
+         */: boolean;
         versionExistingContent?: boolean;
         format?: "md" | "mdx";
     }) => Promise<void>;
@@ -151,19 +156,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>;
@@ -676,7 +669,12 @@ declare const _default: (path: string) => {
      *
      */
     writeDomain: (domain: Domain, options?: {
-        path?: string;
+        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;
         override?: boolean;
         versionExistingContent?: boolean;
         format?: "md" | "mdx";
@@ -1033,8 +1031,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

@@ -135,7 +135,12 @@ declare const _default: (path: string) => {
      */
     writeCommand: (command: Command, options?: {
         path?: string;
-        override?: boolean;
+        override? /**
+         * Remove an event by an Event id
+         *
+         * @param id - The id of the event you want to remove
+         *
+         */: boolean;
         versionExistingContent?: boolean;
         format?: "md" | "mdx";
     }) => Promise<void>;
@@ -151,19 +156,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>;
@@ -676,7 +669,12 @@ declare const _default: (path: string) => {
      *
      */
     writeDomain: (domain: Domain, options?: {
-        path?: string;
+        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;
         override?: boolean;
         versionExistingContent?: boolean;
         format?: "md" | "mdx";
@@ -1033,8 +1031,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

@@ -1155,6 +1155,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 {
@@ -1991,42 +2002,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 +2045,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