@eventcatalog/core 2.33.8 → 2.33.10

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

package/dist/analytics/analytics.js

@@ -1,7 +1,7 @@
 import {
   raiseEvent
-} from "../chunk-HPV7UK2I.js";
-import "../chunk-SSJWAEJA.js";
+} from "../chunk-N7V2JS3E.js";
+import "../chunk-KWYNYLOK.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.33.8";
+var version = "2.33.10";
 
 // src/constants.ts
 var VERSION = version;

package/dist/analytics/log-build.js

@@ -1,8 +1,8 @@
 import {
   log_build_default
-} from "../chunk-DCU5UE7Y.js";
-import "../chunk-HPV7UK2I.js";
-import "../chunk-SSJWAEJA.js";
+} from "../chunk-L2RGENDX.js";
+import "../chunk-N7V2JS3E.js";
+import "../chunk-KWYNYLOK.js";
 import "../chunk-E7TXTI7G.js";
 export {
   log_build_default as default

package/dist/{chunk-SSJWAEJA.js → chunk-KWYNYLOK.js}

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

package/dist/{chunk-DCU5UE7Y.js → chunk-L2RGENDX.js}

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

package/dist/{chunk-HPV7UK2I.js → chunk-N7V2JS3E.js}

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

package/dist/constants.cjs

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

package/dist/constants.js

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

package/dist/eventcatalog.cjs

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

package/dist/eventcatalog.js

@@ -6,15 +6,15 @@ import {
 } from "./chunk-UKJ7F5WR.js";
 import {
   log_build_default
-} from "./chunk-DCU5UE7Y.js";
-import "./chunk-HPV7UK2I.js";
+} from "./chunk-L2RGENDX.js";
+import "./chunk-N7V2JS3E.js";
 import {
   catalogToAstro,
   checkAndConvertMdToMdx
 } from "./chunk-7SI5EVOX.js";
 import {
   VERSION
-} from "./chunk-SSJWAEJA.js";
+} from "./chunk-KWYNYLOK.js";
 import {
   isBackstagePluginEnabled,
   isEventCatalogScaleEnabled,

package/eventcatalog/src/components/MDX/Admonition.tsx

@@ -1,33 +1,37 @@
-import { ExclamationTriangleIcon } from '@heroicons/react/20/solid';
-import { InformationCircleIcon } from '@heroicons/react/24/solid';
+import { InformationCircleIcon, ExclamationTriangleIcon } from '@heroicons/react/24/outline';
 
 const getConfigurationByType = (type: string) => {
   switch (type) {
+    case 'danger':
+      return { color: 'red', icon: ExclamationTriangleIcon, title: 'Danger' };
     case 'alert':
-      return { color: 'red', icon: ExclamationTriangleIcon };
+      return { color: 'red', icon: ExclamationTriangleIcon, title: 'Alert' };
     case 'warning':
-      return { color: 'yellow', icon: ExclamationTriangleIcon };
+      return { color: 'yellow', icon: ExclamationTriangleIcon, title: 'Warning' };
     default:
-      return { color: 'indigo', icon: InformationCircleIcon };
+      return { color: 'indigo', icon: InformationCircleIcon, title: 'Info' };
   }
 };
 
 interface AdmonitionProps {
-  children: JSX.Element;
+  children: React.ReactNode;
   type?: string;
   className?: string;
+  title?: string;
 }
 
-export default function Admonition({ children, type = 'info', className = '' }: AdmonitionProps) {
-  const { color, icon: Icon } = getConfigurationByType(type);
+export default function Admonition({ children, type = 'info', className = '', title }: AdmonitionProps) {
+  const config = getConfigurationByType(type);
+  const Icon = config.icon;
 
   return (
-    <div className={`bg-${color}-50 border-l-4 border-${color}-400 my-4 ${className}`}>
-      <div className="flex">
-        <div className="ml-3 py-2 text-sm flex items-center">
-          <Icon className={`block mr-2 h-7 w-7 text-${color}-400`} aria-hidden="true" />
-          <div>{children}</div>
+    <div className={`bg-${config.color}-50 border-l-4 border-${config.color}-500 p-4 my-4 ${className} rounded-md`}>
+      <div className="flex flex-col">
+        <div className="flex items-center">
+          <Icon className={`h-6 w-6 text-${config.color}-500 stroke-2`} aria-hidden="true" />
+          <h3 className={`ml-2 text-${config.color}-600 font-bold text-md`}>{title || config.title}</h3>
         </div>
+        <div className={`mt-2 text-${config.color}-700 text-md`}>{children}</div>
       </div>
     </div>
   );

package/eventcatalog/src/content.config.ts

@@ -115,6 +115,15 @@ const baseSchema = z.object({
         .optional(),
     })
     .optional(),
+  deprecated: z
+    .union([
+      z.object({
+        message: z.string().optional(),
+        date: z.date().optional(),
+      }),
+      z.boolean().optional(),
+    ])
+    .optional(),
   // Used by eventcatalog
   versions: z.array(z.string()).optional(),
   latestVersion: z.string().optional(),

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

@@ -1,10 +1,12 @@
 ---
 import VerticalSideBarLayout from '@layouts/VerticalSideBarLayout.astro';
 import Footer from '@layouts/Footer.astro';
+import { marked } from 'marked';
 
 import components from '@components/MDX/components';
 import NodeGraph from '@components/MDX/NodeGraph/NodeGraph.astro';
 import SchemaViewer from '@components/MDX/SchemaViewer/SchemaViewerRoot.astro';
+import Admonition from '@components/MDX/Admonition';
 
 // SideBars
 import ServiceSideBar from '@components/SideBars/ServiceSideBar.astro';
@@ -14,16 +16,20 @@ import ChannelSideBar from '@components/SideBars/ChannelSideBar.astro';
 import FlowSideBar from '@components/SideBars/FlowSideBar.astro';
 
 import { QueueListIcon, RectangleGroupIcon, ServerIcon, BoltIcon, ChatBubbleLeftIcon } from '@heroicons/react/24/outline';
+import { ArrowsRightLeftIcon } from '@heroicons/react/20/solid';
+
 import type { PageTypes } from '@types';
+import type { CollectionTypes } from '@types';
 
-import { buildUrl } from '@utils/url-builder';
-import { pageDataLoader } from '@utils/page-loaders/page-data-loader';
 import { ClientRouter } from 'astro:transitions';
 import { render } from 'astro:content';
-import { ArrowsRightLeftIcon } from '@heroicons/react/20/solid';
+import type { CollectionEntry } from 'astro:content';
 
-import config from '@config';
 import { getIcon } from '@utils/badges';
+import { getDeprecatedDetails } from '@utils/collections/util';
+import { pageDataLoader } from '@utils/page-loaders/page-data-loader';
+import { buildUrl } from '@utils/url-builder';
+import config from '@config';
 
 export async function getStaticPaths() {
   const itemTypes: PageTypes[] = ['events', 'commands', 'queries', 'services', 'domains', 'flows', 'channels'];
@@ -132,18 +138,65 @@ const pagefindAttributes =
         'data-pagefind-meta': `title:${pageTitle}`,
       }
     : {};
+
+const {
+  hasDeprecated,
+  message: deprecatedMessage,
+  isMarkedAsDeprecated,
+  deprecatedDate: formattedDate,
+} = getDeprecatedDetails(props as unknown as CollectionEntry<CollectionTypes>);
+
+let friendlyCollectionName = props.collection.slice(0, props.collection.length - 1);
+friendlyCollectionName = friendlyCollectionName === 'querie' ? 'query' : friendlyCollectionName;
 ---
 
 <VerticalSideBarLayout title={pageTitle} description={props.data.summary}>
   <main class="flex sm:px-8 docs-layout h-full" {...pagefindAttributes}>
     <div class="flex docs-layout w-full">
       <div class="w-full lg:mr-2 pr-8 overflow-y-auto py-8">
-        <div class="border-b border-gray-200 flex justify-between items-start md:pb-2">
+        <div class="border-b border-gray-200 md:pb-2">
           <div>
-            <h2 id="doc-page-header" class="text-2xl md:text-4xl font-bold text-black">
+            <h2
+              id="doc-page-header"
+              class={`text-2xl md:text-4xl font-bold text-black ${props.data.deprecated && hasDeprecated ? 'text-red-500' : ''}`}
+            >
               {props.data.name}
               <span class="">(v{props.data.version})</span>
             </h2>
+            {
+              isMarkedAsDeprecated && hasDeprecated && (
+                <Admonition
+                  className="w-full"
+                  type="alert"
+                  title={formattedDate ? `This ${friendlyCollectionName} was deprecated on ${formattedDate}` : `Deprecated`}
+                >
+                  <div>
+                    {!deprecatedMessage && (
+                      <p>
+                        The {friendlyCollectionName} has been marked as deprecated
+                        {formattedDate && ` on ${formattedDate}`}.
+                      </p>
+                    )}
+                    {deprecatedMessage && <div class="prose prose-sm max-w-none" set:html={marked.parse(deprecatedMessage)} />}
+                  </div>
+                </Admonition>
+              )
+            }
+            {
+              isMarkedAsDeprecated && !hasDeprecated && (
+                <Admonition type="warning" title={`This ${friendlyCollectionName} will be deprecated on ${formattedDate}`}>
+                  <div>
+                    {!deprecatedMessage && (
+                      <p>
+                        The {friendlyCollectionName} will be deprecated on {formattedDate}.
+                      </p>
+                    )}
+                    {deprecatedMessage && <div class="prose prose-sm max-w-none" set:html={marked.parse(deprecatedMessage)} />}
+                  </div>
+                </Admonition>
+              )
+            }
+
             <h2 class="text-lg pt-2 text-gray-500 font-light">{props.data.summary}</h2>
             {
               badges && (

package/eventcatalog/src/utils/collections/util.ts

@@ -109,3 +109,30 @@ export const resourceToCollectionMap = {
   user: 'users',
   team: 'teams',
 } as const;
+
+export const getDeprecatedDetails = (item: CollectionEntry<CollectionTypes>) => {
+  let options = {
+    isMarkedAsDeprecated: false,
+    hasDeprecated: false,
+    message: '',
+    deprecatedDate: '',
+  };
+
+  if (!item.data?.deprecated) return options;
+
+  if (typeof item.data.deprecated === 'boolean') {
+    options.hasDeprecated = item.data.deprecated;
+    options.isMarkedAsDeprecated = item.data.deprecated;
+  }
+
+  if (typeof item.data.deprecated === 'object') {
+    options.isMarkedAsDeprecated = true;
+    options.hasDeprecated = item.data.deprecated.date ? new Date(item.data.deprecated.date) < new Date() : false;
+    options.message = item.data.deprecated.message ?? '';
+    options.deprecatedDate = item.data.deprecated.date
+      ? new Date(item.data.deprecated.date).toLocaleDateString('en-US', { year: 'numeric', month: 'long', day: 'numeric' })
+      : '';
+  }
+
+  return options;
+};

package/package.json

@@ -6,7 +6,7 @@
     "url": "https://github.com/event-catalog/eventcatalog.git"
   },
   "type": "module",
-  "version": "2.33.8",
+  "version": "2.33.10",
   "publishConfig": {
     "access": "public"
   },