@eventcatalog/sdk 1.2.2 → 1.3.0

package/dist/index.mjs

@@ -41,9 +41,9 @@ var findFileById = async (catalogDir, id, version) => {
     return match[0].path;
   }
 };
-var getFiles = async (pattern) => {
+var getFiles = async (pattern, ignore = "") => {
   try {
-    const files = await glob(pattern, { ignore: "node_modules/**" });
+    const files = await glob(pattern, { ignore: ["node_modules/**", ignore] });
     return files;
   } catch (error) {
     throw new Error(`Error finding files: ${error}`);
@@ -95,6 +95,7 @@ var uniqueVersions = (messages) => {
 import { dirname, join as join2 } from "path";
 import matter2 from "gray-matter";
 import fs2 from "node:fs/promises";
+import { satisfies as satisfies2 } from "semver";
 var versionResource = async (catalogDir, id) => {
   const files = await getFiles(`${catalogDir}/**/index.md`);
   const matchedFiles = await searchFilesForId(files, id);
@@ -119,13 +120,28 @@ var versionResource = async (catalogDir, id) => {
     );
   });
 };
-var writeResource = async (catalogDir, resource, options = { path: "", type: "", override: false }) => {
+var writeResource = async (catalogDir, resource, options = {
+  path: "",
+  type: "",
+  override: false,
+  versionExistingContent: false
+}) => {
   const path = options.path || `/${resource.id}`;
   const exists = await versionExists(catalogDir, resource.id, resource.version);
   if (exists && !options.override) {
     throw new Error(`Failed to write ${resource.id} (${options.type}) as the version ${resource.version} already exists`);
   }
   const { markdown, ...frontmatter } = resource;
+  if (options.versionExistingContent) {
+    const currentResource = await getResource(catalogDir, resource.id);
+    if (currentResource) {
+      if (satisfies2(resource.version, `>${currentResource.version}`)) {
+        await versionResource(catalogDir, resource.id);
+      } else {
+        throw new Error(`New version ${resource.version} is not greater than current version ${currentResource.version}`);
+      }
+    }
+  }
   const document = matter2.stringify(markdown.trim(), frontmatter);
   await fs2.mkdir(join2(catalogDir, path), { recursive: true });
   await fs2.writeFile(join2(catalogDir, path, "index.md"), document);
@@ -139,6 +155,18 @@ var getResource = async (catalogDir, id, version, options) => {
     markdown: content.trim()
   };
 };
+var getResources = async (catalogDir, { type, latestOnly = false }) => {
+  const ignore = latestOnly ? `**/versioned/**` : "";
+  const files = await getFiles(`${catalogDir}/**/${type}/**/index.md`, ignore);
+  if (files.length === 0) return;
+  return files.map((file) => {
+    const { data, content } = matter2.read(file);
+    return {
+      ...data,
+      markdown: content.trim()
+    };
+  });
+};
 var rmResourceById = async (catalogDir, id, version, options) => {
   const files = await getFiles(`${catalogDir}/**/index.md`);
   const matchedFiles = await searchFilesForId(files, id, version);
@@ -165,6 +193,7 @@ var getVersionedDirectory = (sourceDirectory, version) => {
 
 // src/events.ts
 var getEvent = (directory) => async (id, version) => getResource(directory, id, version, { type: "event" });
+var getEvents = (directory) => async (options) => getResources(directory, { type: "events", ...options });
 var writeEvent = (directory) => async (event, options = { path: "", override: false }) => writeResource(directory, { ...event }, { ...options, type: "event" });
 var writeEventToService = (directory) => async (event, service, options = { path: "" }) => {
   let pathForEvent = service.version && service.version !== "latest" ? `/${service.id}/versioned/${service.version}/events` : `/${service.id}/events`;
@@ -191,6 +220,7 @@ var eventHasVersion = (directory) => async (id, version) => {
 import fs4 from "node:fs/promises";
 import { join as join4 } from "node:path";
 var getCommand = (directory) => async (id, version) => getResource(directory, id, version, { type: "command" });
+var getCommands = (directory) => async (options) => getResources(directory, { type: "commands", ...options });
 var writeCommand = (directory) => async (command, options = { path: "" }) => writeResource(directory, { ...command }, { ...options, type: "command" });
 var writeCommandToService = (directory) => async (command, service, options = { path: "" }) => {
   let pathForEvent = service.version && service.version !== "latest" ? `/${service.id}/versioned/${service.version}/commands` : `/${service.id}/commands`;
@@ -216,6 +246,7 @@ import fs5 from "node:fs/promises";
 import { join as join5 } from "node:path";
 var getQuery = (directory) => async (id, version) => getResource(directory, id, version, { type: "query" });
 var writeQuery = (directory) => async (query, options = { path: "" }) => writeResource(directory, { ...query }, { ...options, type: "query" });
+var getQueries = (directory) => async (options) => getResources(directory, { type: "queries", ...options });
 var writeQueryToService = (directory) => async (query, service, options = { path: "" }) => {
   let pathForQuery = service.version && service.version !== "latest" ? `/${service.id}/versioned/${service.version}/queries` : `/${service.id}/queries`;
   pathForQuery = join5(pathForQuery, query.id);
@@ -241,6 +272,7 @@ var queryHasVersion = (directory) => async (id, version) => {
 import fs6 from "node:fs/promises";
 import { join as join6, dirname as dirname2 } from "node:path";
 var getService = (directory) => async (id, version) => getResource(directory, id, version, { type: "service" });
+var getServices = (directory) => async (options) => getResources(directory, { type: "services", ...options });
 var writeService = (directory) => async (service, options = { path: "" }) => {
   const resource = { ...service };
   if (Array.isArray(service.sends)) {
@@ -324,6 +356,7 @@ var serviceHasVersion = (directory) => async (id, version) => {
 import fs7 from "node:fs/promises";
 import { join as join7 } from "node:path";
 var getDomain = (directory) => async (id, version) => getResource(directory, id, version, { type: "domain" });
+var getDomains = (directory) => async (options) => getResources(directory, { type: "domains", ...options });
 var writeDomain = (directory) => async (domain, options = { path: "" }) => {
   const resource = { ...domain };
   if (Array.isArray(domain.services)) {
@@ -359,6 +392,7 @@ var addServiceToDomain = (directory) => async (id, service, version) => {
 import fs8 from "node:fs/promises";
 import { join as join8 } from "node: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" });
 var rmChannel = (directory) => async (path) => {
   await fs8.rm(join8(directory, path), { recursive: true });
@@ -410,6 +444,12 @@ var src_default = (path) => {
      * @returns Event|Undefined
      */
     getEvent: getEvent(join9(path)),
+    /**
+     * Returns all events from EventCatalog
+     * @param latestOnly - optional boolean, set to true to get only latest versions
+     * @returns Event[]|Undefined
+     */
+    getEvents: getEvents(join9(path)),
     /**
      * Adds an event to EventCatalog
      *
@@ -481,6 +521,12 @@ var src_default = (path) => {
      * @returns Command|Undefined
      */
     getCommand: getCommand(join9(path)),
+    /**
+     * Returns all commands from EventCatalog
+     * @param latestOnly - optional boolean, set to true to get only latest versions
+     * @returns Command[]|Undefined
+     */
+    getCommands: getCommands(join9(path)),
     /**
      * Adds an command to EventCatalog
      *
@@ -552,6 +598,12 @@ var src_default = (path) => {
      * @returns Query|Undefined
      */
     getQuery: getQuery(join9(path)),
+    /**
+     * Returns all queries from EventCatalog
+     * @param latestOnly - optional boolean, set to true to get only latest versions
+     * @returns Query[]|Undefined
+     */
+    getQueries: getQueries(join9(path)),
     /**
      * Adds a query to EventCatalog
      *
@@ -623,6 +675,12 @@ var src_default = (path) => {
      * @returns Channel|Undefined
      */
     getChannel: getChannel(join9(path)),
+    /**
+     * Returns all channels from EventCatalog
+     * @param latestOnly - optional boolean, set to true to get only latest versions
+     * @returns Channel[]|Undefined
+     */
+    getChannels: getChannels(join9(path)),
     /**
      * Adds an channel to EventCatalog
      *
@@ -744,6 +802,12 @@ var src_default = (path) => {
      * @returns Service|Undefined
      */
     getService: getService(join9(path)),
+    /**
+     * Returns all services from EventCatalog
+     * @param latestOnly - optional boolean, set to true to get only latest versions
+     * @returns Service[]|Undefined
+     */
+    getServices: getServices(join9(path)),
     /**
      * Moves a given service id to the version directory
      * @param directory
@@ -865,6 +929,12 @@ var src_default = (path) => {
      * @returns Domain|Undefined
      */
     getDomain: getDomain(join9(path, "domains")),
+    /**
+     * Returns all domains from EventCatalog
+     * @param latestOnly - optional boolean, set to true to get only latest versions
+     * @returns Domain[]|Undefined
+     */
+    getDomains: getDomains(join9(path)),
     /**
      * Moves a given domain id to the version directory
      * @param directory