@eventcatalog/sdk 0.0.9 → 0.0.11

package/dist/index.d.mts

@@ -10,8 +10,8 @@ declare const _default: (path: string) => {
     /**
      * Returns an events from EventCatalog
      * @param id - The id of the event to retrieve
-     * @param version - Optional id of the version to get
-     * @returns
+     * @param version - Optional id of the version to get (supports semver)
+     * @returns Event|Undefined
      */
     getEvent: (id: string, version?: string) => Promise<Event>;
     /**
@@ -65,6 +65,13 @@ declare const _default: (path: string) => {
         schema: string;
         fileName: string;
     }, version?: string) => Promise<void>;
+    /**
+     * Check to see if an event version exists
+     * @param id - The id of the event
+     * @param version - The version of the event (supports semver)
+     * @returns
+     */
+    eventHasVersion: (id: string, version: string) => Promise<boolean>;
     /**
      * ================================
      *            Commands
@@ -73,8 +80,8 @@ declare const _default: (path: string) => {
     /**
      * Returns a command from EventCatalog
      * @param id - The id of the command to retrieve
-     * @param version - Optional id of the version to get
-     * @returns
+     * @param version - Optional id of the version to get (supports semver)
+     * @returns Command|Undefined
      */
     getCommand: (id: string, version?: string) => Promise<Command>;
     /**
@@ -128,6 +135,13 @@ declare const _default: (path: string) => {
         schema: string;
         fileName: string;
     }, version?: string) => Promise<void>;
+    /**
+     * Check to see if a command version exists
+     * @param id - The id of the command
+     * @param version - The version of the command (supports semver)
+     * @returns
+     */
+    commandHasVersion: (id: string, version: string) => Promise<boolean>;
     /**
      * ================================
      *            SERVICES
@@ -146,8 +160,8 @@ declare const _default: (path: string) => {
     /**
      * Returns a service from EventCatalog
      * @param id - The id of the service to retrieve
-     * @param version - Optional id of the version to get
-     * @returns
+     * @param version - Optional id of the version to get (supports semver)
+     * @returns Service|Undefined
      */
     getService: (id: string, version?: string) => Promise<Service>;
     /**
@@ -180,6 +194,13 @@ declare const _default: (path: string) => {
         content: string;
         fileName: string;
     }, version?: string) => Promise<void>;
+    /**
+     * Check to see if a service version exists
+     * @param id - The id of the service
+     * @param version - The version of the service (supports semver)
+     * @returns
+     */
+    serviceHasVersion: (id: string, version: string) => Promise<boolean>;
     /**
      * ================================
      *            Domains
@@ -198,8 +219,8 @@ declare const _default: (path: string) => {
     /**
      * Returns a domain from EventCatalog
      * @param id - The id of the domain to retrieve
-     * @param version - Optional id of the version to get
-     * @returns
+     * @param version - Optional id of the version to get (supports semver)
+     * @returns Domain|Undefined
      */
     getDomain: (id: string, version?: string) => Promise<Domain>;
     /**
@@ -278,6 +299,13 @@ declare const _default: (path: string) => {
         id: string;
         version: string;
     }, version?: string) => Promise<void>;
+    /**
+     * Check to see if a domain version exists
+     * @param id - The id of the domain
+     * @param version - The version of the domain (supports semver)
+     * @returns
+     */
+    domainHasVersion: (id: string, version: string) => Promise<boolean>;
 };
 
 export { _default as default };

package/dist/index.d.ts

@@ -10,8 +10,8 @@ declare const _default: (path: string) => {
     /**
      * Returns an events from EventCatalog
      * @param id - The id of the event to retrieve
-     * @param version - Optional id of the version to get
-     * @returns
+     * @param version - Optional id of the version to get (supports semver)
+     * @returns Event|Undefined
      */
     getEvent: (id: string, version?: string) => Promise<Event>;
     /**
@@ -65,6 +65,13 @@ declare const _default: (path: string) => {
         schema: string;
         fileName: string;
     }, version?: string) => Promise<void>;
+    /**
+     * Check to see if an event version exists
+     * @param id - The id of the event
+     * @param version - The version of the event (supports semver)
+     * @returns
+     */
+    eventHasVersion: (id: string, version: string) => Promise<boolean>;
     /**
      * ================================
      *            Commands
@@ -73,8 +80,8 @@ declare const _default: (path: string) => {
     /**
      * Returns a command from EventCatalog
      * @param id - The id of the command to retrieve
-     * @param version - Optional id of the version to get
-     * @returns
+     * @param version - Optional id of the version to get (supports semver)
+     * @returns Command|Undefined
      */
     getCommand: (id: string, version?: string) => Promise<Command>;
     /**
@@ -128,6 +135,13 @@ declare const _default: (path: string) => {
         schema: string;
         fileName: string;
     }, version?: string) => Promise<void>;
+    /**
+     * Check to see if a command version exists
+     * @param id - The id of the command
+     * @param version - The version of the command (supports semver)
+     * @returns
+     */
+    commandHasVersion: (id: string, version: string) => Promise<boolean>;
     /**
      * ================================
      *            SERVICES
@@ -146,8 +160,8 @@ declare const _default: (path: string) => {
     /**
      * Returns a service from EventCatalog
      * @param id - The id of the service to retrieve
-     * @param version - Optional id of the version to get
-     * @returns
+     * @param version - Optional id of the version to get (supports semver)
+     * @returns Service|Undefined
      */
     getService: (id: string, version?: string) => Promise<Service>;
     /**
@@ -180,6 +194,13 @@ declare const _default: (path: string) => {
         content: string;
         fileName: string;
     }, version?: string) => Promise<void>;
+    /**
+     * Check to see if a service version exists
+     * @param id - The id of the service
+     * @param version - The version of the service (supports semver)
+     * @returns
+     */
+    serviceHasVersion: (id: string, version: string) => Promise<boolean>;
     /**
      * ================================
      *            Domains
@@ -198,8 +219,8 @@ declare const _default: (path: string) => {
     /**
      * Returns a domain from EventCatalog
      * @param id - The id of the domain to retrieve
-     * @param version - Optional id of the version to get
-     * @returns
+     * @param version - Optional id of the version to get (supports semver)
+     * @returns Domain|Undefined
      */
     getDomain: (id: string, version?: string) => Promise<Domain>;
     /**
@@ -278,6 +299,13 @@ declare const _default: (path: string) => {
         id: string;
         version: string;
     }, version?: string) => Promise<void>;
+    /**
+     * Check to see if a domain version exists
+     * @param id - The id of the domain
+     * @param version - The version of the domain (supports semver)
+     * @returns
+     */
+    domainHasVersion: (id: string, version: string) => Promise<boolean>;
 };
 
 export { _default as default };

package/dist/index.js

@@ -39,15 +39,13 @@ var import_node_path6 = require("path");
 var import_promises3 = __toESM(require("fs/promises"));
 var import_node_path2 = require("path");
 
-// src/internal/resources.ts
-var import_path = require("path");
-
 // src/internal/utils.ts
 var import_glob = require("glob");
 var import_promises = __toESM(require("fs/promises"));
 var import_fs_extra = require("fs-extra");
 var import_node_path = require("path");
 var import_gray_matter = __toESM(require("gray-matter"));
+var import_semver = require("semver");
 var versionExists = async (catalogDir, id, version) => {
   const files = await getFiles(`${catalogDir}/**/index.md`);
   const matchedFiles = await searchFilesForId(files, id, version) || [];
@@ -60,14 +58,22 @@ var findFileById = async (catalogDir, id, version) => {
   if (!version) {
     return latestVersion;
   }
-  const match = matchedFiles.find((path) => path.includes(`versioned/${version}`));
-  if (!match && latestVersion) {
-    const { data } = import_gray_matter.default.read(latestVersion);
-    if (data.version === version) {
-      return latestVersion;
-    }
+  const parsedFiles = matchedFiles.map((path) => {
+    const { data } = import_gray_matter.default.read(path);
+    return { ...data, path };
+  });
+  const semverRange = (0, import_semver.validRange)(version);
+  if (semverRange) {
+    const match2 = parsedFiles.filter((c) => (0, import_semver.satisfies)(c.version, semverRange));
+    return match2.length > 0 ? match2[0].path : void 0;
+  }
+  const sorted = parsedFiles.sort((a, b) => {
+    return a.version.localeCompare(b.version);
+  });
+  const match = sorted.length > 0 ? [sorted[sorted.length - 1]] : [];
+  if (match.length > 0) {
+    return match[0].path;
   }
-  return match;
 };
 var getFiles = async (pattern) => {
   try {
@@ -109,6 +115,7 @@ var copyDir = async (catalogDir, source, target, filter) => {
 };
 
 // src/internal/resources.ts
+var import_path = require("path");
 var import_gray_matter2 = __toESM(require("gray-matter"));
 var import_promises2 = __toESM(require("fs/promises"));
 var versionResource = async (catalogDir, id) => {
@@ -148,10 +155,7 @@ var writeResource = async (catalogDir, resource, options = { path: "", type: ""
 };
 var getResource = async (catalogDir, id, version, options) => {
   const file = await findFileById(catalogDir, id, version);
-  if (!file)
-    throw new Error(
-      `No ${options?.type || "resource"} found for the given id: ${id}` + (version ? ` and version ${version}` : "")
-    );
+  if (!file) return;
   const { data, content } = import_gray_matter2.default.read(file);
   return {
     ...data,
@@ -184,6 +188,10 @@ var addFileToEvent = (directory) => async (id, file, version) => addFileToResour
 var addSchemaToEvent = (directory) => async (id, schema, version) => {
   await addFileToEvent(directory)(id, { content: schema.schema, fileName: schema.fileName }, version);
 };
+var eventHasVersion = (directory) => async (id, version) => {
+  const file = await findFileById(directory, id, version);
+  return !!file;
+};
 
 // src/commands.ts
 var import_promises4 = __toESM(require("fs/promises"));
@@ -199,6 +207,10 @@ var addFileToCommand = (directory) => async (id, file, version) => addFileToReso
 var addSchemaToCommand = (directory) => async (id, schema, version) => {
   await addFileToCommand(directory)(id, { content: schema.schema, fileName: schema.fileName }, version);
 };
+var commandHasVersion = (directory) => async (id, version) => {
+  const file = await findFileById(directory, id, version);
+  return !!file;
+};
 
 // src/services.ts
 var import_promises5 = __toESM(require("fs/promises"));
@@ -239,6 +251,10 @@ var addMessageToService = (directory) => async (id, direction, event, version) =
   await rmServiceById(directory)(id, version);
   await writeService(directory)(service);
 };
+var serviceHasVersion = (directory) => async (id, version) => {
+  const file = await findFileById(directory, id, version);
+  return !!file;
+};
 
 // src/domains.ts
 var import_promises6 = __toESM(require("fs/promises"));
@@ -251,6 +267,10 @@ var rmDomain = (directory) => async (path) => {
 };
 var rmDomainById = (directory) => async (id, version) => rmResourceById(directory, id, version, { type: "domain" });
 var addFileToDomain = (directory) => async (id, file, version) => addFileToResource(directory, id, file, version);
+var domainHasVersion = (directory) => async (id, version) => {
+  const file = await findFileById(directory, id, version);
+  return !!file;
+};
 
 // src/index.ts
 var src_default = (path) => {
@@ -258,8 +278,8 @@ var src_default = (path) => {
     /**
      * Returns an events from EventCatalog
      * @param id - The id of the event to retrieve
-     * @param version - Optional id of the version to get
-     * @returns
+     * @param version - Optional id of the version to get (supports semver)
+     * @returns Event|Undefined
      */
     getEvent: getEvent((0, import_node_path6.join)(path, "events")),
     /**
@@ -305,6 +325,13 @@ var src_default = (path) => {
      * @returns
      */
     addSchemaToEvent: addSchemaToEvent((0, import_node_path6.join)(path, "events")),
+    /**
+     * Check to see if an event version exists
+     * @param id - The id of the event
+     * @param version - The version of the event (supports semver)
+     * @returns
+     */
+    eventHasVersion: eventHasVersion((0, import_node_path6.join)(path, "events")),
     /**
      * ================================
      *            Commands
@@ -313,8 +340,8 @@ var src_default = (path) => {
     /**
      * Returns a command from EventCatalog
      * @param id - The id of the command to retrieve
-     * @param version - Optional id of the version to get
-     * @returns
+     * @param version - Optional id of the version to get (supports semver)
+     * @returns Command|Undefined
      */
     getCommand: getCommand((0, import_node_path6.join)(path, "commands")),
     /**
@@ -360,6 +387,13 @@ var src_default = (path) => {
      * @returns
      */
     addSchemaToCommand: addSchemaToCommand((0, import_node_path6.join)(path, "commands")),
+    /**
+     * Check to see if a command version exists
+     * @param id - The id of the command
+     * @param version - The version of the command (supports semver)
+     * @returns
+     */
+    commandHasVersion: commandHasVersion((0, import_node_path6.join)(path, "commands")),
     /**
      * ================================
      *            SERVICES
@@ -376,8 +410,8 @@ var src_default = (path) => {
     /**
      * Returns a service from EventCatalog
      * @param id - The id of the service to retrieve
-     * @param version - Optional id of the version to get
-     * @returns
+     * @param version - Optional id of the version to get (supports semver)
+     * @returns Service|Undefined
      */
     getService: getService((0, import_node_path6.join)(path, "services")),
     /**
@@ -407,6 +441,13 @@ var src_default = (path) => {
      * @returns
      */
     addFileToService: addFileToService((0, import_node_path6.join)(path, "services")),
+    /**
+     * Check to see if a service version exists
+     * @param id - The id of the service
+     * @param version - The version of the service (supports semver)
+     * @returns
+     */
+    serviceHasVersion: serviceHasVersion((0, import_node_path6.join)(path, "services")),
     /**
      * ================================
      *            Domains
@@ -423,8 +464,8 @@ var src_default = (path) => {
     /**
      * Returns a domain from EventCatalog
      * @param id - The id of the domain to retrieve
-     * @param version - Optional id of the version to get
-     * @returns
+     * @param version - Optional id of the version to get (supports semver)
+     * @returns Domain|Undefined
      */
     getDomain: getDomain((0, import_node_path6.join)(path, "domains")),
     /**
@@ -493,7 +534,14 @@ var src_default = (path) => {
      *
      * ```
      */
-    addCommandToService: addMessageToService((0, import_node_path6.join)(path, "services"))
+    addCommandToService: addMessageToService((0, import_node_path6.join)(path, "services")),
+    /**
+     * Check to see if a domain version exists
+     * @param id - The id of the domain
+     * @param version - The version of the domain (supports semver)
+     * @returns
+     */
+    domainHasVersion: domainHasVersion((0, import_node_path6.join)(path, "domains"))
   };
 };
 //# sourceMappingURL=index.js.map