@eventcatalog/core 4.8.1 → 4.8.2

package/dist/analytics/analytics.cjs

@@ -36,7 +36,7 @@ module.exports = __toCommonJS(analytics_exports);
 var import_os = __toESM(require("os"), 1);
 
 // package.json
-var version = "4.8.1";
+var version = "4.8.2";
 
 // src/constants.ts
 var VERSION = version;

package/dist/analytics/analytics.js

@@ -1,7 +1,7 @@
 import {
   raiseEvent
-} from "../chunk-GTLUF3KQ.js";
-import "../chunk-BHPDJ2Q6.js";
+} from "../chunk-KSSKB6IR.js";
+import "../chunk-23XZD2VJ.js";
 export {
   raiseEvent
 };

package/dist/analytics/log-build.cjs

@@ -140,7 +140,7 @@ var verifyRequiredFieldsAreInCatalogConfigFile = async (projectDirectory) => {
 var import_os = __toESM(require("os"), 1);
 
 // package.json
-var version = "4.8.1";
+var version = "4.8.2";
 
 // src/constants.ts
 var VERSION = version;

package/dist/analytics/log-build.js

@@ -1,9 +1,9 @@
 import {
   log_build_default
-} from "../chunk-S5H6UD4S.js";
-import "../chunk-GTLUF3KQ.js";
+} from "../chunk-6QNERNKA.js";
+import "../chunk-KSSKB6IR.js";
 import "../chunk-K2XIENVT.js";
-import "../chunk-BHPDJ2Q6.js";
+import "../chunk-23XZD2VJ.js";
 import "../chunk-6QENHZZP.js";
 export {
   log_build_default as default

package/dist/{chunk-BHPDJ2Q6.js → chunk-23XZD2VJ.js}

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

package/dist/{chunk-2X2LL6EJ.js → chunk-5CHDOSI2.js}

@@ -1,6 +1,6 @@
 import {
   VERSION
-} from "./chunk-BHPDJ2Q6.js";
+} from "./chunk-23XZD2VJ.js";
 
 // src/utils/cli-logger.ts
 import pc from "picocolors";

package/dist/{chunk-S5H6UD4S.js → chunk-6QNERNKA.js}

@@ -1,6 +1,6 @@
 import {
   raiseEvent
-} from "./chunk-GTLUF3KQ.js";
+} from "./chunk-KSSKB6IR.js";
 import {
   countResources,
   serializeCounts

package/dist/{chunk-GTLUF3KQ.js → chunk-KSSKB6IR.js}

@@ -1,6 +1,6 @@
 import {
   VERSION
-} from "./chunk-BHPDJ2Q6.js";
+} from "./chunk-23XZD2VJ.js";
 
 // src/analytics/analytics.js
 import os from "os";

package/dist/{chunk-QWE42VSC.js → chunk-THS3TMA6.js}

@@ -1,6 +1,6 @@
 import {
   logger
-} from "./chunk-2X2LL6EJ.js";
+} from "./chunk-5CHDOSI2.js";
 import {
   cleanup,
   getEventCatalogConfigFile

package/dist/constants.cjs

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

package/dist/constants.js

@@ -1,6 +1,6 @@
 import {
   VERSION
-} from "./chunk-BHPDJ2Q6.js";
+} from "./chunk-23XZD2VJ.js";
 export {
   VERSION
 };

package/dist/eventcatalog.cjs

@@ -144,7 +144,7 @@ var verifyRequiredFieldsAreInCatalogConfigFile = async (projectDirectory) => {
 var import_picocolors = __toESM(require("picocolors"), 1);
 
 // package.json
-var version = "4.8.1";
+var version = "4.8.2";
 
 // src/constants.ts
 var VERSION = version;

package/dist/eventcatalog.js

@@ -4,8 +4,8 @@ import {
 import "./chunk-CA4U2JP7.js";
 import {
   log_build_default
-} from "./chunk-S5H6UD4S.js";
-import "./chunk-GTLUF3KQ.js";
+} from "./chunk-6QNERNKA.js";
+import "./chunk-KSSKB6IR.js";
 import "./chunk-K2XIENVT.js";
 import {
   FederationConflictError,
@@ -31,10 +31,10 @@ import {
 } from "./chunk-B7HCX5HM.js";
 import {
   generate
-} from "./chunk-QWE42VSC.js";
+} from "./chunk-THS3TMA6.js";
 import {
   logger
-} from "./chunk-2X2LL6EJ.js";
+} from "./chunk-5CHDOSI2.js";
 import {
   resolve_catalog_dependencies_default
 } from "./chunk-LHR4G2UO.js";
@@ -54,7 +54,7 @@ import {
 import "./chunk-W5JQON7Z.js";
 import {
   VERSION
-} from "./chunk-BHPDJ2Q6.js";
+} from "./chunk-23XZD2VJ.js";
 import {
   linkCoreNodeModules,
   resolveInstalledCoreNodeModules

package/dist/generate.cjs

@@ -108,7 +108,7 @@ var getEventCatalogConfigFile = async (projectDirectory) => {
 var import_picocolors = __toESM(require("picocolors"), 1);
 
 // package.json
-var version = "4.8.1";
+var version = "4.8.2";
 
 // src/constants.ts
 var VERSION = version;

package/dist/generate.js

@@ -1,8 +1,8 @@
 import {
   generate
-} from "./chunk-QWE42VSC.js";
-import "./chunk-2X2LL6EJ.js";
-import "./chunk-BHPDJ2Q6.js";
+} from "./chunk-THS3TMA6.js";
+import "./chunk-5CHDOSI2.js";
+import "./chunk-23XZD2VJ.js";
 import "./chunk-6QENHZZP.js";
 export {
   generate

package/dist/utils/cli-logger.cjs

@@ -36,7 +36,7 @@ module.exports = __toCommonJS(cli_logger_exports);
 var import_picocolors = __toESM(require("picocolors"), 1);
 
 // package.json
-var version = "4.8.1";
+var version = "4.8.2";
 
 // src/constants.ts
 var VERSION = version;

package/dist/utils/cli-logger.js

@@ -1,7 +1,7 @@
 import {
   logger
-} from "../chunk-2X2LL6EJ.js";
-import "../chunk-BHPDJ2Q6.js";
+} from "../chunk-5CHDOSI2.js";
+import "../chunk-23XZD2VJ.js";
 export {
   logger
 };

package/eventcatalog/src/content.config.ts

@@ -956,6 +956,7 @@ const ubiquitousLanguages = defineCollection({
     },
   }),
   schema: z.object({
+    editUrl: z.string().optional(),
     dictionary: z
       .array(
         z.object({
@@ -964,6 +965,7 @@ const ubiquitousLanguages = defineCollection({
           summary: z.string().optional(),
           description: z.string().optional(),
           icon: z.string().optional(),
+          editUrl: z.string().optional(),
         })
       )
       .optional(),

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

@@ -0,0 +1,150 @@
+import { beforeEach, describe, expect, it, vi } from 'vitest';
+import { buildUbiquitousLanguageTermPage, Page, resolveUbiquitousLanguageTermEditUrl } from './_index.data';
+
+const mocks = vi.hoisted(() => ({
+  isSSR: vi.fn(() => false),
+  getDomains: vi.fn(),
+  getUbiquitousLanguage: vi.fn(),
+}));
+
+vi.mock('@utils/feature', () => ({
+  isSSR: () => mocks.isSSR(),
+}));
+
+vi.mock('@utils/collections/domains', () => ({
+  getDomains: mocks.getDomains,
+  getUbiquitousLanguage: mocks.getUbiquitousLanguage,
+}));
+
+const domain = {
+  collection: 'domains',
+  filePath: 'domains/Orders/index.mdx',
+  data: {
+    id: 'Orders',
+    name: 'Orders',
+    version: '0.0.1',
+  },
+} as any;
+
+const term = {
+  id: 'Order',
+  name: 'Order',
+  summary: 'A confirmed intent to purchase',
+};
+
+const collection = {
+  collection: 'ubiquitousLanguages',
+  filePath: 'domains/Orders/ubiquitous-language.mdx',
+  data: {
+    dictionary: [term],
+  },
+} as any;
+
+const configEditUrl = 'https://github.com/event-catalog/eventcatalog/edit/main';
+
+describe('ubiquitous language term page data', () => {
+  beforeEach(() => {
+    vi.clearAllMocks();
+    mocks.isSSR.mockReturnValue(false);
+    mocks.getDomains.mockResolvedValue([domain]);
+    mocks.getUbiquitousLanguage.mockResolvedValue([collection]);
+  });
+
+  describe('resolveUbiquitousLanguageTermEditUrl', () => {
+    it('uses a per-term editUrl when it is set', () => {
+      expect(
+        resolveUbiquitousLanguageTermEditUrl({
+          term: { ...term, editUrl: 'https://github.com/org/glossary/edit/main/Order.md' },
+          collection: { ...collection, data: { ...collection.data, editUrl: 'https://example.com/ignored' } },
+          configEditUrl,
+        })
+      ).toBe('https://github.com/org/glossary/edit/main/Order.md');
+    });
+
+    it('uses a collection-level editUrl when the term does not set one', () => {
+      expect(
+        resolveUbiquitousLanguageTermEditUrl({
+          term,
+          collection: { ...collection, data: { ...collection.data, editUrl: 'https://github.com/org/catalog/edit/main/ul.mdx' } },
+          configEditUrl,
+        })
+      ).toBe('https://github.com/org/catalog/edit/main/ul.mdx');
+    });
+
+    it('falls back to the site-wide config.editUrl and the dictionary file path', () => {
+      expect(resolveUbiquitousLanguageTermEditUrl({ term, collection, configEditUrl })).toBe(
+        'https://github.com/event-catalog/eventcatalog/edit/main/domains/Orders/ubiquitous-language.mdx'
+      );
+    });
+
+    it('returns an empty string when no editUrl is available', () => {
+      expect(resolveUbiquitousLanguageTermEditUrl({ term, collection })).toBe('');
+    });
+  });
+
+  describe('buildUbiquitousLanguageTermPage', () => {
+    it('exposes the dictionary file path and collection editUrl for the Edit this page link', () => {
+      const page = buildUbiquitousLanguageTermPage({
+        domain,
+        collection: {
+          ...collection,
+          data: {
+            editUrl: 'https://github.com/org/catalog/edit/main/ul.mdx',
+            dictionary: [term],
+          },
+        },
+        term: { ...term, editUrl: 'https://github.com/org/glossary/edit/main/Order.md' },
+      });
+
+      expect(page.params).toEqual({
+        type: 'domains',
+        id: 'Orders',
+        dictionaryId: 'Order',
+      });
+      expect(page.props.filePath).toBe('domains/Orders/ubiquitous-language.mdx');
+      expect(page.props.collectionEditUrl).toBe('https://github.com/org/catalog/edit/main/ul.mdx');
+      expect(page.props.ubiquitousLanguage.editUrl).toBe('https://github.com/org/glossary/edit/main/Order.md');
+      expect(
+        resolveUbiquitousLanguageTermEditUrl({
+          term: page.props.ubiquitousLanguage,
+          collection: { filePath: page.props.filePath, data: { editUrl: page.props.collectionEditUrl } },
+          configEditUrl,
+        })
+      ).toBe('https://github.com/org/glossary/edit/main/Order.md');
+    });
+  });
+
+  describe('Page.getStaticPaths', () => {
+    it('includes the dictionary file path used for the config.editUrl fallback href', async () => {
+      const paths = await Page.getStaticPaths();
+
+      expect(paths).toHaveLength(1);
+      expect(paths[0].params.dictionaryId).toBe('Order');
+      expect(paths[0].props.filePath).toBe('domains/Orders/ubiquitous-language.mdx');
+      expect(
+        resolveUbiquitousLanguageTermEditUrl({
+          term: paths[0].props.ubiquitousLanguage,
+          collection: { filePath: paths[0].props.filePath, data: { editUrl: paths[0].props.collectionEditUrl } },
+          configEditUrl,
+        })
+      ).toBe('https://github.com/event-catalog/eventcatalog/edit/main/domains/Orders/ubiquitous-language.mdx');
+    });
+  });
+
+  describe('Page.getData', () => {
+    it('resolves the Edit this page href when loading a term in SSR', async () => {
+      const props = await Page.getData({
+        props: {},
+        params: { type: 'domains', id: 'Orders', dictionaryId: 'Order' },
+      } as any);
+
+      expect(
+        resolveUbiquitousLanguageTermEditUrl({
+          term: props.ubiquitousLanguage,
+          collection: { filePath: props.filePath, data: { editUrl: props.collectionEditUrl } },
+          configEditUrl,
+        })
+      ).toBe('https://github.com/event-catalog/eventcatalog/edit/main/domains/Orders/ubiquitous-language.mdx');
+    });
+  });
+});

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

@@ -1,7 +1,52 @@
-import { getUbiquitousLanguage } from '@utils/collections/domains';
-import { getDomains } from '@utils/collections/domains';
+import type { CollectionEntry } from 'astro:content';
+import { getDomains, getUbiquitousLanguage } from '@utils/collections/domains';
 import { isSSR } from '@utils/feature';
 import { HybridPage } from '@utils/page-loaders/hybrid-page';
+import { resolveEditUrl } from '@utils/url-builder';
+
+type Domain = CollectionEntry<'domains'>;
+type UbiquitousLanguage = CollectionEntry<'ubiquitousLanguages'>;
+type DictionaryTerm = NonNullable<UbiquitousLanguage['data']['dictionary']>[number];
+
+export const resolveUbiquitousLanguageTermEditUrl = ({
+  term,
+  collection,
+  configEditUrl,
+}: {
+  term: Pick<DictionaryTerm, 'editUrl'>;
+  collection: Pick<UbiquitousLanguage, 'filePath'> & { data: Pick<UbiquitousLanguage['data'], 'editUrl'> };
+  configEditUrl?: string;
+}) =>
+  resolveEditUrl({
+    resourceEditUrl: term.editUrl || collection.data.editUrl,
+    configEditUrl,
+    filePath: collection.filePath,
+  });
+
+export const buildUbiquitousLanguageTermPage = ({
+  domain,
+  collection,
+  term,
+}: {
+  domain: Domain;
+  collection: UbiquitousLanguage;
+  term: DictionaryTerm;
+}) => ({
+  params: {
+    type: domain.collection,
+    id: domain.data.id,
+    dictionaryId: term.id,
+  },
+  props: {
+    type: domain.collection,
+    domainId: domain.data.id,
+    domain: domain.data,
+    ...term,
+    ubiquitousLanguage: term,
+    filePath: collection.filePath,
+    collectionEditUrl: collection.data.editUrl,
+  },
+});
 
 export class Page extends HybridPage {
   static async getStaticPaths() {
@@ -19,34 +64,21 @@ export class Page extends HybridPage {
         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,
-          },
-        })),
+        ...ubiquitousLanguages.flatMap((collection) =>
+          (collection.data.dictionary ?? []).map((term) => buildUbiquitousLanguageTermPage({ domain, collection, term }))
+        ),
       ];
     }, Promise.resolve([]));
 
     return pages;
   }
 
+  protected static hasValidProps(props: any): boolean {
+    return Boolean(props?.ubiquitousLanguage && props?.domain);
+  }
+
   protected static async fetchData(params: any) {
     const { getDomains } = await import('@utils/collections/domains');
     const domains = await getDomains({ getAllVersions: false });
@@ -58,20 +90,14 @@ export class Page extends HybridPage {
     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;
+    const collection = ubiquitousLanguages.find((l) => l.data.dictionary?.some((d) => d.id === params.dictionaryId));
+    if (!collection) 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,
-    };
+    const term = collection.data.dictionary?.find((d) => d.id === params.dictionaryId);
+    if (!term) return null;
+
+    return buildUbiquitousLanguageTermPage({ domain, collection, term }).props;
   }
 
   protected static createNotFoundResponse(): Response {

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

@@ -7,8 +7,10 @@ import { buildUrl } from '@utils/url-builder';
 import { ClientRouter } from 'astro:transitions';
 import { marked } from 'marked';
 import * as LucideIcons from 'lucide-react';
+import { SquarePenIcon } from 'lucide-react';
+import config from '@config';
 
-import { Page } from './_index.data';
+import { Page, resolveUbiquitousLanguageTermEditUrl } from './_index.data';
 
 export const prerender = Page.prerender;
 export const getStaticPaths = Page.getStaticPaths;
@@ -17,6 +19,11 @@ const props = await Page.getData(Astro);
 
 const { ubiquitousLanguage } = props;
 const pageTitle = `${props.type} | ${ubiquitousLanguage.name}`.replace(/^\w/, (c) => c.toUpperCase());
+const editUrl = resolveUbiquitousLanguageTermEditUrl({
+  term: ubiquitousLanguage,
+  collection: { filePath: props.filePath, data: { editUrl: props.collectionEditUrl } },
+  configEditUrl: config.editUrl,
+});
 
 marked.setOptions({
   breaks: true,
@@ -104,6 +111,21 @@ const badges = [
         }
 
         <Footer />
+        <div class="flex justify-end">
+          {
+            editUrl && (
+              <div class="flex justify-end">
+                <a
+                  href={editUrl}
+                  class="text-sm text-[rgb(var(--ec-page-text-muted))] hover:text-[rgb(var(--ec-page-text))] border border-[rgb(var(--ec-page-border))] rounded-md p-2"
+                >
+                  <SquarePenIcon className="w-4 h-4 inline-block mr-1" />
+                  Edit this page
+                </a>
+              </div>
+            )
+          }
+        </div>
       </div>
     </div>
     <ClientRouter />

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

@@ -53,6 +53,20 @@ export const buildEditUrlForResource = (editUrl: string, filePath: string) => {
   return `${editUrl}/${cleanFilePath}`;
 };
 
+export const resolveEditUrl = ({
+  resourceEditUrl,
+  configEditUrl,
+  filePath,
+}: {
+  resourceEditUrl?: string;
+  configEditUrl?: string;
+  filePath?: string;
+}) => {
+  if (resourceEditUrl) return resourceEditUrl;
+  if (configEditUrl && filePath) return buildEditUrlForResource(configEditUrl, filePath);
+  return '';
+};
+
 // Takes a given url and returns the .mdx url
 export const toMarkdownUrl = (url: string) => {
   const trailingSlash = typeof __EC_TRAILING_SLASH__ !== 'undefined' ? __EC_TRAILING_SLASH__ : false;

package/package.json

@@ -7,7 +7,7 @@
   },
   "license": "SEE LICENSE IN LICENSE",
   "type": "module",
-  "version": "4.8.1",
+  "version": "4.8.2",
   "publishConfig": {
     "access": "public"
   },
@@ -119,8 +119,8 @@
     "update-notifier": "^7.3.1",
     "uuid": "^11.1.1",
     "zod": "^4.3.6",
-    "@eventcatalog/linter": "1.1.15",
-    "@eventcatalog/sdk": "2.28.0",
+    "@eventcatalog/linter": "1.1.16",
+    "@eventcatalog/sdk": "2.28.1",
     "@eventcatalog/visualiser": "^4.1.3"
   },
   "devDependencies": {