@eventcatalog/core 5.0.0-beta.20 → 5.0.0-beta.22

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

@@ -1,53 +1,30 @@
 ---
 import Seo from '@components/Seo.astro';
 import { buildUrl } from '@utils/url-builder';
-import { getEvents } from '@utils/collections/events';
-import { getCommands } from '@utils/collections/commands';
-import { getServices } from '@utils/collections/services';
-import { getDomains } from '@utils/collections/domains';
-import { getContainers } from '@utils/collections/containers';
-import type { CollectionEntry } from 'astro:content';
-import type { CollectionTypes } from '@types';
-import { isVisualiserEnabled } from '@utils/feature';
+import { isSSR } from '@utils/feature';
+import { findVisualiserResource, getVisualiserResources } from './_index.data';
 
-export async function getStaticPaths() {
-  if (!isVisualiserEnabled()) {
-    return [];
-  }
-
-  const [events, commands, services, domains, containers] = await Promise.all([
-    getEvents(),
-    getCommands(),
-    getServices(),
-    getDomains(),
-    getContainers(),
-  ]);
+export const prerender = !isSSR();
 
-  const resources = [...domains, ...events, ...services, ...commands, ...containers];
-  const resourcesWithVisualiserEnabled = resources.filter((resource) => resource.data.visualiser !== false);
+export async function getStaticPaths() {
+  const resources = await getVisualiserResources();
+  return resources.map(({ type, item }) => ({ params: { type, id: item.data.id }, props: item }));
+}
 
-  const buildPages = (collection: CollectionEntry<CollectionTypes>[]) => {
-    return collection.map((item) => ({
-      params: {
-        type: item.collection,
-        id: item.data.id,
-      },
-      props: {
-        type: item.collection,
-        ...item,
-      },
-    }));
-  };
+// A static build gets the resource from getStaticPaths; a server, which has no static paths, looks it up
+const resource = isSSR() ? await findVisualiserResource(Astro.params.type, Astro.params.id) : Astro.props;
 
-  return [...buildPages(resourcesWithVisualiserEnabled)];
+if (!resource?.data) {
+  return new Response(null, { status: 404, statusText: 'Not found' });
 }
 
-const props = Astro.props;
-const pageTitle = `${props.collection} | ${props.data.name}`.replace(/^\w/, (c) => c.toUpperCase());
-
-const { pathname } = Astro.url;
+const pageTitle = `${resource.collection} | ${resource.data.name}`.replace(/^\w/, (c) => c.toUpperCase());
+const redirectUrl = buildUrl(`${Astro.url.pathname.replace(/\/$/, '')}/${resource.data.latestVersion}`, false, true);
 
-const redirectUrl = buildUrl(pathname + '/' + props.data.latestVersion, false, true);
+// A server redirects straight away (with any query string); a static page redirects in the browser
+if (isSSR()) {
+  return Astro.redirect(`${redirectUrl}${Astro.url.search}`);
+}
 ---
 
 <!doctype html>

package/eventcatalog/src/pages/visualiser/designs/[id]/_index.data.ts

@@ -45,13 +45,6 @@ export class Page extends HybridPage {
     };
   }
 
-  protected static createNotFoundResponse(): Response {
-    return new Response(null, {
-      status: 404,
-      statusText: 'Design not found',
-    });
-  }
-
   static get clientAuthScript(): string {
     if (!isAuthEnabled() || !isVisualiserEnabled()) {
       return '';

package/eventcatalog/src/pages/visualiser/designs/[id]/index.astro

@@ -13,7 +13,8 @@ const isChatEnabled = isEventCatalogChatVisible();
 export const prerender = Page.prerender;
 export const getStaticPaths = Page.getStaticPaths;
 
-const props = Astro.props;
+const props = await Page.getData(Astro);
+if (!props) return Astro.rewrite('/404');
 
 const { data } = props;
 ---

package/eventcatalog/src/pages/visualiser/domains/[id]/[version]/entity-map/_index.data.ts

@@ -47,13 +47,6 @@ export class Page extends HybridPage {
     return item;
   }
 
-  protected static createNotFoundResponse(): Response {
-    return new Response(null, {
-      status: 404,
-      statusText: 'Domain entity map page not found',
-    });
-  }
-
   static get clientAuthScript(): string {
     if (!isAuthEnabled() || !isVisualiserEnabled()) {
       return '';

package/eventcatalog/src/pages/visualiser/domains/[id]/[version]/entity-map/index.astro

@@ -10,6 +10,7 @@ export const getStaticPaths = Page.getStaticPaths;
 
 // Get data
 const props = await Page.getData(Astro);
+if (!props) return Astro.rewrite('/404');
 
 const {
   data: { id },

package/eventcatalog/src/pages/visualiser/domains/[id]/[version]/index.astro

@@ -11,6 +11,7 @@ export const getStaticPaths = Page.getStaticPaths;
 
 // Get data
 const props = await Page.getData(Astro);
+if (!props) return Astro.rewrite('/404');
 
 const {
   data: { id },

package/eventcatalog/src/pages/visualiser/domains/[id]/[version]/systems-context/_index.data.ts

@@ -58,13 +58,6 @@ export class Page extends HybridPage {
     return item;
   }
 
-  protected static createNotFoundResponse(): Response {
-    return new Response(null, {
-      status: 404,
-      statusText: 'Domain System Diagram page not found',
-    });
-  }
-
   static get clientAuthScript(): string {
     if (!isAuthEnabled() || !isVisualiserEnabled()) {
       return '';

package/eventcatalog/src/pages/visualiser/domains/[id]/[version]/systems-context/index.astro

@@ -8,6 +8,7 @@ export const getStaticPaths = Page.getStaticPaths;
 
 // Get data
 const props = await Page.getData(Astro);
+if (!props) return Astro.rewrite('/404');
 
 // The System Diagram is now level 1 of the domain's visualiser page
 return Astro.redirect(buildUrl(`/visualiser/domains/${props.data.id}/${props.data.version}?level=1`));

package/eventcatalog/src/pages/visualiser/systems/[id]/[version]/context/_index.data.ts

@@ -61,13 +61,6 @@ export class Page extends HybridPage {
     return item;
   }
 
-  protected static createNotFoundResponse(): Response {
-    return new Response(null, {
-      status: 404,
-      statusText: 'System Diagram page not found',
-    });
-  }
-
   static get clientAuthScript(): string {
     if (!isAuthEnabled() || !isVisualiserEnabled()) {
       return '';

package/eventcatalog/src/pages/visualiser/systems/[id]/[version]/context/index.astro

@@ -8,6 +8,7 @@ export const getStaticPaths = Page.getStaticPaths;
 
 // Get data
 const props = await Page.getData(Astro);
+if (!props) return Astro.rewrite('/404');
 
 // The System Context diagram is now level 1 of the system's visualiser page
 return Astro.redirect(buildUrl(`/visualiser/systems/${props.data.id}/${props.data.version}?level=1`));

package/eventcatalog/src/pages/visualiser/systems/[id]/[version]/index.astro

@@ -11,6 +11,7 @@ export const getStaticPaths = Page.getStaticPaths;
 
 // Get data
 const props = await Page.getData(Astro);
+if (!props) return Astro.rewrite('/404');
 
 const {
   data: { id },

package/eventcatalog/src/utils/page-loaders/hybrid-page.ts

@@ -24,7 +24,9 @@ export class HybridPage<T = any> {
   }
 
   /**
-   * Static method for getting data
+   * The page's data: its props in a static build, or looked up from its URL on a server. Undefined
+   * when nothing matches (an unknown resource or version): the page then returns
+   * `Astro.rewrite('/404')`. Throwing a Response instead made Astro answer with an empty 500.
    */
   static async getData(astro: AstroGlobal): Promise<any> {
     // Try props first (static mode)
@@ -32,13 +34,7 @@ export class HybridPage<T = any> {
       return this.transformProps(astro.props);
     }
 
-    const data = await this.fetchData(astro.params);
-
-    if (!data) {
-      throw this.createNotFoundResponse();
-    }
-
-    return data;
+    return (await this.fetchData(astro.params)) ?? undefined;
   }
 
   /**
@@ -58,11 +54,4 @@ export class HybridPage<T = any> {
   protected static transformProps(props: any): any {
     return props;
   }
-
-  protected static createNotFoundResponse(): Response {
-    return new Response(null, {
-      status: 404,
-      statusText: 'Not found',
-    });
-  }
 }

package/package.json

@@ -7,7 +7,7 @@
   },
   "license": "BUSL-1.1",
   "type": "module",
-  "version": "5.0.0-beta.20",
+  "version": "5.0.0-beta.22",
   "publishConfig": {
     "access": "public"
   },