@eventcatalog/sdk 2.3.6 → 2.4.0

package/dist/index.d.ts

@@ -14,7 +14,9 @@ declare const _default: (path: string) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Event|Undefined
      */
-    getEvent: (id: string, version?: string) => Promise<Event>;
+    getEvent: (id: string, version?: string, options?: {
+        attachSchema?: boolean;
+    }) => Promise<Event>;
     /**
      * Returns all events from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
@@ -22,6 +24,7 @@ declare const _default: (path: string) => {
      */
     getEvents: (options?: {
         latestOnly?: boolean;
+        attachSchema?: boolean;
     }) => Promise<Event[]>;
     /**
      * Adds an event to EventCatalog
@@ -111,7 +114,9 @@ declare const _default: (path: string) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Command|Undefined
      */
-    getCommand: (id: string, version?: string) => Promise<Command>;
+    getCommand: (id: string, version?: string, options?: {
+        attachSchema?: boolean;
+    }) => Promise<Command>;
     /**
      * Returns all commands from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
@@ -119,6 +124,7 @@ declare const _default: (path: string) => {
      */
     getCommands: (options?: {
         latestOnly?: boolean;
+        attachSchema?: boolean;
     }) => Promise<Command[]>;
     /**
      * Adds an command to EventCatalog
@@ -208,7 +214,9 @@ declare const _default: (path: string) => {
      * @param version - Optional id of the version to get (supports semver)
      * @returns Query|Undefined
      */
-    getQuery: (id: string, version?: string) => Promise<Query>;
+    getQuery: (id: string, version?: string, options?: {
+        attachSchema?: boolean;
+    }) => Promise<Query>;
     /**
      * Returns all queries from EventCatalog
      * @param latestOnly - optional boolean, set to true to get only latest versions
@@ -216,6 +224,7 @@ declare const _default: (path: string) => {
      */
     getQueries: (options?: {
         latestOnly?: boolean;
+        attachSchema?: boolean;
     }) => Promise<Query[]>;
     /**
      * Adds a query to EventCatalog
@@ -462,12 +471,7 @@ declare const _default: (path: string) => {
     }, options?: {
         path?: string;
         format?: "md" | "mdx";
-        override? /**
-         * Remove an command by an Event id
-         *
-         * @param id - The id of the command you want to remove
-         *
-         */: boolean;
+        override?: boolean;
     }) => Promise<void>;
     /**
      * Returns a service from EventCatalog
@@ -813,6 +817,19 @@ declare const _default: (path: string) => {
     dumpCatalog: (options?: {
         includeMarkdown?: boolean;
     }) => Promise<EventCatalogObject>;
+    /**
+     * ================================
+     *            Resources Utils
+     * ================================
+     */
+    /**
+     * Returns the path to a given resource by id and version
+     */
+    getResourcePath: (catalogDir: string, id: string, version?: string) => Promise<{
+        fullPath: string;
+        relativePath: string;
+        directory: string;
+    } | undefined>;
 };
 
 export { _default as default };

package/dist/index.js

@@ -221,9 +221,22 @@ var writeResource = async (catalogDir, resource, options = {
   }
 };
 var getResource = async (catalogDir, id, version, options) => {
+  const attachSchema = options?.attachSchema || false;
   const file = await findFileById(catalogDir, id, version);
   if (!file) return;
   const { data, content } = import_gray_matter2.default.read(file);
+  if (attachSchema && data?.schemaPath) {
+    const resourceDirectory = (0, import_path.dirname)(file);
+    const pathToSchema = (0, import_path.join)(resourceDirectory, data.schemaPath);
+    if (import_node_fs2.default.existsSync(pathToSchema)) {
+      const schema = import_node_fs2.default.readFileSync(pathToSchema, "utf8");
+      try {
+        data.schema = JSON.parse(schema);
+      } catch (error) {
+        data.schema = schema;
+      }
+    }
+  }
   return {
     ...data,
     markdown: content.trim()
@@ -242,7 +255,8 @@ var getResources = async (catalogDir, {
   type,
   latestOnly = false,
   ignore = [],
-  pattern = ""
+  pattern = "",
+  attachSchema = false
 }) => {
   const ignoreList = latestOnly ? `**/versioned/**` : "";
   const filePattern = pattern || `${catalogDir}/**/${type}/**/index.{md,mdx}`;
@@ -250,6 +264,18 @@ var getResources = async (catalogDir, {
   if (files.length === 0) return;
   return files.map((file) => {
     const { data, content } = import_gray_matter2.default.read(file);
+    if (attachSchema && data?.schemaPath) {
+      const resourceDirectory = (0, import_path.dirname)(file);
+      const pathToSchema = (0, import_path.join)(resourceDirectory, data.schemaPath);
+      if (import_node_fs2.default.existsSync(pathToSchema)) {
+        const schema = import_node_fs2.default.readFileSync(pathToSchema, "utf8");
+        try {
+          data.schema = JSON.parse(schema);
+        } catch (error) {
+          data.schema = schema;
+        }
+      }
+    }
     return {
       ...data,
       markdown: content.trim()
@@ -300,7 +326,7 @@ var getVersionedDirectory = (sourceDirectory, version) => {
 };
 
 // src/events.ts
-var getEvent = (directory) => async (id, version) => getResource(directory, id, version, { type: "event" });
+var getEvent = (directory) => async (id, version, options) => getResource(directory, id, version, { type: "event", ...options });
 var getEvents = (directory) => async (options) => getResources(directory, { type: "events", ...options });
 var writeEvent = (directory) => async (event, options = {
   path: "",
@@ -335,7 +361,7 @@ var eventHasVersion = (directory) => async (id, version) => {
 // src/commands.ts
 var import_promises3 = __toESM(require("fs/promises"));
 var import_node_path3 = require("path");
-var getCommand = (directory) => async (id, version) => getResource(directory, id, version, { type: "command" });
+var getCommand = (directory) => async (id, version, options) => getResource(directory, id, version, { type: "command", ...options });
 var getCommands = (directory) => async (options) => getResources(directory, { type: "commands", ...options });
 var writeCommand = (directory) => async (command, options = {
   path: "",
@@ -369,7 +395,7 @@ var commandHasVersion = (directory) => async (id, version) => {
 // src/queries.ts
 var import_promises4 = __toESM(require("fs/promises"));
 var import_node_path4 = require("path");
-var getQuery = (directory) => async (id, version) => getResource(directory, id, version, { type: "query" });
+var getQuery = (directory) => async (id, version, options) => getResource(directory, id, version, { type: "query", ...options });
 var writeQuery = (directory) => async (query, options = {
   path: "",
   override: false,
@@ -1517,7 +1543,16 @@ var index_default = (path4) => {
      * @param directory - The directory to dump the catalog to
      * @returns A JSON file with the catalog
      */
-    dumpCatalog: dumpCatalog((0, import_node_path12.join)(path4))
+    dumpCatalog: dumpCatalog((0, import_node_path12.join)(path4)),
+    /**
+     * ================================
+     *            Resources Utils
+     * ================================
+     */
+    /**
+     * Returns the path to a given resource by id and version
+     */
+    getResourcePath
   };
 };
 //# sourceMappingURL=index.js.map