@eventcatalog/sdk 2.5.0 → 2.5.1

package/dist/index.d.mts

@@ -250,14 +250,21 @@ declare const _default: (path: string) => {
      */
     writeQueryToService: (query: Query, service: {
         id: string;
-        version? /**
+        version?: string;
+    }, options?: {
+        path
+        /**
+         * Returns a command from EventCatalog
+         * @param id - The id of the command to retrieve
+         * @param version - Optional id of the version to get (supports semver)
+         * @returns Command|Undefined
+         */
+        ? /**
          * Returns a command from EventCatalog
          * @param id - The id of the command to retrieve
          * @param version - Optional id of the version to get (supports semver)
          * @returns Command|Undefined
          */: string;
-    }, options?: {
-        path?: string;
         format?: "md" | "mdx";
         override?: boolean;
     }) => Promise<void>;
@@ -823,6 +830,14 @@ declare const _default: (path: string) => {
     dumpCatalog: (options?: {
         includeMarkdown?: boolean;
     }) => Promise<EventCatalogObject>;
+    /**
+     * Returns the event catalog configuration file.
+     * The event catalog configuration file is the file that contains the configuration for the event catalog.
+     *
+     * @param directory - The directory of the catalog.
+     * @returns A JSON object with the configuration for the event catalog.
+     */
+    getEventCatalogConfigurationFile: () => Promise<any>;
     /**
      * ================================
      *            Resources Utils

package/dist/index.d.ts

@@ -250,14 +250,21 @@ declare const _default: (path: string) => {
      */
     writeQueryToService: (query: Query, service: {
         id: string;
-        version? /**
+        version?: string;
+    }, options?: {
+        path
+        /**
+         * Returns a command from EventCatalog
+         * @param id - The id of the command to retrieve
+         * @param version - Optional id of the version to get (supports semver)
+         * @returns Command|Undefined
+         */
+        ? /**
          * Returns a command from EventCatalog
          * @param id - The id of the command to retrieve
          * @param version - Optional id of the version to get (supports semver)
          * @returns Command|Undefined
          */: string;
-    }, options?: {
-        path?: string;
         format?: "md" | "mdx";
         override?: boolean;
     }) => Promise<void>;
@@ -823,6 +830,14 @@ declare const _default: (path: string) => {
     dumpCatalog: (options?: {
         includeMarkdown?: boolean;
     }) => Promise<EventCatalogObject>;
+    /**
+     * Returns the event catalog configuration file.
+     * The event catalog configuration file is the file that contains the configuration for the event catalog.
+     *
+     * @param directory - The directory of the catalog.
+     * @returns A JSON object with the configuration for the event catalog.
+     */
+    getEventCatalogConfigurationFile: () => Promise<any>;
     /**
      * ================================
      *            Resources Utils

package/dist/index.js

@@ -832,6 +832,16 @@ var filterCollection = (collection, options) => {
     markdown: options?.includeMarkdown ? item.markdown : void 0
   }));
 };
+var getEventCatalogConfigurationFile = (directory) => async () => {
+  try {
+    const path4 = (0, import_node_path11.join)(directory, "eventcatalog.config.js");
+    const configModule = await import(path4);
+    return configModule.default;
+  } catch (error) {
+    console.error("Error getting event catalog configuration file", error);
+    return null;
+  }
+};
 var dumpCatalog = (directory) => async (options) => {
   const { getDomains: getDomains2, getServices: getServices2, getEvents: getEvents2, getQueries: getQueries2, getCommands: getCommands2, getChannels: getChannels2, getTeams: getTeams2, getUsers: getUsers2 } = index_default(directory);
   const { includeMarkdown = true } = options || {};
@@ -1544,6 +1554,14 @@ var index_default = (path4) => {
      * @returns A JSON file with the catalog
      */
     dumpCatalog: dumpCatalog((0, import_node_path12.join)(path4)),
+    /**
+     * Returns the event catalog configuration file.
+     * The event catalog configuration file is the file that contains the configuration for the event catalog.
+     *
+     * @param directory - The directory of the catalog.
+     * @returns A JSON object with the configuration for the event catalog.
+     */
+    getEventCatalogConfigurationFile: getEventCatalogConfigurationFile((0, import_node_path12.join)(path4)),
     /**
      * ================================
      *            Resources Utils