@eventcatalog/create-eventcatalog 2.0.13 → 2.0.15

package/dist/index.js

@@ -1203,7 +1203,7 @@ var require_has_flag = __commonJS({
 var require_supports_color = __commonJS({
   "node_modules/supports-color/index.js"(exports2, module2) {
     "use strict";
-    var os2 = require("os");
+    var os3 = require("os");
     var hasFlag = require_has_flag();
     var env = process.env;
     var forceColor;
@@ -1241,7 +1241,7 @@ var require_supports_color = __commonJS({
       }
       const min = forceColor ? 1 : 0;
       if (process.platform === "win32") {
-        const osRelease = os2.release().split(".");
+        const osRelease = os3.release().split(".");
         if (Number(process.versions.node.split(".")[0]) >= 8 && Number(osRelease[0]) >= 10 && Number(osRelease[2]) >= 10586) {
           return Number(osRelease[2]) >= 14931 ? 3 : 2;
         }
@@ -7884,9 +7884,9 @@ var require_path = __commonJS({
     "use strict";
     Object.defineProperty(exports2, "__esModule", { value: true });
     exports2.convertPosixPathToPattern = exports2.convertWindowsPathToPattern = exports2.convertPathToPattern = exports2.escapePosixPath = exports2.escapeWindowsPath = exports2.escape = exports2.removeLeadingDotSegment = exports2.makeAbsolute = exports2.unixify = void 0;
-    var os2 = require("os");
+    var os3 = require("os");
     var path8 = require("path");
-    var IS_WINDOWS_PLATFORM = os2.platform() === "win32";
+    var IS_WINDOWS_PLATFORM = os3.platform() === "win32";
     var LEADING_DOT_SEGMENT_CHARACTERS_COUNT = 2;
     var POSIX_UNESCAPED_GLOB_SYMBOLS_RE = /(\\?)([()*?[\]{|}]|^!|[!+@](?=\()|\\(?![!()*+?@[\]{|}]))/g;
     var WINDOWS_UNESCAPED_GLOB_SYMBOLS_RE = /(\\?)([()[\]{}]|^!|[!+@](?=\())/g;
@@ -13106,8 +13106,8 @@ var require_settings4 = __commonJS({
     Object.defineProperty(exports2, "__esModule", { value: true });
     exports2.DEFAULT_FILE_SYSTEM_ADAPTER = void 0;
     var fs7 = require("fs");
-    var os2 = require("os");
-    var CPU_COUNT = Math.max(os2.cpus().length, 1);
+    var os3 = require("os");
+    var CPU_COUNT = Math.max(os3.cpus().length, 1);
     exports2.DEFAULT_FILE_SYSTEM_ADAPTER = {
       lstat: fs7.lstat,
       lstatSync: fs7.lstatSync,
@@ -22452,10 +22452,97 @@ function install(root, dependencies, { packageManager: packageManager2, isOnline
 }
 
 // templates/index.ts
-var import_os2 = __toESM(require("os"));
+var import_os3 = __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"));
+var import_os2 = __toESM(require("os"));
+
+// package.json
+var package_default = {
+  name: "@eventcatalog/create-eventcatalog",
+  description: "Create EventCatalog with one command",
+  version: "2.0.15",
+  bin: {
+    "create-catalog": "./dist/index.js"
+  },
+  files: [
+    "dist",
+    "templates"
+  ],
+  publishConfig: {
+    access: "public"
+  },
+  scripts: {
+    prepublishOnly: "npm run build",
+    build: "tsup index.ts --format cjs --dts",
+    run: "node dist/index.js",
+    dev: "npm run build --watch",
+    changeset: "changeset",
+    release: "changeset publish"
+  },
+  devDependencies: {
+    "@types/async-retry": "1.4.2",
+    "@types/ci-info": "2.0.0",
+    "@types/cross-spawn": "6.0.0",
+    "@types/node": "^12.6.8",
+    "@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",
+    chalk: "2.4.2",
+    "ci-info": "watson/ci-info#f43f6a1cefff47fb361c88cf4b943fdbcaafe540",
+    commander: "2.20.0",
+    cpy: "^11.0.0",
+    "cross-spawn": "6.0.5",
+    "fast-glob": "^3.3.2",
+    got: "^14.0.0",
+    prompts: "2.1.0",
+    rimraf: "^5.0.7",
+    tar: "^4.4.19",
+    tsup: "^8.1.0",
+    typescript: "^5.4.5",
+    "update-check": "1.5.4",
+    "validate-npm-package-name": "3.0.0"
+  },
+  dependencies: {
+    "@changesets/cli": "^2.27.6",
+    axios: "^1.7.7",
+    uuid: "^10.0.0"
+  }
+};
+
+// templates/analytics.ts
+async function raiseEvent(eventData) {
+  const url2 = "https://queue.simpleanalyticscdn.com/events";
+  const userAgent = `@eventcatalog/create-eventcatalog/${package_default.version} (${import_os2.default.platform()}; ${import_os2.default.arch()}; Node/${process.version})`;
+  const headers = {
+    "Content-Type": "application/json"
+  };
+  const payload = {
+    type: "event",
+    hostname: "eventcatalog.dev",
+    event: "@eventcatalog/create-eventcatalog",
+    metadata: {
+      ...eventData,
+      ua: userAgent
+    },
+    ua: userAgent
+  };
+  try {
+    await import_axios.default.post(url2, payload, { headers });
+  } catch (error) {
+  }
+}
+
+// templates/index.ts
 var installTemplate = async ({
   appName,
   root,
@@ -22463,7 +22550,8 @@ var installTemplate = async ({
   isOnline,
   template,
   mode,
-  eslint
+  eslint,
+  organizationName: organizationName2
 }) => {
   console.log(import_chalk3.default.bold(`Using ${packageManager2}.`));
   const packageJson = {
@@ -22484,7 +22572,7 @@ var installTemplate = async ({
   };
   import_fs16.default.writeFileSync(
     import_path9.default.join(root, "package.json"),
-    JSON.stringify(packageJson, null, 2) + import_os2.default.EOL
+    JSON.stringify(packageJson, null, 2) + import_os3.default.EOL
   );
   const installFlags = { packageManager: packageManager2, isOnline };
   const dependencies = [];
@@ -22533,6 +22621,13 @@ var installTemplate = async ({
       }
     }
   });
+  const cId = (0, import_uuid.v4)();
+  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, cId);
+  import_fs16.default.writeFileSync(eventCatalogConfigPath, eventCatalogConfig);
+  await raiseEvent({ command: "create", org: organizationName2, cId });
   if (!eslint) {
     await import_fs16.default.promises.unlink(import_path9.default.join(root, ".eslintrc.json"));
   }
@@ -22548,7 +22643,8 @@ async function createApp({
   examplePath,
   typescript,
   eslint,
-  experimentalApp
+  experimentalApp,
+  organizationName: organizationName2
 }) {
   let repoInfo;
   const mode = typescript ? "ts" : "js";
@@ -22582,7 +22678,8 @@ async function createApp({
     mode,
     packageManager: packageManager2,
     isOnline,
-    eslint
+    eslint,
+    organizationName: organizationName2
   });
   if (tryGitInit(root)) {
     console.log("Initialized a git repository.");
@@ -22651,62 +22748,9 @@ function validateNpmName(name) {
   };
 }
 
-// package.json
-var package_default = {
-  name: "@eventcatalog/create-eventcatalog",
-  description: "Create EventCatalog with one command",
-  version: "2.0.13",
-  bin: {
-    "create-catalog": "./dist/index.js"
-  },
-  files: [
-    "dist",
-    "templates"
-  ],
-  publishConfig: {
-    access: "public"
-  },
-  scripts: {
-    prepublishOnly: "npm run build",
-    build: "tsup index.ts --format cjs --dts",
-    run: "node dist/index.js",
-    dev: "npm run build --watch",
-    changeset: "changeset",
-    release: "changeset publish"
-  },
-  devDependencies: {
-    "@types/async-retry": "1.4.2",
-    "@types/ci-info": "2.0.0",
-    "@types/cross-spawn": "6.0.0",
-    "@types/node": "^12.6.8",
-    "@types/prompts": "2.0.1",
-    "@types/rimraf": "3.0.0",
-    "@types/tar": "4.0.3",
-    "@types/validate-npm-package-name": "3.0.0",
-    "@vercel/ncc": "0.34.0",
-    "async-retry": "1.3.1",
-    chalk: "2.4.2",
-    "ci-info": "watson/ci-info#f43f6a1cefff47fb361c88cf4b943fdbcaafe540",
-    commander: "2.20.0",
-    cpy: "^11.0.0",
-    "cross-spawn": "6.0.5",
-    "fast-glob": "^3.3.2",
-    got: "^14.0.0",
-    prompts: "2.1.0",
-    rimraf: "^5.0.7",
-    tar: "^4.4.19",
-    tsup: "^8.1.0",
-    typescript: "^5.4.5",
-    "update-check": "1.5.4",
-    "validate-npm-package-name": "3.0.0"
-  },
-  dependencies: {
-    "@changesets/cli": "^2.27.6"
-  }
-};
-
 // 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 +22846,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 +22884,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 +22906,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.15",
   "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,37 @@
+import axios from 'axios';
+import os from 'os';
+import pkg from '../package.json';
+
+interface EventMetadata {
+  command: string;
+  org: string;
+  cId: string;
+}
+
+async function raiseEvent(eventData: EventMetadata): Promise<void> {
+  const url = "https://queue.simpleanalyticscdn.com/events";
+  const userAgent = `@eventcatalog/create-eventcatalog/${pkg.version} (${os.platform()}; ${os.arch()}; Node/${process.version})`;
+  const headers = {
+    "Content-Type": "application/json",
+  };
+
+  const payload = {
+    type: "event",
+    hostname: "eventcatalog.dev",
+    event: "@eventcatalog/create-eventcatalog",
+    metadata: {
+      ...eventData,
+      ua: userAgent
+    },
+    ua: userAgent
+  };
+
+  try {
+    await axios.post(url, payload, { headers });
+  } catch (error) {
+    // swallow the 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,17 @@ export const installTemplate = async ({
     },
   });
 
+  const cId = v4();
+
+  // 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, cId );
+  fs.writeFileSync(eventCatalogConfigPath, eventCatalogConfig);
+
+  await raiseEvent({ command: 'create', org: organizationName, cId });
+
   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;