@eventcatalog/create-eventcatalog 2.0.13 → 2.0.14

package/dist/index.js

@@ -22456,6 +22456,31 @@ var import_os2 = __toESM(require("os"));
 var import_fs16 = __toESM(require("fs"));
 var import_path9 = __toESM(require("path"));
 var import_chalk3 = __toESM(require_chalk());
+var import_uuid = require("uuid");
+
+// templates/analytics.ts
+var import_axios = __toESM(require("axios"));
+async function raiseEvent(eventData) {
+  const url2 = "https://queue.simpleanalyticscdn.com/events";
+  const headers = {
+    "Content-Type": "application/json"
+  };
+  const payload = {
+    type: "event",
+    hostname: "eventcatalog.dev",
+    event: "@eventcatalog/create-eventcatalog",
+    metadata: eventData,
+    timestamp: (/* @__PURE__ */ new Date()).toISOString()
+  };
+  try {
+    await import_axios.default.post(url2, payload, { headers });
+    console.log("Event successfully sent");
+  } catch (error) {
+    console.log("Error sending event:", error);
+  }
+}
+
+// templates/index.ts
 var installTemplate = async ({
   appName,
   root,
@@ -22463,7 +22488,8 @@ var installTemplate = async ({
   isOnline,
   template,
   mode,
-  eslint
+  eslint,
+  organizationName: organizationName2
 }) => {
   console.log(import_chalk3.default.bold(`Using ${packageManager2}.`));
   const packageJson = {
@@ -22533,6 +22559,12 @@ var installTemplate = async ({
       }
     }
   });
+  const eventCatalogConfigPath = import_path9.default.join(root, "eventcatalog.config.js");
+  let eventCatalogConfig = import_fs16.default.readFileSync(eventCatalogConfigPath, "utf8");
+  eventCatalogConfig = eventCatalogConfig.replace(/<organizationName>/g, organizationName2);
+  eventCatalogConfig = eventCatalogConfig.replace(/<cId>/g, (0, import_uuid.v4)());
+  import_fs16.default.writeFileSync(eventCatalogConfigPath, eventCatalogConfig);
+  await raiseEvent({ command: "create", org: organizationName2, id: (0, import_uuid.v4)() });
   if (!eslint) {
     await import_fs16.default.promises.unlink(import_path9.default.join(root, ".eslintrc.json"));
   }
@@ -22548,7 +22580,8 @@ async function createApp({
   examplePath,
   typescript,
   eslint,
-  experimentalApp
+  experimentalApp,
+  organizationName: organizationName2
 }) {
   let repoInfo;
   const mode = typescript ? "ts" : "js";
@@ -22582,7 +22615,8 @@ async function createApp({
     mode,
     packageManager: packageManager2,
     isOnline,
-    eslint
+    eslint,
+    organizationName: organizationName2
   });
   if (tryGitInit(root)) {
     console.log("Initialized a git repository.");
@@ -22655,7 +22689,7 @@ function validateNpmName(name) {
 var package_default = {
   name: "@eventcatalog/create-eventcatalog",
   description: "Create EventCatalog with one command",
-  version: "2.0.13",
+  version: "2.0.14",
   bin: {
     "create-catalog": "./dist/index.js"
   },
@@ -22682,6 +22716,7 @@ var package_default = {
     "@types/prompts": "2.0.1",
     "@types/rimraf": "3.0.0",
     "@types/tar": "4.0.3",
+    "@types/uuid": "^10.0.0",
     "@types/validate-npm-package-name": "3.0.0",
     "@vercel/ncc": "0.34.0",
     "async-retry": "1.3.1",
@@ -22701,12 +22736,15 @@ var package_default = {
     "validate-npm-package-name": "3.0.0"
   },
   dependencies: {
-    "@changesets/cli": "^2.27.6"
+    "@changesets/cli": "^2.27.6",
+    axios: "^1.7.7",
+    uuid: "^10.0.0"
   }
 };
 
 // index.ts
 var projectPath = "";
+var organizationName = "";
 var program = new import_commander.default.Command(package_default.name).version(package_default.version).arguments("<project-directory>").usage(`${import_chalk5.default.green("<project-directory>")} [options]`).action((name) => {
   projectPath = name;
 }).option(
@@ -22802,6 +22840,17 @@ Run ${import_chalk5.default.cyan(`${program.name()} --help`)} to see all options
     );
     process.exit(1);
   }
+  if (!organizationName) {
+    const res = await (0, import_prompts.default)({
+      type: "text",
+      name: "organizationName",
+      message: "What is your organization name?",
+      initial: "EventCatalog Ltd"
+    });
+    if (typeof res.organizationName === "string") {
+      organizationName = res.organizationName.trim();
+    }
+  }
   const resolvedProjectPath = import_path11.default.resolve(projectPath);
   const projectName = import_path11.default.basename(resolvedProjectPath);
   const { valid, problems } = validateNpmName(projectName);
@@ -22829,7 +22878,8 @@ Run ${import_chalk5.default.cyan(`${program.name()} --help`)} to see all options
       examplePath: program.examplePath,
       typescript: true,
       eslint: true,
-      experimentalApp: false
+      experimentalApp: false,
+      organizationName
     });
   } catch (reason) {
     if (!(reason instanceof DownloadError)) {
@@ -22850,6 +22900,7 @@ Do you want to use the default template instead?`,
       packageManager,
       typescript: program.typescript,
       eslint: program.eslint,
+      organizationName,
       experimentalApp: program.experimentalApp
     });
   }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@eventcatalog/create-eventcatalog",
   "description": "Create EventCatalog with one command",
-  "version": "2.0.13",
+  "version": "2.0.14",
   "bin": {
     "create-catalog": "./dist/index.js"
   },
@@ -28,6 +28,7 @@
     "@types/prompts": "2.0.1",
     "@types/rimraf": "3.0.0",
     "@types/tar": "4.0.3",
+    "@types/uuid": "^10.0.0",
     "@types/validate-npm-package-name": "3.0.0",
     "@vercel/ncc": "0.34.0",
     "async-retry": "1.3.1",
@@ -47,6 +48,8 @@
     "validate-npm-package-name": "3.0.0"
   },
   "dependencies": {
-    "@changesets/cli": "^2.27.6"
+    "@changesets/cli": "^2.27.6",
+    "axios": "^1.7.7",
+    "uuid": "^10.0.0"
   }
 }

package/templates/analytics.ts

@@ -0,0 +1,32 @@
+import axios from 'axios';
+
+interface EventMetadata {
+  command: string;
+  org: string;
+  id: string;
+}
+
+async function raiseEvent(eventData: EventMetadata): Promise<void> {
+  const url = "https://queue.simpleanalyticscdn.com/events";
+  const headers = {
+    "Content-Type": "application/json",
+  };
+
+  const payload = {
+    type: "event",
+    hostname: "eventcatalog.dev",
+    event: "@eventcatalog/create-eventcatalog",
+    metadata: eventData,
+    timestamp: new Date().toISOString(),
+  };
+
+  try {
+    await axios.post(url, payload, { headers });
+    console.log("Event successfully sent");
+  } catch (error) {
+    console.log("Error sending event:", error);
+  }
+}
+
+// Export the function so it can be used in other parts of the application
+export { raiseEvent };

package/templates/default/eventcatalog.config.js

@@ -2,7 +2,7 @@
 export default {
   title: 'EventCatalog',
   tagline: 'Discover, Explore and Document your Event Driven Architectures',
-  organizationName: 'Your Company',
+  organizationName: '<organizationName>',
   homepageLink: 'https://eventcatalog.dev/',
   editUrl: 'https://github.com/boyney123/eventcatalog-demo/edit/master',
   // By default set to false, add true to get urls ending in /
@@ -21,5 +21,7 @@ export default {
       // Should the sub heading be rendered in the docs sidebar?
       showPageHeadings: true
     }
-  }
+  },
+  // required random generated id used by eventcatalog
+  cId: '<cId>'
 }

package/templates/index.ts

@@ -5,8 +5,10 @@ import os from "os";
 import fs from "fs";
 import path from "path";
 import chalk from "chalk";
+import { v4 } from 'uuid'
 
 import { GetTemplateFileArgs, InstallTemplateArgs } from "./types";
+import { raiseEvent } from "./analytics";
 
 /**
  * Get the file path for a given file in a template, e.g. "next.config.js".
@@ -30,6 +32,7 @@ export const installTemplate = async ({
   template,
   mode,
   eslint,
+  organizationName
 }: InstallTemplateArgs) => {
   console.log(chalk.bold(`Using ${packageManager}.`));
 
@@ -131,6 +134,15 @@ export const installTemplate = async ({
     },
   });
 
+  // update the properties in the eventcatalog.config.js
+  const eventCatalogConfigPath = path.join(root, "eventcatalog.config.js");
+  let eventCatalogConfig = fs.readFileSync(eventCatalogConfigPath, "utf8");
+  eventCatalogConfig = eventCatalogConfig.replace( /<organizationName>/g, organizationName );
+  eventCatalogConfig = eventCatalogConfig.replace( /<cId>/g, v4() );
+  fs.writeFileSync(eventCatalogConfigPath, eventCatalogConfig);
+
+  await raiseEvent({ command: 'create', org: organizationName, id: v4() });
+
   if (!eslint) {
     // remove un-necessary template file if eslint is not desired
     await fs.promises.unlink(path.join(root, ".eslintrc.json"));

package/templates/types.ts

@@ -14,7 +14,7 @@ export interface InstallTemplateArgs {
   root: string;
   packageManager: PackageManager;
   isOnline: boolean;
-
+  organizationName: string;
   template: TemplateType;
   mode: TemplateMode;
   eslint: boolean;