@eventcatalog/core 2.7.9 → 2.7.10

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @eventcatalog/core
 
+## 2.7.10
+
+### Patch Changes
+
+- d4e2013: chore(core): added ability to check and add properties on users catal…
+
 ## 2.7.9
 
 ### Patch Changes

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@eventcatalog/core",
   "type": "module",
-  "version": "2.7.9",
+  "version": "2.7.10",
   "publishConfig": {
     "access": "public"
   },
@@ -65,7 +65,8 @@
     "semver": "7.6.3",
     "tailwindcss": "^3.4.3",
     "typescript": "^5.4.5",
-    "unist-util-visit": "^5.0.0"
+    "unist-util-visit": "^5.0.0",
+    "uuid": "^10.0.0"
   },
   "devDependencies": {
     "@parcel/watcher": "^2.4.1",

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

@@ -3,6 +3,7 @@ import * as path from 'node:path';
 import fs from 'fs';
 import { fileURLToPath } from 'url';
 import os from 'node:os';
+import { verifyRequiredFieldsAreInCatalogConfigFile } from './eventcatalog-config-file-utils.js';
 
 const __filename = fileURLToPath(import.meta.url);
 const scriptsDir = path.dirname(__filename);
@@ -262,6 +263,9 @@ export const catalogToAstro = async (source, astroContentDir, catalogFilesDir) =
 
   // Copy the components if they are defined
   await copyComponents({ source, target: astroContentDir, catalogFilesDir });
+
+  // Verify required fields are in the catalog config file
+  await verifyRequiredFieldsAreInCatalogConfigFile(source);
 };
 
 if (process.env.NODE_ENV !== 'test') {

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

@@ -1,6 +1,7 @@
 import { readFile, writeFile, rm } from 'node:fs/promises';
 import { existsSync } from 'fs';
 import path from 'node:path';
+import { v4 as uuidV4 } from 'uuid';
 
 // * Very strange behaviour when importing ESM files from catalogs into core.
 //  * Core (node) does not know how to handle ESM files, so we have to try and convert them.
@@ -94,3 +95,16 @@ export const writeEventCatalogConfigFile = async (projectDirectory, newConfig) =
     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
+  }
+};