@eventcatalog/sdk 2.17.0 → 2.17.2

package/dist/index.mjs

@@ -1292,7 +1292,7 @@ var addMessageToService = (directory) => async (id, direction, event, version) =
   }
   const path8 = existingResource.split(/[\\/]+services/)[0];
   const pathToResource = join6(path8, "services");
-  await rmServiceById(directory)(id, version);
+  await rmServiceById(directory)(id, version, true);
   await writeService(pathToResource)(service, { format: extension === ".md" ? "md" : "mdx" });
 };
 var serviceHasVersion = (directory) => async (id, version) => {
@@ -1325,7 +1325,7 @@ var addEntityToService = (directory) => async (id, entity, version) => {
   }
   const path8 = existingResource.split(/[\\/]+services/)[0];
   const pathToResource = join6(path8, "services");
-  await rmServiceById(directory)(id, version);
+  await rmServiceById(directory)(id, version, true);
   await writeService(pathToResource)(service, { format: extension === ".md" ? "md" : "mdx" });
 };
 var addDataStoreToService = (directory) => async (id, operation, dataStore, version) => {
@@ -1361,7 +1361,7 @@ var addDataStoreToService = (directory) => async (id, operation, dataStore, vers
   }
   const path8 = existingResource.split(/[\\/]+services/)[0];
   const pathToResource = join6(path8, "services");
-  await rmServiceById(directory)(id, version);
+  await rmServiceById(directory)(id, version, true);
   await writeService(pathToResource)(service, { format: extension === ".md" ? "md" : "mdx" });
 };
 
@@ -1583,7 +1583,8 @@ var addMessageToChannel = (directory, collection) => async (id, _message, versio
 };
 
 // src/messages.ts
-import { dirname as dirname5 } from "path";
+import { dirname as dirname5, join as join9 } from "path";
+import fsSync4 from "fs";
 import matter4 from "gray-matter";
 import { satisfies as satisfies4, validRange as validRange3 } from "semver";
 var getMessageBySchemaPath = (directory) => async (path8, options) => {
@@ -1677,17 +1678,31 @@ var getProducersOfSchema = (directory) => async (path8) => {
     return [];
   }
 };
+var getSchemaForMessage = (directory) => async (id, version) => {
+  const file = await findFileById(directory, id, version);
+  if (!file || !fsSync4.existsSync(file)) return void 0;
+  const { data } = matter4.read(file);
+  if (!data.schemaPath) return void 0;
+  const resourceDirectory = dirname5(file);
+  const pathToSchema = join9(resourceDirectory, data.schemaPath);
+  if (!fsSync4.existsSync(pathToSchema)) return void 0;
+  const schema = fsSync4.readFileSync(pathToSchema, "utf8");
+  return {
+    schema,
+    fileName: data.schemaPath
+  };
+};
 
 // src/custom-docs.ts
 import path3, { join as join10 } from "path";
-import fsSync4 from "fs";
+import fsSync5 from "fs";
 import fs8 from "fs/promises";
 import matter5 from "gray-matter";
 import slugify from "slugify";
 var getCustomDoc = (directory) => async (filePath) => {
   const fullPath = path3.join(directory, filePath);
   const fullPathWithExtension = fullPath.endsWith(".mdx") ? fullPath : `${fullPath}.mdx`;
-  const fileExists = fsSync4.existsSync(fullPathWithExtension);
+  const fileExists = fsSync5.existsSync(fullPathWithExtension);
   if (!fileExists) {
     return void 0;
   }
@@ -1705,9 +1720,9 @@ var writeCustomDoc = (directory) => async (customDoc, options = { path: "" }) =>
   const name = fileName || slugify(customDoc.title, { lower: true });
   const withExtension = name.endsWith(".mdx") ? name : `${name}.mdx`;
   const fullPath = path3.join(directory, options.path || "", withExtension);
-  fsSync4.mkdirSync(path3.dirname(fullPath), { recursive: true });
+  fsSync5.mkdirSync(path3.dirname(fullPath), { recursive: true });
   const document = matter5.stringify(customDoc.markdown.trim(), rest);
-  fsSync4.writeFileSync(fullPath, document);
+  fsSync5.writeFileSync(fullPath, document);
   invalidateFileCache();
 };
 var rmCustomDoc = (directory) => async (filePath) => {
@@ -1718,13 +1733,13 @@ var rmCustomDoc = (directory) => async (filePath) => {
 
 // src/teams.ts
 import fs9 from "fs/promises";
-import fsSync6 from "fs";
+import fsSync7 from "fs";
 import { join as join12 } from "path";
 import matter7 from "gray-matter";
 import path4 from "path";
 
 // src/users.ts
-import fsSync5 from "fs";
+import fsSync6 from "fs";
 import { join as join11 } from "path";
 import matter6 from "gray-matter";
 var getUser = (catalogDir) => async (id) => {
@@ -1763,12 +1778,12 @@ var writeUser = (catalogDir) => async (user, options = {}) => {
   }
   const { markdown, ...frontmatter } = resource;
   const document = matter6.stringify(markdown, frontmatter);
-  fsSync5.mkdirSync(join11(catalogDir, ""), { recursive: true });
-  fsSync5.writeFileSync(join11(catalogDir, "", `${resource.id}.mdx`), document);
+  fsSync6.mkdirSync(join11(catalogDir, ""), { recursive: true });
+  fsSync6.writeFileSync(join11(catalogDir, "", `${resource.id}.mdx`), document);
   invalidateFileCache();
 };
 var rmUserById = (catalogDir) => async (id) => {
-  fsSync5.rmSync(join11(catalogDir, `${id}.mdx`), { recursive: true });
+  fsSync6.rmSync(join11(catalogDir, `${id}.mdx`), { recursive: true });
   invalidateFileCache();
 };
 
@@ -1807,8 +1822,8 @@ var writeTeam = (catalogDir) => async (team, options = {}) => {
   }
   const { markdown, ...frontmatter } = resource;
   const document = matter7.stringify(markdown, frontmatter);
-  fsSync6.mkdirSync(join12(catalogDir, ""), { recursive: true });
-  fsSync6.writeFileSync(join12(catalogDir, "", `${resource.id}.mdx`), document);
+  fsSync7.mkdirSync(join12(catalogDir, ""), { recursive: true });
+  fsSync7.writeFileSync(join12(catalogDir, "", `${resource.id}.mdx`), document);
   invalidateFileCache();
 };
 var rmTeamById = (catalogDir) => async (id) => {
@@ -2244,7 +2259,7 @@ var listSnapshots = (directory) => async () => {
 
 // src/changelogs.ts
 import path7, { dirname as dirname6 } from "path";
-import fsSync7 from "fs";
+import fsSync8 from "fs";
 import fs12 from "fs/promises";
 import matter8 from "gray-matter";
 var writeChangelog = (catalogDir) => async (id, changelog, options = {}) => {
@@ -2263,9 +2278,9 @@ var writeChangelog = (catalogDir) => async (id, changelog, options = {}) => {
   if (!fm.badges || fm.badges.length === 0) {
     delete fm.badges;
   }
-  fsSync7.mkdirSync(resourceDir, { recursive: true });
+  fsSync8.mkdirSync(resourceDir, { recursive: true });
   const document = matter8.stringify(markdown.trim(), fm);
-  fsSync7.writeFileSync(changelogPath, document);
+  fsSync8.writeFileSync(changelogPath, document);
   invalidateFileCache();
 };
 var appendChangelog = (catalogDir) => async (id, changelog, options = {}) => {
@@ -2277,7 +2292,7 @@ var appendChangelog = (catalogDir) => async (id, changelog, options = {}) => {
   const resourceDir = dirname6(resourceFile);
   const mdxPath = path7.join(resourceDir, "changelog.mdx");
   const mdPath = path7.join(resourceDir, "changelog.md");
-  const existingPath = fsSync7.existsSync(mdxPath) ? mdxPath : fsSync7.existsSync(mdPath) ? mdPath : void 0;
+  const existingPath = fsSync8.existsSync(mdxPath) ? mdxPath : fsSync8.existsSync(mdPath) ? mdPath : void 0;
   if (!existingPath) {
     return writeChangelog(catalogDir)(id, changelog, options);
   }
@@ -2297,7 +2312,7 @@ ${existingContent}`;
     delete fm.badges;
   }
   const document = matter8.stringify(combined, fm);
-  fsSync7.writeFileSync(existingPath, document);
+  fsSync8.writeFileSync(existingPath, document);
   invalidateFileCache();
 };
 var getChangelog = (catalogDir) => async (id, options = {}) => {
@@ -2307,7 +2322,7 @@ var getChangelog = (catalogDir) => async (id, options = {}) => {
   const resourceDir = dirname6(resourceFile);
   const mdxPath = path7.join(resourceDir, "changelog.mdx");
   const mdPath = path7.join(resourceDir, "changelog.md");
-  const changelogPath = fsSync7.existsSync(mdxPath) ? mdxPath : fsSync7.existsSync(mdPath) ? mdPath : void 0;
+  const changelogPath = fsSync8.existsSync(mdxPath) ? mdxPath : fsSync8.existsSync(mdPath) ? mdPath : void 0;
   if (!changelogPath) return void 0;
   const { data, content } = matter8.read(changelogPath);
   return { ...data, markdown: content.trim() };
@@ -2321,10 +2336,10 @@ var rmChangelog = (catalogDir) => async (id, options = {}) => {
   const resourceDir = dirname6(resourceFile);
   const mdxPath = path7.join(resourceDir, "changelog.mdx");
   const mdPath = path7.join(resourceDir, "changelog.md");
-  if (fsSync7.existsSync(mdxPath)) {
+  if (fsSync8.existsSync(mdxPath)) {
     await fs12.rm(mdxPath);
   }
-  if (fsSync7.existsSync(mdPath)) {
+  if (fsSync8.existsSync(mdPath)) {
     await fs12.rm(mdPath);
   }
   invalidateFileCache();
@@ -3331,6 +3346,14 @@ var src_default = (path8) => {
      * @returns Service[]
      */
     getProducersOfSchema: getProducersOfSchema(join18(path8)),
+    /**
+     * Returns the schema for a given message (event, command or query) by its id and version.
+     * If no version is given, the latest version is used.
+     * @param id - The id of the message to get the schema for
+     * @param version - Optional version of the message
+     * @returns { schema: string, fileName: string } | undefined
+     */
+    getSchemaForMessage: getSchemaForMessage(join18(path8)),
     /**
      * Returns the owners for a given resource (e.g domain, service, event, command, query, etc.)
      * @param id - The id of the resource to get the owners for