@eventcatalog/core 2.49.3 → 2.49.5

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

package/dist/analytics/analytics.js

@@ -1,7 +1,7 @@
 import {
   raiseEvent
-} from "../chunk-DRNVNFGC.js";
-import "../chunk-L6MICE4M.js";
+} from "../chunk-SRWBNIXA.js";
+import "../chunk-XHCERMFT.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.49.3";
+var version = "2.49.5";
 
 // src/constants.ts
 var VERSION = version;

package/dist/analytics/log-build.js

@@ -1,8 +1,8 @@
 import {
   log_build_default
-} from "../chunk-QXSGLYMA.js";
-import "../chunk-DRNVNFGC.js";
-import "../chunk-L6MICE4M.js";
+} from "../chunk-BUPT4PSW.js";
+import "../chunk-SRWBNIXA.js";
+import "../chunk-XHCERMFT.js";
 import "../chunk-E7TXTI7G.js";
 export {
   log_build_default as default

package/dist/{chunk-QXSGLYMA.js → chunk-BUPT4PSW.js}

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

package/dist/{chunk-DRNVNFGC.js → chunk-SRWBNIXA.js}

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

package/dist/{chunk-L6MICE4M.js → chunk-XHCERMFT.js}

@@ -1,5 +1,5 @@
 // package.json
-var version = "2.49.3";
+var version = "2.49.5";
 
 // 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.49.3";
+var version = "2.49.5";
 
 // src/constants.ts
 var VERSION = version;

package/dist/constants.js

@@ -1,6 +1,6 @@
 import {
   VERSION
-} from "./chunk-L6MICE4M.js";
+} from "./chunk-XHCERMFT.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.49.3";
+var version = "2.49.5";
 
 // src/constants.ts
 var VERSION = version;

package/dist/eventcatalog.js

@@ -6,8 +6,8 @@ import {
 } from "./chunk-XE6PFSH5.js";
 import {
   log_build_default
-} from "./chunk-QXSGLYMA.js";
-import "./chunk-DRNVNFGC.js";
+} from "./chunk-BUPT4PSW.js";
+import "./chunk-SRWBNIXA.js";
 import {
   catalogToAstro,
   checkAndConvertMdToMdx
@@ -15,7 +15,7 @@ import {
 import "./chunk-LDBRNJIL.js";
 import {
   VERSION
-} from "./chunk-L6MICE4M.js";
+} from "./chunk-XHCERMFT.js";
 import {
   isAuthEnabled,
   isBackstagePluginEnabled,

package/eventcatalog/src/components/CopyAsMarkdown.tsx

@@ -1,6 +1,5 @@
-import { Button } from '@headlessui/react';
 import * as DropdownMenu from '@radix-ui/react-dropdown-menu';
-import { Copy, FileText, MessageCircleQuestion, ChevronDownIcon, ExternalLink } from 'lucide-react';
+import { Copy, FileText, MessageCircleQuestion, ChevronDownIcon, ExternalLink, PenSquareIcon } from 'lucide-react';
 import React, { useState, isValidElement } from 'react';
 import type { Schema } from '@utils/collections/schemas';
 import { buildUrl } from '@utils/url-builder';
@@ -47,10 +46,12 @@ export function CopyPageMenu({
   schemas,
   chatQuery,
   chatEnabled = false,
+  editUrl,
 }: {
   schemas: Schema[];
   chatQuery?: string;
   chatEnabled: boolean;
+  editUrl: string;
 }) {
   const [buttonText, setButtonText] = useState('Copy page');
 
@@ -136,6 +137,20 @@ export function CopyPageMenu({
           <MenuItemContent icon={Copy} title="Copy page" description="Copy page as Markdown for LLMs" />
         </DropdownMenu.Item>
 
+        {editUrl && (
+          <DropdownMenu.Item
+            className="cursor-pointer hover:bg-gray-100 focus:outline-none focus:bg-gray-100"
+            onSelect={() => window.open(editUrl, '_blank')}
+          >
+            <MenuItemContent
+              icon={PenSquareIcon}
+              title="Edit page"
+              description="Edit the contents of this page"
+              external={true}
+            />
+          </DropdownMenu.Item>
+        )}
+
         {schemas.map((schema) => {
           const title =
             schema.format === 'asyncapi'
@@ -166,6 +181,7 @@ export function CopyPageMenu({
             </DropdownMenu.Item>
           );
         })}
+
         <DropdownMenu.Item
           className="cursor-pointer hover:bg-gray-100 focus:outline-none focus:bg-gray-100"
           onSelect={() => window.open(markdownUrl, '_blank')}

package/eventcatalog/src/content.config.ts

@@ -105,6 +105,7 @@ const baseSchema = z.object({
     ])
     .optional(),
   hidden: z.boolean().optional(),
+  editUrl: z.string().optional(),
   resourceGroups: z
     .array(
       z.object({

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

@@ -30,7 +30,7 @@ import {
   MagnifyingGlassIcon,
 } from '@heroicons/react/24/outline';
 import { ArrowsRightLeftIcon } from '@heroicons/react/20/solid';
-import { Box, Boxes } from 'lucide-react';
+import { Box, Boxes, SquarePenIcon } from 'lucide-react';
 import type { CollectionTypes } from '@types';
 
 import { render } from 'astro:content';
@@ -38,7 +38,7 @@ import type { CollectionEntry } from 'astro:content';
 
 import { getIcon } from '@utils/badges';
 import { getDeprecatedDetails } from '@utils/collections/util';
-import { buildUrl } from '@utils/url-builder';
+import { buildUrl, buildEditUrlForResource } from '@utils/url-builder';
 import { getSchemasFromResource } from '@utils/collections/schemas';
 import { isEventCatalogChatEnabled, isMarkdownDownloadEnabled } from '@utils/feature';
 
@@ -57,6 +57,8 @@ const { Content } = await render(props);
 
 const pageTitle = `${props.collection} | ${props.data.name}`.replace(/^\w/, (c) => c.toUpperCase());
 const contentBadges = props.data.badges || [];
+const editUrl =
+  props.data.editUrl || (config.editUrl && props?.filePath ? buildEditUrlForResource(config.editUrl, props?.filePath) : '');
 
 const getContentBadges = () =>
   contentBadges.map((badge: any) => ({
@@ -218,6 +220,7 @@ nodeGraphs.push({
                       schemas={schemasForResource}
                       chatQuery={generatePromptForResource(props)}
                       chatEnabled={isEventCatalogChatEnabled()}
+                      editUrl={editUrl}
                     />
                   </div>
                 )
@@ -362,6 +365,20 @@ nodeGraphs.push({
           }
         </div>
         <Footer />
+        <!-- Add edit this page button  with icon and text-->
+        <div class="flex justify-end">
+          <!-- Built with EventCatalog -->
+          {
+            editUrl && (
+              <div class="flex justify-end">
+                <a href={editUrl} class="text-sm text-gray-700 hover:text-gray-700 border border-gray-200 rounded-md p-2">
+                  <SquarePenIcon className="w-4 h-4 inline-block mr-1" />
+                  Edit this page
+                </a>
+              </div>
+            )
+          }
+        </div>
       </div>
       <aside class="hidden lg:block sticky top-0 pb-10 w-96 overflow-y-auto py-2" data-pagefind-ignore>
         <!-- @ts-ignore -->

package/eventcatalog/src/pages/docs/[type]/[id]/language/[dictionaryId]/_index.data.ts

@@ -0,0 +1,83 @@
+import { getUbiquitousLanguage } from '@utils/collections/domains';
+import { getDomains } from '@utils/collections/domains';
+import { isSSR } from '@utils/feature';
+import { HybridPage } from '@utils/page-loaders/hybrid-page';
+
+export class Page extends HybridPage {
+  static async getStaticPaths() {
+    if (isSSR()) {
+      return [];
+    }
+
+    const domains = await getDomains({ getAllVersions: false });
+
+    const pages = await domains.reduce<Promise<any[]>>(async (acc, domain) => {
+      const accumulator = await acc;
+      const ubiquitousLanguages = await getUbiquitousLanguage(domain);
+
+      if (ubiquitousLanguages.length === 0) {
+        return accumulator;
+      }
+
+      const dictionary = ubiquitousLanguages[0].data.dictionary;
+
+      if (!dictionary) {
+        return accumulator;
+      }
+
+      return [
+        ...accumulator,
+        ...dictionary.map((item) => ({
+          params: {
+            type: domain.collection,
+            id: domain.data.id,
+            dictionaryId: item.id,
+          },
+          props: {
+            type: domain.collection,
+            domainId: domain.data.id,
+            domain: domain.data,
+            ubiquitousLanguage: item,
+            ...item,
+          },
+        })),
+      ];
+    }, Promise.resolve([]));
+
+    return pages;
+  }
+
+  protected static async fetchData(params: any) {
+    const { getDomains } = await import('@utils/collections/domains');
+    const domains = await getDomains({ getAllVersions: false });
+
+    const domain = domains.find((d) => d.data.id === params.id && d.collection === params.type);
+    if (!domain) return null;
+
+    const ubiquitousLanguages = await getUbiquitousLanguage(domain);
+    if (ubiquitousLanguages.length === 0) return null;
+
+    // Find the ubiquitous language that contains our dictionary item
+    const ubiquitousLanguage = ubiquitousLanguages.find((l) => l.data.dictionary?.some((d) => d.id === params.dictionaryId));
+    if (!ubiquitousLanguage) return null;
+
+    // Find the specific dictionary item
+    const item = ubiquitousLanguage.data.dictionary?.find((d) => d.id === params.dictionaryId);
+    if (!item) return null;
+
+    return {
+      type: domain.collection,
+      domainId: domain.data.id,
+      domain: domain.data,
+      ubiquitousLanguage: item,
+      ...item,
+    };
+  }
+
+  protected static createNotFoundResponse(): Response {
+    return new Response(null, {
+      status: 404,
+      statusText: 'Domain not found',
+    });
+  }
+}

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

@@ -2,51 +2,17 @@
 import RectangleGroupIcon from '@heroicons/react/24/outline/RectangleGroupIcon';
 import Footer from '@layouts/Footer.astro';
 import VerticalSideBarLayout from '@layouts/VerticalSideBarLayout.astro';
-import { getDomains, getUbiquitousLanguage } from '@utils/collections/domains';
 import { buildUrl } from '@utils/url-builder';
 import { ClientRouter } from 'astro:transitions';
 import { marked } from 'marked';
 
-export async function getStaticPaths() {
-  const domains = await getDomains({ getAllVersions: false });
+import { Page } from './_index.data';
 
-  const pages = await domains.reduce<Promise<any[]>>(async (acc, domain) => {
-    const accumulator = await acc;
-    const ubiquitousLanguages = await getUbiquitousLanguage(domain);
+export const prerender = Page.prerender;
+export const getStaticPaths = Page.getStaticPaths;
 
-    if (ubiquitousLanguages.length === 0) {
-      return accumulator;
-    }
-
-    const dictionary = ubiquitousLanguages[0].data.dictionary;
-
-    if (!dictionary) {
-      return accumulator;
-    }
+const props = await Page.getData(Astro);
 
-    return [
-      ...accumulator,
-      ...dictionary.map((item) => ({
-        params: {
-          type: domain.collection,
-          id: domain.data.id,
-          dictionaryId: item.id,
-        },
-        props: {
-          type: domain.collection,
-          domainId: domain.data.id,
-          domain: domain.data,
-          ubiquitousLanguage: item,
-          ...item,
-        },
-      })),
-    ];
-  }, Promise.resolve([]));
-
-  return pages;
-}
-
-const props = Astro.props;
 const { ubiquitousLanguage } = props;
 const pageTitle = `${props.type} | ${ubiquitousLanguage.name}`.replace(/^\w/, (c) => c.toUpperCase());
 
@@ -89,7 +55,7 @@ const badges = [
                 >
                   <path stroke-linecap="round" stroke-linejoin="round" d="M10.5 19.5L3 12m0 0l7.5-7.5M3 12h18"></path>
                 </svg>
-                Back to ubiquitous language List
+                Back to Ubiquitous Language List
               </a>
             </li>
           </ol>

package/eventcatalog/src/utils/url-builder.ts

@@ -42,3 +42,9 @@ export const buildUrlWithParams = (baseUrl: string, params: Record<string, strin
 
   return `${buildUrl(baseUrl)}?${queryString}`;
 };
+
+export const buildEditUrlForResource = (editUrl: string, filePath: string) => {
+  // filepath may have ../ or ./ in it, so we need to remove it
+  const cleanFilePath = filePath.replace(/^\.\.?\//g, '');
+  return `${editUrl}/${cleanFilePath}`;
+};

package/package.json

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