@eventcatalog/sdk 2.3.6 → 2.4.0

package/dist/index.mjs

@@ -1,15 +1,15 @@
 // src/index.ts
-import { join as join13 } from "node:path";
+import { join as join13 } from "path";
 
 // src/events.ts
-import fs2 from "node:fs/promises";
-import { join as join3 } from "node:path";
+import fs2 from "fs/promises";
+import { join as join3 } from "path";
 
 // src/internal/utils.ts
 import { globSync } from "glob";
-import fsSync from "node:fs";
+import fsSync from "fs";
 import { copy } from "fs-extra";
-import { join, dirname, normalize, resolve, relative } from "node:path";
+import { join, dirname, normalize, resolve, relative } from "path";
 import matter from "gray-matter";
 import { satisfies, validRange, valid } from "semver";
 var versionExists = async (catalogDir, id, version) => {
@@ -115,8 +115,8 @@ var uniqueVersions = (messages) => {
 // src/internal/resources.ts
 import { dirname as dirname2, join as join2 } from "path";
 import matter2 from "gray-matter";
-import fs from "node:fs/promises";
-import fsSync2 from "node:fs";
+import fs from "fs/promises";
+import fsSync2 from "fs";
 import { satisfies as satisfies2 } from "semver";
 import { lock, unlock } from "proper-lockfile";
 var versionResource = async (catalogDir, id) => {
@@ -187,9 +187,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 } = matter2.read(file);
+  if (attachSchema && data?.schemaPath) {
+    const resourceDirectory = dirname2(file);
+    const pathToSchema = join2(resourceDirectory, data.schemaPath);
+    if (fsSync2.existsSync(pathToSchema)) {
+      const schema = fsSync2.readFileSync(pathToSchema, "utf8");
+      try {
+        data.schema = JSON.parse(schema);
+      } catch (error) {
+        data.schema = schema;
+      }
+    }
+  }
   return {
     ...data,
     markdown: content.trim()
@@ -208,7 +221,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}`;
@@ -216,6 +230,18 @@ var getResources = async (catalogDir, {
   if (files.length === 0) return;
   return files.map((file) => {
     const { data, content } = matter2.read(file);
+    if (attachSchema && data?.schemaPath) {
+      const resourceDirectory = dirname2(file);
+      const pathToSchema = join2(resourceDirectory, data.schemaPath);
+      if (fsSync2.existsSync(pathToSchema)) {
+        const schema = fsSync2.readFileSync(pathToSchema, "utf8");
+        try {
+          data.schema = JSON.parse(schema);
+        } catch (error) {
+          data.schema = schema;
+        }
+      }
+    }
     return {
       ...data,
       markdown: content.trim()
@@ -266,7 +292,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: "",
@@ -299,9 +325,9 @@ var eventHasVersion = (directory) => async (id, version) => {
 };
 
 // src/commands.ts
-import fs3 from "node:fs/promises";
-import { join as join4 } from "node:path";
-var getCommand = (directory) => async (id, version) => getResource(directory, id, version, { type: "command" });
+import fs3 from "fs/promises";
+import { join as join4 } from "path";
+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: "",
@@ -333,9 +359,9 @@ var commandHasVersion = (directory) => async (id, version) => {
 };
 
 // src/queries.ts
-import fs4 from "node:fs/promises";
-import { join as join5 } from "node:path";
-var getQuery = (directory) => async (id, version) => getResource(directory, id, version, { type: "query" });
+import fs4 from "fs/promises";
+import { join as join5 } from "path";
+var getQuery = (directory) => async (id, version, options) => getResource(directory, id, version, { type: "query", ...options });
 var writeQuery = (directory) => async (query, options = {
   path: "",
   override: false,
@@ -369,8 +395,8 @@ var queryHasVersion = (directory) => async (id, version) => {
 };
 
 // src/services.ts
-import fs5 from "node:fs/promises";
-import { join as join6, dirname as dirname4, extname } from "node:path";
+import fs5 from "fs/promises";
+import { join as join6, dirname as dirname4, extname } from "path";
 var getService = (directory) => async (id, version) => getResource(directory, id, version, { type: "service" });
 var getServices = (directory) => async (options) => getResources(directory, {
   type: "services",
@@ -469,9 +495,9 @@ var serviceHasVersion = (directory) => async (id, version) => {
 };
 
 // src/domains.ts
-import fs6 from "node:fs/promises";
-import path, { join as join7 } from "node:path";
-import fsSync3 from "node:fs";
+import fs6 from "fs/promises";
+import path, { join as join7 } from "path";
+import fsSync3 from "fs";
 import matter3 from "gray-matter";
 var getDomain = (directory) => async (id, version) => getResource(directory, id, version, { type: "domain" });
 var getDomains = (directory) => async (options) => getResources(directory, {
@@ -552,8 +578,8 @@ var addSubDomainToDomain = (directory) => async (id, subDomain, version) => {
 };
 
 // src/channels.ts
-import fs7 from "node:fs/promises";
-import { join as join8, extname as extname2 } from "node:path";
+import fs7 from "fs/promises";
+import { join as join8, extname as extname2 } from "path";
 var getChannel = (directory) => async (id, version) => getResource(directory, id, version, { type: "channel" });
 var getChannels = (directory) => async (options) => getResources(directory, { type: "channels", ...options });
 var writeChannel = (directory) => async (channel, options = { path: "" }) => writeResource(directory, { ...channel }, { ...options, type: "channel" });
@@ -607,7 +633,7 @@ var addMessageToChannel = (directory, collection) => async (id, _message, versio
 
 // src/eventcatalog.ts
 import fs8 from "fs";
-import path2, { join as join9 } from "node:path";
+import path2, { join as join9 } from "path";
 var DUMP_VERSION = "0.0.1";
 var getEventCatalogVersion = async (catalogDir) => {
   try {
@@ -693,9 +719,9 @@ var dumpCatalog = (directory) => async (options) => {
 };
 
 // src/custom-docs.ts
-import path3, { join as join10 } from "node:path";
-import fsSync4 from "node:fs";
-import fs9 from "node:fs/promises";
+import path3, { join as join10 } from "path";
+import fsSync4 from "fs";
+import fs9 from "fs/promises";
 import matter4 from "gray-matter";
 import slugify from "slugify";
 var getCustomDoc = (directory) => async (filePath) => {
@@ -729,9 +755,9 @@ var rmCustomDoc = (directory) => async (filePath) => {
 };
 
 // src/teams.ts
-import fs10 from "node:fs/promises";
-import fsSync5 from "node:fs";
-import { join as join11 } from "node:path";
+import fs10 from "fs/promises";
+import fsSync5 from "fs";
+import { join as join11 } from "path";
 import matter5 from "gray-matter";
 var getTeam = (catalogDir) => async (id) => {
   const files = await getFiles(`${catalogDir}/${id}.{md,mdx}`);
@@ -775,8 +801,8 @@ var rmTeamById = (catalogDir) => async (id) => {
 };
 
 // src/users.ts
-import fsSync6 from "node:fs";
-import { join as join12 } from "node:path";
+import fsSync6 from "fs";
+import { join as join12 } from "path";
 import matter6 from "gray-matter";
 var getUser = (catalogDir) => async (id) => {
   const files = await getFiles(`${catalogDir}/${id}.{md,mdx}`);
@@ -1483,7 +1509,16 @@ var index_default = (path4) => {
      * @param directory - The directory to dump the catalog to
      * @returns A JSON file with the catalog
      */
-    dumpCatalog: dumpCatalog(join13(path4))
+    dumpCatalog: dumpCatalog(join13(path4)),
+    /**
+     * ================================
+     *            Resources Utils
+     * ================================
+     */
+    /**
+     * Returns the path to a given resource by id and version
+     */
+    getResourcePath
   };
 };
 export {