@eventcatalog/core 2.7.9 → 2.7.11

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @eventcatalog/core
 
+## 2.7.11
+
+### Patch Changes
+
+- b106e34: chore(core): added logs for builds
+
+## 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.11",
   "publishConfig": {
     "access": "public"
   },
@@ -16,7 +16,7 @@
     "test": "vitest --config vitest.config.ts",
     "test:ci": "node scripts/ci/test.js",
     "start": "astro dev",
-    "build": "npm run scripts:hydrate-content && astro check --minimumSeverity error && astro build",
+    "build": "npm run scripts:hydrate-content && node scripts/analytics/log-build.js && astro check --minimumSeverity error && astro build",
     "build:cd": "node scripts/build-ci.js",
     "preview": "astro preview",
     "astro": "astro",
@@ -49,6 +49,7 @@
     "astro-expressive-code": "^0.36.1",
     "astro-pagefind": "^1.6.0",
     "astro-seo": "^0.8.4",
+    "axios": "^1.7.7",
     "dagre": "^0.8.5",
     "diff": "^7.0.0",
     "diff2html": "^3.4.48",
@@ -65,7 +66,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/analytics/analytics.js

@@ -0,0 +1,45 @@
+import axios from 'axios';
+import os from 'os';
+import fs from 'fs';
+import path from 'path';
+
+async function getVersion() {
+  try {
+    const pkg = await fs.readFileSync(path.join(process.env.CATALOG_DIR, 'package.json'));
+    const parsed = JSON.parse(pkg);
+    return parsed.version;
+  } catch (error) {
+    console.log(error);
+    return 'unknown';
+  }
+}
+
+async function raiseEvent(eventData) {
+  const version = await getVersion();
+
+  const url = 'https://queue.simpleanalyticscdn.com/events';
+  const userAgent = `@eventcatalog/eventcatalog@${version} (${os.platform()}; ${os.arch()}; Node/${process.version})`;
+  const headers = {
+    'Content-Type': 'application/json',
+  };
+
+  const payload = {
+    type: 'event',
+    hostname: 'eventcatalog.dev',
+    event: '@eventcatalog/eventcatalog',
+    metadata: {
+      ...eventData,
+      t: `t;${new Date().toISOString()}`,
+      ua: userAgent,
+    },
+    ua: userAgent,
+  };
+
+  try {
+    await axios.post(url, payload, { headers });
+  } catch (error) {
+    // swallow the error
+  }
+}
+
+export { raiseEvent };

package/scripts/analytics/log-build.js

@@ -0,0 +1,22 @@
+import { getEventCatalogConfigFile, verifyRequiredFieldsAreInCatalogConfigFile } from '../eventcatalog-config-file-utils.js';
+import { raiseEvent } from './analytics.js';
+
+const main = async () => {
+  if (process.env.NODE_ENV === 'CI') return;
+  try {
+    await verifyRequiredFieldsAreInCatalogConfigFile(process.env.PROJECT_DIR);
+    const configFile = await getEventCatalogConfigFile(process.env.PROJECT_DIR);
+    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
+  }
+};
+
+main();

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
+  }
+};