@eventcatalog/sdk 2.17.2 → 2.17.4

package/dist/index.mjs

@@ -1062,6 +1062,55 @@ var getFileFromResource = async (catalogDir, id, file, version) => {
 var getVersionedDirectory = (sourceDirectory, version) => {
   return join2(sourceDirectory, "versioned", version);
 };
+var CONFIG_FILES = ["examples.config.yaml", "examples.config.yml", "examples.config.json"];
+function resolveExamplePath(examplesDir, fileName) {
+  const resolved = path.resolve(examplesDir, fileName);
+  if (!resolved.startsWith(path.resolve(examplesDir) + path.sep) && resolved !== path.resolve(examplesDir)) {
+    throw new Error(`Invalid example fileName: path traversal detected in "${fileName}"`);
+  }
+  return resolved;
+}
+var addExampleToResource = async (catalogDir, id, example, version) => {
+  const pathToResource = await findFileById(catalogDir, id, version);
+  if (!pathToResource) throw new Error("Cannot find directory to write example to");
+  const examplesDir = join2(dirname2(pathToResource), "examples");
+  const targetPath = resolveExamplePath(examplesDir, example.fileName);
+  fsSync2.mkdirSync(path.dirname(targetPath), { recursive: true });
+  fsSync2.writeFileSync(targetPath, example.content);
+};
+var getExamplesFromResource = async (catalogDir, id, version) => {
+  const pathToResource = await findFileById(catalogDir, id, version);
+  if (!pathToResource) throw new Error("Cannot find resource");
+  const examplesDir = join2(dirname2(pathToResource), "examples");
+  if (!fsSync2.existsSync(examplesDir)) return [];
+  const collectFiles = (dir, baseDir) => {
+    const results = [];
+    const entries = fsSync2.readdirSync(dir, { withFileTypes: true });
+    for (const entry of entries) {
+      const fullPath = join2(dir, entry.name);
+      if (entry.isDirectory()) {
+        results.push(...collectFiles(fullPath, baseDir));
+      } else if (entry.isFile() && !CONFIG_FILES.includes(entry.name)) {
+        results.push({
+          fileName: path.relative(baseDir, fullPath),
+          content: fsSync2.readFileSync(fullPath, "utf-8")
+        });
+      }
+    }
+    return results;
+  };
+  return collectFiles(examplesDir, examplesDir).sort((a, b) => a.fileName.localeCompare(b.fileName));
+};
+var removeExampleFromResource = async (catalogDir, id, fileName, version) => {
+  const pathToResource = await findFileById(catalogDir, id, version);
+  if (!pathToResource) throw new Error("Cannot find resource");
+  const examplesDir = join2(dirname2(pathToResource), "examples");
+  const examplePath = resolveExamplePath(examplesDir, fileName);
+  if (!fsSync2.existsSync(examplePath)) {
+    throw new Error(`Example file ${fileName} does not exist in resource ${id}${version ? ` v(${version})` : ""}`);
+  }
+  fsSync2.unlinkSync(examplePath);
+};
 var isLatestVersion = async (catalogDir, id, version) => {
   const resource = await getResource(catalogDir, id, version);
   if (!resource) return false;
@@ -1102,6 +1151,9 @@ var eventHasVersion = (directory) => async (id, version) => {
   const file = await findFileById(directory, id, version);
   return !!file;
 };
+var addExampleToEvent = (directory) => async (id, example, version) => addExampleToResource(directory, id, example, version);
+var getExamplesFromEvent = (directory) => async (id, version) => getExamplesFromResource(directory, id, version);
+var removeExampleFromEvent = (directory) => async (id, fileName, version) => removeExampleFromResource(directory, id, fileName, version);
 
 // src/commands.ts
 import fs3 from "fs/promises";
@@ -1137,6 +1189,9 @@ var commandHasVersion = (directory) => async (id, version) => {
   const file = await findFileById(directory, id, version);
   return !!file;
 };
+var addExampleToCommand = (directory) => async (id, example, version) => addExampleToResource(directory, id, example, version);
+var getExamplesFromCommand = (directory) => async (id, version) => getExamplesFromResource(directory, id, version);
+var removeExampleFromCommand = (directory) => async (id, fileName, version) => removeExampleFromResource(directory, id, fileName, version);
 
 // src/queries.ts
 import fs4 from "fs/promises";
@@ -1174,6 +1229,9 @@ var queryHasVersion = (directory) => async (id, version) => {
   const file = await findFileById(directory, id, version);
   return !!file;
 };
+var addExampleToQuery = (directory) => async (id, example, version) => addExampleToResource(directory, id, example, version);
+var getExamplesFromQuery = (directory) => async (id, version) => getExamplesFromResource(directory, id, version);
+var removeExampleFromQuery = (directory) => async (id, fileName, version) => removeExampleFromResource(directory, id, fileName, version);
 
 // src/services.ts
 import fs5 from "fs/promises";
@@ -1949,6 +2007,7 @@ var dumpCatalog = (directory) => async (options) => {
 // src/snapshots.ts
 import fs11 from "fs";
 import path6 from "path";
+import { createHash } from "crypto";
 import { execSync } from "child_process";
 import { compare } from "semver";
 
@@ -2139,6 +2198,8 @@ var pickCoreFields = (resource) => {
   if (resource.receives) picked.receives = resource.receives;
   if (resource.deprecated) picked.deprecated = resource.deprecated;
   if (resource.owners) picked.owners = resource.owners;
+  if (resource.schemaPath) picked.schemaPath = resource.schemaPath;
+  if (resource.schemaHash) picked.schemaHash = resource.schemaHash;
   return picked;
 };
 var deduplicateByLatestVersion = (resources) => {
@@ -2166,6 +2227,16 @@ var detectGitInfo = (catalogDir) => {
     return void 0;
   }
 };
+var enrichWithSchemaHashes = async (getSchemaForMessage2, resources) => {
+  await Promise.all(
+    resources.map(async (resource) => {
+      if (!resource.schemaPath) return;
+      const schema = await getSchemaForMessage2(resource.id, resource.version);
+      if (!schema) return;
+      resource.schemaHash = createHash("sha256").update(schema.schema).digest("hex");
+    })
+  );
+};
 var createSnapshot = (directory) => {
   return async (options) => {
     const { label, outputDir, git } = options || {};
@@ -2178,6 +2249,11 @@ var createSnapshot = (directory) => {
       sdk.getQueries(),
       sdk.getChannels()
     ]);
+    await Promise.all([
+      enrichWithSchemaHashes(sdk.getSchemaForMessage, events || []),
+      enrichWithSchemaHashes(sdk.getSchemaForMessage, commands || []),
+      enrichWithSchemaHashes(sdk.getSchemaForMessage, queries || [])
+    ]);
     const snapshotDomains = stripToCore(domains);
     const snapshotServices = stripToCore(services);
     const snapshotEvents = stripToCore(events);
@@ -2540,6 +2616,9 @@ var src_default = (path8) => {
      * @returns
      */
     eventHasVersion: eventHasVersion(join18(path8)),
+    addExampleToEvent: addExampleToEvent(join18(path8)),
+    getExamplesFromEvent: getExamplesFromEvent(join18(path8)),
+    removeExampleFromEvent: removeExampleFromEvent(join18(path8)),
     /**
      * ================================
      *            Commands
@@ -2617,6 +2696,9 @@ var src_default = (path8) => {
      * @returns
      */
     commandHasVersion: commandHasVersion(join18(path8)),
+    addExampleToCommand: addExampleToCommand(join18(path8)),
+    getExamplesFromCommand: getExamplesFromCommand(join18(path8)),
+    removeExampleFromCommand: removeExampleFromCommand(join18(path8)),
     /**
      * ================================
      *            Queries
@@ -2694,6 +2776,9 @@ var src_default = (path8) => {
      * @returns
      */
     queryHasVersion: queryHasVersion(join18(path8)),
+    addExampleToQuery: addExampleToQuery(join18(path8)),
+    getExamplesFromQuery: getExamplesFromQuery(join18(path8)),
+    removeExampleFromQuery: removeExampleFromQuery(join18(path8)),
     /**
      * ================================
      *            Channels