@eventcatalog/core 2.33.9 → 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.9";
+var version = "2.33.10";
 
 // src/constants.ts
 var VERSION = version;

package/dist/analytics/analytics.js

@@ -1,7 +1,7 @@
 import {
   raiseEvent
-} from "../chunk-LHX6OHFE.js";
-import "../chunk-OKSJ75RQ.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.9";
+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-LVSH6F2F.js";
-import "../chunk-LHX6OHFE.js";
-import "../chunk-OKSJ75RQ.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-OKSJ75RQ.js → chunk-KWYNYLOK.js}

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

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

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

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

@@ -1,6 +1,6 @@
 import {
   VERSION
-} from "./chunk-OKSJ75RQ.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.9";
+var version = "2.33.10";
 
 // src/constants.ts
 var VERSION = version;

package/dist/constants.js

@@ -1,6 +1,6 @@
 import {
   VERSION
-} from "./chunk-OKSJ75RQ.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.9";
+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-LVSH6F2F.js";
-import "./chunk-LHX6OHFE.js";
+} from "./chunk-L2RGENDX.js";
+import "./chunk-N7V2JS3E.js";
 import {
   catalogToAstro,
   checkAndConvertMdToMdx
 } from "./chunk-7SI5EVOX.js";
 import {
   VERSION
-} from "./chunk-OKSJ75RQ.js";
+} from "./chunk-KWYNYLOK.js";
 import {
   isBackstagePluginEnabled,
   isEventCatalogScaleEnabled,

package/eventcatalog/src/content.config.ts

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

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

@@ -6,7 +6,6 @@ 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
@@ -17,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'];
@@ -136,11 +139,13 @@ const pagefindAttributes =
       }
     : {};
 
-const isMarkedAsDeprecated = props.data.deprecated;
-const hasDeprecated = props.data.deprecated?.date && new Date(props.data.deprecated?.date) < new Date();
-const formattedDate = props.data.deprecated?.date
-  ? new Date(props.data.deprecated?.date).toLocaleDateString('en-US', { year: 'numeric', month: 'long', day: 'numeric' })
-  : '';
+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;
 ---
@@ -149,7 +154,7 @@ friendlyCollectionName = friendlyCollectionName === 'querie' ? 'query' : friendl
   <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"
@@ -160,16 +165,19 @@ friendlyCollectionName = friendlyCollectionName === 'querie' ? 'query' : friendl
             </h2>
             {
               isMarkedAsDeprecated && hasDeprecated && (
-                <Admonition type="alert" title={`This ${friendlyCollectionName} was deprecated on ${formattedDate}`}>
+                <Admonition
+                  className="w-full"
+                  type="alert"
+                  title={formattedDate ? `This ${friendlyCollectionName} was deprecated on ${formattedDate}` : `Deprecated`}
+                >
                   <div>
-                    {!props.data.deprecated?.message && (
+                    {!deprecatedMessage && (
                       <p>
-                        The {friendlyCollectionName} has been deprecated ({props.data.deprecated?.date}).
+                        The {friendlyCollectionName} has been marked as deprecated
+                        {formattedDate && ` on ${formattedDate}`}.
                       </p>
                     )}
-                    {props.data.deprecated?.message && (
-                      <div class="prose prose-sm max-w-none" set:html={marked.parse(props.data.deprecated?.message)} />
-                    )}
+                    {deprecatedMessage && <div class="prose prose-sm max-w-none" set:html={marked.parse(deprecatedMessage)} />}
                   </div>
                 </Admonition>
               )
@@ -178,14 +186,12 @@ friendlyCollectionName = friendlyCollectionName === 'querie' ? 'query' : friendl
               isMarkedAsDeprecated && !hasDeprecated && (
                 <Admonition type="warning" title={`This ${friendlyCollectionName} will be deprecated on ${formattedDate}`}>
                   <div>
-                    {!props.data.deprecated?.message && (
+                    {!deprecatedMessage && (
                       <p>
                         The {friendlyCollectionName} will be deprecated on {formattedDate}.
                       </p>
                     )}
-                    {props.data.deprecated?.message && (
-                      <div class="prose prose-sm max-w-none" set:html={marked.parse(props.data.deprecated?.message)} />
-                    )}
+                    {deprecatedMessage && <div class="prose prose-sm max-w-none" set:html={marked.parse(deprecatedMessage)} />}
                   </div>
                 </Admonition>
               )

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.9",
+  "version": "2.33.10",
   "publishConfig": {
     "access": "public"
   },