@eventcatalog/core 2.0.26 → 2.0.28

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @eventcatalog/core
 
+## 2.0.28
+
+### Patch Changes
+
+- 0bad036: feat(core): added beta version of generators
+
+## 2.0.27
+
+### Patch Changes
+
+- c6da224: feat(core): added ability to configure landing page
+
 ## 2.0.26
 
 ### Patch Changes

package/astro.config.mjs

@@ -43,6 +43,6 @@ export default defineConfig({
     pagefind(),
   ],
   redirects: {
-    "/": "/docs"
+    "/": config.landingPage || '/docs',
   }
 });

package/bin/dist/eventcatalog.cjs

@@ -3155,4 +3155,14 @@ program2.command("start").description("Serves the contents of your eventcatalog
   console.log("Starting preview of your build...");
   previewCatalog();
 });
+program2.command("generate [siteDir]").description("Start the generator scripts.").action(() => {
+  copyCore();
+  copyFolder((0, import_node_path.join)(dir, "public"), (0, import_node_path.join)(core, "public"));
+  copyFile((0, import_node_path.join)(dir, "eventcatalog.config.js"), (0, import_node_path.join)(core, "eventcatalog.config.js"));
+  copyFile((0, import_node_path.join)(dir, "eventcatalog.styles.css"), (0, import_node_path.join)(core, "eventcatalog.styles.css"));
+  (0, import_node_child_process.execSync)(`PROJECT_DIR='${dir}' npm run generate`, {
+    cwd: core,
+    stdio: "inherit"
+  });
+});
 program2.parse();

package/bin/dist/eventcatalog.config.d.cts

@@ -7,6 +7,7 @@ interface Config {
     organizationName: string;
     homepageLink: string;
     editUrl: string;
+    landingPage?: string;
     base?: string;
     port?: string;
     trailingSlash?: boolean;

package/bin/dist/eventcatalog.config.d.ts

@@ -7,6 +7,7 @@ interface Config {
     organizationName: string;
     homepageLink: string;
     editUrl: string;
+    landingPage?: string;
     base?: string;
     port?: string;
     trailingSlash?: boolean;

package/bin/dist/eventcatalog.js

@@ -3122,4 +3122,14 @@ program2.command("start").description("Serves the contents of your eventcatalog
   console.log("Starting preview of your build...");
   previewCatalog();
 });
+program2.command("generate [siteDir]").description("Start the generator scripts.").action(() => {
+  copyCore();
+  copyFolder(join(dir, "public"), join(core, "public"));
+  copyFile(join(dir, "eventcatalog.config.js"), join(core, "eventcatalog.config.js"));
+  copyFile(join(dir, "eventcatalog.styles.css"), join(core, "eventcatalog.styles.css"));
+  execSync(`PROJECT_DIR='${dir}' npm run generate`, {
+    cwd: core,
+    stdio: "inherit"
+  });
+});
 program2.parse();

package/bin/eventcatalog.config.ts

@@ -8,6 +8,7 @@ export interface Config {
   organizationName: string;
   homepageLink: string;
   editUrl: string;
+  landingPage?: string;
   base?: string;
   port?: string;
   trailingSlash?: boolean;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@eventcatalog/core",
   "type": "module",
-  "version": "2.0.26",
+  "version": "2.0.28",
   "publishConfig": {
     "access": "public"
   },
@@ -23,6 +23,7 @@
     "start:catalog": "node scripts/start-catalog-locally.js",
     "verify-build:catalog": "rimraf dist && npm run build:cd",
     "changeset": "changeset",
+    "generate": "node scripts/generate.js",
     "release": "changeset publish",
     "format": "prettier --config .prettierrc --write \"**/*.{js,jsx,ts,tsx,json}\"",
     "format:diff": "prettier --config .prettierrc --list-different \"**/*.{js,jsx,ts,tsx,json}\""

package/scripts/generate.js

@@ -0,0 +1,53 @@
+import { readFile, writeFile } from 'node:fs/promises';
+import { createRequire } from 'module';
+import path from 'node:path';
+
+const generate = async () => {
+  // Fix for the file
+  const rawFile = await readFile(path.join(process.env.PROJECT_DIR, 'eventcatalog.config.js'), 'utf8');
+
+  const require = createRequire(process.env.PROJECT_DIR);
+
+  // Convert export default to module.exports (Needed for dynamic require)
+  if (rawFile.includes('export default')) {
+    const fixedFile = rawFile.replace('export default', 'module.exports =');
+    await writeFile(path.join(process.env.PROJECT_DIR, 'eventcatalog.config.js'), fixedFile);
+  }
+
+  const config = require(path.join(process.env.PROJECT_DIR, 'eventcatalog.config.js'));
+
+  const { generators = [] } = config;
+
+  if (!generators.length) {
+    console.log('No configured generators found, skipping generation');
+    return;
+  }
+
+  console.log('Running generators...');
+
+  // Tidy up
+  await writeFile(path.join(process.env.PROJECT_DIR, 'eventcatalog.config.js'), rawFile);
+
+  const plugins = generators.map((generator) => {
+    let plugin = generator[0];
+    const pluginConfig = generator[1];
+
+    if (plugin.startsWith('./')) {
+      plugin = path.join(process.env.PROJECT_DIR, plugin);
+    }
+
+    if (plugin.includes('<rootDir>')) {
+      plugin = plugin.replace('<rootDir>', process.env.PROJECT_DIR);
+    }
+
+    const importedGenerator = require(plugin);
+
+    console.log(`Generating EventCatalog docs using: ${plugin}`);
+
+    return importedGenerator({ eventCatalogConfig: config }, pluginConfig);
+  });
+
+  await Promise.all(plugins);
+};
+
+generate();

package/src/components/Header.astro

@@ -1,6 +1,5 @@
 ---
 import catalog from '@eventcatalog';
-// import Search from 'astro-pagefind/components/Search';
 import Search from '@components/Search.astro';
 import { buildUrl } from '@utils/url-builder';
 
@@ -31,7 +30,7 @@ const logo = {
 <nav class="md:fixed top-0 w-full z-20 bg-white border-b border-gray-200 py-4 font-bold text-xl max-w-[70em]">
   <div class="flex justify-between items-center">
     <div class="w-1/3 flex space-x-2 items-center">
-      <a href={buildUrl('/docs')} class="flex space-x-2 items-center">
+      <a href={buildUrl(catalog.landingPage || '/docs')} class="flex space-x-2 items-center">
         {logo.src && <img alt={logo.alt} src={buildUrl(logo.src, true)} class="w-8" />}
         {logo.text && <span class="hidden sm:inline-block text-[1em]">{logo.text}</span>}
       </a>