@eventcatalog/sdk 2.17.3 → 2.18.0

package/dist/index.mjs

@@ -828,6 +828,11 @@ var copyDir = async (catalogDir, source, target, filter) => {
   });
   fsSync.rmSync(tmpDirectory, { recursive: true });
 };
+var buildMessagePointer = (message) => {
+  const pointer = { id: message.id, version: message.version };
+  if (message.fields) pointer.fields = message.fields;
+  return pointer;
+};
 var uniqueVersions = (messages) => {
   const uniqueSet = /* @__PURE__ */ new Set();
   return messages.filter((message) => {
@@ -1062,6 +1067,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 +1156,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 +1194,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 +1234,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";
@@ -1272,7 +1335,7 @@ var addMessageToService = (directory) => async (id, direction, event, version) =
         return;
       }
     }
-    service.sends.push({ id: event.id, version: event.version });
+    service.sends.push(buildMessagePointer(event));
   } else if (direction === "receives") {
     if (service.receives === void 0) {
       service.receives = [];
@@ -1282,7 +1345,7 @@ var addMessageToService = (directory) => async (id, direction, event, version) =
         return;
       }
     }
-    service.receives.push({ id: event.id, version: event.version });
+    service.receives.push(buildMessagePointer(event));
   } else {
     throw new Error(`Direction ${direction} is invalid, only 'receives' and 'sends' are supported`);
   }
@@ -1502,7 +1565,7 @@ var addMessageToDomain = (directory) => async (id, direction, message, version)
         return;
       }
     }
-    domain.sends.push({ id: message.id, version: message.version });
+    domain.sends.push(buildMessagePointer(message));
   } else if (direction === "receives") {
     if (domain.receives === void 0) {
       domain.receives = [];
@@ -1512,7 +1575,7 @@ var addMessageToDomain = (directory) => async (id, direction, message, version)
         return;
       }
     }
-    domain.receives.push({ id: message.id, version: message.version });
+    domain.receives.push(buildMessagePointer(message));
   } else {
     throw new Error(`Direction ${direction} is invalid, only 'receives' and 'sends' are supported`);
   }
@@ -2558,6 +2621,9 @@ var src_default = (path8) => {
      * @returns
      */
     eventHasVersion: eventHasVersion(join18(path8)),
+    addExampleToEvent: addExampleToEvent(join18(path8)),
+    getExamplesFromEvent: getExamplesFromEvent(join18(path8)),
+    removeExampleFromEvent: removeExampleFromEvent(join18(path8)),
     /**
      * ================================
      *            Commands
@@ -2635,6 +2701,9 @@ var src_default = (path8) => {
      * @returns
      */
     commandHasVersion: commandHasVersion(join18(path8)),
+    addExampleToCommand: addExampleToCommand(join18(path8)),
+    getExamplesFromCommand: getExamplesFromCommand(join18(path8)),
+    removeExampleFromCommand: removeExampleFromCommand(join18(path8)),
     /**
      * ================================
      *            Queries
@@ -2712,6 +2781,9 @@ var src_default = (path8) => {
      * @returns
      */
     queryHasVersion: queryHasVersion(join18(path8)),
+    addExampleToQuery: addExampleToQuery(join18(path8)),
+    getExamplesFromQuery: getExamplesFromQuery(join18(path8)),
+    removeExampleFromQuery: removeExampleFromQuery(join18(path8)),
     /**
      * ================================
      *            Channels