@eventcatalog/core 5.1.0 → 5.1.1

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 = "5.1.0";
+var version = "5.1.1";
 
 // src/constants.ts
 var VERSION = version;

package/dist/analytics/analytics.js

@@ -1,8 +1,8 @@
 import {
   raiseEvent
-} from "../chunk-FHZXZWCY.js";
+} from "../chunk-UCUZ44U2.js";
 import "../chunk-CPW6G62V.js";
-import "../chunk-OT57IOWN.js";
+import "../chunk-GKEHJQ5K.js";
 export {
   raiseEvent
 };

package/dist/analytics/log-build.cjs

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

package/dist/analytics/log-build.js

@@ -1,12 +1,12 @@
 import {
   log_build_default
-} from "../chunk-G3CHTDAE.js";
+} from "../chunk-BEBDEEDY.js";
 import "../chunk-AD7CL772.js";
-import "../chunk-FHZXZWCY.js";
+import "../chunk-UCUZ44U2.js";
 import "../chunk-ZAZHAVKB.js";
 import "../chunk-CA6WCQ2T.js";
 import "../chunk-CPW6G62V.js";
-import "../chunk-OT57IOWN.js";
+import "../chunk-GKEHJQ5K.js";
 import "../chunk-4G7FSRPN.js";
 export {
   log_build_default as default

package/dist/{chunk-TBXLUIJD.js → chunk-BAUH53EV.js}

@@ -1,6 +1,6 @@
 import {
   logger
-} from "./chunk-WBUSFEBH.js";
+} from "./chunk-NJTLAFFT.js";
 import {
   cleanup,
   getEventCatalogConfigFile

package/dist/{chunk-G3CHTDAE.js → chunk-BEBDEEDY.js}

@@ -3,7 +3,7 @@ import {
 } from "./chunk-AD7CL772.js";
 import {
   raiseEvent
-} from "./chunk-FHZXZWCY.js";
+} from "./chunk-UCUZ44U2.js";
 import {
   countResources,
   hashCatalogContent,

package/dist/{chunk-OT57IOWN.js → chunk-GKEHJQ5K.js}

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

package/dist/{chunk-WBUSFEBH.js → chunk-NJTLAFFT.js}

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

package/dist/{chunk-FHZXZWCY.js → chunk-UCUZ44U2.js}

@@ -4,7 +4,7 @@ import {
 } from "./chunk-CPW6G62V.js";
 import {
   VERSION
-} from "./chunk-OT57IOWN.js";
+} from "./chunk-GKEHJQ5K.js";
 
 // src/analytics/analytics.js
 import os from "os";

package/dist/constants.cjs

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

package/dist/constants.js

@@ -1,6 +1,6 @@
 import {
   VERSION
-} from "./chunk-OT57IOWN.js";
+} from "./chunk-GKEHJQ5K.js";
 export {
   VERSION
 };

package/dist/docs/api/02-config.md

@@ -968,6 +968,27 @@ Enable tools like Claude, ChatGPT, GitHub Copilot, and Cursor to quickly underst
 See the [LLMs documentation](/docs/development/ask-your-architecture/llms.txt) for more information, how you can use it and examples.
 
 
+### `exports.html` {#exports.html}
+
+<AddedIn version="5.1.0" />
+
+- Type: `object`
+- Default: `{ enabled: true }` (`false` when your catalog uses authentication)
+
+Controls the [architecture reference](/docs/development/guides/architecture-reference): your whole catalog as one HTML file, written to `architecture.html` in your build output on every build.
+
+```js title="eventcatalog.config.js"
+module.exports = {
+  exports: {
+    html: {
+      enabled: false, // default is true
+    },
+  },
+};
+```
+
+Catalogs with authentication only get the reference when `enabled` is `true`, because files in the build output are served without the authentication checks.
+
 ### `fullCatalogAPIEnabled` {#fullCatalogAPIEnabled}
 
 <AddedIn version="3.10.2" />

package/dist/docs/development/guides/96-architecture-reference.md

@@ -0,0 +1,95 @@
+---
+sidebar_position: 96
+keywords:
+- EventCatalog architecture reference
+- Export architecture documentation
+- Single HTML file
+- Share architecture
+sidebar_label: Architecture Reference
+title: Architecture reference
+description: Export your whole catalog as one self-contained HTML file you can share, attach or host anywhere.
+---
+
+import AddedIn from '@site/src/components/MDX/AddedIn';
+
+<AddedIn version="5.1.0" />
+
+The architecture reference is your whole catalog in **one self-contained HTML file**. Every domain, system, service, message, channel, data store, flow, entity and team gets its own section, linked to everything it relates to.
+
+It doesn't need a server: everything is in the file, so you can attach it to an email, add it to a design review, keep it with an audit, or host it next to your catalog.
+
+![The overview of an architecture reference, listing the domains, systems and services in the sidebar and a summary of the catalog](./img/architecture-reference-overview.png)
+
+[See demo architecture reference](https://demo.eventcatalog.dev/architecture.html)
+
+## What's in it
+
+- **An overview of the catalog**, with how many of each resource it documents.
+- **A section for every resource**, with its summary, owners, badges and documentation (including mermaid diagrams).
+- **Relationships on every section**: who produces and consumes a message, what a service sends and receives, which services read and write a data store, what lives inside a domain or system. Every relationship is a link.
+- **Message attributes** from your JSON Schema, Avro and Protobuf schemas, with an example payload, a TypeScript type and the raw schema.
+- **Your specifications** (OpenAPI, AsyncAPI and GraphQL), which you can view and download from the page.
+- **Flows**, step by step, with every resource each step touches.
+- **Search** across the document (press `⌘K` or `Ctrl+K`), a sidebar filter, and light and dark themes.
+
+Only the latest version of each resource is included. Resources marked as hidden are left out.
+
+![A message in the architecture reference, with its attributes, producers, consumers and an example payload](./img/architecture-reference-message.png)
+
+## Get it on every build
+
+The reference is generated every time you build your catalog. You don't need to set anything up.
+
+```bash
+npm run build
+```
+
+It is written to `dist/architecture.html`, or to `dist/client/architecture.html` when your catalog [runs in server mode](/docs/development/deployment/build-ssr-mode). Wherever you host your catalog, the reference is available at `/architecture.html`.
+
+### Turn it off
+
+Set `exports.html.enabled` to `false` in your `eventcatalog.config.js` file:
+
+```js title="eventcatalog.config.js"
+module.exports = {
+  exports: {
+    html: {
+      enabled: false,
+    },
+  },
+};
+```
+
+### Catalogs with authentication
+
+If your catalog uses [authentication](/docs/development/authentication/introduction), the reference is **not** generated unless you turn it on. Files in the build output are served without the authentication checks, so anyone who knows the URL could read it.
+
+To generate it anyway, set `exports.html.enabled` to `true`.
+
+## Export it with the CLI
+
+Use the [`export` command](/docs/cli/cli-export) of the [EventCatalog CLI](/docs/cli) to export the reference on demand, without building the catalog. From the root of your catalog, run:
+
+```bash
+npx @eventcatalog/cli export --format html
+```
+
+This writes `architecture.html` and opens it in your browser.
+
+| Option | Description |
+| --- | --- |
+| `--output <path>` | Where to write the file. Defaults to `architecture.html` |
+| `--no-open` | Don't open the reference in your browser (useful in CI) |
+| `--dir <path>` | Path to your catalog, if you aren't running the command from it |
+
+For example, to export the reference in a CI pipeline and publish it as a build artifact:
+
+```bash
+npx @eventcatalog/cli export --format html --output reports/architecture.html --no-open
+```
+
+## Sharing the reference
+
+The reference uses the `title`, `organizationName` and `logo` from your `eventcatalog.config.js` file. When you share a link to a hosted reference in Slack, Teams or on social media, the preview shows the catalog's name and what it documents.
+
+The file shows when it was generated, and the command to generate it again.

package/dist/eventcatalog.cjs

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

package/dist/eventcatalog.js

@@ -7,12 +7,12 @@ import {
 import "./chunk-CA4U2JP7.js";
 import {
   log_build_default
-} from "./chunk-G3CHTDAE.js";
+} from "./chunk-BEBDEEDY.js";
 import {
   getLicenseStatus,
   printLicenseStatus
 } from "./chunk-AD7CL772.js";
-import "./chunk-FHZXZWCY.js";
+import "./chunk-UCUZ44U2.js";
 import "./chunk-ZAZHAVKB.js";
 import "./chunk-CA6WCQ2T.js";
 import "./chunk-CPW6G62V.js";
@@ -39,10 +39,10 @@ import {
 } from "./chunk-NKNOXQ62.js";
 import {
   generate
-} from "./chunk-TBXLUIJD.js";
+} from "./chunk-BAUH53EV.js";
 import {
   logger
-} from "./chunk-WBUSFEBH.js";
+} from "./chunk-NJTLAFFT.js";
 import {
   resolve_catalog_dependencies_default
 } from "./chunk-PD7KTSYN.js";
@@ -76,7 +76,7 @@ import {
 } from "./chunk-LFQJXLHG.js";
 import {
   VERSION
-} from "./chunk-OT57IOWN.js";
+} from "./chunk-GKEHJQ5K.js";
 import {
   getEventCatalogConfigFile,
   verifyRequiredFieldsAreInCatalogConfigFile

package/dist/generate.cjs

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

package/dist/generate.js

@@ -1,8 +1,8 @@
 import {
   generate
-} from "./chunk-TBXLUIJD.js";
-import "./chunk-WBUSFEBH.js";
-import "./chunk-OT57IOWN.js";
+} from "./chunk-BAUH53EV.js";
+import "./chunk-NJTLAFFT.js";
+import "./chunk-GKEHJQ5K.js";
 import "./chunk-4G7FSRPN.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 = "5.1.0";
+var version = "5.1.1";
 
 // src/constants.ts
 var VERSION = version;

package/dist/utils/cli-logger.js

@@ -1,7 +1,7 @@
 import {
   logger
-} from "../chunk-WBUSFEBH.js";
-import "../chunk-OT57IOWN.js";
+} from "../chunk-NJTLAFFT.js";
+import "../chunk-GKEHJQ5K.js";
 export {
   logger
 };

package/package.json

@@ -7,7 +7,7 @@
   },
   "license": "BUSL-1.1",
   "type": "module",
-  "version": "5.1.0",
+  "version": "5.1.1",
   "publishConfig": {
     "access": "public"
   },
@@ -140,10 +140,10 @@
     "y-protocols": "^1.0.7",
     "yjs": "^13.6.33",
     "zod": "^4.6.6",
-    "@eventcatalog/exporters": "0.0.2",
-    "@eventcatalog/linter": "1.2.1",
+    "@eventcatalog/exporters": "0.0.3",
     "@eventcatalog/sdk": "2.30.0",
-    "@eventcatalog/visualiser": "^5.0.0"
+    "@eventcatalog/visualiser": "^5.0.0",
+    "@eventcatalog/linter": "1.2.1"
   },
   "devDependencies": {
     "@astrojs/check": "^0.9.10",