@eventcatalog/core 2.22.0 → 2.23.1

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.22.0";
+var version = "2.23.1";
 
 // src/constants.ts
 var VERSION = version;

package/dist/analytics/analytics.js

@@ -1,7 +1,7 @@
 import {
   raiseEvent
-} from "../chunk-6HZQETSS.js";
-import "../chunk-NQSIMY3C.js";
+} from "../chunk-GGTLXJHB.js";
+import "../chunk-MUBFMCSR.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.22.0";
+var version = "2.23.1";
 
 // src/constants.ts
 var VERSION = version;

package/dist/analytics/log-build.js

@@ -1,8 +1,8 @@
 import {
   log_build_default
-} from "../chunk-O3MRQUYC.js";
-import "../chunk-6HZQETSS.js";
-import "../chunk-NQSIMY3C.js";
+} from "../chunk-I76AB6JV.js";
+import "../chunk-GGTLXJHB.js";
+import "../chunk-MUBFMCSR.js";
 import "../chunk-E7TXTI7G.js";
 export {
   log_build_default as default

package/dist/{chunk-6HZQETSS.js → chunk-GGTLXJHB.js}

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

package/dist/{chunk-O3MRQUYC.js → chunk-I76AB6JV.js}

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

package/dist/{chunk-NQSIMY3C.js → chunk-MUBFMCSR.js}

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

package/dist/constants.cjs

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

package/dist/constants.js

@@ -1,6 +1,6 @@
 import {
   VERSION
-} from "./chunk-NQSIMY3C.js";
+} from "./chunk-MUBFMCSR.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.22.0";
+var version = "2.23.1";
 
 // 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.config.d.cts

@@ -33,6 +33,10 @@ interface Config {
     mdxOptimize?: boolean;
     docs: {
         sidebar: {
+            /**
+             * @default 'FLAT_VIEW'
+             */
+            type?: 'FLAT_VIEW' | 'TREE_VIEW';
             showPageHeadings: true;
             services?: SideBarConfig;
             messages?: SideBarConfig;

package/dist/eventcatalog.config.d.ts

@@ -33,6 +33,10 @@ interface Config {
     mdxOptimize?: boolean;
     docs: {
         sidebar: {
+            /**
+             * @default 'FLAT_VIEW'
+             */
+            type?: 'FLAT_VIEW' | 'TREE_VIEW';
             showPageHeadings: true;
             services?: SideBarConfig;
             messages?: SideBarConfig;

package/dist/eventcatalog.js

@@ -6,14 +6,14 @@ import {
 } from "./chunk-OW2FQPYP.js";
 import {
   log_build_default
-} from "./chunk-O3MRQUYC.js";
-import "./chunk-6HZQETSS.js";
+} from "./chunk-I76AB6JV.js";
+import "./chunk-GGTLXJHB.js";
 import {
   catalogToAstro
 } from "./chunk-CXKIF3EI.js";
 import {
   VERSION
-} from "./chunk-NQSIMY3C.js";
+} from "./chunk-MUBFMCSR.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/SideNav/CatalogResourcesSideBar/getCatalogResources.ts

@@ -0,0 +1,65 @@
+import { isCollectionVisibleInCatalog } from '@eventcatalog';
+import { buildUrl } from '@utils/url-builder';
+import { getChannels } from '@utils/channels';
+import { getDomains } from '@utils/collections/domains';
+import { getFlows } from '@utils/collections/flows';
+import { getServices } from '@utils/collections/services';
+import { getCommands } from '@utils/commands';
+import { getEvents } from '@utils/events';
+import { getQueries } from '@utils/queries';
+import { getTeams } from '@utils/teams';
+import { getUsers } from '@utils/users';
+
+export async function getCatalogResources({ currentPath }: { currentPath: string }) {
+  const events = await getEvents({ getAllVersions: false });
+  const commands = await getCommands({ getAllVersions: false });
+  const queries = await getQueries({ getAllVersions: false });
+  const services = await getServices({ getAllVersions: false });
+  const domains = await getDomains({ getAllVersions: false });
+  const channels = await getChannels({ getAllVersions: false });
+  const flows = await getFlows({ getAllVersions: false });
+
+  const messages = [...events, ...commands, ...queries];
+
+  // @ts-ignore for large catalogs https://github.com/event-catalog/eventcatalog/issues/552
+  const allData = [...domains, ...services, ...messages, ...channels, ...flows];
+
+  const allDataAsSideNav = allData.reduce((acc, item) => {
+    const title = item.collection;
+    const group = acc[title] || [];
+    const route = currentPath.includes('visualiser') ? 'visualiser' : 'docs';
+
+    const navigationItem = {
+      label: item.data.name,
+      version: item.data.version,
+      // items: item.collection === 'users' ? [] : item.headings,
+      visible: isCollectionVisibleInCatalog(item.collection),
+      // @ts-ignore
+      href: item.data.version
+        ? // @ts-ignore
+          buildUrl(`/${route}/${item.collection}/${item.data.id}/${item.data.version}`)
+        : buildUrl(`/${route}/${item.collection}/${item.data.id}`),
+      collection: item.collection,
+    };
+
+    group.push(navigationItem);
+
+    return {
+      ...acc,
+      [title]: group,
+    };
+  }, {} as any);
+
+  const sideNav = {
+    ...(currentPath.includes('visualiser')
+      ? {
+          'bounded context map': [
+            { label: 'Domain map', href: buildUrl('/visualiser/context-map'), collection: 'bounded-context-map' },
+          ],
+        }
+      : {}),
+    ...allDataAsSideNav,
+  };
+
+  return sideNav;
+}

package/eventcatalog/src/components/{SideBars → SideNav}/CatalogResourcesSideBar/index.tsx

@@ -75,7 +75,7 @@ const CatalogResourcesSideBar: React.FC<CatalogResourcesSideBarProps> = ({ resou
   if (!isInitialized) return null;
 
   return (
-    <nav className="space-y-6 text-black ">
+    <nav className="space-y-6 text-black px-5 py-4 ">
       <div className="space-y-2">
         <div className="mb-4 px-1">
           <input

package/eventcatalog/src/components/SideNav/SideNav.astro

@@ -0,0 +1,31 @@
+---
+import type { HTMLAttributes } from 'astro/types';
+import config from '@config';
+
+// FlatView
+import CatalogResourcesSideBar from './CatalogResourcesSideBar';
+import { getCatalogResources } from './CatalogResourcesSideBar/getCatalogResources';
+
+// TreeView
+import { SideNavTreeView } from './TreeView';
+import { getTreeView } from './TreeView/getTreeView';
+
+interface Props extends Omit<HTMLAttributes<'div'>, 'children'> {}
+
+const currentPath = Astro.url.pathname;
+
+let props;
+
+const SIDENAV_TYPE = config?.docs?.sidebar?.type ?? 'FLAT_VIEW';
+
+if (SIDENAV_TYPE === 'FLAT_VIEW') {
+  props = await getCatalogResources({ currentPath });
+} else if (SIDENAV_TYPE === 'TREE_VIEW') {
+  props = getTreeView({ projectDir: process.env.PROJECT_DIR!, currentPath });
+}
+---
+
+<div {...Astro.props}>
+  {SIDENAV_TYPE === 'FLAT_VIEW' && <CatalogResourcesSideBar resources={props} currentPath={currentPath} client:load />}
+  {SIDENAV_TYPE === 'TREE_VIEW' && <SideNavTreeView client:only transition:persist tree={props} />}
+</div>