github event-catalog/eventcatalog @eventcatalog/core@4.0.0

latest releases: @eventcatalog/core@4.0.2, @eventcatalog/core@4.0.1, @eventcatalog/linter@1.1.3...
7 hours ago

Major Changes

  • 728ca67: Add support for a new systems collection. Systems are a versioned resource that can be defined in any folder (including inside domains), rendered as documentation pages, and listed in the sidebar with their own icon and color. Systems can group services, flows, entities, data stores (containers), and diagrams, have their own architecture overview page (/architecture/systems/[id]) listing their entities, services, external integrations, data stores, and flows, be visualised as an architecture map, be browsed and filtered on a dedicated discover page (/discover/systems), and be targeted by architecture decision records (appliesTo: [{ type: 'system' }]). Domains can reference one or more systems, which are listed in the domain sidebar, rendered as expandable sections on the domain's architecture page (listing the system's services, like subdomains, with external services shown under "External Integrations"), and merged into the domain's architecture map (each referenced system's services are grouped within the domain graph). Teams and users can own systems, which are surfaced on their profile pages.

    Systems can also declare relationships to other systems (each with an optional version and label), which power a new Context Diagram visualiser (/visualiser/systems/[id]/[version]/context, linked from the system sidebar under Architecture). Starting from a system, the diagram walks its relationships outward to build the reachable neighbourhood of systems, rendering each as a node (showing its service, entity, and data store counts) connected by labelled edges. Clicking a system node opens that system's architecture map.

    Systems support a scope of internal (default) or external. External systems represent third-party/SaaS systems you integrate with (e.g. "Resend", "Stripe") and are shaded and badged as "External System" in the Context Diagram.

    Systems can also declare actors — people or roles that interact with the system (e.g. a Customer or Support Agent). Each actor has an id (used to de-duplicate the same actor across systems), an optional name/label, and a direction (inbound = actor → system, e.g. "logs into"; outbound = system → actor, e.g. "sends notifications to"). Actors are rendered as nodes on the Context Diagram connected to their system by a labelled, directional edge.

Minor Changes

  • cc936ab: Add configurable navigation groups for the vertical sidebar. You can now define custom navigation groups and items via navigation.groups in your eventcatalog.config.ts, including custom labels, Lucide icons, hrefs, external links, active-state matching, and top/bottom positioning. This replaces the previous sidebar visibility config.
  • f02e737: Add a dedicated "Top level diagrams" navigation group that surfaces the System Context Map below top-level domains in the sidebar.
  • e1c3984: Upgrade to Astro 7 and migrate markdown/MDX config to the new unified processor API

Patch Changes

  • 6f1790b: Replace the resource-specific Browse sidebar links with a single Discover link and add a Kind filter to discover pages for switching between available resource collections.
  • bea8571: Rebuild the create-eventcatalog default template with a new e-commerce catalog (domains, systems, services, messages) and fix the collapsed vertical nav brand link alignment.
  • 15aabba: Fix dev watcher incorrectly matching generated files when IGNORE_BUILD_ARTIFACTS is set. Build-artifact exclusions are now skipped in dev mode, since Astro's watcher uses picomatch against the pattern array where negated patterns caused unrelated generated files to match.
  • a99dc45: Remove the Export to PDF / print feature and make diagram version comparison available to everyone (no longer gated behind the Scale plan)
  • 86148d9: Add systems support to AI Chat, catalog tools, and sidebar navigation. The chat panel now recognises system pages and resources, the AI tools accept the systems collection, the custom documentation page renders the System Context Map when a domain has systems, and the System section in the sidebar shows the System Context Map when systems exist.
  • d64cfab: Add systems support to the SDK. Systems are a new resource type that can group services, flows, entities, and containers, and can be nested within domains. Includes helpers to read and write systems, add resources to a system, write resources directly into a system, and add systems to domains.
  • Updated dependencies [9949f9f]
  • Updated dependencies [728ca67]
  • Updated dependencies [d64cfab]
    • @eventcatalog/sdk@2.25.0
    • @eventcatalog/visualiser@4.0.0
    • @eventcatalog/linter@1.1.2

Don't miss a new eventcatalog release

NewReleases is sending notifications on new releases.