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

package/dist/eventcatalog.config.d.cts

@@ -197,6 +197,38 @@ type McpConfig = {
     enabled?: boolean;
     auth?: McpAuthConfig;
 };
+/**
+ * The state EventCatalog keeps for features that need it (today, Studio's canvases). Features always work on a copy
+ * held in memory by the server, so storage doesn't slow them down: it's read when the server starts and written a
+ * moment after something changes (and as the server stops).
+ */
+type StorageConfig = 
+/** Kept only while the server runs: lost when it restarts or redeploys (the default) */
+{
+    type: 'memory';
+}
+/**
+ * One SQLite database file for the whole catalog, brought up to date (migrated) as `eventcatalog dev` and
+ * `eventcatalog start` start. Uses Node.js's built-in SQLite, so needs Node.js 22.13 or later.
+ */
+ | {
+    type: 'sqlite';
+    /**
+     * The database file, relative to the catalog. In a container, put it on a volume (e.g. `/data/eventcatalog.db`)
+     * so it survives redeploys.
+     * @default '.eventcatalog/eventcatalog.db'
+     */
+    path?: string;
+};
+type StudioConfig = {
+    /**
+     * Turns Studio on in production (`output: 'server'`, served with `eventcatalog start`). It's on in the dev server
+     * unless this is `false`, which turns it off everywhere. Experimental. With authentication on, only signed-in people
+     * can open canvases, and they're shown by the name and picture they signed in with.
+     * @default false
+     */
+    enabled?: boolean;
+};
 type GA4Config = {
     measurementId: string;
 };
@@ -257,6 +289,17 @@ interface Config {
     };
     security?: {
         checkOrigin?: boolean;
+        /**
+         * Hosts to trust in a proxy's X-Forwarded-Host and X-Forwarded-Proto headers (server output), e.g. when deployed
+         * behind Fly.io, Railway or a load balancer that serves HTTPS. Without it, form posts (like starting a canvas in
+         * Studio) fail the origin check. Passed to Astro's `security.allowedDomains`.
+         * @example [{ hostname: 'catalog.example.com', protocol: 'https' }]
+         */
+        allowedDomains?: {
+            hostname?: string;
+            protocol?: string;
+            port?: string;
+        }[];
     };
     /**
      * Theme for the catalog UI.
@@ -270,6 +313,13 @@ interface Config {
     theme?: CatalogTheme;
     auth?: AuthConfig;
     mcp?: McpConfig;
+    /** EventCatalog Studio: collaborative canvases (experimental) */
+    studio?: StudioConfig;
+    /**
+     * Where EventCatalog keeps state between restarts (e.g. Studio's canvases), for every feature that has some.
+     * @default { type: 'memory' }
+     */
+    storage?: StorageConfig;
     rss?: {
         enabled?: boolean;
         limit?: number;
@@ -410,6 +460,14 @@ interface Config {
     queries?: {
         tableConfiguration?: TableConfiguration;
     };
+    /**
+     * Anonymous telemetry for `eventcatalog dev` and `eventcatalog build`.
+     * On by default. Set to false to opt out.
+     * `EVENTCATALOG_TELEMETRY_DISABLED` or `DO_NOT_TRACK` set to `1` or `true` also opts out.
+     * `cloud.analytics` stays its own opt-in for EventCatalog Cloud.
+     * @default true
+     */
+    telemetry?: boolean;
     cloud?: EventCatalogCloudConfig;
     integrations?: IntegrationsConfig;
     scalarConfiguration?: ScalarConfiguration;
@@ -418,4 +476,4 @@ interface Config {
     federation?: FederationConfig;
 }
 
-export type { Config, FederationRuleId, FederationRuleLevel, FederationRulesConfig, FederationSourceConfig };
+export type { Config, FederationRuleId, FederationRuleLevel, FederationRulesConfig, FederationSourceConfig, StorageConfig };

package/dist/eventcatalog.config.d.ts

@@ -197,6 +197,38 @@ type McpConfig = {
     enabled?: boolean;
     auth?: McpAuthConfig;
 };
+/**
+ * The state EventCatalog keeps for features that need it (today, Studio's canvases). Features always work on a copy
+ * held in memory by the server, so storage doesn't slow them down: it's read when the server starts and written a
+ * moment after something changes (and as the server stops).
+ */
+type StorageConfig = 
+/** Kept only while the server runs: lost when it restarts or redeploys (the default) */
+{
+    type: 'memory';
+}
+/**
+ * One SQLite database file for the whole catalog, brought up to date (migrated) as `eventcatalog dev` and
+ * `eventcatalog start` start. Uses Node.js's built-in SQLite, so needs Node.js 22.13 or later.
+ */
+ | {
+    type: 'sqlite';
+    /**
+     * The database file, relative to the catalog. In a container, put it on a volume (e.g. `/data/eventcatalog.db`)
+     * so it survives redeploys.
+     * @default '.eventcatalog/eventcatalog.db'
+     */
+    path?: string;
+};
+type StudioConfig = {
+    /**
+     * Turns Studio on in production (`output: 'server'`, served with `eventcatalog start`). It's on in the dev server
+     * unless this is `false`, which turns it off everywhere. Experimental. With authentication on, only signed-in people
+     * can open canvases, and they're shown by the name and picture they signed in with.
+     * @default false
+     */
+    enabled?: boolean;
+};
 type GA4Config = {
     measurementId: string;
 };
@@ -257,6 +289,17 @@ interface Config {
     };
     security?: {
         checkOrigin?: boolean;
+        /**
+         * Hosts to trust in a proxy's X-Forwarded-Host and X-Forwarded-Proto headers (server output), e.g. when deployed
+         * behind Fly.io, Railway or a load balancer that serves HTTPS. Without it, form posts (like starting a canvas in
+         * Studio) fail the origin check. Passed to Astro's `security.allowedDomains`.
+         * @example [{ hostname: 'catalog.example.com', protocol: 'https' }]
+         */
+        allowedDomains?: {
+            hostname?: string;
+            protocol?: string;
+            port?: string;
+        }[];
     };
     /**
      * Theme for the catalog UI.
@@ -270,6 +313,13 @@ interface Config {
     theme?: CatalogTheme;
     auth?: AuthConfig;
     mcp?: McpConfig;
+    /** EventCatalog Studio: collaborative canvases (experimental) */
+    studio?: StudioConfig;
+    /**
+     * Where EventCatalog keeps state between restarts (e.g. Studio's canvases), for every feature that has some.
+     * @default { type: 'memory' }
+     */
+    storage?: StorageConfig;
     rss?: {
         enabled?: boolean;
         limit?: number;
@@ -410,6 +460,14 @@ interface Config {
     queries?: {
         tableConfiguration?: TableConfiguration;
     };
+    /**
+     * Anonymous telemetry for `eventcatalog dev` and `eventcatalog build`.
+     * On by default. Set to false to opt out.
+     * `EVENTCATALOG_TELEMETRY_DISABLED` or `DO_NOT_TRACK` set to `1` or `true` also opts out.
+     * `cloud.analytics` stays its own opt-in for EventCatalog Cloud.
+     * @default true
+     */
+    telemetry?: boolean;
     cloud?: EventCatalogCloudConfig;
     integrations?: IntegrationsConfig;
     scalarConfiguration?: ScalarConfiguration;
@@ -418,4 +476,4 @@ interface Config {
     federation?: FederationConfig;
 }
 
-export type { Config, FederationRuleId, FederationRuleLevel, FederationRulesConfig, FederationSourceConfig };
+export type { Config, FederationRuleId, FederationRuleLevel, FederationRulesConfig, FederationSourceConfig, StorageConfig };

package/dist/eventcatalog.js

@@ -4,17 +4,18 @@ import {
 import "./chunk-CA4U2JP7.js";
 import {
   log_build_default
-} from "./chunk-KIDISU6X.js";
+} from "./chunk-5ZUN2TXB.js";
 import {
   getLicenseStatus,
   printLicenseStatus
-} from "./chunk-TQLRG35T.js";
+} from "./chunk-AWOO63ME.js";
 import "./chunk-ZAZHAVKB.js";
 import {
   FederationConflictError,
   FederationDiagnosticError,
   federateCatalog
-} from "./chunk-AYNZXUB5.js";
+} from "./chunk-KHACCTW2.js";
+import "./chunk-WRNH5C3U.js";
 import "./chunk-5EPNFDT5.js";
 import "./chunk-A2RZR3U4.js";
 import "./chunk-R7Z5ALYI.js";
@@ -24,7 +25,6 @@ import {
 } from "./chunk-JJPB6EOZ.js";
 import "./chunk-SDZQJTJW.js";
 import "./chunk-352FGP6W.js";
-import "./chunk-WRNH5C3U.js";
 import {
   getProjectOutDir,
   isAuthEnabled,
@@ -33,10 +33,10 @@ import {
 } from "./chunk-MDWB5HLO.js";
 import {
   generate
-} from "./chunk-HGRFXTFC.js";
+} from "./chunk-3VQSVQTU.js";
 import {
   logger
-} from "./chunk-4J2ZM2HX.js";
+} from "./chunk-F236OJZD.js";
 import {
   resolve_catalog_dependencies_default
 } from "./chunk-36RYTYT5.js";
@@ -50,7 +50,8 @@ import {
 import {
   watch
 } from "./chunk-U63GDPPY.js";
-import "./chunk-XARPIXWF.js";
+import "./chunk-FWH5T6U4.js";
+import "./chunk-CPW6G62V.js";
 import {
   getAstroConfigPath
 } from "./chunk-VIJJ7JKH.js";
@@ -66,7 +67,7 @@ import {
 } from "./chunk-LFQJXLHG.js";
 import {
   VERSION
-} from "./chunk-62EV4IJA.js";
+} from "./chunk-R2X4ZEF6.js";
 import {
   getEventCatalogConfigFile,
   verifyRequiredFieldsAreInCatalogConfigFile
@@ -79,7 +80,7 @@ import { join } from "path";
 import http from "http";
 import fs3 from "fs";
 import path2 from "path";
-import { fileURLToPath } from "url";
+import { fileURLToPath, pathToFileURL } from "url";
 import { createRequire } from "module";
 import boxen from "boxen";
 import updateNotifier from "update-notifier";
@@ -668,7 +669,7 @@ var resolveDevPort = async ({ projectDir }) => {
 };
 var startDevPrewarm = ({
   port = 3e3,
-  paths = ["/ping", "/"],
+  paths = ["/"],
   retries = 80,
   intervalMs = 250,
   initialDelayMs = 500
@@ -677,10 +678,13 @@ var startDevPrewarm = ({
   const hit = (requestPath) => new Promise((resolve) => {
     const req = http.get(
       {
-        hostname: "127.0.0.1",
+        // Not 127.0.0.1: the dev server can listen on IPv6 only ([::1]), which refused
+        // every prewarm request
+        hostname: "localhost",
         port,
         path: requestPath,
-        timeout: 1200
+        // A refused connection fails at once; once connected, let the first render finish
+        timeout: 3e4
       },
       (res) => {
         res.resume();
@@ -939,7 +943,9 @@ program.command("dev").description("Run development server of EventCatalog").opt
       });
       startDevPrewarm({
         port: prewarmPort,
-        paths: ["/ping", "/"]
+        // Renders the homepage before anyone opens it. Requests stop at the first response,
+        // so a probe path like /ping first would leave the homepage cold.
+        paths: ["/"]
       });
     }
     await runCommandWithFilteredOutput({
@@ -1028,15 +1034,33 @@ var previewCatalog = async ({ command }) => {
     shouldFilterLine: createAstroLineFilter()
   });
 };
+var SERVER_BOOTSTRAP = `
+const entry = await import(process.argv[1]);
+const { server } = entry.startServer();
+globalThis[Symbol.for('eventcatalog.http-server')] = server.server;
+const start = process.env.EVENTCATALOG_START_PATH;
+if (start) {
+  server.server.once('listening', () => {
+    // Where the server listens (HOST can be one address only); loopback when it listens on every address
+    const { address, port } = server.server.address();
+    const host = ['0.0.0.0', '::'].includes(address) ? '127.0.0.1' : address.includes(':') ? '[' + address + ']' : address;
+    fetch('http://' + host + ':' + port + start).catch((error) => console.error('[eventcatalog] Could not start the server:', error.message));
+  });
+}
+`;
 var startServerCatalog = async () => {
   const serverEntryPath = path2.join(dir, "dist", "server", "entry.mjs");
+  const config = await getEventCatalogConfigFile(dir);
+  const base = (config?.base || "/").replace(/\/$/, "");
   await runCommandWithFilteredOutput({
     command: process.execPath,
-    args: [serverEntryPath],
+    args: ["--input-type=module", "-e", SERVER_BOOTSTRAP, pathToFileURL(serverEntryPath).href],
     cwd: dir,
     env: {
       PROJECT_DIR: dir,
-      CATALOG_DIR: core
+      CATALOG_DIR: core,
+      ASTRO_NODE_AUTOSTART: "disabled",
+      EVENTCATALOG_START_PATH: `${base}/_eventcatalog/start`
     },
     shouldFilterLine: createAstroLineFilter()
   });

package/dist/federation/federate.js

@@ -2,14 +2,14 @@ import {
   FederationConflictError,
   FederationDiagnosticError,
   federateCatalog
-} from "../chunk-AYNZXUB5.js";
+} from "../chunk-KHACCTW2.js";
+import "../chunk-WRNH5C3U.js";
 import "../chunk-5EPNFDT5.js";
 import "../chunk-A2RZR3U4.js";
 import "../chunk-R7Z5ALYI.js";
 import "../chunk-JJPB6EOZ.js";
 import "../chunk-SDZQJTJW.js";
 import "../chunk-352FGP6W.js";
-import "../chunk-WRNH5C3U.js";
 import "../chunk-RFIXKATC.js";
 export {
   FederationConflictError,

package/dist/generate.cjs

@@ -112,7 +112,7 @@ var getEventCatalogConfigFile = async (projectDirectory) => {
 var import_picocolors = __toESM(require("picocolors"), 1);
 
 // package.json
-var version = "5.0.0-beta.2";
+var version = "5.0.0-beta.20";
 
 // src/constants.ts
 var VERSION = version;

package/dist/generate.js

@@ -1,8 +1,8 @@
 import {
   generate
-} from "./chunk-HGRFXTFC.js";
-import "./chunk-4J2ZM2HX.js";
-import "./chunk-62EV4IJA.js";
+} from "./chunk-3VQSVQTU.js";
+import "./chunk-F236OJZD.js";
+import "./chunk-R2X4ZEF6.js";
 import "./chunk-RFIXKATC.js";
 export {
   generate

package/dist/runtime-dependencies/@eventcatalog__visualiser__studio-fonts.css.mjs

@@ -0,0 +1,3 @@
+export * from "@eventcatalog/visualiser/studio-fonts.css";
+import * as dependency from "@eventcatalog/visualiser/studio-fonts.css";
+export default dependency.default;

package/dist/runtime-dependencies/@eventcatalog__visualiser__studio.css.mjs

@@ -0,0 +1,3 @@
+export * from "@eventcatalog/visualiser/studio.css";
+import * as dependency from "@eventcatalog/visualiser/studio.css";
+export default dependency.default;

package/dist/runtime-dependencies/@eventcatalog__visualiser__studio.mjs

@@ -0,0 +1,3 @@
+export * from "@eventcatalog/visualiser/studio";
+import * as dependency from "@eventcatalog/visualiser/studio";
+export default dependency.default;

package/dist/runtime-dependencies/@hocuspocus__provider.mjs

@@ -0,0 +1,3 @@
+export * from "@hocuspocus/provider";
+import * as dependency from "@hocuspocus/provider";
+export default dependency.default;

package/dist/runtime-dependencies/@hocuspocus__server.mjs

@@ -0,0 +1,3 @@
+export * from "@hocuspocus/server";
+import * as dependency from "@hocuspocus/server";
+export default dependency.default;

package/dist/runtime-dependencies/@mcp-b__webmcp-local-relay.mjs

@@ -0,0 +1,3 @@
+export * from "@mcp-b/webmcp-local-relay";
+import * as dependency from "@mcp-b/webmcp-local-relay";
+export default dependency.default;

package/dist/runtime-dependencies/@mcp-b__webmcp-polyfill.mjs

@@ -0,0 +1,3 @@
+export * from "@mcp-b/webmcp-polyfill";
+import * as dependency from "@mcp-b/webmcp-polyfill";
+export default dependency.default;

package/dist/runtime-dependencies/htmlparser2.mjs

@@ -0,0 +1,3 @@
+export * from "htmlparser2";
+import * as dependency from "htmlparser2";
+export default dependency.default;

package/dist/runtime-dependencies/manifest.json

@@ -21,6 +21,9 @@
   "@eventcatalog/sdk": "@eventcatalog__sdk.mjs",
   "@eventcatalog/visualiser": "@eventcatalog__visualiser.mjs",
   "@eventcatalog/visualiser/layout": "@eventcatalog__visualiser__layout.mjs",
+  "@eventcatalog/visualiser/studio": "@eventcatalog__visualiser__studio.mjs",
+  "@eventcatalog/visualiser/studio-fonts.css": "@eventcatalog__visualiser__studio-fonts.css.mjs",
+  "@eventcatalog/visualiser/studio.css": "@eventcatalog__visualiser__studio.css.mjs",
   "@eventcatalog/visualiser/styles-core.css": "@eventcatalog__visualiser__styles-core.css.mjs",
   "@fontsource/inter": "@fontsource__inter.mjs",
   "@fontsource/inter/400.css": "@fontsource__inter__400.css.mjs",
@@ -34,7 +37,11 @@
   "@heroicons/react/24/outline/RectangleGroupIcon": "@heroicons__react__24__outline__RectangleGroupIcon.mjs",
   "@heroicons/react/24/outline/ServerIcon": "@heroicons__react__24__outline__ServerIcon.mjs",
   "@heroicons/react/24/solid": "@heroicons__react__24__solid.mjs",
+  "@hocuspocus/provider": "@hocuspocus__provider.mjs",
+  "@hocuspocus/server": "@hocuspocus__server.mjs",
   "@iconify-json/logos": "@iconify-json__logos.mjs",
+  "@mcp-b/webmcp-local-relay": "@mcp-b__webmcp-local-relay.mjs",
+  "@mcp-b/webmcp-polyfill": "@mcp-b__webmcp-polyfill.mjs",
   "@mermaid-js/layout-elk": "@mermaid-js__layout-elk.mjs",
   "@mermaid-js/layout-elk/dist/mermaid-layout-elk.core.mjs": "@mermaid-js__layout-elk__dist__mermaid-layout-elk.core.mjs.mjs",
   "@modelcontextprotocol/ext-apps": "@modelcontextprotocol__ext-apps.mjs",
@@ -87,6 +94,7 @@
   "gray-matter": "gray-matter.mjs",
   "hono": "hono.mjs",
   "html-to-image": "html-to-image.mjs",
+  "htmlparser2": "htmlparser2.mjs",
   "js-yaml": "js-yaml.mjs",
   "jsonpath-plus": "jsonpath-plus.mjs",
   "jsonwebtoken": "jsonwebtoken.mjs",
@@ -107,8 +115,10 @@
   "react-dom": "react-dom.mjs",
   "react-dom/client": "react-dom__client.mjs",
   "react-dom/server": "react-dom__server.mjs",
+  "react-hotkeys-hook": "react-hotkeys-hook.mjs",
   "react-markdown": "react-markdown.mjs",
   "react-syntax-highlighter": "react-syntax-highlighter.mjs",
+  "react-syntax-highlighter/dist/cjs/create-element.js": "react-syntax-highlighter__dist__cjs__create-element.js.mjs",
   "react-syntax-highlighter/dist/cjs/styles/prism": "react-syntax-highlighter__dist__cjs__styles__prism.mjs",
   "react-syntax-highlighter/dist/cjs/styles/prism/index.js": "react-syntax-highlighter__dist__cjs__styles__prism__index.js.mjs",
   "react-syntax-highlighter/dist/esm/languages/prism/graphql": "react-syntax-highlighter__dist__esm__languages__prism__graphql.mjs",
@@ -132,7 +142,6 @@
   "rimraf": "rimraf.mjs",
   "semver": "semver.mjs",
   "set-cookie-parser": "set-cookie-parser.mjs",
-  "shelljs": "shelljs.mjs",
   "sonner": "sonner.mjs",
   "sql.js": "sql.js.mjs",
   "tailwindcss": "tailwindcss.mjs",
@@ -140,6 +149,9 @@
   "unist-util-visit": "unist-util-visit.mjs",
   "update-notifier": "update-notifier.mjs",
   "uuid": "uuid.mjs",
+  "y-protocols": "y-protocols.mjs",
+  "y-protocols/awareness": "y-protocols__awareness.mjs",
+  "yjs": "yjs.mjs",
   "zod": "zod.mjs",
   "zod/v4": "zod__v4.mjs"
 }

package/dist/runtime-dependencies/react-hotkeys-hook.mjs

@@ -0,0 +1,3 @@
+export * from "react-hotkeys-hook";
+import * as dependency from "react-hotkeys-hook";
+export default dependency.default;

package/dist/runtime-dependencies/react-syntax-highlighter__dist__cjs__create-element.js.mjs

@@ -0,0 +1,3 @@
+export * from "react-syntax-highlighter/dist/cjs/create-element.js";
+import * as dependency from "react-syntax-highlighter/dist/cjs/create-element.js";
+export default dependency.default;

package/dist/runtime-dependencies/y-protocols.mjs

@@ -0,0 +1,3 @@
+export * from "y-protocols";
+import * as dependency from "y-protocols";
+export default dependency.default;

package/dist/runtime-dependencies/y-protocols__awareness.mjs

@@ -0,0 +1,3 @@
+export * from "y-protocols/awareness";
+import * as dependency from "y-protocols/awareness";
+export default dependency.default;

package/dist/runtime-dependencies/yjs.mjs

@@ -0,0 +1,3 @@
+export * from "yjs";
+import * as dependency from "yjs";
+export default dependency.default;

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.0.0-beta.2";
+var version = "5.0.0-beta.20";
 
 // src/constants.ts
 var VERSION = version;

package/dist/utils/cli-logger.js

@@ -1,7 +1,7 @@
 import {
   logger
-} from "../chunk-4J2ZM2HX.js";
-import "../chunk-62EV4IJA.js";
+} from "../chunk-F236OJZD.js";
+import "../chunk-R2X4ZEF6.js";
 export {
   logger
 };