@eventcatalog/core 2.14.3 → 2.16.0

package/scripts/analytics/log-build.js

@@ -1,26 +0,0 @@
-import { getEventCatalogConfigFile, verifyRequiredFieldsAreInCatalogConfigFile } from '../eventcatalog-config-file-utils.js';
-import { raiseEvent } from './analytics.js';
-
-/**
- *
- * @param {string} projectDir
- */
-const main = async (projectDir) => {
-  if (process.env.NODE_ENV === 'CI') return;
-  try {
-    await verifyRequiredFieldsAreInCatalogConfigFile(projectDir);
-    const configFile = await getEventCatalogConfigFile(projectDir);
-    const { cId, organizationName, generators = [] } = configFile;
-    const generatorNames = generators.length > 0 ? generators.map((generator) => generator[0]) : ['none'];
-    await raiseEvent({
-      command: 'build',
-      org: organizationName,
-      cId,
-      generators: generatorNames.toString(),
-    });
-  } catch (error) {
-    // Just swallow the error
-  }
-};
-
-export default main;

package/scripts/build-ci.js

@@ -1,27 +0,0 @@
-#!/usr/bin/env node
-
-// This is used for CI on vercel. Must copy files before building.
-import { join } from 'node:path';
-import { execSync } from 'node:child_process';
-const __dirname = import.meta.dirname;
-
-const args = process.argv.slice(2);
-const catalog = args[0] || 'default';
-
-const catalogDir = join(__dirname, '../');
-const projectDIR = join(__dirname, `../examples/${catalog}`);
-
-// Build cli
-execSync('npm run build:bin', { stdio: 'inherit' });
-
-// Build catalog
-execSync(`cross-env NODE_ENV=CI PROJECT_DIR=${projectDIR} CATALOG_DIR=${catalogDir} npx . build`, {
-  cwd: catalogDir,
-  stdio: 'inherit',
-});
-
-// Type check
-execSync('npx astro check --minimumSeverity error', {
-  cwd: catalogDir,
-  stdio: 'inherit',
-});

package/scripts/catalog-to-astro-content-directory.js

@@ -1,115 +0,0 @@
-import { glob } from 'glob';
-import * as path from 'node:path';
-import fs from 'fs';
-import { fileURLToPath } from 'url';
-import os from 'node:os';
-import { verifyRequiredFieldsAreInCatalogConfigFile, addPropertyToFrontMatter } from './eventcatalog-config-file-utils.js';
-import { mapCatalogToAstro } from './map-catalog-to-astro.js';
-
-const __filename = fileURLToPath(import.meta.url);
-const rootPkg = path.resolve(
-  path.dirname(__filename),
-  /**
-   * TODO: fix me =0
-   *
-   * The following is a workaround until organize the structure to have the correct path
-   * for any value of NODE_ENV
-   *
-   * @author carlosallexandre
-   */
-  process.env.NODE_ENV === 'test' ? '../' : '../../'
-);
-
-const copyFiles = async (source, target) => {
-  const files = await glob(path.join(source, '**'), {
-    nodir: true,
-    windowsPathsNoEscape: os.platform() == 'win32',
-  });
-
-  for (const file of files) {
-    mapCatalogToAstro({
-      filePath: file,
-      astroDir: target,
-      projectDir: source,
-    })
-      .map((astroPath) => {
-        fs.cpSync(file, astroPath);
-        return { oldPath: file, newPath: astroPath };
-      })
-      .map(({ oldPath, newPath }) => {
-        if (!oldPath.endsWith('.md') && !oldPath.endsWith('.mdx')) return;
-        try {
-          // EventCatalog requires the original path to be in the frontmatter for Schemas and Changelogs
-          const content = fs.readFileSync(newPath, 'utf-8');
-          const frontmatter = addPropertyToFrontMatter(content, 'pathToFile', oldPath);
-          fs.writeFileSync(newPath, frontmatter);
-        } catch (error) {
-          // silent fail
-        }
-      });
-  }
-};
-
-const ensureAstroCollectionNotEmpty = async (astroDir) => {
-  // TODO: maybe import collections from `src/content/config.ts`...
-  const COLLECTIONS = [
-    'events',
-    'commands',
-    'services',
-    'users',
-    'teams',
-    'domains',
-    'flows',
-    'pages',
-    'changelogs',
-    'queries',
-    'channels',
-  ];
-
-  // Check empty collections
-  const emptyCollections = [];
-  for (const collection of COLLECTIONS) {
-    const markdownFiles = await glob(path.join(astroDir, 'src/content/', collection, '**'), {
-      nodir: true,
-      windowsPathsNoEscape: os.platform() == 'win32',
-    });
-
-    if (markdownFiles.length === 0) emptyCollections.push(collection);
-  }
-
-  // Hydrate empty collections
-  const defaultCollectionFilesDir = path.join(rootPkg, 'default-files-for-collections');
-  for (const collection of emptyCollections) {
-    const defaultFile = path.join(defaultCollectionFilesDir, `${collection}.md`);
-    const targetDir = path.join(astroDir, 'src/content/', collection);
-    if (!fs.existsSync(targetDir)) {
-      fs.mkdirSync(targetDir, { recursive: true });
-    }
-    fs.cpSync(defaultFile, path.join(targetDir, `${collection}.md`));
-  }
-};
-
-export const catalogToAstro = async (source, astroDir) => {
-  const astroContentDir = path.join(astroDir, 'src/content/');
-
-  // Config file
-  const astroConfigFile = fs.readFileSync(path.join(astroContentDir, 'config.ts'));
-
-  // Clear the astro directory before we copy files over
-  fs.rmSync(astroContentDir, { recursive: true });
-
-  // Create the folder again
-  fs.mkdirSync(astroContentDir);
-
-  // Write config file back
-  fs.writeFileSync(path.join(astroContentDir, 'config.ts'), astroConfigFile);
-
-  // Verify required fields are in the catalog config file
-  await verifyRequiredFieldsAreInCatalogConfigFile(source);
-
-  await copyFiles(source, astroDir);
-
-  // Check if the directory is empty. EC (astro collections) requires at least 1 item in the collection
-  // insert empty one that is filtered out
-  await ensureAstroCollectionNotEmpty(astroDir);
-};

package/scripts/ci/test.js

@@ -1,24 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * Script for GitHub Actions
- * Sets up the project with required files
- */
-
-import { join } from 'node:path';
-import fs from 'fs';
-import { execSync } from 'node:child_process';
-
-const args = process.argv.slice(2);
-const catalog = args[0] || 'default';
-
-const catalogDir = join(process.cwd());
-const projectDIR = join(process.cwd(), `/examples/${catalog}`);
-
-fs.copyFileSync(join(projectDIR, 'eventcatalog.config.js'), join(catalogDir, 'eventcatalog.config.js'));
-fs.copyFileSync(join(projectDIR, 'eventcatalog.styles.css'), join(catalogDir, 'eventcatalog.styles.css'));
-
-execSync(`cross-env NODE_ENV=test PROJECT_DIR=${projectDIR} CATALOG_DIR=${catalogDir} npm run test`, {
-  cwd: catalogDir,
-  stdio: 'inherit',
-});

package/scripts/constants.ts

@@ -1,3 +0,0 @@
-import { version } from '../package.json';
-
-export const VERSION = version;

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

@@ -1,89 +0,0 @@
-import { readFile, writeFile, rm } from 'node:fs/promises';
-import { existsSync } from 'node:fs';
-import { copyFile } from 'node:fs/promises';
-import path from 'node:path';
-import { v4 as uuidV4 } from 'uuid';
-import { pathToFileURL } from 'url';
-import matter from 'gray-matter';
-
-export async function cleanup(projectDirectory) {
-  const filePath = path.join(projectDirectory, 'eventcatalog.config.mjs');
-  if (existsSync(filePath)) {
-    await rm(filePath);
-  }
-}
-
-export const getEventCatalogConfigFile = async (projectDirectory) => {
-  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'));
-
-    if (packageJson?.type !== 'module') {
-      await copyFile(configFilePath, path.join(projectDirectory, 'eventcatalog.config.mjs'));
-      configFilePath = path.join(projectDirectory, 'eventcatalog.config.mjs');
-    }
-
-    const configFileURL = pathToFileURL(configFilePath).href;
-    const config = await import(/* @vite-ignore */ configFileURL);
-
-    return config.default;
-  } finally {
-    await cleanup(projectDirectory);
-  }
-};
-
-export const writeEventCatalogConfigFile = async (projectDirectory, newConfig) => {
-  try {
-    const configFilePath = path.join(projectDirectory, 'eventcatalog.config.js');
-    let content = await readFile(configFilePath, 'utf8');
-
-    // Find the start of the config object
-    const startIndex = content.indexOf('export default {');
-    if (startIndex === -1) {
-      // Just fail silently if the config object is not found
-      return;
-    }
-
-    // Update or add each new config item
-    Object.entries(newConfig).forEach(([key, value]) => {
-      const valueString = JSON.stringify(value, null, 2).replace(/"/g, "'").replace(/\n/g, '\n  ');
-
-      // Check if the key already exists
-      const keyRegex = new RegExp(`(${key}\\s*:)([^,}]+)`, 'g');
-      if (content.match(keyRegex)) {
-        // Update existing key
-        content = content.replace(keyRegex, `$1 ${valueString}`);
-      } else {
-        // Add new key-value pair
-        const insertPosition = content.indexOf('{', startIndex) + 1;
-        content = content.slice(0, insertPosition) + `\n  ${key}: ${valueString},` + content.slice(insertPosition);
-      }
-    });
-
-    // Write the updated content back to the file
-    await writeFile(configFilePath, content);
-  } finally {
-    await cleanup(projectDirectory);
-  }
-};
-
-// Check the eventcatalog.config.js and add any missing required fields on it
-export const verifyRequiredFieldsAreInCatalogConfigFile = async (projectDirectory) => {
-  try {
-    const config = await getEventCatalogConfigFile(projectDirectory);
-
-    if (!config.cId) {
-      await writeEventCatalogConfigFile(projectDirectory, { cId: uuidV4() });
-    }
-  } catch (error) {
-    // fail silently, it's overly important
-  }
-};
-
-export function addPropertyToFrontMatter(input, newProperty, newValue) {
-  const file = matter(input);
-
-  return matter.stringify(file.content, { ...file.data, [newProperty]: newValue });
-}

package/scripts/generate.js

@@ -1,65 +0,0 @@
-import path from 'node:path';
-import { getEventCatalogConfigFile, cleanup } from './eventcatalog-config-file-utils.js';
-
-function getDefaultExport(importedModule) {
-  if (importedModule === null || typeof importedModule !== 'object') {
-    throw new Error('Invalid module');
-  }
-
-  if (typeof importedModule.default === 'object' && importedModule.default !== null) {
-    return importedModule.default.default || importedModule.default;
-  }
-
-  if (typeof importedModule.default !== 'undefined') {
-    return importedModule.default;
-  }
-
-  return importedModule;
-}
-
-export const generate = async (PROJECT_DIRECTORY) => {
-  try {
-    const config = await getEventCatalogConfigFile(PROJECT_DIRECTORY);
-
-    const { generators = [] } = config;
-
-    if (!generators.length) {
-      console.log('No configured generators found, skipping generation');
-      return;
-    }
-
-    for (const generator of generators) {
-      let plugin = generator[0];
-      const pluginConfig = generator[1];
-
-      if (plugin.startsWith('./')) {
-        plugin = path.join(PROJECT_DIRECTORY, plugin);
-      }
-
-      if (plugin.includes('<rootDir>')) {
-        plugin = plugin.replace('<rootDir>', PROJECT_DIRECTORY);
-      }
-
-      try {
-        const importedGenerator = await import(plugin);
-
-        // TODO: Fix this...
-        const generator = getDefaultExport(importedGenerator);
-
-        await generator({ eventCatalogConfig: {} }, pluginConfig);
-
-        // Use importedGenerator here
-      } catch (error) {
-        console.error('Error loading plugin:', error);
-        await cleanup(PROJECT_DIRECTORY);
-        return;
-      }
-    }
-
-    await cleanup(PROJECT_DIRECTORY);
-  } catch (error) {
-    // Failed to generate clean up...
-    console.error(error);
-    await cleanup(PROJECT_DIRECTORY);
-  }
-};

package/scripts/map-catalog-to-astro.js

@@ -1,174 +0,0 @@
-import path from 'node:path';
-
-const COLLECTION_KEYS = [
-  'events',
-  'commands',
-  'services',
-  'users',
-  'teams',
-  'domains',
-  'flows',
-  'pages',
-  'changelogs',
-  'queries',
-  'channels',
-];
-
-/**
- * @typedef {Object} MapCatalogToAstroParams
- * @prop {string} filePath The catalog file path
- * @prop {string} astroDir The astro directory
- * @prop {string} projectDir The user's project directory
- */
-
-/**
- *
- * @param {MapCatalogToAstroParams} params
- * @returns {string[]} The astro file paths
- */
-export function mapCatalogToAstro({ filePath, astroDir, projectDir }) {
-  const relativeFilePath = removeBasePath(filePath, projectDir);
-
-  if (!isCatalogRelated(relativeFilePath)) {
-    return [];
-  }
-
-  const baseTargetPaths = getBaseTargetPaths(relativeFilePath);
-  const relativeTargetPath = getRelativeTargetPath(relativeFilePath);
-
-  return baseTargetPaths.map((base) =>
-    path.join(astroDir, base, relativeTargetPath.replace('index.md', 'index.mdx').replace('changelog.md', 'changelog.mdx'))
-  );
-}
-
-/**
- *
- * @param {string} fullPath
- * @param {string} basePath
- * @returns {string} The fullPath without the basePath
- */
-function removeBasePath(fullPath, basePath) {
-  const relativePath = path.relative(basePath, fullPath);
-  return relativePath.startsWith('..') ? fullPath : relativePath;
-}
-
-/**
- * Check if the key is an ASTRO COLLECTION KEY
- * @param {string} key
- * @returns {boolean}
- */
-function isCollectionKey(key) {
-  return COLLECTION_KEYS.includes(key);
-}
-
-/**
- * Checks whether the given path is a configuration file, styles file, public asset file or collection file.
- * @param {string} filePath - The file path without the projectDir prefix.
- * @returns {boolean}
- */
-function isCatalogRelated(filePath) {
-  const filePathArr = filePath.split(path.sep).filter(Boolean);
-
-  if (
-    [
-      'eventcatalog.config.js', // config file at root
-      'eventcatalog.styles.css', // custom styles file at root
-      'components', // custom components
-      'public', // public assets
-      ...COLLECTION_KEYS,
-    ].includes(filePathArr[0])
-  ) {
-    return true;
-  }
-
-  return false;
-}
-
-/**
- * Generates the base target path accordingly to the file path.
- * @param {string} filePath The path to the file without PROJECT_DIR prefix.
- * @returns {Array.<'src/content'|'public/generated'|'src/catalog-files'|'/'>} The base target path.
- */
-function getBaseTargetPaths(filePath) {
-  const filePathArr = filePath.split(path.sep).filter(Boolean);
-
-  // Collection
-  if (isCollectionKey(filePathArr[0])) {
-    // Changelogs files
-    if (filePathArr[filePathArr.length - 1] == 'changelog.md') {
-      return [path.join('src', 'content', 'changelogs')];
-    }
-
-    // Markdown files
-    if (filePathArr[filePathArr.length - 1].match(/\.md$/)) {
-      return [path.join('src', 'content')];
-    }
-
-    // This is a workaround to differentiate between a file and a directory.
-    // Of course this is not the best solution. But how differentiate? `fs.stats`
-    // could be used, but sometimes the filePath references a deleted file/directory
-    // which causes an error when using `fs.stats`.
-    const hasExtension = (str) => /\.[a-zA-Z0-9]{2,}$/.test(str);
-
-    // Assets files
-    if (hasExtension(filePath)) {
-      return [path.join('public', 'generated'), path.join('src', 'catalog-files')];
-    }
-
-    /**
-     * @parcel/watcher throttle and coalesce events for performance reasons.
-     *
-     * Consider the following:
-     *    The user deletes a large `services/` dir from eventcatalog.
-     *    The @parcel/watcher could emit only one delete event of the
-     *    `services/` directory.
-     *
-     * In this situation we need delete all files from
-     * - `public/generated/services/`
-     * - `src/catalog-files/services/`
-     * - `src/content/services/`
-     *
-     * TODO: What happens if services contains commands/events inside of it??? How handle this?
-     */
-    // Directories
-    return [path.join('public', 'generated'), path.join('src', 'catalog-files'), path.join('src', 'content')];
-  }
-
-  // Custom components
-  if (filePathArr[0] == 'components') {
-    return [path.join('src', 'custom-defined-components')];
-  }
-
-  // Public assets (public/*)
-  if (filePathArr[0] == 'public') {
-    return [path.join('public')];
-  }
-
-  /**
-   * Config files:
-   * - eventcatalog.config.js
-   * - eventcatalog.styles.css
-   */
-  return [path.join('/')];
-}
-
-/**
- * Generates the path until the ASTRO_COLLECTION_KEY or the PROJECT_DIR root.
- * @param {string} filePath The path to the file.
- * @returns {string} The path until the COLLECTION_KEY or PROJECT_DIR root.
- */
-function getRelativeTargetPath(filePath) {
-  const filePathArr = filePath.split(path.sep).filter(Boolean);
-
-  if (filePathArr[0] == 'public' || filePathArr[0] == 'components') {
-    filePathArr.shift();
-  }
-
-  const relativePath = [];
-  for (let i = filePathArr.length - 1; i >= 0; i--) {
-    relativePath.unshift(filePathArr[i]);
-    if (isCollectionKey(filePathArr[i])) break;
-  }
-
-  return path.join(...relativePath);
-}

package/scripts/start-catalog-locally.js

@@ -1,26 +0,0 @@
-#!/usr/bin/env node
-import { join } from 'node:path';
-import { execSync } from 'node:child_process';
-
-async function main() {
-  const __dirname = import.meta.dirname;
-
-  const args = process.argv.slice(2);
-  const catalog = args[0] || 'default';
-
-  const catalogDir = join(__dirname, '../');
-  const projectDIR = join(__dirname, `../examples/${catalog}`);
-
-  execSync('npm run build:bin', { stdio: 'inherit' });
-
-  execSync(`cross-env NODE_ENV=development PROJECT_DIR=${projectDIR} CATALOG_DIR=${catalogDir} npx . dev`, {
-    stdio: 'inherit',
-  });
-}
-
-main()
-  .then(() => process.exit(0))
-  .catch((err) => {
-    console.error(err);
-    process.exit(1);
-  });