@eventcatalog/core 5.0.0-beta.9 → 5.0.0

package/dist/docs/plugins/openapi/03-features.md

@@ -8,12 +8,10 @@ description: Features of OpenAPI with EventCatalog
 ---
 
 import AddedIn from '@site/src/components/MDX/AddedIn';
-import PluginLicense from '@site/src/components/MDX/PluginLicense';
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
 <!-- <AddedIn version="2.6.0"/> -->
-<PluginLicense url="#commercial-use" />
 
 <!-- Table -->
 | Feature | Use cases |
@@ -289,7 +287,6 @@ This can be useful if you want to introduce a new endpoint, but warn users that
 
 </details>
 
-
 ---
 
 ### Map many OpenAPI files to a single service
@@ -554,7 +551,6 @@ generators: [
 </TabItem>
 </Tabs>
 
-
 ### Deprecating messages
 
 <AddedIn version="5.0.4" pkg="@eventcatalog/generator-openapi" url="https://github.com/event-catalog/generators/releases/tag/v"/>

package/dist/eventcatalog-config-file-utils.cjs

@@ -48,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 });
-    }
   }
 };
 

package/dist/eventcatalog-config-file-utils.d.cts

@@ -1,8 +1,8 @@
-import { rm, readFile, copyFile, mkdtemp, symlink } from 'node:fs/promises';
+import { rm, readFile } from 'node:fs/promises';
 import { existsSync } from 'node:fs';
 import path from 'node:path';
 import { pathToFileURL } from 'node:url';
-import { tmpdir } from 'node:os';
+import { register } from 'node:module';
 
 async function cleanup(projectDirectory) {
   const filePath = path.join(projectDirectory, 'eventcatalog.config.mjs');
@@ -11,76 +11,74 @@ async function cleanup(projectDirectory) {
   }
 }
 
-const findNodeModulesDirectory = (directory) => {
-  let currentDirectory = directory;
-
-  while (true) {
-    const nodeModulesDirectory = path.join(currentDirectory, 'node_modules');
-
-    if (existsSync(nodeModulesDirectory)) {
-      return nodeModulesDirectory;
-    }
-
-    const parentDirectory = path.dirname(currentDirectory);
-
-    if (parentDirectory === currentDirectory) {
-      return undefined;
-    }
-
-    currentDirectory = parentDirectory;
-  }
+let hidesConfigModuleTypeWarning = false;
+let loads = 0;
+
+/**
+ * Node loads an eventcatalog.config.js that uses import/export as an ES module even when the catalog's
+ * package.json has no "type": "module" (a new catalog's doesn't), and warns that it had to detect it.
+ * That warning, for the config file only, is hidden: the catalog doesn't need to change anything.
+ */
+const 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);
+  };
 };
 
-const linkNodeModulesIntoTempDirectory = async ({ projectDirectory, tempDir }) => {
-  const nodeModulesDirectory = findNodeModulesDirectory(projectDirectory);
-
-  if (!nodeModulesDirectory) {
-    return;
-  }
-
-  await symlink(nodeModulesDirectory, path.join(tempDir, 'node_modules'), 'dir');
+// Marks a config URL Node should load as an ES module, whatever the catalog's package.json says
+const AS_MODULE_QUERY = 'eventcatalog-config-as-module';
+let loadsMarkedConfigsAsModules = false;
+
+/**
+ * Node won't load a config written with import/export in a catalog whose package.json has
+ * "type": "commonjs". A loader hook loads that config file (and only it) as an ES module.
+ */
+const 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);
+  }`;
+  register(`data:text/javascript,${encodeURIComponent(hook)}`);
 };
 
-const createTemporaryConfigDirectory = async (projectDirectory) => {
-  const nodeModulesDirectory = findNodeModulesDirectory(projectDirectory);
-
-  if (nodeModulesDirectory) {
-    return mkdtemp(path.join(nodeModulesDirectory, '.eventcatalog-config-'));
+/**
+ * Loads the catalog's eventcatalog.config.js from where it is, so paths it builds from its own location
+ * (`import.meta.url`, `import.meta.dirname`) and its relative imports point into the catalog. It was
+ * loaded from a copy in a temporary folder before, which broke them (e.g. the paths to a generator's specs).
+ */
+const isCommonJSPackage = async (projectDirectory) => {
+  try {
+    const packageJson = JSON.parse(await readFile(path.join(projectDirectory, 'package.json'), 'utf-8'));
+    return packageJson?.type === 'commonjs';
+  } catch {
+    return false;
   }
-
-  const tempDir = await mkdtemp(path.join(tmpdir(), 'eventcatalog-config-'));
-  await linkNodeModulesIntoTempDirectory({ projectDirectory, tempDir });
-  return tempDir;
 };
 
 const getEventCatalogConfigFile = async (projectDirectory) => {
-  let tempDir;
-
   try {
-    let configFilePath = path.join(projectDirectory, 'eventcatalog.config.js');
-
-    const filePath = path.join(projectDirectory, 'package.json');
-    const packageJson = JSON.parse(await readFile(filePath, 'utf-8'));
+    hideConfigModuleTypeWarning();
+    // A catalog's config is an ES module, as it always was (with "type": "commonjs" it was loaded from an .mjs copy)
+    const asModule = await isCommonJSPackage(projectDirectory);
+    if (asModule) loadMarkedConfigsAsModules();
 
-    if (packageJson?.type !== 'module') {
-      // Importing CommonJS config via ESM import requires an .mjs file.
-      // Keep this temp copy outside the project directory so Astro/Vite
-      // file watchers do not trigger a dev-server restart during startup.
-      tempDir = await createTemporaryConfigDirectory(projectDirectory);
-      configFilePath = path.join(tempDir, 'eventcatalog.config.mjs');
-      await copyFile(path.join(projectDirectory, 'eventcatalog.config.js'), configFilePath);
-    }
-
-    const configFileURL = `${pathToFileURL(configFilePath).href}?t=${Date.now()}`;
-    const config = await import(/* @vite-ignore */ configFileURL);
+    const configFileURL = pathToFileURL(path.join(projectDirectory, 'eventcatalog.config.js')).href;
+    // A new URL each time, so a changed config is loaded again (not `?t=`: Vite drops it as its own timestamp)
+    const query = `${asModule ? AS_MODULE_QUERY : 'loaded'}=${Date.now()}-${loads++}`;
+    const config = await import(/* @vite-ignore */ `${configFileURL}?${query}`);
 
     return config.default;
   } finally {
+    // Earlier versions loaded a copy from eventcatalog.config.mjs in the catalog: remove one left behind
     await cleanup(projectDirectory);
-
-    if (tempDir) {
-      await rm(tempDir, { recursive: true, force: true });
-    }
   }
 };
 

package/dist/eventcatalog-config-file-utils.d.ts

@@ -1,8 +1,8 @@
-import { rm, readFile, copyFile, mkdtemp, symlink } from 'node:fs/promises';
+import { rm, readFile } from 'node:fs/promises';
 import { existsSync } from 'node:fs';
 import path from 'node:path';
 import { pathToFileURL } from 'node:url';
-import { tmpdir } from 'node:os';
+import { register } from 'node:module';
 
 async function cleanup(projectDirectory) {
   const filePath = path.join(projectDirectory, 'eventcatalog.config.mjs');
@@ -11,76 +11,74 @@ async function cleanup(projectDirectory) {
   }
 }
 
-const findNodeModulesDirectory = (directory) => {
-  let currentDirectory = directory;
-
-  while (true) {
-    const nodeModulesDirectory = path.join(currentDirectory, 'node_modules');
-
-    if (existsSync(nodeModulesDirectory)) {
-      return nodeModulesDirectory;
-    }
-
-    const parentDirectory = path.dirname(currentDirectory);
-
-    if (parentDirectory === currentDirectory) {
-      return undefined;
-    }
-
-    currentDirectory = parentDirectory;
-  }
+let hidesConfigModuleTypeWarning = false;
+let loads = 0;
+
+/**
+ * Node loads an eventcatalog.config.js that uses import/export as an ES module even when the catalog's
+ * package.json has no "type": "module" (a new catalog's doesn't), and warns that it had to detect it.
+ * That warning, for the config file only, is hidden: the catalog doesn't need to change anything.
+ */
+const 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);
+  };
 };
 
-const linkNodeModulesIntoTempDirectory = async ({ projectDirectory, tempDir }) => {
-  const nodeModulesDirectory = findNodeModulesDirectory(projectDirectory);
-
-  if (!nodeModulesDirectory) {
-    return;
-  }
-
-  await symlink(nodeModulesDirectory, path.join(tempDir, 'node_modules'), 'dir');
+// Marks a config URL Node should load as an ES module, whatever the catalog's package.json says
+const AS_MODULE_QUERY = 'eventcatalog-config-as-module';
+let loadsMarkedConfigsAsModules = false;
+
+/**
+ * Node won't load a config written with import/export in a catalog whose package.json has
+ * "type": "commonjs". A loader hook loads that config file (and only it) as an ES module.
+ */
+const 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);
+  }`;
+  register(`data:text/javascript,${encodeURIComponent(hook)}`);
 };
 
-const createTemporaryConfigDirectory = async (projectDirectory) => {
-  const nodeModulesDirectory = findNodeModulesDirectory(projectDirectory);
-
-  if (nodeModulesDirectory) {
-    return mkdtemp(path.join(nodeModulesDirectory, '.eventcatalog-config-'));
+/**
+ * Loads the catalog's eventcatalog.config.js from where it is, so paths it builds from its own location
+ * (`import.meta.url`, `import.meta.dirname`) and its relative imports point into the catalog. It was
+ * loaded from a copy in a temporary folder before, which broke them (e.g. the paths to a generator's specs).
+ */
+const isCommonJSPackage = async (projectDirectory) => {
+  try {
+    const packageJson = JSON.parse(await readFile(path.join(projectDirectory, 'package.json'), 'utf-8'));
+    return packageJson?.type === 'commonjs';
+  } catch {
+    return false;
   }
-
-  const tempDir = await mkdtemp(path.join(tmpdir(), 'eventcatalog-config-'));
-  await linkNodeModulesIntoTempDirectory({ projectDirectory, tempDir });
-  return tempDir;
 };
 
 const getEventCatalogConfigFile = async (projectDirectory) => {
-  let tempDir;
-
   try {
-    let configFilePath = path.join(projectDirectory, 'eventcatalog.config.js');
-
-    const filePath = path.join(projectDirectory, 'package.json');
-    const packageJson = JSON.parse(await readFile(filePath, 'utf-8'));
+    hideConfigModuleTypeWarning();
+    // A catalog's config is an ES module, as it always was (with "type": "commonjs" it was loaded from an .mjs copy)
+    const asModule = await isCommonJSPackage(projectDirectory);
+    if (asModule) loadMarkedConfigsAsModules();
 
-    if (packageJson?.type !== 'module') {
-      // Importing CommonJS config via ESM import requires an .mjs file.
-      // Keep this temp copy outside the project directory so Astro/Vite
-      // file watchers do not trigger a dev-server restart during startup.
-      tempDir = await createTemporaryConfigDirectory(projectDirectory);
-      configFilePath = path.join(tempDir, 'eventcatalog.config.mjs');
-      await copyFile(path.join(projectDirectory, 'eventcatalog.config.js'), configFilePath);
-    }
-
-    const configFileURL = `${pathToFileURL(configFilePath).href}?t=${Date.now()}`;
-    const config = await import(/* @vite-ignore */ configFileURL);
+    const configFileURL = pathToFileURL(path.join(projectDirectory, 'eventcatalog.config.js')).href;
+    // A new URL each time, so a changed config is loaded again (not `?t=`: Vite drops it as its own timestamp)
+    const query = `${asModule ? AS_MODULE_QUERY : 'loaded'}=${Date.now()}-${loads++}`;
+    const config = await import(/* @vite-ignore */ `${configFileURL}?${query}`);
 
     return config.default;
   } finally {
+    // Earlier versions loaded a copy from eventcatalog.config.mjs in the catalog: remove one left behind
     await cleanup(projectDirectory);
-
-    if (tempDir) {
-      await rm(tempDir, { recursive: true, force: true });
-    }
   }
 };
 

package/dist/eventcatalog-config-file-utils.js

@@ -5,7 +5,7 @@ import {
   getEventCatalogConfigFile,
   verifyRequiredFieldsAreInCatalogConfigFile,
   writeEventCatalogConfigFile
-} from "./chunk-RFIXKATC.js";
+} from "./chunk-4G7FSRPN.js";
 export {
   addPropertyToFrontMatter,
   addTrialStartDateToCatalogConfigFile,