@eventcatalog/sdk 2.17.0 → 2.17.2

package/dist/index.d.mts

@@ -475,13 +475,7 @@ declare const _default: (path: string) => {
     writeEvent: (event: Event, options?: {
         path?: string;
         override?: boolean;
-        versionExistingContent? /**
-         * Adds an event to EventCatalog
-         *
-         * @param event - The event to write
-         * @param options - Optional options to write the event
-         *
-         */: boolean;
+        versionExistingContent?: boolean;
         format?: "md" | "mdx";
     }) => Promise<void>;
     /**
@@ -926,14 +920,7 @@ declare const _default: (path: string) => {
         version?: string;
         direction?: string;
     }, options?: {
-        path? /**
-         * Adds a command to a service in EventCatalog
-         *
-         * @param command - The command to write to the service
-         * @param service - The service and it's id to write to the command to
-         * @param options - Optional options to write the command
-         *
-         */: string;
+        path?: string;
         format?: "md" | "mdx";
         override?: boolean;
     }) => Promise<void>;
@@ -1538,6 +1525,17 @@ declare const _default: (path: string) => {
      * @returns Service[]
      */
     getProducersOfSchema: (path: string) => Promise<Service[]>;
+    /**
+     * 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: (id: string, version?: string) => Promise<{
+        schema: string;
+        fileName: string;
+    } | undefined>;
     /**
      * 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
@@ -1803,11 +1801,7 @@ declare const _default: (path: string) => {
      *
      */
     writeDiagram: (diagram: Diagram, options?: {
-        path? /**
-         * Returns all events from EventCatalog
-         * @param latestOnly - optional boolean, set to true to get only latest versions
-         * @returns Event[]|Undefined
-         */: string;
+        path?: string;
         override?: boolean;
         versionExistingContent?: boolean;
         format?: "md" | "mdx";

package/dist/index.d.ts

@@ -475,13 +475,7 @@ declare const _default: (path: string) => {
     writeEvent: (event: Event, options?: {
         path?: string;
         override?: boolean;
-        versionExistingContent? /**
-         * Adds an event to EventCatalog
-         *
-         * @param event - The event to write
-         * @param options - Optional options to write the event
-         *
-         */: boolean;
+        versionExistingContent?: boolean;
         format?: "md" | "mdx";
     }) => Promise<void>;
     /**
@@ -926,14 +920,7 @@ declare const _default: (path: string) => {
         version?: string;
         direction?: string;
     }, options?: {
-        path? /**
-         * Adds a command to a service in EventCatalog
-         *
-         * @param command - The command to write to the service
-         * @param service - The service and it's id to write to the command to
-         * @param options - Optional options to write the command
-         *
-         */: string;
+        path?: string;
         format?: "md" | "mdx";
         override?: boolean;
     }) => Promise<void>;
@@ -1538,6 +1525,17 @@ declare const _default: (path: string) => {
      * @returns Service[]
      */
     getProducersOfSchema: (path: string) => Promise<Service[]>;
+    /**
+     * 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: (id: string, version?: string) => Promise<{
+        schema: string;
+        fileName: string;
+    } | undefined>;
     /**
      * 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
@@ -1803,11 +1801,7 @@ declare const _default: (path: string) => {
      *
      */
     writeDiagram: (diagram: Diagram, options?: {
-        path? /**
-         * Returns all events from EventCatalog
-         * @param latestOnly - optional boolean, set to true to get only latest versions
-         * @returns Event[]|Undefined
-         */: string;
+        path?: string;
         override?: boolean;
         versionExistingContent?: boolean;
         format?: "md" | "mdx";

package/dist/index.js

@@ -1326,7 +1326,7 @@ var addMessageToService = (directory) => async (id, direction, event, version) =
   }
   const path8 = existingResource.split(/[\\/]+services/)[0];
   const pathToResource = (0, import_node_path7.join)(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) => {
@@ -1359,7 +1359,7 @@ var addEntityToService = (directory) => async (id, entity, version) => {
   }
   const path8 = existingResource.split(/[\\/]+services/)[0];
   const pathToResource = (0, import_node_path7.join)(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) => {
@@ -1395,7 +1395,7 @@ var addDataStoreToService = (directory) => async (id, operation, dataStore, vers
   }
   const path8 = existingResource.split(/[\\/]+services/)[0];
   const pathToResource = (0, import_node_path7.join)(path8, "services");
-  await rmServiceById(directory)(id, version);
+  await rmServiceById(directory)(id, version, true);
   await writeService(pathToResource)(service, { format: extension === ".md" ? "md" : "mdx" });
 };
 
@@ -1618,6 +1618,7 @@ var addMessageToChannel = (directory, collection) => async (id, _message, versio
 
 // src/messages.ts
 var import_node_path10 = require("path");
+var import_node_fs4 = __toESM(require("fs"));
 var import_gray_matter4 = __toESM(require("gray-matter"));
 var import_semver5 = require("semver");
 var getMessageBySchemaPath = (directory) => async (path8, options) => {
@@ -1711,17 +1712,31 @@ var getProducersOfSchema = (directory) => async (path8) => {
     return [];
   }
 };
+var getSchemaForMessage = (directory) => async (id, version) => {
+  const file = await findFileById(directory, id, version);
+  if (!file || !import_node_fs4.default.existsSync(file)) return void 0;
+  const { data } = import_gray_matter4.default.read(file);
+  if (!data.schemaPath) return void 0;
+  const resourceDirectory = (0, import_node_path10.dirname)(file);
+  const pathToSchema = (0, import_node_path10.join)(resourceDirectory, data.schemaPath);
+  if (!import_node_fs4.default.existsSync(pathToSchema)) return void 0;
+  const schema = import_node_fs4.default.readFileSync(pathToSchema, "utf8");
+  return {
+    schema,
+    fileName: data.schemaPath
+  };
+};
 
 // src/custom-docs.ts
 var import_node_path11 = __toESM(require("path"));
-var import_node_fs4 = __toESM(require("fs"));
+var import_node_fs5 = __toESM(require("fs"));
 var import_promises8 = __toESM(require("fs/promises"));
 var import_gray_matter5 = __toESM(require("gray-matter"));
 var import_slugify = __toESM(require("slugify"));
 var getCustomDoc = (directory) => async (filePath) => {
   const fullPath = import_node_path11.default.join(directory, filePath);
   const fullPathWithExtension = fullPath.endsWith(".mdx") ? fullPath : `${fullPath}.mdx`;
-  const fileExists = import_node_fs4.default.existsSync(fullPathWithExtension);
+  const fileExists = import_node_fs5.default.existsSync(fullPathWithExtension);
   if (!fileExists) {
     return void 0;
   }
@@ -1739,9 +1754,9 @@ var writeCustomDoc = (directory) => async (customDoc, options = { path: "" }) =>
   const name = fileName || (0, import_slugify.default)(customDoc.title, { lower: true });
   const withExtension = name.endsWith(".mdx") ? name : `${name}.mdx`;
   const fullPath = import_node_path11.default.join(directory, options.path || "", withExtension);
-  import_node_fs4.default.mkdirSync(import_node_path11.default.dirname(fullPath), { recursive: true });
+  import_node_fs5.default.mkdirSync(import_node_path11.default.dirname(fullPath), { recursive: true });
   const document = import_gray_matter5.default.stringify(customDoc.markdown.trim(), rest);
-  import_node_fs4.default.writeFileSync(fullPath, document);
+  import_node_fs5.default.writeFileSync(fullPath, document);
   invalidateFileCache();
 };
 var rmCustomDoc = (directory) => async (filePath) => {
@@ -1752,13 +1767,13 @@ var rmCustomDoc = (directory) => async (filePath) => {
 
 // src/teams.ts
 var import_promises9 = __toESM(require("fs/promises"));
-var import_node_fs6 = __toESM(require("fs"));
+var import_node_fs7 = __toESM(require("fs"));
 var import_node_path13 = require("path");
 var import_gray_matter7 = __toESM(require("gray-matter"));
 var import_node_path14 = __toESM(require("path"));
 
 // src/users.ts
-var import_node_fs5 = __toESM(require("fs"));
+var import_node_fs6 = __toESM(require("fs"));
 var import_node_path12 = require("path");
 var import_gray_matter6 = __toESM(require("gray-matter"));
 var getUser = (catalogDir) => async (id) => {
@@ -1797,12 +1812,12 @@ var writeUser = (catalogDir) => async (user, options = {}) => {
   }
   const { markdown, ...frontmatter } = resource;
   const document = import_gray_matter6.default.stringify(markdown, frontmatter);
-  import_node_fs5.default.mkdirSync((0, import_node_path12.join)(catalogDir, ""), { recursive: true });
-  import_node_fs5.default.writeFileSync((0, import_node_path12.join)(catalogDir, "", `${resource.id}.mdx`), document);
+  import_node_fs6.default.mkdirSync((0, import_node_path12.join)(catalogDir, ""), { recursive: true });
+  import_node_fs6.default.writeFileSync((0, import_node_path12.join)(catalogDir, "", `${resource.id}.mdx`), document);
   invalidateFileCache();
 };
 var rmUserById = (catalogDir) => async (id) => {
-  import_node_fs5.default.rmSync((0, import_node_path12.join)(catalogDir, `${id}.mdx`), { recursive: true });
+  import_node_fs6.default.rmSync((0, import_node_path12.join)(catalogDir, `${id}.mdx`), { recursive: true });
   invalidateFileCache();
 };
 
@@ -1841,8 +1856,8 @@ var writeTeam = (catalogDir) => async (team, options = {}) => {
   }
   const { markdown, ...frontmatter } = resource;
   const document = import_gray_matter7.default.stringify(markdown, frontmatter);
-  import_node_fs6.default.mkdirSync((0, import_node_path13.join)(catalogDir, ""), { recursive: true });
-  import_node_fs6.default.writeFileSync((0, import_node_path13.join)(catalogDir, "", `${resource.id}.mdx`), document);
+  import_node_fs7.default.mkdirSync((0, import_node_path13.join)(catalogDir, ""), { recursive: true });
+  import_node_fs7.default.writeFileSync((0, import_node_path13.join)(catalogDir, "", `${resource.id}.mdx`), document);
   invalidateFileCache();
 };
 var rmTeamById = (catalogDir) => async (id) => {
@@ -1966,7 +1981,7 @@ var dumpCatalog = (directory) => async (options) => {
 };
 
 // src/snapshots.ts
-var import_node_fs7 = __toESM(require("fs"));
+var import_node_fs8 = __toESM(require("fs"));
 var import_node_path16 = __toESM(require("path"));
 var import_node_child_process = require("child_process");
 var import_semver6 = require("semver");
@@ -2145,7 +2160,7 @@ var computeRelationshipDiff = (snapshotA, snapshotB) => {
 var SNAPSHOT_VERSION = "1.0.0";
 var getEventCatalogVersion2 = (catalogDir) => {
   try {
-    const packageJson = import_node_fs7.default.readFileSync(import_node_path16.default.join(catalogDir, "package.json"), "utf8");
+    const packageJson = import_node_fs8.default.readFileSync(import_node_path16.default.join(catalogDir, "package.json"), "utf8");
     const packageJsonObject = JSON.parse(packageJson);
     return packageJsonObject["dependencies"]?.["@eventcatalog/core"] ?? "unknown";
   } catch {
@@ -2223,16 +2238,16 @@ var createSnapshot = (directory) => {
       }
     };
     const snapshotsDir = outputDir || import_node_path16.default.join(directory, ".snapshots");
-    import_node_fs7.default.mkdirSync(snapshotsDir, { recursive: true });
+    import_node_fs8.default.mkdirSync(snapshotsDir, { recursive: true });
     const fileName = `${snapshotLabel}.snapshot.json`;
     const filePath = import_node_path16.default.join(snapshotsDir, fileName);
-    import_node_fs7.default.writeFileSync(filePath, JSON.stringify(snapshot));
+    import_node_fs8.default.writeFileSync(filePath, JSON.stringify(snapshot));
     return { filePath, snapshot };
   };
 };
 var diffSnapshots = (directory) => async (snapshotAPath, snapshotBPath) => {
-  const snapshotA = JSON.parse(import_node_fs7.default.readFileSync(snapshotAPath, "utf-8"));
-  const snapshotB = JSON.parse(import_node_fs7.default.readFileSync(snapshotBPath, "utf-8"));
+  const snapshotA = JSON.parse(import_node_fs8.default.readFileSync(snapshotAPath, "utf-8"));
+  const snapshotB = JSON.parse(import_node_fs8.default.readFileSync(snapshotBPath, "utf-8"));
   const resourceChanges = computeResourceDiff(snapshotA, snapshotB);
   const relationshipChanges = computeRelationshipDiff(snapshotA, snapshotB);
   const resourceCounts = { added: 0, removed: 0, modified: 0, versioned: 0 };
@@ -2257,13 +2272,13 @@ var diffSnapshots = (directory) => async (snapshotAPath, snapshotBPath) => {
 };
 var listSnapshots = (directory) => async () => {
   const snapshotsDir = import_node_path16.default.join(directory, ".snapshots");
-  if (!import_node_fs7.default.existsSync(snapshotsDir)) return [];
-  const files = import_node_fs7.default.readdirSync(snapshotsDir).filter((f) => f.endsWith(".snapshot.json"));
+  if (!import_node_fs8.default.existsSync(snapshotsDir)) return [];
+  const files = import_node_fs8.default.readdirSync(snapshotsDir).filter((f) => f.endsWith(".snapshot.json"));
   const snapshots = [];
   for (const file of files) {
     try {
       const filePath = import_node_path16.default.join(snapshotsDir, file);
-      const content = JSON.parse(import_node_fs7.default.readFileSync(filePath, "utf-8"));
+      const content = JSON.parse(import_node_fs8.default.readFileSync(filePath, "utf-8"));
       snapshots.push({
         label: content.label,
         createdAt: content.createdAt,
@@ -2278,7 +2293,7 @@ var listSnapshots = (directory) => async () => {
 
 // src/changelogs.ts
 var import_node_path17 = __toESM(require("path"));
-var import_node_fs8 = __toESM(require("fs"));
+var import_node_fs9 = __toESM(require("fs"));
 var import_promises10 = __toESM(require("fs/promises"));
 var import_gray_matter8 = __toESM(require("gray-matter"));
 var writeChangelog = (catalogDir) => async (id, changelog, options = {}) => {
@@ -2297,9 +2312,9 @@ var writeChangelog = (catalogDir) => async (id, changelog, options = {}) => {
   if (!fm.badges || fm.badges.length === 0) {
     delete fm.badges;
   }
-  import_node_fs8.default.mkdirSync(resourceDir, { recursive: true });
+  import_node_fs9.default.mkdirSync(resourceDir, { recursive: true });
   const document = import_gray_matter8.default.stringify(markdown.trim(), fm);
-  import_node_fs8.default.writeFileSync(changelogPath, document);
+  import_node_fs9.default.writeFileSync(changelogPath, document);
   invalidateFileCache();
 };
 var appendChangelog = (catalogDir) => async (id, changelog, options = {}) => {
@@ -2311,7 +2326,7 @@ var appendChangelog = (catalogDir) => async (id, changelog, options = {}) => {
   const resourceDir = (0, import_node_path17.dirname)(resourceFile);
   const mdxPath = import_node_path17.default.join(resourceDir, "changelog.mdx");
   const mdPath = import_node_path17.default.join(resourceDir, "changelog.md");
-  const existingPath = import_node_fs8.default.existsSync(mdxPath) ? mdxPath : import_node_fs8.default.existsSync(mdPath) ? mdPath : void 0;
+  const existingPath = import_node_fs9.default.existsSync(mdxPath) ? mdxPath : import_node_fs9.default.existsSync(mdPath) ? mdPath : void 0;
   if (!existingPath) {
     return writeChangelog(catalogDir)(id, changelog, options);
   }
@@ -2331,7 +2346,7 @@ ${existingContent}`;
     delete fm.badges;
   }
   const document = import_gray_matter8.default.stringify(combined, fm);
-  import_node_fs8.default.writeFileSync(existingPath, document);
+  import_node_fs9.default.writeFileSync(existingPath, document);
   invalidateFileCache();
 };
 var getChangelog = (catalogDir) => async (id, options = {}) => {
@@ -2341,7 +2356,7 @@ var getChangelog = (catalogDir) => async (id, options = {}) => {
   const resourceDir = (0, import_node_path17.dirname)(resourceFile);
   const mdxPath = import_node_path17.default.join(resourceDir, "changelog.mdx");
   const mdPath = import_node_path17.default.join(resourceDir, "changelog.md");
-  const changelogPath = import_node_fs8.default.existsSync(mdxPath) ? mdxPath : import_node_fs8.default.existsSync(mdPath) ? mdPath : void 0;
+  const changelogPath = import_node_fs9.default.existsSync(mdxPath) ? mdxPath : import_node_fs9.default.existsSync(mdPath) ? mdPath : void 0;
   if (!changelogPath) return void 0;
   const { data, content } = import_gray_matter8.default.read(changelogPath);
   return { ...data, markdown: content.trim() };
@@ -2355,10 +2370,10 @@ var rmChangelog = (catalogDir) => async (id, options = {}) => {
   const resourceDir = (0, import_node_path17.dirname)(resourceFile);
   const mdxPath = import_node_path17.default.join(resourceDir, "changelog.mdx");
   const mdPath = import_node_path17.default.join(resourceDir, "changelog.md");
-  if (import_node_fs8.default.existsSync(mdxPath)) {
+  if (import_node_fs9.default.existsSync(mdxPath)) {
     await import_promises10.default.rm(mdxPath);
   }
-  if (import_node_fs8.default.existsSync(mdPath)) {
+  if (import_node_fs9.default.existsSync(mdPath)) {
     await import_promises10.default.rm(mdPath);
   }
   invalidateFileCache();
@@ -3365,6 +3380,14 @@ var src_default = (path8) => {
      * @returns Service[]
      */
     getProducersOfSchema: getProducersOfSchema((0, import_node_path22.join)(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((0, import_node_path22.join)(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