@eventcatalog/core 3.14.6 → 3.15.0-beta.1

package/eventcatalog/src/content.config.ts

@@ -29,9 +29,14 @@ export const projectDirBase = (() => {
   return projectDir;
 })();
 
+const withIgnoredBuildArtifacts = (patterns: string | string[]) => {
+  const patternList = Array.isArray(patterns) ? patterns : [patterns];
+  return [...patternList, '!dist/**'];
+};
+
 const pages = defineCollection({
   loader: glob({
-    pattern: ['**/pages/*.(md|mdx)'],
+    pattern: withIgnoredBuildArtifacts(['**/pages/*.(md|mdx)']),
     base: projectDirBase,
   }),
   schema: z
@@ -90,7 +95,7 @@ const resourcePointer = z.object({
 
 const changelogs = defineCollection({
   loader: glob({
-    pattern: ['**/changelog.(md|mdx)'],
+    pattern: withIgnoredBuildArtifacts(['**/changelog.(md|mdx)']),
     base: projectDirBase,
   }),
   schema: z.object({
@@ -229,7 +234,7 @@ const flowStep = z
 
 const flows = defineCollection({
   loader: glob({
-    pattern: ['**/flows/*/index.(md|mdx)', '**/flows/*/versioned/*/index.(md|mdx)'],
+    pattern: withIgnoredBuildArtifacts(['**/flows/*/index.(md|mdx)', '**/flows/*/versioned/*/index.(md|mdx)']),
     base: projectDirBase,
     generateId: ({ data }) => {
       return `${data.id}-${data.version}`;
@@ -317,7 +322,7 @@ const messageDetailsPanelPropertySchema = z.object({
 
 const events = defineCollection({
   loader: glob({
-    pattern: ['**/events/*/index.(md|mdx)', '**/events/*/versioned/*/index.(md|mdx)'],
+    pattern: withIgnoredBuildArtifacts(['**/events/*/index.(md|mdx)', '**/events/*/versioned/*/index.(md|mdx)']),
     base: projectDirBase,
     generateId: ({ data, ...rest }) => {
       return `${data.id}-${data.version}`;
@@ -337,7 +342,7 @@ const events = defineCollection({
 
 const commands = defineCollection({
   loader: glob({
-    pattern: ['**/commands/*/index.(md|mdx)', '**/commands/*/versioned/*/index.(md|mdx)'],
+    pattern: withIgnoredBuildArtifacts(['**/commands/*/index.(md|mdx)', '**/commands/*/versioned/*/index.(md|mdx)']),
     base: projectDirBase,
     generateId: ({ data }) => {
       return `${data.id}-${data.version}`;
@@ -357,7 +362,7 @@ const commands = defineCollection({
 
 const queries = defineCollection({
   loader: glob({
-    pattern: ['**/queries/*/index.(md|mdx)', '**/queries/*/versioned/*/index.(md|mdx)'],
+    pattern: withIgnoredBuildArtifacts(['**/queries/*/index.(md|mdx)', '**/queries/*/versioned/*/index.(md|mdx)']),
     base: projectDirBase,
     generateId: ({ data }) => {
       return `${data.id}-${data.version}`;
@@ -389,7 +394,7 @@ const dataProductOutputPointer = z.object({
 
 const dataProducts = defineCollection({
   loader: glob({
-    pattern: ['**/data-products/*/index.(md|mdx)', '**/data-products/*/versioned/*/index.(md|mdx)'],
+    pattern: withIgnoredBuildArtifacts(['**/data-products/*/index.(md|mdx)', '**/data-products/*/versioned/*/index.(md|mdx)']),
     base: projectDirBase,
     generateId: ({ data }) => {
       return `${data.id}-${data.version}`;
@@ -405,7 +410,7 @@ const dataProducts = defineCollection({
 
 const services = defineCollection({
   loader: glob({
-    pattern: [
+    pattern: withIgnoredBuildArtifacts([
       'domains/*/services/*/index.(md|mdx)',
       'domains/*/services/*/versioned/*/index.(md|mdx)',
 
@@ -416,7 +421,7 @@ const services = defineCollection({
       // Capture services in the root
       'services/*/index.(md|mdx)', // ✅ Capture only services markdown files
       'services/*/versioned/*/index.(md|mdx)', // ✅ Capture versioned files inside services
-    ],
+    ]),
     base: projectDirBase,
     generateId: ({ data, ...rest }) => {
       return `${data.id}-${data.version}`;
@@ -466,7 +471,7 @@ const dataClassificationEnum = z.enum(['public', 'internal', 'confidential', 're
 
 const containers = defineCollection({
   loader: glob({
-    pattern: ['**/containers/**/index.(md|mdx)', '**/containers/**/versioned/*/index.(md|mdx)'],
+    pattern: withIgnoredBuildArtifacts(['**/containers/**/index.(md|mdx)', '**/containers/**/versioned/*/index.(md|mdx)']),
     base: projectDirBase,
     generateId: ({ data }) => {
       return `${data.id}-${data.version}`;
@@ -505,15 +510,66 @@ const containers = defineCollection({
 const customPages = defineCollection({
   loader: glob({
     // any number of child folders
-    pattern: ['docs/*.(md|mdx)', 'docs/**/*.@(md|mdx)'],
+    pattern: withIgnoredBuildArtifacts(['docs/*.(md|mdx)', 'docs/**/*.@(md|mdx)']),
     base: projectDirBase,
   }),
   schema: customPagesSchema,
 });
 
+const resourceDocs = defineCollection({
+  loader: glob({
+    // Resource-level docs are restricted to known resource paths.
+    // This avoids scanning external docs such as node_modules/**/docs.
+    pattern: withIgnoredBuildArtifacts([
+      '{events,commands,queries,services,flows,containers,channels,entities,data-products}/*/docs/**/*.@(md|mdx)',
+      '{events,commands,queries,services,flows,containers,channels,entities,data-products}/*/versioned/*/docs/**/*.@(md|mdx)',
+      'domains/*/docs/**/*.@(md|mdx)',
+      'domains/*/versioned/*/docs/**/*.@(md|mdx)',
+      'domains/*/subdomains/*/docs/**/*.@(md|mdx)',
+      'domains/*/subdomains/*/versioned/*/docs/**/*.@(md|mdx)',
+    ]),
+    base: projectDirBase,
+  }),
+  schema: z.object({
+    id: z.string().optional(),
+    type: z.string().optional(),
+    version: z.string().optional(),
+    order: z.number().optional(),
+    badges: z.array(badge).optional(),
+    title: z.string().optional(),
+    summary: z.string().optional(),
+    slug: z.string().optional(),
+    hidden: z.boolean().optional(),
+  }),
+});
+
+const resourceDocCategories = defineCollection({
+  loader: glob({
+    pattern: withIgnoredBuildArtifacts([
+      '{events,commands,queries,services,flows,containers,channels,entities,data-products}/*/docs/**/category.json',
+      '{events,commands,queries,services,flows,containers,channels,entities,data-products}/*/docs/**/_category_.json',
+      '{events,commands,queries,services,flows,containers,channels,entities,data-products}/*/versioned/*/docs/**/category.json',
+      '{events,commands,queries,services,flows,containers,channels,entities,data-products}/*/versioned/*/docs/**/_category_.json',
+      'domains/*/docs/**/category.json',
+      'domains/*/docs/**/_category_.json',
+      'domains/*/versioned/*/docs/**/category.json',
+      'domains/*/versioned/*/docs/**/_category_.json',
+      'domains/*/subdomains/*/docs/**/category.json',
+      'domains/*/subdomains/*/docs/**/_category_.json',
+      'domains/*/subdomains/*/versioned/*/docs/**/category.json',
+      'domains/*/subdomains/*/versioned/*/docs/**/_category_.json',
+    ]),
+    base: projectDirBase,
+  }),
+  schema: z.object({
+    label: z.string().optional(),
+    position: z.number().optional(),
+  }),
+});
+
 const domains = defineCollection({
   loader: glob({
-    pattern: [
+    pattern: withIgnoredBuildArtifacts([
       // ✅ Strictly include only index.md at the expected levels
       'domains/*/index.(md|mdx)',
       'domains/*/versioned/*/index.(md|mdx)',
@@ -521,7 +577,7 @@ const domains = defineCollection({
       // Capture subdomain folders
       'domains/*/subdomains/*/index.(md|mdx)',
       'domains/*/subdomains/*/versioned/*/index.(md|mdx)',
-    ],
+    ]),
     base: projectDirBase,
     generateId: ({ data, ...rest }) => {
       return `${data.id}-${data.version}`;
@@ -557,7 +613,7 @@ const domains = defineCollection({
 
 const channels = defineCollection({
   loader: glob({
-    pattern: ['**/channels/**/index.(md|mdx)', '**/channels/**/versioned/*/index.(md|mdx)'],
+    pattern: withIgnoredBuildArtifacts(['**/channels/**/index.(md|mdx)', '**/channels/**/versioned/*/index.(md|mdx)']),
     base: projectDirBase,
     generateId: ({ data }) => {
       return `${data.id}-${data.version}`;
@@ -600,7 +656,10 @@ const channels = defineCollection({
 
 const ubiquitousLanguages = defineCollection({
   loader: glob({
-    pattern: ['domains/*/ubiquitous-language.(md|mdx)', 'domains/*/subdomains/*/ubiquitous-language.(md|mdx)'],
+    pattern: withIgnoredBuildArtifacts([
+      'domains/*/ubiquitous-language.(md|mdx)',
+      'domains/*/subdomains/*/ubiquitous-language.(md|mdx)',
+    ]),
     base: projectDirBase,
     generateId: ({ data }) => {
       // File has no id, so we need to generate one
@@ -624,7 +683,7 @@ const ubiquitousLanguages = defineCollection({
 
 const entities = defineCollection({
   loader: glob({
-    pattern: ['**/entities/*/index.(md|mdx)', '**/entities/*/versioned/*/index.(md|mdx)'],
+    pattern: withIgnoredBuildArtifacts(['**/entities/*/index.(md|mdx)', '**/entities/*/versioned/*/index.(md|mdx)']),
     base: projectDirBase,
     generateId: ({ data, ...rest }) => {
       return `${data.id}-${data.version}`;
@@ -672,7 +731,11 @@ const entities = defineCollection({
 });
 
 const users = defineCollection({
-  loader: glob({ pattern: 'users/*.(md|mdx)', base: projectDirBase, generateId: ({ data }) => data.id as string }),
+  loader: glob({
+    pattern: withIgnoredBuildArtifacts('users/*.(md|mdx)'),
+    base: projectDirBase,
+    generateId: ({ data }) => data.id as string,
+  }),
   schema: z.object({
     id: z.string(),
     name: z.string(),
@@ -692,7 +755,11 @@ const users = defineCollection({
 });
 
 const teams = defineCollection({
-  loader: glob({ pattern: 'teams/*.(md|mdx)', base: projectDirBase, generateId: ({ data }) => data.id as string }),
+  loader: glob({
+    pattern: withIgnoredBuildArtifacts('teams/*.(md|mdx)'),
+    base: projectDirBase,
+    generateId: ({ data }) => data.id as string,
+  }),
   schema: z.object({
     id: z.string(),
     name: z.string(),
@@ -712,7 +779,7 @@ const teams = defineCollection({
 
 const designs = defineCollection({
   loader: async () => {
-    const data = await globPackage('**/**/*.ecstudio', { cwd: projectDirBase });
+    const data = await globPackage('**/**/*.ecstudio', { cwd: projectDirBase, ignore: ['dist/**'] });
     // File all the files in the designs folder
     // Limit 3 designs community edition?
     const files = data.reduce<{ id: string; name: string }[]>((acc, filePath) => {
@@ -741,7 +808,7 @@ const designs = defineCollection({
 
 const diagrams = defineCollection({
   loader: glob({
-    pattern: ['**/diagrams/**/index.(md|mdx)', '**/diagrams/**/versioned/*/index.(md|mdx)'],
+    pattern: withIgnoredBuildArtifacts(['**/diagrams/**/index.(md|mdx)', '**/diagrams/**/versioned/*/index.(md|mdx)']),
     base: projectDirBase,
     generateId: ({ data }) => `${data.id}-${data.version}`,
   }),
@@ -778,6 +845,8 @@ export const collections = {
 
   // EventCatalog Pro Collections
   customPages,
+  resourceDocs,
+  resourceDocCategories,
 
   // EventCatalog Studio Collections
   designs,

package/eventcatalog/src/pages/docs/[type]/[id]/[version]/[docType]/[docId]/[docVersion]/_index.data.ts

@@ -0,0 +1,85 @@
+import { isSSR, isResourceDocsEnabled } from '@utils/feature';
+import { HybridPage } from '@utils/page-loaders/hybrid-page';
+import { getResourceDocs, getResourceDocsForResource, type ResourceCollection } from '@utils/collections/resource-docs';
+
+const supportedResourceCollections = new Set<ResourceCollection>([
+  'domains',
+  'services',
+  'events',
+  'commands',
+  'queries',
+  'flows',
+  'containers',
+  'channels',
+  'entities',
+  'data-products',
+]);
+
+export class Page extends HybridPage {
+  static async getStaticPaths() {
+    if (isSSR() || !isResourceDocsEnabled()) {
+      return [];
+    }
+
+    const docs = await getResourceDocs();
+
+    return docs.map((doc) => ({
+      params: {
+        type: doc.data.resourceCollection,
+        id: doc.data.resourceId,
+        version: doc.data.resourceVersion,
+        docType: doc.data.type,
+        docId: doc.data.id,
+        docVersion: doc.data.version,
+      },
+      props: {},
+    }));
+  }
+
+  protected static async fetchData(params: any) {
+    if (!isResourceDocsEnabled()) {
+      return null;
+    }
+
+    const decodeParam = (value: string) => {
+      try {
+        return decodeURIComponent(value);
+      } catch {
+        return value;
+      }
+    };
+
+    const type = decodeParam(params.type);
+    const id = decodeParam(params.id);
+    const version = decodeParam(params.version);
+    const docType = decodeParam(params.docType);
+    const docId = decodeParam(params.docId);
+    const docVersion = decodeParam(params.docVersion);
+    if (!type || !id || !version || !docType || !docId || !docVersion) {
+      return null;
+    }
+
+    if (!supportedResourceCollections.has(type as ResourceCollection)) {
+      return null;
+    }
+
+    const docsForResource = await getResourceDocsForResource(type as ResourceCollection, id, version);
+    const doc = docsForResource.find(
+      (resourceDoc) =>
+        resourceDoc.data.type === docType && resourceDoc.data.id === docId && resourceDoc.data.version === docVersion
+    );
+
+    if (!doc) {
+      return null;
+    }
+
+    return doc;
+  }
+
+  protected static createNotFoundResponse(): Response {
+    return new Response(null, {
+      status: 404,
+      statusText: 'Resource documentation not found',
+    });
+  }
+}

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

@@ -0,0 +1,195 @@
+---
+import { render } from 'astro:content';
+
+import VerticalSideBarLayout from '@layouts/VerticalSideBarLayout.astro';
+import components from '@components/MDX/components';
+import { buildUrl } from '@utils/url-builder';
+import { AlignLeftIcon, HistoryIcon } from 'lucide-react';
+import { isResourceDocsEnabled } from '@utils/feature';
+import { getIcon } from '@utils/badges';
+import { collectionToResourceMap } from '@utils/collections/util';
+
+import { Page } from './_index.data';
+
+export const prerender = Page.prerender;
+export const getStaticPaths = Page.getStaticPaths;
+
+if (!isResourceDocsEnabled()) {
+  return Astro.redirect(buildUrl('/docs/custom/feature'));
+}
+
+const props = await Page.getData(Astro);
+const { Content, headings } = await render(props);
+
+const title = props.data.title || props.data.id;
+const pageTitle = `${title} | ${props.data.resourceId}`;
+const versions = props.data.versions || [props.data.version];
+const badges = (props.data.badges || []).map((badge: any) => ({
+  ...badge,
+  iconComponent: badge.icon ? getIcon(badge.icon) : null,
+}));
+
+const docsBasePath = `/docs/${props.data.resourceCollection}/${props.data.resourceId}/${props.data.resourceVersion}/${encodeURIComponent(props.data.type)}/${encodeURIComponent(props.data.id)}`;
+const singularResourceName =
+  collectionToResourceMap[props.data.resourceCollection as keyof typeof collectionToResourceMap] ??
+  props.data.resourceCollection.slice(0, props.data.resourceCollection.length - 1);
+
+const pagefindAttributes =
+  props.data.version === props.data.latestVersion
+    ? {
+        'data-pagefind-body': '',
+        'data-pagefind-meta': `title:${pageTitle}`,
+      }
+    : {};
+---
+
+<VerticalSideBarLayout title={pageTitle} description={props.data.summary}>
+  <main class="flex docs-layout h-full bg-[rgb(var(--ec-page-bg))]" {...pagefindAttributes}>
+    <div class="flex docs-layout w-full pl-16">
+      <div class="w-full lg:mr-2 pr-8 overflow-y-auto py-8 bg-[rgb(var(--ec-page-bg))]">
+        <div class="border-b border-[rgb(var(--ec-page-border))] pb-4">
+          <p class="text-xs uppercase tracking-wide text-[rgb(var(--ec-page-text-muted))]">
+            <a
+              href={buildUrl(`/docs/${props.data.resourceCollection}/${props.data.resourceId}/${props.data.resourceVersion}`)}
+              class="hover:underline"
+            >
+              {singularResourceName}: {props.data.resourceId}
+            </a>
+          </p>
+          <div class="flex items-center gap-2 pt-1">
+            <h2 id="doc-page-header" class="text-2xl md:text-4xl font-bold text-[rgb(var(--ec-page-text))]">{title}</h2>
+            <span
+              class="text-xs rounded-md px-2 py-1 bg-[rgb(var(--ec-content-hover))] text-[rgb(var(--ec-page-text-muted))] border border-[rgb(var(--ec-page-border))]"
+            >
+              v{props.data.version}
+              {props.data.version === props.data.latestVersion && ' (latest)'}
+            </span>
+          </div>
+          {
+            props.data.summary && (
+              <p class="text-lg pt-2 text-[rgb(var(--ec-page-text-muted))] font-light">{props.data.summary}</p>
+            )
+          }
+          {
+            badges.length > 0 && (
+              <div class="flex flex-wrap gap-3 pt-4">
+                {badges.map((badge: any) => (
+                  <span
+                    class={`
+                      inline-flex items-center gap-2 px-3 py-1.5 rounded-lg text-sm font-medium
+                      bg-[rgb(var(--ec-content-hover))] border border-[rgb(var(--ec-page-border))]
+                      text-[rgb(var(--ec-page-text))]
+                    `}
+                  >
+                    {badge.iconComponent && (
+                      <badge.iconComponent className="w-4 h-4 flex-shrink-0 text-[rgb(var(--ec-icon-color))]" />
+                    )}
+                    <span>{badge.content}</span>
+                  </span>
+                ))}
+              </div>
+            )
+          }
+        </div>
+        <div data-pagefind-ignore>
+          {
+            props.data.version !== props.data.latestVersion && (
+              <div class="rounded-md bg-[rgb(var(--ec-accent-subtle))] p-4 not-prose my-4">
+                <div class="flex">
+                  <div class="flex-shrink-0">
+                    <svg class="h-5 w-5 text-[rgb(var(--ec-accent))]" viewBox="0 0 20 20" fill="currentColor" aria-hidden="true">
+                      <path
+                        fill-rule="evenodd"
+                        d="M8.485 2.495c.673-1.167 2.357-1.167 3.03 0l6.28 10.875c.673 1.167-.17 2.625-1.516 2.625H3.72c-1.347 0-2.189-1.458-1.515-2.625L8.485 2.495zM10 5a.75.75 0 01.75.75v3.5a.75.75 0 01-1.5 0v-3.5A.75.75 0 0110 5zm0 9a1 1 0 100-2 1 1 0 000 2z"
+                        clip-rule="evenodd"
+                      />
+                    </svg>
+                  </div>
+                  <div class="ml-3">
+                    <h3 class="text-sm font-medium text-[rgb(var(--ec-accent-text))]">New version found</h3>
+                    <div class="mt-2 text-sm text-[rgb(var(--ec-accent-text))]">
+                      <p>
+                        You are looking at a previous version of the {singularResourceName} doc <strong>{title}</strong>.{' '}
+                        <a
+                          class="underline hover:text-primary block pt-2"
+                          href={buildUrl(`${docsBasePath}/${props.data.latestVersion}`)}
+                        >
+                          The latest version of this doc is <span>v{props.data.latestVersion}</span> &rarr;
+                        </a>
+                      </p>
+                    </div>
+                  </div>
+                </div>
+              </div>
+            )
+          }
+        </div>
+        <div class="prose py-8 max-w-none">
+          <Content components={components(props)} />
+        </div>
+      </div>
+      <aside class="hidden lg:block sticky top-0 pb-10 w-80 overflow-y-auto border-l border-[rgb(var(--ec-page-border))] py-2">
+        <div class="sticky top-28 left-0 h-full overflow-y-auto px-6 py-4">
+          <h3 class="text-sm text-[rgb(var(--ec-page-text))] font-semibold capitalize flex items-center gap-2">
+            <AlignLeftIcon className="w-4 h-4" />
+            On this page
+          </h3>
+          <nav class="space-y-1 text-sm py-4">
+            {
+              headings.map((heading) => {
+                if (heading.depth > 3) {
+                  return null;
+                }
+                return (
+                  <a
+                    href={`#${heading.slug}`}
+                    class={`block text-[12px] py-0.5 ${heading.depth === 1 ? 'font-light' : ''} text-[rgb(var(--ec-page-text-muted))] hover:text-[rgb(var(--ec-page-text))]`}
+                    style={`padding-left: ${(heading.depth - 1) * 8}px`}
+                  >
+                    {heading.text}
+                  </a>
+                );
+              })
+            }
+          </nav>
+          <div class="space-y-2 pb-4">
+            <span class="text-xs text-[rgb(var(--ec-page-text))] font-semibold capitalize">Versions ({versions.length})</span>
+            <ul role="list" class="space-y-2">
+              {
+                versions.map((version: string) => (
+                  <li class="version-item rounded-md px-1 group w-full">
+                    <a class="flex items-center space-x-2" href={buildUrl(`${docsBasePath}/${encodeURIComponent(version)}`)}>
+                      <HistoryIcon
+                        className="h-4 w-4 text-[rgb(var(--ec-page-text-muted))] group-hover:text-[rgb(var(--ec-accent-text))]"
+                        strokeWidth={1}
+                      />
+                      <span
+                        class={`font-light text-xs text-[rgb(var(--ec-page-text))] group-hover:text-[rgb(var(--ec-accent-text))] ${
+                          version === props.data.version ? 'underline' : ''
+                        }`}
+                      >
+                        {version === props.data.latestVersion ? `v${version} (latest)` : `v${version}`}
+                      </span>
+                    </a>
+                  </li>
+                ))
+              }
+            </ul>
+            <div class="border-b border-[rgb(var(--ec-page-border))] pt-2"></div>
+          </div>
+        </div>
+      </aside>
+    </div>
+  </main>
+</VerticalSideBarLayout>
+
+<style is:global>
+  .docs-layout .prose {
+    max-width: none;
+    overflow: auto;
+  }
+
+  .version-item:hover {
+    background: linear-gradient(to left, rgb(var(--ec-accent-gradient-from)), rgb(var(--ec-accent-gradient-to)));
+  }
+</style>

package/eventcatalog/src/pages/docs/[type]/[id]/[version]/[docType]/[docId]/_index.data.ts

@@ -0,0 +1,86 @@
+import { isSSR, isResourceDocsEnabled } from '@utils/feature';
+import { HybridPage } from '@utils/page-loaders/hybrid-page';
+import { getResourceDocs, getResourceDocsForResource, type ResourceCollection } from '@utils/collections/resource-docs';
+
+const supportedResourceCollections = new Set<ResourceCollection>([
+  'domains',
+  'services',
+  'events',
+  'commands',
+  'queries',
+  'flows',
+  'containers',
+  'channels',
+  'entities',
+  'data-products',
+]);
+
+export class Page extends HybridPage {
+  static async getStaticPaths() {
+    if (isSSR() || !isResourceDocsEnabled()) {
+      return [];
+    }
+
+    const docs = await getResourceDocs();
+    const latestDocs = docs.filter((doc) => doc.data.version === doc.data.latestVersion);
+
+    return latestDocs.map((doc) => ({
+      params: {
+        type: doc.data.resourceCollection,
+        id: doc.data.resourceId,
+        version: doc.data.resourceVersion,
+        docType: doc.data.type,
+        docId: doc.data.id,
+      },
+      props: {},
+    }));
+  }
+
+  protected static async fetchData(params: any) {
+    if (!isResourceDocsEnabled()) {
+      return null;
+    }
+
+    const decodeParam = (value: string) => {
+      try {
+        return decodeURIComponent(value);
+      } catch {
+        return value;
+      }
+    };
+
+    const type = decodeParam(params.type);
+    const id = decodeParam(params.id);
+    const version = decodeParam(params.version);
+    const docType = decodeParam(params.docType);
+    const docId = decodeParam(params.docId);
+    if (!type || !id || !version || !docType || !docId) {
+      return null;
+    }
+
+    if (!supportedResourceCollections.has(type as ResourceCollection)) {
+      return null;
+    }
+
+    const docsForResource = await getResourceDocsForResource(type as ResourceCollection, id, version);
+    const doc = docsForResource.find(
+      (resourceDoc) =>
+        resourceDoc.data.type === docType &&
+        resourceDoc.data.id === docId &&
+        resourceDoc.data.version === resourceDoc.data.latestVersion
+    );
+
+    if (!doc) {
+      return null;
+    }
+
+    return doc;
+  }
+
+  protected static createNotFoundResponse(): Response {
+    return new Response(null, {
+      status: 404,
+      statusText: 'Resource documentation not found',
+    });
+  }
+}