@eventcatalog/core 3.39.4 → 3.39.6

package/eventcatalog/src/pages/docs/[type]/[id]/[version]/index.astro

@@ -15,6 +15,7 @@ import Admonition from '@components/MDX/Admonition';
 import VersionList from '@components/Lists/VersionList.astro';
 import CopyAsMarkdown from '@components/CopyAsMarkdown';
 import FavoriteButton from '@components/FavoriteButton';
+import Badge from '@components/Badge.astro';
 import { shouldRenderSideBarSection } from '@stores/sidebar-store/builders/shared';
 
 import {
@@ -34,7 +35,6 @@ import { getSpecificationsForService } from '@utils/collections/services';
 import { resourceToCollectionMap, collectionToResourceMap, getDeprecatedDetails } from '@utils/collections/util';
 import { getSchemasFromResource } from '@utils/collections/schemas';
 import { getIcon } from '@utils/badges';
-import { getBadgeStyle } from '@utils/badge-styles';
 import { buildUrl, buildEditUrlForResource } from '@utils/url-builder';
 import { isIconPath, resolveIconUrl } from '@utils/icon';
 import {
@@ -377,23 +377,7 @@ if (!hasCurrentFlowEmbed && !hasCurrentPageNodeGraph) {
               badges && (
                 <div class="flex flex-wrap gap-3 pt-6 pb-2">
                   {badges.map((badge: any) => {
-                    return (
-                      <span
-                        id={badge.id || ''}
-                        class={`
-                          inline-flex items-center gap-2 px-3 py-1.5 rounded-lg text-sm font-medium
-                          ${badge.backgroundColor ? 'bg-[rgb(var(--ec-content-hover))]' : 'bg-transparent'} border border-[rgb(var(--ec-page-border))]
-                          text-[rgb(var(--ec-page-text))]
-                          shadow-xs
-                          ${badge.class ? badge.class : ''}
-                        `}
-                        style={getBadgeStyle(badge)}
-                      >
-                        {badge.icon && <badge.icon className="w-4 h-4 flex-shrink-0" />}
-                        {badge.iconURL && <img src={badge.iconURL} class="w-4 h-4 flex-shrink-0 opacity-80" alt="" />}
-                        <span>{badge.content}</span>
-                      </span>
-                    );
+                    return <Badge badge={badge} />;
                   })}
                 </div>
               )

package/eventcatalog/src/pages/docs/[type]/[id]/language/[dictionaryId]/index.astro

@@ -1,5 +1,6 @@
 ---
 import RectangleGroupIcon from '@heroicons/react/24/outline/RectangleGroupIcon';
+import Badge from '@components/Badge.astro';
 import Footer from '@layouts/Footer.astro';
 import VerticalSideBarLayout from '@layouts/VerticalSideBarLayout.astro';
 import { buildUrl } from '@utils/url-builder';
@@ -80,17 +81,7 @@ const badges = [
               badges && badges.length > 0 && (
                 <div class="flex flex-wrap gap-3 py-4">
                   {badges.map((badge: any) => {
-                    return (
-                      <span
-                        class="inline-flex items-center gap-2 px-3 py-1.5 rounded-lg text-sm font-medium
-                          bg-[rgb(var(--ec-content-hover))] border border-[rgb(var(--ec-page-border))]
-                          text-[rgb(var(--ec-page-text))] shadow-xs"
-                      >
-                        {badge.icon && <badge.icon className="w-4 h-4 flex-shrink-0 text-[rgb(var(--ec-icon-color))]" />}
-                        {badge.iconURL && <img src={badge.iconURL} class="w-4 h-4 flex-shrink-0 opacity-80" alt="" />}
-                        <span>{badge.content}</span>
-                      </span>
-                    );
+                    return <Badge badge={badge} />;
                   })}
                 </div>
               )

package/eventcatalog/src/utils/badge-styles.ts

@@ -1,8 +1,23 @@
+import { buildUrl } from './url-builder';
+
 type BadgeColorKind = 'background' | 'text';
 
 type Badge = {
   backgroundColor?: string;
   textColor?: string;
+  url?: string;
+};
+
+const URL_SCHEME_PATTERN = /^[a-z][a-z\d+\-.]*:/i;
+const PROTOCOL_RELATIVE_URL_PATTERN = /^\/\//;
+const SAFE_BADGE_URL_SCHEMES = new Set(['http:', 'https:', 'mailto:', 'tel:']);
+
+const isAlreadyBasePrefixed = (url: string) => {
+  const baseUrl = import.meta.env.BASE_URL;
+  if (!baseUrl || baseUrl === '/') return false;
+
+  const normalizedBaseUrl = baseUrl.endsWith('/') ? baseUrl.slice(0, -1) : baseUrl;
+  return url === normalizedBaseUrl || url.startsWith(`${normalizedBaseUrl}/`);
 };
 
 const NAMED_BADGE_COLOR_KEYS = new Set([
@@ -204,3 +219,19 @@ export const getBadgeReactStyle = (badge: Badge) => {
     ...(color ? { color } : {}),
   };
 };
+
+export const getBadgeHref = (badge: Badge) => {
+  if (!badge.url) return undefined;
+
+  const url = badge.url.trim();
+  if (!url) return undefined;
+  if (url.startsWith('#') || url.startsWith('?') || PROTOCOL_RELATIVE_URL_PATTERN.test(url)) return url;
+
+  const scheme = URL_SCHEME_PATTERN.exec(url)?.[0].toLowerCase();
+  if (scheme) return SAFE_BADGE_URL_SCHEMES.has(scheme) ? url : undefined;
+
+  if (isAlreadyBasePrefixed(url)) return url;
+  if (url.startsWith('/')) return buildUrl(url);
+
+  return url;
+};

package/eventcatalog/src/utils/sidebar-visibility.ts

@@ -0,0 +1,41 @@
+export type SidebarVisibilityConfig = {
+  id: string;
+  visible: boolean;
+};
+
+export type SidebarConfigurableItem = {
+  id: string;
+  aliases?: string[];
+  visible?: boolean;
+};
+
+const getVisibilityOption = <T extends SidebarConfigurableItem>(
+  item: T,
+  configuration: SidebarVisibilityConfig[]
+): SidebarVisibilityConfig | undefined => {
+  const exactMatch = configuration.find((option) => option.id === item.id);
+
+  if (exactMatch) {
+    return exactMatch;
+  }
+
+  return configuration.find((option) => item.aliases?.includes(option.id));
+};
+
+export const isSidebarItemVisible = <T extends SidebarConfigurableItem>(
+  item: T,
+  configuration: SidebarVisibilityConfig[] = []
+): boolean => {
+  const visibilityOption = getVisibilityOption(item, configuration);
+
+  if (visibilityOption) {
+    return visibilityOption.visible;
+  }
+
+  return item.visible ?? true;
+};
+
+export const filterSidebarItems = <T extends SidebarConfigurableItem>(
+  items: T[],
+  configuration: SidebarVisibilityConfig[] = []
+): T[] => items.filter((item) => isSidebarItemVisible(item, configuration));

package/package.json

@@ -7,7 +7,7 @@
   },
   "license": "SEE LICENSE IN LICENSE",
   "type": "module",
-  "version": "3.39.4",
+  "version": "3.39.6",
   "publishConfig": {
     "access": "public"
   },
@@ -106,9 +106,9 @@
     "update-notifier": "^7.3.1",
     "uuid": "^10.0.0",
     "zod": "^4.3.6",
-    "@eventcatalog/sdk": "2.21.1",
-    "@eventcatalog/visualiser": "^3.21.0",
-    "@eventcatalog/linter": "1.0.23"
+    "@eventcatalog/sdk": "2.21.2",
+    "@eventcatalog/linter": "1.0.24",
+    "@eventcatalog/visualiser": "^3.21.0"
   },
   "devDependencies": {
     "@astrojs/check": "^0.9.9",