@eventcatalog/core 4.11.0 → 4.11.1

package/eventcatalog/src/components/SchemaExplorer/protobuf-validation.test.ts

@@ -1,84 +0,0 @@
-import { describe, expect, it } from 'vitest';
-import type { ProtobufField } from '@utils/protobuf-schema';
-import {
-  formatProtobufOptionValue,
-  formatProtovalidateRule,
-  getCustomFieldAnnotations,
-  getProtovalidateRules,
-  isProtovalidateRequired,
-} from './protobuf-validation';
-
-describe('protobuf validation helpers', () => {
-  it('flattens direct and aggregate Protovalidate options', () => {
-    const field: ProtobufField = {
-      name: 'status',
-      type: 'Status',
-      options: [
-        { name: '(buf.validate.field).required', value: true },
-        {
-          name: '(buf.validate.field).enum',
-          value: { defined_only: true, not_in: [0] },
-        },
-      ],
-    };
-
-    expect(getProtovalidateRules(field)).toEqual([
-      { path: 'required', value: true },
-      { path: 'enum.defined_only', value: true },
-      { path: 'enum.not_in', value: [0] },
-    ]);
-    expect(isProtovalidateRequired(field)).toBe(true);
-  });
-
-  it('ignores non-Protovalidate custom options', () => {
-    const field: ProtobufField = {
-      name: 'description',
-      type: 'string',
-      options: [{ name: '(datahub.v1.gdpr_rule).string', value: true }],
-    };
-
-    expect(getProtovalidateRules(field)).toEqual([]);
-    expect(isProtovalidateRequired(field)).toBe(false);
-    expect(getCustomFieldAnnotations(field)).toEqual([{ name: '(datahub.v1.gdpr_rule).string', value: true }]);
-  });
-
-  it('only treats extension options as custom annotations and formats aggregate values', () => {
-    const field: ProtobufField = {
-      name: 'description',
-      type: 'string',
-      options: [
-        { name: 'deprecated', value: true },
-        { name: '(buf.validate.field).string.min_len', value: 1 },
-        { name: '(datahub.v1.classification)', value: { level: 'personal', encrypted: true } },
-      ],
-    };
-
-    expect(getCustomFieldAnnotations(field)).toEqual([
-      {
-        name: '(datahub.v1.classification)',
-        value: { level: 'personal', encrypted: true },
-      },
-    ]);
-    expect(formatProtobufOptionValue(getCustomFieldAnnotations(field)[0].value)).toBe('{"level":"personal","encrypted":true}');
-  });
-
-  it('formats common rules for display', () => {
-    expect(formatProtovalidateRule({ path: 'string.email', value: true })).toEqual({ label: 'Format', value: 'Email' });
-    expect(formatProtovalidateRule({ path: 'uint32.gte', value: 1 })).toEqual({ label: 'Minimum', value: '1' });
-    expect(formatProtovalidateRule({ path: 'enum.defined_only', value: true })).toEqual({
-      label: 'Defined enum values only',
-    });
-    expect(formatProtovalidateRule({ path: 'enum.not_in', value: [0] })).toEqual({
-      label: 'Excluded values',
-      value: '0',
-    });
-    expect(formatProtovalidateRule({ path: 'repeated.items.string.min_len', value: 3 })).toEqual({
-      label: 'Item minimum length',
-      value: '3',
-    });
-    expect(formatProtovalidateRule({ path: 'map.values.string.max_len', value: 100 })).toEqual({
-      label: 'Value maximum length',
-      value: '100',
-    });
-  });
-});

package/eventcatalog/src/components/Search/search-utils.spec.ts

@@ -1,173 +0,0 @@
-import { describe, expect, it, beforeEach } from 'vitest';
-import {
-  applyActiveFilter,
-  getIndexedResultRank,
-  getSearchFilters,
-  getUrlForSearchItem,
-  hasMeaningfulIndexedMatch,
-  highlightQuery,
-  mapPagefindResultsToSearchItems,
-  normalizeResultUrl,
-} from './search-utils';
-
-declare global {
-  interface Window {
-    __EC_TRAILING_SLASH__: boolean;
-  }
-}
-
-describe('getUrlForSearchItem', () => {
-  beforeEach(() => {
-    // @ts-ignore
-    global.__EC_TRAILING_SLASH__ = false;
-  });
-
-  it.each([
-    ['container:OrdersDatabase:1.0.0', '/docs/containers/OrdersDatabase/1.0.0'],
-    ['data-product:Customer360:1.0.0', '/docs/data-products/Customer360/1.0.0'],
-    ['entity:Order:1.0.0', '/docs/entities/Order/1.0.0'],
-    ['flow:CheckoutFlow:1.0.0', '/docs/flows/CheckoutFlow/1.0.0'],
-  ])('builds a docs URL for %s', (key, expected) => {
-    expect(getUrlForSearchItem({}, key)).toBe(expected);
-  });
-
-  it('uses the explicit node href when provided', () => {
-    expect(getUrlForSearchItem({ href: '/custom/search-result' }, 'data-product:Customer360:1.0.0')).toBe(
-      '/custom/search-result'
-    );
-  });
-
-  it('skips aliases and unsupported keys', () => {
-    expect(getUrlForSearchItem({}, 'data-product:Customer360')).toBeNull();
-    expect(getUrlForSearchItem({}, 'list:data-products')).toBeNull();
-    expect(getUrlForSearchItem({}, 'unknown:Customer360:1.0.0')).toBeNull();
-  });
-});
-
-describe('indexed search result helpers', () => {
-  it('filters weak single-character highlighted matches for longer queries', () => {
-    expect(
-      hasMeaningfulIndexedMatch({
-        query: 'random',
-        title: 'Orders Service',
-        content: 'Order Metadata in api service server logs',
-        excerpt: 'Order Metadata in api db L -- <mark>R</mark> server',
-      })
-    ).toBe(false);
-  });
-
-  it('keeps short but meaningful marked terms', () => {
-    expect(
-      hasMeaningfulIndexedMatch({
-        query: 'db',
-        title: 'Orders Service',
-        content: 'Order Metadata in api service server logs',
-        excerpt: 'Order Metadata in api <mark>db</mark>',
-      })
-    ).toBe(true);
-  });
-
-  it('keeps exact title or content matches even without marked excerpts', () => {
-    expect(
-      hasMeaningfulIndexedMatch({
-        query: 'payments',
-        title: 'Payments Database',
-        content: '',
-        excerpt: '',
-      })
-    ).toBe(true);
-
-    expect(
-      hasMeaningfulIndexedMatch({
-        query: 'idempotency',
-        title: 'Payments Database',
-        content: 'Always include an idempotency key in payment creation.',
-        excerpt: '',
-      })
-    ).toBe(true);
-  });
-
-  it('normalizes Pagefind URLs to root-relative paths', () => {
-    expect(normalizeResultUrl('docs/containers/payments-db/0.0.1')).toBe('/docs/containers/payments-db/0.0.1');
-    expect(normalizeResultUrl('/docs/containers/payments-db/0.0.1')).toBe('/docs/containers/payments-db/0.0.1');
-    expect(normalizeResultUrl('https://example.com/docs')).toBe('https://example.com/docs');
-  });
-
-  it('highlights title matches while escaping unsafe title text', () => {
-    expect(highlightQuery('Payment <Service>', 'payment')).toBe('<mark>Payment</mark> &lt;Service&gt;');
-  });
-
-  it('ranks title matches above id/url matches and content matches', () => {
-    const query = 'payment';
-    const contentRank = getIndexedResultRank({
-      query,
-      title: 'Orders Service',
-      url: '/docs/services/OrdersService/1.0.0',
-      content: 'Handles payment retries',
-    });
-    const urlRank = getIndexedResultRank({
-      query,
-      title: 'Orders Service',
-      url: '/docs/services/PaymentService/1.0.0',
-      content: 'Handles orders',
-    });
-    const titleRank = getIndexedResultRank({
-      query,
-      title: 'Payment Service',
-      url: '/docs/services/PaymentService/1.0.0',
-      content: 'Handles orders',
-    });
-
-    expect(titleRank).toBeGreaterThan(urlRank);
-    expect(urlRank).toBeGreaterThan(contentRank);
-  });
-
-  it('applies grouped search filters', () => {
-    const items = [{ type: 'Event' }, { type: 'Command' }, { type: 'Team' }, { type: 'User' }, { type: 'Service' }];
-
-    expect(applyActiveFilter(items, 'Message')).toEqual([{ type: 'Event' }, { type: 'Command' }]);
-    expect(applyActiveFilter(items, 'Team')).toEqual([{ type: 'Team' }, { type: 'User' }]);
-    expect(applyActiveFilter(items, 'Service')).toEqual([{ type: 'Service' }]);
-  });
-
-  it('builds filter metadata without encoding behavior in labels', () => {
-    expect(getSearchFilters({ items: [], query: 'missing' })).toEqual([{ id: 'all', name: 'All (0)', count: 0 }]);
-    expect(getSearchFilters({ items: [{ type: 'Event' }, { type: 'Service' }], query: 'order' })).toEqual([
-      { id: 'all', name: 'All (2)', count: 2 },
-      { id: 'Service', name: 'Services (1)', count: 1 },
-      { id: 'Message', name: 'Messages (1)', count: 1 },
-    ]);
-  });
-
-  it('maps Pagefind results into ranked search items', async () => {
-    const items = await mapPagefindResultsToSearchItems({
-      query: 'payment',
-      limit: 10,
-      results: [
-        {
-          id: 'content',
-          score: 10,
-          data: async () => ({
-            url: 'docs/services/OrdersService/1.0.0',
-            content: 'Handles payment retries',
-            excerpt: 'Handles <mark>payment</mark> retries',
-            meta: { title: 'Orders Service', type: 'Service', id: 'OrdersService' },
-          }),
-        },
-        {
-          id: 'title',
-          score: 1,
-          data: async () => ({
-            url: 'docs/services/PaymentService/1.0.0',
-            content: 'Handles orders',
-            excerpt: '<mark>Payment</mark> service',
-            meta: { title: 'Payment Service', type: 'Service', id: 'PaymentService' },
-          }),
-        },
-      ],
-    });
-
-    expect(items.map((item) => item.id)).toEqual(['title', 'content']);
-    expect(items[0].url).toBe('/docs/services/PaymentService/1.0.0');
-  });
-});

package/eventcatalog/src/components/SideNav/NestedSideBar/utils.spec.ts

@@ -1,105 +0,0 @@
-import { describe, expect, it } from 'vitest';
-import {
-  canCollapseGroup,
-  createSectionCollapsePreferences,
-  findNodeKeyByUrl,
-  getDefaultCollapsedState,
-  isGroupCollapsed,
-  toggleGroupCollapsed,
-} from './utils';
-
-const preferences = (expanded: string[] = [], collapsed: string[] = []) => createSectionCollapsePreferences(expanded, collapsed);
-
-describe('sidebar group presentation', () => {
-  it('keeps root-level groups expanded', () => {
-    expect(canCollapseGroup(true)).toBe(false);
-  });
-
-  it('lets every group inside a resource sidebar collapse, whatever its size', () => {
-    expect(canCollapseGroup(false)).toBe(true);
-    expect(canCollapseGroup(false)).toBe(true);
-  });
-
-  it('keeps groups marked as non-collapsible expanded regardless of their size', () => {
-    expect(canCollapseGroup(false, false)).toBe(false);
-  });
-
-  it('starts long lists collapsed and short ones open unless told otherwise', () => {
-    expect(getDefaultCollapsedState(5)).toBe(false);
-    expect(getDefaultCollapsedState(6)).toBe(true);
-    expect(getDefaultCollapsedState(6, false)).toBe(false);
-    expect(getDefaultCollapsedState(2, true)).toBe(true);
-  });
-
-  it('always allows collapsing when an explicit collapsed state is set, overriding every other rule', () => {
-    expect(canCollapseGroup(false, true, true)).toBe(true);
-    expect(canCollapseGroup(false, true, false)).toBe(true);
-    expect(canCollapseGroup(true, false, true)).toBe(true);
-  });
-});
-
-describe('isGroupCollapsed', () => {
-  it('keeps groups without a caret expanded', () => {
-    expect(isGroupCollapsed(false, 'group-1', preferences())).toBe(false);
-  });
-
-  it('collapses expandable groups by default', () => {
-    expect(isGroupCollapsed(true, 'outbound-messages', preferences())).toBe(true);
-  });
-
-  it('uses an explicit expanded preference', () => {
-    expect(isGroupCollapsed(true, 'outbound-messages', preferences(['outbound-messages']))).toBe(false);
-  });
-
-  it('starts expanded when the group defaults to expanded, until the user collapses it', () => {
-    expect(isGroupCollapsed(true, 'owners', preferences(), false)).toBe(false);
-    expect(isGroupCollapsed(true, 'owners', preferences([], ['owners']), false)).toBe(true);
-  });
-});
-
-describe('toggleGroupCollapsed', () => {
-  it('records the user overriding a collapsed-by-default group, then clears it on the way back', () => {
-    const opened = toggleGroupCollapsed('g', preferences());
-    expect([...opened.expanded]).toEqual(['g']);
-    expect(opened.collapsed.size).toBe(0);
-
-    const closedAgain = toggleGroupCollapsed('g', opened);
-    expect(closedAgain.expanded.size).toBe(0);
-    expect([...closedAgain.collapsed]).toEqual(['g']);
-  });
-
-  it('records the user overriding an expanded-by-default group', () => {
-    const closed = toggleGroupCollapsed('g', preferences(), false);
-    expect([...closed.collapsed]).toEqual(['g']);
-    expect(isGroupCollapsed(true, 'g', closed, false)).toBe(true);
-
-    const reopened = toggleGroupCollapsed('g', closed, false);
-    expect(reopened.collapsed.size).toBe(0);
-    expect([...reopened.expanded]).toEqual(['g']);
-  });
-
-  it('does not mutate the previous preferences', () => {
-    const before = preferences();
-    toggleGroupCollapsed('g', before);
-    expect(before.expanded.size).toBe(0);
-    expect(before.collapsed.size).toBe(0);
-  });
-});
-
-describe('findNodeKeyByUrl', () => {
-  const channelKey = 'channel:product-events:1.0.0';
-  const nodes = { [channelKey]: {} };
-  const nodeLookup = new Map([['channel:product-events', channelKey]]);
-
-  it('selects the channel sidebar for channel documentation', () => {
-    expect(findNodeKeyByUrl('/docs/channels/product-events/1.0.0', nodes, nodeLookup)).toBe(channelKey);
-  });
-
-  it('keeps the channel sidebar selected on the channel map', () => {
-    expect(findNodeKeyByUrl('/visualiser/channels/product-events/1.0.0', nodes, nodeLookup)).toBe(channelKey);
-  });
-
-  it('falls back to the available channel version', () => {
-    expect(findNodeKeyByUrl('/docs/channels/product-events/latest', nodes, nodeLookup)).toBe(channelKey);
-  });
-});

package/eventcatalog/src/components/navigation-progress.spec.ts

@@ -1,68 +0,0 @@
-// @vitest-environment jsdom
-
-import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
-import { initializeNavigationProgress } from './navigation-progress';
-
-const dispatchNavigationEvent = (name: string, sourceElement?: HTMLElement) => {
-  const event = new Event(name) as Event & { sourceElement?: HTMLElement };
-  event.sourceElement = sourceElement;
-  document.dispatchEvent(event);
-};
-
-describe('navigation progress', () => {
-  let cleanup: () => void;
-
-  beforeEach(() => {
-    vi.useFakeTimers();
-    document.body.innerHTML = `
-      <a id="navigation-link" href="/next">Next page</a>
-      <div id="navigation-progress" data-visible="false" aria-hidden="true"></div>
-      <span id="navigation-progress-status"></span>
-      <main id="content"></main>
-    `;
-    cleanup = initializeNavigationProgress();
-  });
-
-  afterEach(() => {
-    cleanup();
-    vi.useRealTimers();
-  });
-
-  it('does not show the indicator for fast navigations', () => {
-    const link = document.getElementById('navigation-link')!;
-
-    dispatchNavigationEvent('astro:before-preparation', link);
-    vi.advanceTimersByTime(199);
-    dispatchNavigationEvent('astro:after-preparation');
-    vi.runAllTimers();
-
-    expect(document.getElementById('navigation-progress')?.dataset.visible).toBe('false');
-    expect(link.hasAttribute('aria-busy')).toBe(false);
-    expect(document.getElementById('content')?.hasAttribute('aria-busy')).toBe(false);
-  });
-
-  it('shows accessible pending state during slow navigations', () => {
-    const link = document.getElementById('navigation-link')!;
-
-    dispatchNavigationEvent('astro:before-preparation', link);
-    expect(link.getAttribute('aria-busy')).toBe('true');
-    expect(link.dataset.navigationPending).toBe('true');
-
-    vi.advanceTimersByTime(200);
-
-    expect(document.getElementById('navigation-progress')?.dataset.visible).toBe('true');
-    expect(document.getElementById('navigation-progress')?.getAttribute('aria-hidden')).toBe('false');
-    expect(document.getElementById('content')?.getAttribute('aria-busy')).toBe('true');
-    expect(document.getElementById('navigation-progress-status')?.textContent).toBe('Loading page');
-
-    dispatchNavigationEvent('astro:after-preparation');
-    vi.advanceTimersByTime(249);
-    expect(document.getElementById('navigation-progress')?.dataset.visible).toBe('true');
-
-    vi.advanceTimersByTime(1);
-    expect(document.getElementById('navigation-progress')?.dataset.visible).toBe('false');
-    expect(link.hasAttribute('data-navigation-pending')).toBe(false);
-    expect(document.getElementById('content')?.hasAttribute('aria-busy')).toBe(false);
-    expect(document.getElementById('navigation-progress-status')?.textContent).toBe('');
-  });
-});