@eventcatalog/core 5.0.0-beta.8 → 5.0.0

package/dist/eventcatalog.config.d.cts

@@ -198,22 +198,25 @@ type McpConfig = {
     auth?: McpAuthConfig;
 };
 /**
- * Where EventCatalog Studio keeps canvases. People and agents always work on the copy held in memory by the
- * server, so storage doesn't slow editing down: it's read when the server starts and written a moment after a
- * canvas changes (and as the server stops).
+ * 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 StudioStorageConfig = 
-/** Kept only while the server runs: canvases are lost when it restarts or redeploys (the default) */
+type StorageConfig = 
+/** Kept only while the server runs: lost when it restarts or redeploys (the default) */
 {
     type: 'memory';
 }
-/** A SQLite database file. Uses Node.js's built-in SQLite, so needs Node.js 22.13 or later. */
+/**
+ * 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/studio.db`)
-     * so canvases survive redeploys.
-     * @default '.eventcatalog/studio.db'
+     * 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;
 };
@@ -225,11 +228,6 @@ type StudioConfig = {
      * @default false
      */
     enabled?: boolean;
-    /**
-     * Where canvases are kept between restarts.
-     * @default { type: 'memory' }
-     */
-    storage?: StudioStorageConfig;
 };
 type GA4Config = {
     measurementId: string;
@@ -317,6 +315,11 @@ interface Config {
     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;
@@ -457,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;
@@ -465,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

@@ -198,22 +198,25 @@ type McpConfig = {
     auth?: McpAuthConfig;
 };
 /**
- * Where EventCatalog Studio keeps canvases. People and agents always work on the copy held in memory by the
- * server, so storage doesn't slow editing down: it's read when the server starts and written a moment after a
- * canvas changes (and as the server stops).
+ * 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 StudioStorageConfig = 
-/** Kept only while the server runs: canvases are lost when it restarts or redeploys (the default) */
+type StorageConfig = 
+/** Kept only while the server runs: lost when it restarts or redeploys (the default) */
 {
     type: 'memory';
 }
-/** A SQLite database file. Uses Node.js's built-in SQLite, so needs Node.js 22.13 or later. */
+/**
+ * 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/studio.db`)
-     * so canvases survive redeploys.
-     * @default '.eventcatalog/studio.db'
+     * 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;
 };
@@ -225,11 +228,6 @@ type StudioConfig = {
      * @default false
      */
     enabled?: boolean;
-    /**
-     * Where canvases are kept between restarts.
-     * @default { type: 'memory' }
-     */
-    storage?: StudioStorageConfig;
 };
 type GA4Config = {
     measurementId: string;
@@ -317,6 +315,11 @@ interface Config {
     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;
@@ -457,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;
@@ -465,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

@@ -2,45 +2,48 @@ import {
   runMigrations
 } from "./chunk-XUAF2H54.js";
 import "./chunk-CA4U2JP7.js";
+import {
+  stopChildWithParent
+} from "./chunk-S5GWAUG5.js";
 import {
   log_build_default
-} from "./chunk-4W55ZOOS.js";
+} from "./chunk-NEAVAFSJ.js";
 import {
   getLicenseStatus,
   printLicenseStatus
-} from "./chunk-AWOO63ME.js";
+} from "./chunk-AD7CL772.js";
 import "./chunk-ZAZHAVKB.js";
+import "./chunk-CA6WCQ2T.js";
 import {
   FederationConflictError,
   FederationDiagnosticError,
   federateCatalog
-} from "./chunk-AYNZXUB5.js";
+} from "./chunk-OX6TSVHY.js";
+import "./chunk-WRNH5C3U.js";
 import "./chunk-5EPNFDT5.js";
-import "./chunk-A2RZR3U4.js";
+import "./chunk-6K7XZAYI.js";
+import "./chunk-352FGP6W.js";
 import "./chunk-R7Z5ALYI.js";
 import {
   getFederationDiagnosticCounts,
   getVisibleFederationDiagnostics
 } from "./chunk-JJPB6EOZ.js";
 import "./chunk-SDZQJTJW.js";
-import "./chunk-352FGP6W.js";
-import "./chunk-WRNH5C3U.js";
 import {
   getProjectOutDir,
   isAuthEnabled,
   isIndexedSearchEnabled,
-  isOutputServer,
-  isStudioEnabled
-} from "./chunk-ENAG6UH7.js";
+  isOutputServer
+} from "./chunk-NKNOXQ62.js";
 import {
   generate
-} from "./chunk-T4G3VVZ4.js";
+} from "./chunk-YQGRMDRB.js";
 import {
   logger
-} from "./chunk-PU25TOOJ.js";
+} from "./chunk-JZN4RSMF.js";
 import {
   resolve_catalog_dependencies_default
-} from "./chunk-36RYTYT5.js";
+} from "./chunk-PD7KTSYN.js";
 import {
   buildSearchIndex
 } from "./chunk-DJCOJ77J.js";
@@ -51,7 +54,8 @@ import {
 import {
   watch
 } from "./chunk-U63GDPPY.js";
-import "./chunk-C6T2AAFR.js";
+import "./chunk-NIVST4WY.js";
+import "./chunk-CPW6G62V.js";
 import {
   getAstroConfigPath
 } from "./chunk-VIJJ7JKH.js";
@@ -67,11 +71,11 @@ import {
 } from "./chunk-LFQJXLHG.js";
 import {
   VERSION
-} from "./chunk-RDIZJ7UT.js";
+} from "./chunk-RE7UTPWH.js";
 import {
   getEventCatalogConfigFile,
   verifyRequiredFieldsAreInCatalogConfigFile
-} from "./chunk-RFIXKATC.js";
+} from "./chunk-4G7FSRPN.js";
 
 // src/eventcatalog.ts
 import { Command } from "commander";
@@ -638,6 +642,7 @@ async function buildFieldsIndex(catalogDir, outputDir) {
 // src/eventcatalog.ts
 var currentDir = path2.dirname(fileURLToPath(import.meta.url));
 var astroCli = path2.join(path2.dirname(createRequire(import.meta.url).resolve("astro/package.json")), "bin/astro.mjs");
+var ASTRO_IN_FOREGROUND = { ASTRO_DEV_BACKGROUND: "1", ASTRO_PREVIEW_BACKGROUND: "1" };
 var program = new Command().version(VERSION);
 var dir = path2.resolve(process.env.PROJECT_DIR || process.cwd());
 var eventCatalogDir = path2.resolve(join(currentDir, "../eventcatalog/"));
@@ -669,7 +674,7 @@ var resolveDevPort = async ({ projectDir }) => {
 };
 var startDevPrewarm = ({
   port = 3e3,
-  paths = ["/ping", "/"],
+  paths = ["/"],
   retries = 80,
   intervalMs = 250,
   initialDelayMs = 500
@@ -678,10 +683,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();
@@ -779,10 +787,14 @@ var runCommandWithFilteredOutput = async ({
       cwd,
       env: {
         ...process.env,
+        // Astro sends usage data (commands, config, machine details) to Astro by default: turn it off
+        // for everyone using EventCatalog
+        ASTRO_TELEMETRY_DISABLED: "1",
         ...env
       },
       stdio: ["inherit", "pipe", "pipe"]
     });
+    const signals = stopChildWithParent(child);
     let stdoutBuffer = "";
     let stderrBuffer = "";
     const flush = (buffer, writer, isFinal = false) => {
@@ -810,11 +822,13 @@ var runCommandWithFilteredOutput = async ({
       stderrBuffer = flush(stderrBuffer, process.stderr);
     });
     child.on("error", (error) => {
+      signals.childClosed();
       reject(error);
     });
     child.on("close", (code) => {
       stdoutBuffer = flush(stdoutBuffer, process.stdout, true);
       stderrBuffer = flush(stderrBuffer, process.stderr, true);
+      if (signals.childClosed()) return;
       if (code === 0) {
         resolve();
         return;
@@ -940,7 +954,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({
@@ -952,7 +968,8 @@ program.command("dev").description("Run development server of EventCatalog").opt
         CATALOG_DIR: core,
         EVENTCATALOG_DEV_MODE: "true",
         IGNORE_BUILD_ARTIFACTS: "true",
-        NODE_NO_WARNINGS: "1"
+        NODE_NO_WARNINGS: "1",
+        ...ASTRO_IN_FOREGROUND
       },
       shouldFilterLine: createAstroDevLineFilter(),
       transformLine: replaceAstroReadyVersionLine
@@ -1024,7 +1041,8 @@ var previewCatalog = async ({ command }) => {
     cwd: dir,
     env: {
       PROJECT_DIR: dir,
-      CATALOG_DIR: core
+      CATALOG_DIR: core,
+      ...ASTRO_IN_FOREGROUND
     },
     shouldFilterLine: createAstroLineFilter()
   });
@@ -1033,13 +1051,13 @@ var SERVER_BOOTSTRAP = `
 const entry = await import(process.argv[1]);
 const { server } = entry.startServer();
 globalThis[Symbol.for('eventcatalog.http-server')] = server.server;
-const wake = process.env.EVENTCATALOG_STUDIO_WAKE_PATH;
-if (wake) {
+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 + wake).catch((error) => console.error('[studio] Could not start Studio:', error.message));
+    fetch('http://' + host + ':' + port + start).catch((error) => console.error('[eventcatalog] Could not start the server:', error.message));
   });
 }
 `;
@@ -1055,7 +1073,7 @@ var startServerCatalog = async () => {
       PROJECT_DIR: dir,
       CATALOG_DIR: core,
       ASTRO_NODE_AUTOSTART: "disabled",
-      ...await isStudioEnabled() && { EVENTCATALOG_STUDIO_WAKE_PATH: `${base}/_eventcatalog/studio/wake` }
+      EVENTCATALOG_START_PATH: `${base}/_eventcatalog/start`
     },
     shouldFilterLine: createAstroLineFilter()
   });
@@ -1076,7 +1094,8 @@ program.command("start").description("Serves the contents of your eventcatalog b
   }
   const isServerOutput = await isOutputServer();
   if (isServerOutput) {
-    await getLicenseStatus(dir);
+    const license = await getLicenseStatus(dir);
+    void log_build_default(dir, { command: "start", license });
     await startServerCatalog();
   } else {
     await previewCatalog({ command });
@@ -1223,7 +1242,7 @@ program.addHelpText(
     Example: npx eventcatalog dev --debug -- --env=production --port=3000
   `
 );
-program.parseAsync().then(() => process.exit(0)).catch((err) => {
+program.parseAsync().then(() => process.exit()).catch((err) => {
   if (!(err instanceof FederationConflictError) && !(err instanceof FederationDiagnosticError)) console.error(err);
   process.exit(1);
 });

package/dist/features.cjs

@@ -33,8 +33,7 @@ __export(features_exports, {
   getProjectOutDir: () => getProjectOutDir,
   isAuthEnabled: () => isAuthEnabled,
   isIndexedSearchEnabled: () => isIndexedSearchEnabled,
-  isOutputServer: () => isOutputServer,
-  isStudioEnabled: () => isStudioEnabled
+  isOutputServer: () => isOutputServer
 });
 module.exports = __toCommonJS(features_exports);
 
@@ -49,65 +48,58 @@ var import_promises = require("fs/promises");
 var import_node_fs = require("fs");
 var import_node_path = __toESM(require("path"), 1);
 var import_node_url = require("url");
-var import_node_os = require("os");
+var import_node_module = require("module");
 async function cleanup(projectDirectory) {
   const filePath = import_node_path.default.join(projectDirectory, "eventcatalog.config.mjs");
   if ((0, import_node_fs.existsSync)(filePath)) {
     await (0, import_promises.rm)(filePath);
   }
 }
-var findNodeModulesDirectory = (directory) => {
-  let currentDirectory = directory;
-  while (true) {
-    const nodeModulesDirectory = import_node_path.default.join(currentDirectory, "node_modules");
-    if ((0, import_node_fs.existsSync)(nodeModulesDirectory)) {
-      return nodeModulesDirectory;
-    }
-    const parentDirectory = import_node_path.default.dirname(currentDirectory);
-    if (parentDirectory === currentDirectory) {
-      return void 0;
-    }
-    currentDirectory = parentDirectory;
-  }
+var hidesConfigModuleTypeWarning = false;
+var loads = 0;
+var hideConfigModuleTypeWarning = () => {
+  if (hidesConfigModuleTypeWarning) return;
+  hidesConfigModuleTypeWarning = true;
+  const emitWarning = process.emitWarning;
+  process.emitWarning = function(warning, ...args) {
+    const code = typeof args[0] === "object" ? args[0]?.code : args[1];
+    const message = typeof warning === "string" ? warning : warning?.message;
+    if (code === "MODULE_TYPELESS_PACKAGE_JSON" && message?.includes("eventcatalog.config.js")) return;
+    return emitWarning.call(this, warning, ...args);
+  };
 };
-var linkNodeModulesIntoTempDirectory = async ({ projectDirectory, tempDir }) => {
-  const nodeModulesDirectory = findNodeModulesDirectory(projectDirectory);
-  if (!nodeModulesDirectory) {
-    return;
-  }
-  await (0, import_promises.symlink)(nodeModulesDirectory, import_node_path.default.join(tempDir, "node_modules"), "dir");
+var AS_MODULE_QUERY = "eventcatalog-config-as-module";
+var loadsMarkedConfigsAsModules = false;
+var loadMarkedConfigsAsModules = () => {
+  if (loadsMarkedConfigsAsModules) return;
+  loadsMarkedConfigsAsModules = true;
+  const hook = `export async function load(url, context, nextLoad) {
+    return nextLoad(url, url.includes('${AS_MODULE_QUERY}=') ? { ...context, format: 'module' } : context);
+  }`;
+  (0, import_node_module.register)(`data:text/javascript,${encodeURIComponent(hook)}`);
 };
-var createTemporaryConfigDirectory = async (projectDirectory) => {
-  const nodeModulesDirectory = findNodeModulesDirectory(projectDirectory);
-  if (nodeModulesDirectory) {
-    return (0, import_promises.mkdtemp)(import_node_path.default.join(nodeModulesDirectory, ".eventcatalog-config-"));
+var isCommonJSPackage = async (projectDirectory) => {
+  try {
+    const packageJson = JSON.parse(await (0, import_promises.readFile)(import_node_path.default.join(projectDirectory, "package.json"), "utf-8"));
+    return packageJson?.type === "commonjs";
+  } catch {
+    return false;
   }
-  const tempDir = await (0, import_promises.mkdtemp)(import_node_path.default.join((0, import_node_os.tmpdir)(), "eventcatalog-config-"));
-  await linkNodeModulesIntoTempDirectory({ projectDirectory, tempDir });
-  return tempDir;
 };
 var getEventCatalogConfigFile = async (projectDirectory) => {
-  let tempDir;
   try {
-    let configFilePath = import_node_path.default.join(projectDirectory, "eventcatalog.config.js");
-    const filePath = import_node_path.default.join(projectDirectory, "package.json");
-    const packageJson = JSON.parse(await (0, import_promises.readFile)(filePath, "utf-8"));
-    if (packageJson?.type !== "module") {
-      tempDir = await createTemporaryConfigDirectory(projectDirectory);
-      configFilePath = import_node_path.default.join(tempDir, "eventcatalog.config.mjs");
-      await (0, import_promises.copyFile)(import_node_path.default.join(projectDirectory, "eventcatalog.config.js"), configFilePath);
-    }
-    const configFileURL = `${(0, import_node_url.pathToFileURL)(configFilePath).href}?t=${Date.now()}`;
+    hideConfigModuleTypeWarning();
+    const asModule = await isCommonJSPackage(projectDirectory);
+    if (asModule) loadMarkedConfigsAsModules();
+    const configFileURL = (0, import_node_url.pathToFileURL)(import_node_path.default.join(projectDirectory, "eventcatalog.config.js")).href;
+    const query = `${asModule ? AS_MODULE_QUERY : "loaded"}=${Date.now()}-${loads++}`;
     const config = await import(
       /* @vite-ignore */
-      configFileURL
+      `${configFileURL}?${query}`
     );
     return config.default;
   } finally {
     await cleanup(projectDirectory);
-    if (tempDir) {
-      await (0, import_promises.rm)(tempDir, { recursive: true, force: true });
-    }
   }
 };
 
@@ -122,10 +114,6 @@ var isOutputServer = async () => {
   const config = await getEventCatalogConfigFile(process.env.PROJECT_DIR || "");
   return config?.output === "server";
 };
-var isStudioEnabled = async () => {
-  const config = await getEventCatalogConfigFile(process.env.PROJECT_DIR || "");
-  return config?.output === "server" && config?.studio?.enabled === true;
-};
 var isIndexedSearchEnabled = async () => {
   const config = await getEventCatalogConfigFile(process.env.PROJECT_DIR || "");
   return config?.search?.type === "indexed";
@@ -140,6 +128,5 @@ var isAuthEnabled = async () => {
   getProjectOutDir,
   isAuthEnabled,
   isIndexedSearchEnabled,
-  isOutputServer,
-  isStudioEnabled
+  isOutputServer
 });

package/dist/features.d.cts

@@ -1,8 +1,6 @@
 declare const getProjectOutDir: () => Promise<any>;
 declare const isOutputServer: () => Promise<boolean>;
-/** EventCatalog Studio in production (server output, studio.enabled) */
-declare const isStudioEnabled: () => Promise<boolean>;
 declare const isIndexedSearchEnabled: () => Promise<boolean>;
 declare const isAuthEnabled: () => Promise<boolean>;
 
-export { getProjectOutDir, isAuthEnabled, isIndexedSearchEnabled, isOutputServer, isStudioEnabled };
+export { getProjectOutDir, isAuthEnabled, isIndexedSearchEnabled, isOutputServer };

package/dist/features.d.ts

@@ -1,8 +1,6 @@
 declare const getProjectOutDir: () => Promise<any>;
 declare const isOutputServer: () => Promise<boolean>;
-/** EventCatalog Studio in production (server output, studio.enabled) */
-declare const isStudioEnabled: () => Promise<boolean>;
 declare const isIndexedSearchEnabled: () => Promise<boolean>;
 declare const isAuthEnabled: () => Promise<boolean>;
 
-export { getProjectOutDir, isAuthEnabled, isIndexedSearchEnabled, isOutputServer, isStudioEnabled };
+export { getProjectOutDir, isAuthEnabled, isIndexedSearchEnabled, isOutputServer };

package/dist/features.js

@@ -2,14 +2,12 @@ import {
   getProjectOutDir,
   isAuthEnabled,
   isIndexedSearchEnabled,
-  isOutputServer,
-  isStudioEnabled
-} from "./chunk-ENAG6UH7.js";
-import "./chunk-RFIXKATC.js";
+  isOutputServer
+} from "./chunk-NKNOXQ62.js";
+import "./chunk-4G7FSRPN.js";
 export {
   getProjectOutDir,
   isAuthEnabled,
   isIndexedSearchEnabled,
-  isOutputServer,
-  isStudioEnabled
+  isOutputServer
 };