@eventcatalog/core 2.20.2 → 2.21.0

package/eventcatalog/src/components/SideBars/MessageSideBar.astro

@@ -6,9 +6,10 @@ import type { CollectionMessageTypes } from '@types';
 import * as path from 'path';
 import VersionList from '@components/Lists/VersionList.astro';
 import { buildUrl } from '@utils/url-builder';
-import { FileDownIcon, ScrollText, Workflow } from 'lucide-react';
+import { FileDownIcon, ScrollText, Workflow, RssIcon } from 'lucide-react';
 import RepositoryList from '@components/Lists/RepositoryList.astro';
 import { getOwner } from '@utils/collections/owners';
+import config from '@config';
 
 interface Props {
   message: CollectionEntry<CollectionMessageTypes>;
@@ -86,6 +87,8 @@ const getConsumerEmptyMessage = (type: string) => {
 
 const type = getType(message.collection);
 
+const isRSSEnabled = config.rss?.enabled;
+
 // @ts-ignore
 const publicPath = message?.catalog?.publicPath;
 const schemaFilePath = message?.data?.schemaPath;
@@ -145,6 +148,22 @@ const schemaURL = path.join(publicPath, schemaFilePath || '');
       )
     }
 
+    {
+      isRSSEnabled && (
+        <div class="mx-auto pb-8 w-full max-w-lg divide-y divide-white/5 rounded-xl bg-white/5">
+          <span class="text-sm text-black group-data-[hover]:text-black/80 capitalize">{type} RSS Feed</span>
+          <ul role="list" class="space-y-2 mt-2">
+            <li class="has-tooltip rounded-md text-gray-600 group px-1 w-full hover:bg-gradient-to-l hover:from-purple-500 hover:to-purple-700 hover:text-white hover:font-normal  ">
+              <a class={`flex items-center space-x-2`} target="_blank" href={buildUrl(`/rss/${message.collection}/rss.xml`)}>
+                <RssIcon className="h-4 w-4 text-gray-800 group-hover:text-white" strokeWidth={1} />
+                <span class="font-light text-sm truncate">RSS Feed</span>
+              </a>
+            </li>
+          </ul>
+        </div>
+      )
+    }
+
     <div class="space-y-2">
       {
         message?.data?.schemaPath && (

package/eventcatalog/src/components/SideBars/ServiceSideBar.astro

@@ -7,8 +7,9 @@ import VersionList from '@components/Lists/VersionList.astro';
 import { buildUrl } from '@utils/url-builder';
 import { getOwner } from '@utils/collections/owners';
 import type { CollectionEntry } from 'astro:content';
-import { ScrollText, Workflow, FileDownIcon, Code, Link } from 'lucide-react';
+import { ScrollText, Workflow, FileDownIcon, Code, Link, RssIcon } from 'lucide-react';
 import { join } from 'node:path';
+import config from '@config';
 
 interface Props {
   service: CollectionEntry<'services'>;
@@ -50,6 +51,8 @@ const ownersList = filteredOwners.map((o) => ({
   href: buildUrl(`/docs/${o.collection}/${o.data.id}`),
 }));
 
+const isRSSEnabled = config.rss?.enabled;
+
 // @ts-ignore
 const publicPath = service?.catalog?.publicPath;
 const schemaFilePath = service?.data?.schemaPath;
@@ -89,6 +92,22 @@ const schemaURL = join(publicPath, schemaFilePath || '');
       )
     }
 
+    {
+      isRSSEnabled && (
+        <div class="mx-auto pb-8 w-full max-w-lg divide-y divide-white/5 rounded-xl bg-white/5">
+          <span class="text-sm text-black group-data-[hover]:text-black/80 capitalize">Services RSS Feed</span>
+          <ul role="list" class="space-y-2 mt-2">
+            <li class="has-tooltip rounded-md text-gray-600 group px-1 w-full hover:bg-gradient-to-l hover:from-purple-500 hover:to-purple-700 hover:text-white hover:font-normal  ">
+              <a class={`flex items-center space-x-2`} target="_blank" href={buildUrl(`/rss/services/rss.xml`)}>
+                <RssIcon className="h-4 w-4 text-gray-800 group-hover:text-white" strokeWidth={1} />
+                <span class="font-light text-sm truncate">RSS</span>
+              </a>
+            </li>
+          </ul>
+        </div>
+      )
+    }
+
     <div class="space-y-2">
       {
         service?.data?.schemaPath && (

package/eventcatalog/src/pages/rss/[resource]/rss.xml.js

@@ -0,0 +1,79 @@
+import rss from '@astrojs/rss';
+import { getCollection } from 'astro:content';
+import { statSync } from 'fs';
+import { buildUrl } from '@utils/url-builder';
+import config from '@config';
+
+const isRSSEnabled = config.rss?.enabled;
+const rssLimit = config.rss?.limit || 15;
+
+const collections = ['events', 'services', 'domains', 'commands', 'flows', 'all'];
+
+export function getStaticPaths() {
+  return collections.map((collection) => ({
+    params: { resource: collection },
+  }));
+}
+
+export async function GET(context) {
+  if (!isRSSEnabled) {
+    return new Response('RSS is not enabled for this EventCatalog.', { status: 404 });
+  }
+
+  const collection = context.params.resource;
+  let items = [];
+
+  if (collection === 'all') {
+    const events = await getCollection('events');
+    const services = await getCollection('services');
+    const domains = await getCollection('domains');
+    const commands = await getCollection('commands');
+    const flows = await getCollection('flows');
+    items = [...events, ...services, ...domains, ...commands, ...flows];
+  } else {
+    items = await getCollection(collection);
+  }
+
+  // console.log(events);
+
+  const rssItems = items
+    .map((event) => {
+      const pathToFile = event.data.pathToFile;
+
+      // Get file stats to access modified date
+      const stats = statSync(pathToFile);
+      return {
+        ...event,
+        modifiedDate: stats.mtime,
+      };
+    })
+    .sort((a, b) => b.modifiedDate - a.modifiedDate) // Sort in descending order (newest first)
+    .slice(0, rssLimit); // Only take the first 10 items
+
+  return rss({
+    // `<title>` field in output xml
+    title:
+      collection === 'all'
+        ? 'Documented resources in EventCatalog'
+        : `${collection.charAt(0).toUpperCase() + collection.slice(1)}`,
+    stylesheet: '/rss.xsl',
+    // `<description>` field in output xml
+    description: collection === 'all' ? 'Documented resources in EventCatalog' : `Documented ${collection} in EventCatalog`,
+    // Pull in your project "site" from the endpoint context
+    // https://docs.astro.build/en/reference/api-reference/#site
+    site: context.site,
+    // Array of `<item>`s in output xml
+    // See "Generating items" section for examples using content collections and glob imports
+    items: rssItems.map((event) => ({
+      title: event.data.name,
+      link: buildUrl(`/docs/${collection}/${event.data.id}/${event.data.version}`),
+      pubDate: event.modifiedDate,
+      description: event.data.summary,
+      // Optional: Include modified date in the RSS feed
+      lastBuildDate: items.find((item) => item.id === event.id)?.modifiedDate,
+      // categories: event.data.badges,
+    })),
+    // (optional) inject custom xml
+    customData: `<language>en-us</language>`,
+  });
+}

package/package.json

@@ -6,7 +6,7 @@
     "url": "https://github.com/event-catalog/eventcatalog.git"
   },
   "type": "module",
-  "version": "2.20.2",
+  "version": "2.21.0",
   "publishConfig": {
     "access": "public"
   },
@@ -21,10 +21,11 @@
     "default-files-for-collections/"
   ],
   "dependencies": {
-    "@astrojs/markdown-remark": "^6.0.1",
-    "@astrojs/mdx": "^4.0.5",
-    "@astrojs/react": "^4.1.3",
-    "@astrojs/tailwind": "^5.1.4",
+    "@astrojs/markdown-remark": "^6.1.0",
+    "@astrojs/mdx": "^4.0.8",
+    "@astrojs/react": "^4.2.0",
+    "@astrojs/rss": "^4.0.11",
+    "@astrojs/tailwind": "^6.0.0",
     "@asyncapi/avro-schema-parser": "^3.0.24",
     "@asyncapi/parser": "^3.4.0",
     "@asyncapi/react-component": "^2.4.3",
@@ -36,7 +37,7 @@
     "@tailwindcss/typography": "^0.5.13",
     "@tanstack/react-table": "^8.17.3",
     "@xyflow/react": "^12.3.6",
-    "astro": "^5.1.5",
+    "astro": "^5.2.5",
     "astro-expressive-code": "^0.40.1",
     "astro-pagefind": "^1.6.0",
     "astro-seo": "^0.8.4",