@eventcatalog/core 2.23.0 → 2.23.2

package/README.md

@@ -32,10 +32,10 @@
 <h4>Features: Documentation generator for Event Driven Architectures, Integration with any broker, Docs and Code, Markdown driven, Document Domains/Services/Messages/Schemas and more, Content versioning, Assign Owners, Schemas, OpenAPI, MDX Components and more...</h4>
 
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-47-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-48-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
-[Read the Docs](https://eventcatalog.dev/) | [Edit the Docs](https://github.com/event-catalog/docs) | [View Demo](https://demo.eventcatalog.dev/docs)
+[Read the Docs](https://www.eventcatalog.dev/product/documentation) | [View Demo](https://demo.eventcatalog.dev/docs)
 
 </div>
 
@@ -44,14 +44,14 @@
 # Core Features
 
 - 📃 Document domains, services and messages ([demo](https://demo.eventcatalog.dev/docs))
-- 📊 Visualise your architecture ([demo](https://demo.eventcatalog.dev/visualiser))
+- 📊 Visualise your architecture ([demo](https://demo.eventcatalog.dev/visualiser/domains/Orders))
 - ⭐ Supports any Schema format (e.g Avro, JSON) ([demo](https://demo.eventcatalog.dev/docs/events/InventoryAdjusted/0.0.4))
 - 🗂️ Document any code examples (Any code snippet)
 - 💅 Custom MDX components ([read more](https://eventcatalog.dev/docs/development/components/using-components))
 - 🗄️ Version domains, services and messages
 - ⭐ Discoverability feature (search, filter and more) ([demo](https://demo.eventcatalog.dev/discover/events))
 - ⭐ Document teams and users ([demo](https://demo.eventcatalog.dev/docs/teams/full-stack))
-- 🤖 Automate your catalogs with [generators](https://www.eventcatalog.dev/docs/development/plugins/plugin-overview) (e.g generate your catalogs from your [AsyncAPI](https://www.eventcatalog.dev/docs/ascynapi)/[OpenAPI](https://www.eventcatalog.dev/docs/openapi) documents)
+- 🤖 Automate your catalogs with [generators](https://www.eventcatalog.dev/docs/development/plugins/plugin-overview) (e.g generate your catalogs from your [AsyncAPI](https://www.eventcatalog.dev/docs/asyncapi)/[OpenAPI](https://www.eventcatalog.dev/docs/openapi) documents)
 - 👨🏼‍💻 Follows [Docs as code](https://www.writethedocs.org/guide/docs-as-code/) principles
 - ⭐ And much more...
 
@@ -251,6 +251,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
       <td align="center" valign="top" width="14.28%"><a href="https://pallares.io"><img src="https://avatars.githubusercontent.com/u/1077520?v=4?s=100" width="100px;" alt="Cristian Pallarés"/><br /><sub><b>Cristian Pallarés</b></sub></a><br /><a href="https://github.com/event-catalog/eventcatalog/commits?author=skyrpex" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/SebasRendon12"><img src="https://avatars.githubusercontent.com/u/69688183?v=4?s=100" width="100px;" alt="Sebastian Rendon"/><br /><sub><b>Sebastian Rendon</b></sub></a><br /><a href="https://github.com/event-catalog/eventcatalog/commits?author=SebasRendon12" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="http://craig0990.co.uk"><img src="https://avatars.githubusercontent.com/u/461897?v=4?s=100" width="100px;" alt="Craig Roberts"/><br /><sub><b>Craig Roberts</b></sub></a><br /><a href="https://github.com/event-catalog/eventcatalog/commits?author=craig0990" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Vertygo"><img src="https://avatars.githubusercontent.com/u/1658326?v=4?s=100" width="100px;" alt="Ivan Milosavljevic"/><br /><sub><b>Ivan Milosavljevic</b></sub></a><br /><a href="https://github.com/event-catalog/eventcatalog/commits?author=Vertygo" title="Documentation">📖</a></td>
     </tr>
   </tbody>
 </table>

package/dist/analytics/analytics.cjs

@@ -37,7 +37,7 @@ var import_axios = __toESM(require("axios"), 1);
 var import_os = __toESM(require("os"), 1);
 
 // package.json
-var version = "2.23.0";
+var version = "2.23.2";
 
 // src/constants.ts
 var VERSION = version;

package/dist/analytics/analytics.js

@@ -1,7 +1,7 @@
 import {
   raiseEvent
-} from "../chunk-CLNIEHVG.js";
-import "../chunk-WNRZ5O5C.js";
+} from "../chunk-RMESKTDM.js";
+import "../chunk-OXD723LJ.js";
 export {
   raiseEvent
 };

package/dist/analytics/log-build.cjs

@@ -106,7 +106,7 @@ var import_axios = __toESM(require("axios"), 1);
 var import_os = __toESM(require("os"), 1);
 
 // package.json
-var version = "2.23.0";
+var version = "2.23.2";
 
 // src/constants.ts
 var VERSION = version;

package/dist/analytics/log-build.js

@@ -1,8 +1,8 @@
 import {
   log_build_default
-} from "../chunk-F55C3RGO.js";
-import "../chunk-CLNIEHVG.js";
-import "../chunk-WNRZ5O5C.js";
+} from "../chunk-W3SPESBN.js";
+import "../chunk-RMESKTDM.js";
+import "../chunk-OXD723LJ.js";
 import "../chunk-E7TXTI7G.js";
 export {
   log_build_default as default

package/dist/{chunk-WNRZ5O5C.js → chunk-OXD723LJ.js}

@@ -1,5 +1,5 @@
 // package.json
-var version = "2.23.0";
+var version = "2.23.2";
 
 // src/constants.ts
 var VERSION = version;

package/dist/{chunk-CLNIEHVG.js → chunk-RMESKTDM.js}

@@ -1,6 +1,6 @@
 import {
   VERSION
-} from "./chunk-WNRZ5O5C.js";
+} from "./chunk-OXD723LJ.js";
 
 // src/analytics/analytics.js
 import axios from "axios";

package/dist/{chunk-F55C3RGO.js → chunk-W3SPESBN.js}

@@ -1,6 +1,6 @@
 import {
   raiseEvent
-} from "./chunk-CLNIEHVG.js";
+} from "./chunk-RMESKTDM.js";
 import {
   getEventCatalogConfigFile,
   verifyRequiredFieldsAreInCatalogConfigFile

package/dist/constants.cjs

@@ -25,7 +25,7 @@ __export(constants_exports, {
 module.exports = __toCommonJS(constants_exports);
 
 // package.json
-var version = "2.23.0";
+var version = "2.23.2";
 
 // src/constants.ts
 var VERSION = version;

package/dist/constants.js

@@ -1,6 +1,6 @@
 import {
   VERSION
-} from "./chunk-WNRZ5O5C.js";
+} from "./chunk-OXD723LJ.js";
 export {
   VERSION
 };

package/dist/eventcatalog.cjs

@@ -161,7 +161,7 @@ var import_axios = __toESM(require("axios"), 1);
 var import_os = __toESM(require("os"), 1);
 
 // package.json
-var version = "2.23.0";
+var version = "2.23.2";
 
 // src/constants.ts
 var VERSION = version;
@@ -513,7 +513,6 @@ var resolve_catalog_dependencies_default = async (catalogDir, core2) => {
 };
 
 // src/eventcatalog.ts
-var import_semver = __toESM(require("semver"), 1);
 var import_boxen2 = __toESM(require("boxen"), 1);
 
 // src/features.ts
@@ -562,27 +561,21 @@ var isBackstagePluginEnabled = async (licenseKey) => {
 };
 
 // src/eventcatalog.ts
-var boxenOptions = {
-  padding: 1,
-  margin: 1,
-  align: "center",
-  borderColor: "yellow",
-  borderStyle: {
-    topLeft: " ",
-    topRight: " ",
-    bottomLeft: " ",
-    bottomRight: " ",
-    right: " ",
-    top: "-",
-    bottom: "-",
-    left: " "
-  }
-};
+var import_update_notifier = __toESM(require("update-notifier"), 1);
 var currentDir = import_node_path7.default.dirname((0, import_node_url.fileURLToPath)(importMetaUrl));
 var program = new import_commander.Command().version(VERSION);
 var dir = import_node_path7.default.resolve(process.env.PROJECT_DIR || process.cwd());
 var core = import_node_path7.default.resolve(process.env.CATALOG_DIR || (0, import_node_path6.join)(dir, ".eventcatalog-core"));
 var eventCatalogDir = import_node_path7.default.resolve((0, import_node_path6.join)(currentDir, "../eventcatalog/"));
+var getInstalledEventCatalogVersion = () => {
+  try {
+    const pkg = import_fs2.default.readFileSync((0, import_node_path6.join)(dir, "package.json"), "utf8");
+    const json = JSON.parse(pkg);
+    return json.dependencies["@eventcatalog/core"];
+  } catch (error) {
+    return null;
+  }
+};
 program.name("eventcatalog").description("Documentation tool for event-driven architectures");
 var ensureDir = (dir2) => {
   if (!import_fs2.default.existsSync(dir2)) {
@@ -605,29 +598,35 @@ var clearCore = () => {
   if (import_fs2.default.existsSync(core)) import_fs2.default.rmSync(core, { recursive: true });
 };
 var checkForUpdate = () => {
-  try {
-    const packageJson = JSON.parse(import_fs2.default.readFileSync(import_node_path7.default.join(dir, "package.json"), "utf-8"));
-    const userEventCatalogVersion = packageJson.dependencies["@eventcatalog/core"];
-    const corePackageJson = JSON.parse(import_fs2.default.readFileSync(import_node_path7.default.join(core, "package.json"), "utf-8"));
-    const coreVersion = corePackageJson.version;
-    const userVersion = userEventCatalogVersion.replace(/[\^~]/, "");
-    if (import_semver.default.lt(userVersion, coreVersion)) {
-      const docusaurusUpdateMessage = (0, import_boxen2.default)(
-        `Update available for EventCatalog
-        @eventcatalog/core ${userVersion} \u2192 ${coreVersion}
-        
-        Run \`npm i @eventcatalog/core@${coreVersion}\` to update your EventCatalog
-        `,
-        boxenOptions
-      );
-      console.log(docusaurusUpdateMessage);
-    }
-  } catch (error) {
+  const installedVersion = getInstalledEventCatalogVersion();
+  if (!installedVersion) return;
+  const pkg = { name: "@eventcatalog/core", version: installedVersion };
+  const notifier = (0, import_update_notifier.default)({ pkg, updateCheckInterval: 0 });
+  if (notifier.update) {
+    const message = `EventCatalog update available ${notifier.update.current} \u2192 ${notifier.update.latest}
+Run npm i @eventcatalog/core to update`;
+    console.log(
+      (0, import_boxen2.default)(message, {
+        padding: 1,
+        margin: 1,
+        align: "center",
+        borderColor: "yellow",
+        borderStyle: {
+          topLeft: " ",
+          topRight: " ",
+          bottomLeft: " ",
+          bottomRight: " ",
+          right: " ",
+          top: "-",
+          bottom: "-",
+          left: " "
+        }
+      })
+    );
   }
 };
 program.command("dev").description("Run development server of EventCatalog").option("-d, --debug", "Output EventCatalog application information into your terminal").option("--force-recreate", "Recreate the eventcatalog-core directory", false).action(async (options, command) => {
   console.log("Setting up EventCatalog....");
-  checkForUpdate();
   if (options.debug) {
     console.log("Debug mode enabled");
     console.log("PROJECT_DIR", dir);
@@ -635,10 +634,10 @@ program.command("dev").description("Run development server of EventCatalog").opt
   }
   if (options.forceRecreate) clearCore();
   copyCore();
-  console.log("EventCatalog is starting at http://localhost:3000/docs");
   await resolve_catalog_dependencies_default(dir, core);
   await catalogToAstro(dir, core);
   const canEmbedPages = await isBackstagePluginEnabled();
+  checkForUpdate();
   let watchUnsub;
   try {
     watchUnsub = await watch(dir, core);
@@ -663,12 +662,12 @@ program.command("dev").description("Run development server of EventCatalog").opt
 });
 program.command("build").description("Run build of EventCatalog").action(async (options, command) => {
   console.log("Building EventCatalog...");
-  checkForUpdate();
   copyCore();
   await log_build_default(dir);
   await resolve_catalog_dependencies_default(dir, core);
   await catalogToAstro(dir, core);
   const canEmbedPages = await isBackstagePluginEnabled();
+  checkForUpdate();
   (0, import_node_child_process.execSync)(
     `cross-env PROJECT_DIR='${dir}' CATALOG_DIR='${core}' ENABLE_EMBED=${canEmbedPages} npx astro build ${command.args.join(" ").trim()}`,
     {

package/dist/eventcatalog.js

@@ -6,14 +6,14 @@ import {
 } from "./chunk-OW2FQPYP.js";
 import {
   log_build_default
-} from "./chunk-F55C3RGO.js";
-import "./chunk-CLNIEHVG.js";
+} from "./chunk-W3SPESBN.js";
+import "./chunk-RMESKTDM.js";
 import {
   catalogToAstro
 } from "./chunk-CXKIF3EI.js";
 import {
   VERSION
-} from "./chunk-WNRZ5O5C.js";
+} from "./chunk-OXD723LJ.js";
 import {
   isBackstagePluginEnabled
 } from "./chunk-XMDPVKIJ.js";
@@ -31,29 +31,22 @@ import fs from "fs";
 import path from "node:path";
 import { fileURLToPath } from "node:url";
 import concurrently from "concurrently";
-import semver from "semver";
 import boxen from "boxen";
-var boxenOptions = {
-  padding: 1,
-  margin: 1,
-  align: "center",
-  borderColor: "yellow",
-  borderStyle: {
-    topLeft: " ",
-    topRight: " ",
-    bottomLeft: " ",
-    bottomRight: " ",
-    right: " ",
-    top: "-",
-    bottom: "-",
-    left: " "
-  }
-};
+import updateNotifier from "update-notifier";
 var currentDir = path.dirname(fileURLToPath(import.meta.url));
 var program = new Command().version(VERSION);
 var dir = path.resolve(process.env.PROJECT_DIR || process.cwd());
 var core = path.resolve(process.env.CATALOG_DIR || join(dir, ".eventcatalog-core"));
 var eventCatalogDir = path.resolve(join(currentDir, "../eventcatalog/"));
+var getInstalledEventCatalogVersion = () => {
+  try {
+    const pkg = fs.readFileSync(join(dir, "package.json"), "utf8");
+    const json = JSON.parse(pkg);
+    return json.dependencies["@eventcatalog/core"];
+  } catch (error) {
+    return null;
+  }
+};
 program.name("eventcatalog").description("Documentation tool for event-driven architectures");
 var ensureDir = (dir2) => {
   if (!fs.existsSync(dir2)) {
@@ -76,29 +69,35 @@ var clearCore = () => {
   if (fs.existsSync(core)) fs.rmSync(core, { recursive: true });
 };
 var checkForUpdate = () => {
-  try {
-    const packageJson = JSON.parse(fs.readFileSync(path.join(dir, "package.json"), "utf-8"));
-    const userEventCatalogVersion = packageJson.dependencies["@eventcatalog/core"];
-    const corePackageJson = JSON.parse(fs.readFileSync(path.join(core, "package.json"), "utf-8"));
-    const coreVersion = corePackageJson.version;
-    const userVersion = userEventCatalogVersion.replace(/[\^~]/, "");
-    if (semver.lt(userVersion, coreVersion)) {
-      const docusaurusUpdateMessage = boxen(
-        `Update available for EventCatalog
-        @eventcatalog/core ${userVersion} \u2192 ${coreVersion}
-        
-        Run \`npm i @eventcatalog/core@${coreVersion}\` to update your EventCatalog
-        `,
-        boxenOptions
-      );
-      console.log(docusaurusUpdateMessage);
-    }
-  } catch (error) {
+  const installedVersion = getInstalledEventCatalogVersion();
+  if (!installedVersion) return;
+  const pkg = { name: "@eventcatalog/core", version: installedVersion };
+  const notifier = updateNotifier({ pkg, updateCheckInterval: 0 });
+  if (notifier.update) {
+    const message = `EventCatalog update available ${notifier.update.current} \u2192 ${notifier.update.latest}
+Run npm i @eventcatalog/core to update`;
+    console.log(
+      boxen(message, {
+        padding: 1,
+        margin: 1,
+        align: "center",
+        borderColor: "yellow",
+        borderStyle: {
+          topLeft: " ",
+          topRight: " ",
+          bottomLeft: " ",
+          bottomRight: " ",
+          right: " ",
+          top: "-",
+          bottom: "-",
+          left: " "
+        }
+      })
+    );
   }
 };
 program.command("dev").description("Run development server of EventCatalog").option("-d, --debug", "Output EventCatalog application information into your terminal").option("--force-recreate", "Recreate the eventcatalog-core directory", false).action(async (options, command) => {
   console.log("Setting up EventCatalog....");
-  checkForUpdate();
   if (options.debug) {
     console.log("Debug mode enabled");
     console.log("PROJECT_DIR", dir);
@@ -106,10 +105,10 @@ program.command("dev").description("Run development server of EventCatalog").opt
   }
   if (options.forceRecreate) clearCore();
   copyCore();
-  console.log("EventCatalog is starting at http://localhost:3000/docs");
   await resolve_catalog_dependencies_default(dir, core);
   await catalogToAstro(dir, core);
   const canEmbedPages = await isBackstagePluginEnabled();
+  checkForUpdate();
   let watchUnsub;
   try {
     watchUnsub = await watch(dir, core);
@@ -134,12 +133,12 @@ program.command("dev").description("Run development server of EventCatalog").opt
 });
 program.command("build").description("Run build of EventCatalog").action(async (options, command) => {
   console.log("Building EventCatalog...");
-  checkForUpdate();
   copyCore();
   await log_build_default(dir);
   await resolve_catalog_dependencies_default(dir, core);
   await catalogToAstro(dir, core);
   const canEmbedPages = await isBackstagePluginEnabled();
+  checkForUpdate();
   execSync(
     `cross-env PROJECT_DIR='${dir}' CATALOG_DIR='${core}' ENABLE_EMBED=${canEmbedPages} npx astro build ${command.args.join(" ").trim()}`,
     {

package/eventcatalog/src/components/Tables/columns/ServiceTableColumns.tsx

@@ -128,6 +128,18 @@ export const columns = () => [
       if (sends?.length === 0 || !sends)
         return <div className="text-sm text-gray-400/80 text-left italic">Service sends no messages.</div>;
 
+      const sendersWithIcons = useMemo(
+        () =>
+          sends?.map((sender) => {
+            const type = sender.collection.slice(0, -1);
+            return {
+              ...sender,
+              ...getColorAndIconForMessageType(type),
+            };
+          }) || [],
+        [sends]
+      );
+
       return (
         <div>
           {isExpandable && (
@@ -137,30 +149,25 @@ export const columns = () => [
           )}
           {isExpanded && (
             <ul>
-              {sends.map((consumer, index) => {
-                const type = consumer.collection.slice(0, -1);
-                const color = type === 'event' ? 'orange' : 'blue';
-                const Icon = type === 'event' ? BoltIcon : ChatBubbleLeftIcon;
-                return (
-                  <li key={`${consumer.data.id}-${index}`} className="py-1 group font-light">
-                    <a
-                      href={buildUrl(`/docs/${consumer.collection}/${consumer.data.id}/${consumer.data.version}`)}
-                      className="group-hover:text-primary flex space-x-1 items-center "
-                    >
-                      <div className={`flex items-center border border-gray-300 shadow-sm rounded-md`}>
-                        <span className="flex items-center">
-                          <span className={`bg-${color}-500 h-full rounded-tl rounded-bl p-1`}>
-                            <Icon className="h-4 w-4 text-white" />
-                          </span>
-                          <span className="leading-none px-2 group-hover:underline ">
-                            {consumer.data.name} (v{consumer.data.version})
-                          </span>
+              {sendersWithIcons.map((sender, index) => (
+                <li key={`${sender.data.id}-${index}`} className="py-1 group font-light">
+                  <a
+                    href={buildUrl(`/docs/${sender.collection}/${sender.data.id}/${sender.data.version}`)}
+                    className="group-hover:text-primary flex space-x-1 items-center "
+                  >
+                    <div className={`flex items-center border border-gray-300 shadow-sm rounded-md`}>
+                      <span className="flex items-center">
+                        <span className={`bg-${sender.color}-500 h-full rounded-tl rounded-bl p-1`}>
+                          <sender.Icon className="h-4 w-4 text-white" />
                         </span>
-                      </div>
-                    </a>
-                  </li>
-                );
-              })}
+                        <span className="leading-none px-2 group-hover:underline ">
+                          {sender.data.name} (v{sender.data.version})
+                        </span>
+                      </span>
+                    </div>
+                  </a>
+                </li>
+              ))}
             </ul>
           )}
         </div>

package/package.json

@@ -6,7 +6,7 @@
     "url": "https://github.com/event-catalog/eventcatalog.git"
   },
   "type": "module",
-  "version": "2.23.0",
+  "version": "2.23.2",
   "publishConfig": {
     "access": "public"
   },
@@ -37,7 +37,7 @@
     "@tailwindcss/typography": "^0.5.13",
     "@tanstack/react-table": "^8.17.3",
     "@xyflow/react": "^12.3.6",
-    "astro": "^5.2.5",
+    "astro": "^5.3.0",
     "astro-expressive-code": "^0.40.1",
     "astro-pagefind": "^1.6.0",
     "astro-seo": "^0.8.4",
@@ -72,6 +72,7 @@
     "tailwindcss": "^3.4.3",
     "typescript": "^5.4.5",
     "unist-util-visit": "^5.0.0",
+    "update-notifier": "^7.3.1",
     "uuid": "^10.0.0"
   },
   "devDependencies": {
@@ -88,6 +89,7 @@
     "@types/react-dom": "^18.3.0",
     "@types/semver": "^7.5.8",
     "@types/shelljs": "^0.8.15",
+    "@types/update-notifier": "^6.0.8",
     "prettier": "^3.3.3",
     "prettier-plugin-astro": "^0.14.1",
     "tsup": "^8.1.0",