@eventcatalog/core 5.1.0 → 5.2.0

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.2.0";
 
 // src/constants.ts
 var VERSION = version;
@@ -1938,6 +1938,9 @@ ${errors.join("\n")}`);
   };
 };
 
+// src/eventcatalog.ts
+var import_exporters2 = require("@eventcatalog/exporters");
+
 // src/architecture-export.ts
 var import_node_fs9 = __toESM(require("fs"), 1);
 var import_node_path13 = __toESM(require("path"), 1);
@@ -1963,6 +1966,30 @@ var writeArchitectureExport = ({
   outputPath: getArchitectureExportPath({ outDir, isServer }),
   regenerateCommand: "npx eventcatalog build"
 });
+var resolveCustomExports = (config, { authEnabled }) => {
+  const enabled = config?.exports?.custom?.enabled;
+  if (enabled === false) return { enabled: false, reason: "disabled" };
+  if (authEnabled && enabled !== true) return { enabled: false, reason: "auth" };
+  return { enabled: true };
+};
+var hasCustomExports = ({
+  projectDir,
+  config
+}) => {
+  const folder = import_node_path13.default.join(projectDir, config?.exports?.custom?.dir || import_exporters.DEFAULT_CUSTOM_EXPORTS_DIR);
+  return import_node_fs9.default.existsSync(folder) && import_node_fs9.default.readdirSync(folder).some((name) => /\.mdx?$/i.test(name));
+};
+var getCustomExportsDir = ({ outDir, isServer }) => import_node_path13.default.join(outDir, isServer ? "client" : "", "exports");
+var writeCustomExportsToBuild = ({
+  projectDir,
+  outDir,
+  isServer,
+  config
+}) => (0, import_exporters.writeCustomExports)({
+  dir: projectDir,
+  outputDir: getCustomExportsDir({ outDir, isServer }),
+  config: config?.exports?.custom ?? {}
+});
 
 // src/catalog-runtime.ts
 var import_node_fs10 = __toESM(require("fs"), 1);
@@ -3469,6 +3496,42 @@ program.command("build").description("Run build of EventCatalog").action(async (
       "export"
     );
   }
+  if (hasCustomExports({ projectDir: dir, config })) {
+    const folder = `${config?.exports?.custom?.dir || "exports"}/`;
+    const customExports = resolveCustomExports(config, {
+      authEnabled: isCatalogAuthEnabled({ config, projectDir: dir, isServer })
+    });
+    if (customExports.enabled) {
+      try {
+        const { written, failed } = await writeCustomExportsToBuild({
+          projectDir: dir,
+          outDir: import_node_path23.default.resolve(dir, await getProjectOutDir()),
+          isServer,
+          config
+        });
+        for (const exported of written) {
+          logger.info(
+            `Wrote the custom export "${exported.spec.title}" to ${import_node_path23.default.relative(dir, exported.path)} (${(0, import_exporters2.summariseCustomExportReport)(exported.report)})`,
+            "export"
+          );
+          if (exported.report.unmatched.length)
+            logger.warning(
+              `${exported.spec.file}: nothing in the catalog matches ${exported.report.unmatched.map((u) => `${u.field} ${u.selector} (${u.reason})`).join(", ")}`,
+              "export"
+            );
+        }
+        for (const failure of failed)
+          logger.warning(`Skipped the custom export ${failure.file ?? `"${failure.id}"`}: ${failure.error.message}`, "export");
+      } catch (err) {
+        logger.warning(`Skipped the custom exports in ${folder}: ${err.message}`, "export");
+      }
+    } else if (customExports.reason === "auth") {
+      logger.info(
+        `Skipped the custom exports in ${folder} because auth is enabled and build output is served without it. Set exports.custom.enabled to true to publish them anyway.`,
+        "export"
+      );
+    }
+  }
 });
 var previewCatalog = async ({ command }) => {
   await runCommandWithFilteredOutput({

package/dist/eventcatalog.config.d.cts

@@ -346,6 +346,34 @@ interface Config {
         html?: {
             enabled?: boolean;
         };
+        /**
+         * Custom exports: parts of the catalog chosen for people outside the team (partners, the public, a regulator). Each
+         * is a file in `exports/` (e.g. `exports/partner-payments.mdx`) whose frontmatter says what it includes and whose
+         * body is its introduction, written to `exports/<id>.html` in the build output. Catalogs with auth must set
+         * `enabled: true`, because build output is served without auth.
+         */
+        custom?: {
+            /** Write the custom exports on build. @default true */
+            enabled?: boolean;
+            /** The folder that holds the custom export files. @default 'exports' */
+            dir?: string;
+            /** Build only these custom exports (by id). */
+            only?: string[];
+            /** What every custom export starts from; its own frontmatter overrides it. */
+            defaults?: {
+                /** Fields left out of every resource. @default ['owners', 'repository', 'contacts', 'docs'] */
+                hide?: ('owners' | 'repository' | 'specifications' | 'examples' | 'docs' | 'contacts')[];
+                /** Pointers at resources outside a custom export: dropped, shown as names, or pulled in (one level). @default 'omit' */
+                references?: 'omit' | 'name-only' | 'include';
+            };
+            /**
+             * Resources no custom export may show, whatever it includes: by id, e.g. [{ service: 'FraudAPI' }], or by custom
+             * property, e.g. [{ 'x-internal': true }] or [{ 'x-data-classification': ['confidential', 'restricted'] }].
+             */
+            neverExport?: {
+                [key: string]: string | number | boolean | (string | number | boolean)[] | undefined;
+            }[];
+        };
     };
     logo?: {
         alt: string;

package/dist/eventcatalog.config.d.ts

@@ -346,6 +346,34 @@ interface Config {
         html?: {
             enabled?: boolean;
         };
+        /**
+         * Custom exports: parts of the catalog chosen for people outside the team (partners, the public, a regulator). Each
+         * is a file in `exports/` (e.g. `exports/partner-payments.mdx`) whose frontmatter says what it includes and whose
+         * body is its introduction, written to `exports/<id>.html` in the build output. Catalogs with auth must set
+         * `enabled: true`, because build output is served without auth.
+         */
+        custom?: {
+            /** Write the custom exports on build. @default true */
+            enabled?: boolean;
+            /** The folder that holds the custom export files. @default 'exports' */
+            dir?: string;
+            /** Build only these custom exports (by id). */
+            only?: string[];
+            /** What every custom export starts from; its own frontmatter overrides it. */
+            defaults?: {
+                /** Fields left out of every resource. @default ['owners', 'repository', 'contacts', 'docs'] */
+                hide?: ('owners' | 'repository' | 'specifications' | 'examples' | 'docs' | 'contacts')[];
+                /** Pointers at resources outside a custom export: dropped, shown as names, or pulled in (one level). @default 'omit' */
+                references?: 'omit' | 'name-only' | 'include';
+            };
+            /**
+             * Resources no custom export may show, whatever it includes: by id, e.g. [{ service: 'FraudAPI' }], or by custom
+             * property, e.g. [{ 'x-internal': true }] or [{ 'x-data-classification': ['confidential', 'restricted'] }].
+             */
+            neverExport?: {
+                [key: string]: string | number | boolean | (string | number | boolean)[] | undefined;
+            }[];
+        };
     };
     logo?: {
         alt: string;

package/dist/eventcatalog.js

@@ -7,12 +7,12 @@ import {
 import "./chunk-CA4U2JP7.js";
 import {
   log_build_default
-} from "./chunk-G3CHTDAE.js";
+} from "./chunk-RNYFUWJI.js";
 import {
   getLicenseStatus,
   printLicenseStatus
 } from "./chunk-AD7CL772.js";
-import "./chunk-FHZXZWCY.js";
+import "./chunk-66OL4B7U.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-NBYKF4Z4.js";
 import {
   logger
-} from "./chunk-WBUSFEBH.js";
+} from "./chunk-XI5HQWM2.js";
 import {
   resolve_catalog_dependencies_default
 } from "./chunk-PD7KTSYN.js";
@@ -57,10 +57,13 @@ import {
   watch
 } from "./chunk-U63GDPPY.js";
 import {
+  hasCustomExports,
   isCatalogAuthEnabled,
   resolveArchitectureExport,
-  writeArchitectureExport
-} from "./chunk-E6WTCJUL.js";
+  resolveCustomExports,
+  writeArchitectureExport,
+  writeCustomExportsToBuild
+} from "./chunk-IR5MKGKS.js";
 import {
   getAstroConfigPath
 } from "./chunk-VIJJ7JKH.js";
@@ -76,7 +79,7 @@ import {
 } from "./chunk-LFQJXLHG.js";
 import {
   VERSION
-} from "./chunk-OT57IOWN.js";
+} from "./chunk-N2LLD5TR.js";
 import {
   getEventCatalogConfigFile,
   verifyRequiredFieldsAreInCatalogConfigFile
@@ -645,6 +648,7 @@ async function buildFieldsIndex(catalogDir, outputDir) {
 }
 
 // src/eventcatalog.ts
+import { summariseCustomExportReport } from "@eventcatalog/exporters";
 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" };
@@ -1061,6 +1065,42 @@ program.command("build").description("Run build of EventCatalog").action(async (
       "export"
     );
   }
+  if (hasCustomExports({ projectDir: dir, config })) {
+    const folder = `${config?.exports?.custom?.dir || "exports"}/`;
+    const customExports = resolveCustomExports(config, {
+      authEnabled: isCatalogAuthEnabled({ config, projectDir: dir, isServer })
+    });
+    if (customExports.enabled) {
+      try {
+        const { written, failed } = await writeCustomExportsToBuild({
+          projectDir: dir,
+          outDir: path2.resolve(dir, await getProjectOutDir()),
+          isServer,
+          config
+        });
+        for (const exported of written) {
+          logger.info(
+            `Wrote the custom export "${exported.spec.title}" to ${path2.relative(dir, exported.path)} (${summariseCustomExportReport(exported.report)})`,
+            "export"
+          );
+          if (exported.report.unmatched.length)
+            logger.warning(
+              `${exported.spec.file}: nothing in the catalog matches ${exported.report.unmatched.map((u) => `${u.field} ${u.selector} (${u.reason})`).join(", ")}`,
+              "export"
+            );
+        }
+        for (const failure of failed)
+          logger.warning(`Skipped the custom export ${failure.file ?? `"${failure.id}"`}: ${failure.error.message}`, "export");
+      } catch (err) {
+        logger.warning(`Skipped the custom exports in ${folder}: ${err.message}`, "export");
+      }
+    } else if (customExports.reason === "auth") {
+      logger.info(
+        `Skipped the custom exports in ${folder} because auth is enabled and build output is served without it. Set exports.custom.enabled to true to publish them anyway.`,
+        "export"
+      );
+    }
+  }
 });
 var previewCatalog = async ({ command }) => {
   await runCommandWithFilteredOutput({

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.2.0";
 
 // 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-NBYKF4Z4.js";
+import "./chunk-XI5HQWM2.js";
+import "./chunk-N2LLD5TR.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.2.0";
 
 // 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-XI5HQWM2.js";
+import "../chunk-N2LLD5TR.js";
 export {
   logger
 };

package/package.json

@@ -7,7 +7,7 @@
   },
   "license": "BUSL-1.1",
   "type": "module",
-  "version": "5.1.0",
+  "version": "5.2.0",
   "publishConfig": {
     "access": "public"
   },
@@ -140,9 +140,9 @@
     "y-protocols": "^1.0.7",
     "yjs": "^13.6.33",
     "zod": "^4.6.6",
-    "@eventcatalog/exporters": "0.0.2",
-    "@eventcatalog/linter": "1.2.1",
-    "@eventcatalog/sdk": "2.30.0",
+    "@eventcatalog/exporters": "0.1.0",
+    "@eventcatalog/linter": "1.2.2",
+    "@eventcatalog/sdk": "2.31.0",
     "@eventcatalog/visualiser": "^5.0.0"
   },
   "devDependencies": {

package/dist/chunk-E6WTCJUL.js

@@ -1,32 +0,0 @@
-// src/architecture-export.ts
-import fs from "fs";
-import path from "path";
-import { writeHtml } from "@eventcatalog/exporters";
-var isCatalogAuthEnabled = ({
-  config,
-  projectDir,
-  isServer
-}) => Boolean(config?.auth?.enabled) && isServer && fs.existsSync(path.join(projectDir, "eventcatalog.auth.js"));
-var resolveArchitectureExport = (config, { authEnabled }) => {
-  const enabled = config?.exports?.html?.enabled;
-  if (enabled === false) return { enabled: false, reason: "disabled" };
-  if (authEnabled && enabled !== true) return { enabled: false, reason: "auth" };
-  return { enabled: true };
-};
-var getArchitectureExportPath = ({ outDir, isServer }) => path.join(outDir, isServer ? "client" : "", "architecture.html");
-var writeArchitectureExport = ({
-  projectDir,
-  outDir,
-  isServer
-}) => writeHtml({
-  dir: projectDir,
-  outputPath: getArchitectureExportPath({ outDir, isServer }),
-  regenerateCommand: "npx eventcatalog build"
-});
-
-export {
-  isCatalogAuthEnabled,
-  resolveArchitectureExport,
-  getArchitectureExportPath,
-  writeArchitectureExport
-};