@eventcatalog/core 5.0.0-beta.7 → 5.0.0-beta.9

package/dist/analytics/telemetry.cjs

@@ -0,0 +1,42 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/analytics/telemetry.ts
+var telemetry_exports = {};
+__export(telemetry_exports, {
+  TELEMETRY_REQUEST_TIMEOUT_MS: () => TELEMETRY_REQUEST_TIMEOUT_MS,
+  isTelemetryDisabled: () => isTelemetryDisabled
+});
+module.exports = __toCommonJS(telemetry_exports);
+var TELEMETRY_REQUEST_TIMEOUT_MS = 2e3;
+var isOptOutEnvValue = (value) => {
+  if (typeof value !== "string") return false;
+  const normalized = value.trim().toLowerCase();
+  return normalized === "1" || normalized === "true";
+};
+var isTelemetryDisabled = (config, env) => {
+  if (isOptOutEnvValue(env.EVENTCATALOG_TELEMETRY_DISABLED)) return true;
+  if (isOptOutEnvValue(env.DO_NOT_TRACK)) return true;
+  return config?.telemetry === false;
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  TELEMETRY_REQUEST_TIMEOUT_MS,
+  isTelemetryDisabled
+});

package/dist/analytics/telemetry.d.cts

@@ -0,0 +1,20 @@
+/** How long a telemetry request may take before it is aborted. */
+declare const TELEMETRY_REQUEST_TIMEOUT_MS = 2000;
+type TelemetryConfig = {
+    telemetry?: boolean;
+};
+type TelemetryEnv = {
+    EVENTCATALOG_TELEMETRY_DISABLED?: string;
+    DO_NOT_TRACK?: string;
+};
+/**
+ * Anonymous telemetry is on unless the catalog opts out.
+ * Opt out with EVENTCATALOG_TELEMETRY_DISABLED or DO_NOT_TRACK set to "1" or "true"
+ * (any case), or with telemetry: false in eventcatalog.config.js.
+ *
+ * packages/create-eventcatalog/templates/telemetry.ts copies the env rules and
+ * TELEMETRY_REQUEST_TIMEOUT_MS. Keep that copy in sync.
+ */
+declare const isTelemetryDisabled: (config: TelemetryConfig | null | undefined, env: TelemetryEnv) => boolean;
+
+export { TELEMETRY_REQUEST_TIMEOUT_MS, isTelemetryDisabled };

package/dist/analytics/telemetry.d.ts

@@ -0,0 +1,20 @@
+/** How long a telemetry request may take before it is aborted. */
+declare const TELEMETRY_REQUEST_TIMEOUT_MS = 2000;
+type TelemetryConfig = {
+    telemetry?: boolean;
+};
+type TelemetryEnv = {
+    EVENTCATALOG_TELEMETRY_DISABLED?: string;
+    DO_NOT_TRACK?: string;
+};
+/**
+ * Anonymous telemetry is on unless the catalog opts out.
+ * Opt out with EVENTCATALOG_TELEMETRY_DISABLED or DO_NOT_TRACK set to "1" or "true"
+ * (any case), or with telemetry: false in eventcatalog.config.js.
+ *
+ * packages/create-eventcatalog/templates/telemetry.ts copies the env rules and
+ * TELEMETRY_REQUEST_TIMEOUT_MS. Keep that copy in sync.
+ */
+declare const isTelemetryDisabled: (config: TelemetryConfig | null | undefined, env: TelemetryEnv) => boolean;
+
+export { TELEMETRY_REQUEST_TIMEOUT_MS, isTelemetryDisabled };

package/dist/analytics/telemetry.js

@@ -0,0 +1,8 @@
+import {
+  TELEMETRY_REQUEST_TIMEOUT_MS,
+  isTelemetryDisabled
+} from "../chunk-CPW6G62V.js";
+export {
+  TELEMETRY_REQUEST_TIMEOUT_MS,
+  isTelemetryDisabled
+};

package/dist/{chunk-3VBB2ZMP.js → chunk-4CFZUHGG.js}

@@ -1,10 +1,15 @@
+import {
+  TELEMETRY_REQUEST_TIMEOUT_MS,
+  isTelemetryDisabled
+} from "./chunk-CPW6G62V.js";
 import {
   VERSION
-} from "./chunk-FARBIZ7Y.js";
+} from "./chunk-EUNQJO3J.js";
 
 // src/analytics/analytics.js
 import os from "os";
-async function raiseEvent(eventData) {
+async function raiseEvent(eventData, config) {
+  if (isTelemetryDisabled(config, process.env)) return;
   if (typeof eventData?.command !== "string" || typeof eventData?.cId !== "string") return;
   const url = "https://queue.simpleanalyticscdn.com/events";
   const userAgent = `@eventcatalog/eventcatalog@${VERSION} (${os.platform()}; ${os.arch()}; Node/${process.version})`;
@@ -26,7 +31,8 @@ async function raiseEvent(eventData) {
     const response = await fetch(url, {
       method: "POST",
       headers,
-      body: JSON.stringify(payload)
+      body: JSON.stringify(payload),
+      signal: AbortSignal.timeout(TELEMETRY_REQUEST_TIMEOUT_MS)
     });
     if (!response.ok) {
       throw new Error(`Failed to raise analytics event: ${response.status}`);

package/dist/{chunk-PIYJM642.js → chunk-AWOO63ME.js}

@@ -1,5 +1,6 @@
 // src/utils/license-status.ts
 import boxen from "boxen";
+import pc from "picocolors";
 import { isEventCatalogScaleEnabled, isEventCatalogStarterEnabled } from "@eventcatalog/license";
 
 // eventcatalog/src/utils/trial.ts
@@ -122,75 +123,100 @@ var getLicenseAnalytics = (license = { state: "none" }, tsd) => ({
 });
 var formatDate = (date) => date.toLocaleDateString(void 0, { dateStyle: "medium" });
 var formatDays = (days) => `${days} ${days === 1 ? "day" : "days"}`;
-var getTrialLine = (tsd, now) => {
+var PLAIN = { bold: (text) => text, dim: (text) => text, link: (text) => text };
+var COLOURS = { bold: pc.bold, dim: pc.dim, link: (text) => pc.cyan(text) };
+var render = ({ headline, rows, links }, colours) => {
+  const width = Math.max(0, ...[...rows, ...links].map(([label]) => label.length));
+  const row = ([label, value]) => `${colours.dim(label.padEnd(width))}  ${value}`;
+  return [
+    colours.bold(headline),
+    ...rows.length ? ["", ...rows.map(row)] : [],
+    ...links.length ? ["", ...links.map(([label, url]) => row([label, colours.link(url)]))] : []
+  ].join("\n");
+};
+var message = (content) => ({
+  ...content,
+  text: render(content, PLAIN)
+});
+var getTrialRow = (tsd, now) => {
   const trial = getTrialStatus(tsd, now);
   if (!trial) return;
-  return trial.ended ? `Your ${TRIAL_LENGTH_DAYS}-day EventCatalog trial ended on ${formatDate(trial.endsAt)}.` : `${formatDays(trial.daysLeft)} left of your ${TRIAL_LENGTH_DAYS}-day EventCatalog trial (ends ${formatDate(trial.endsAt)}).`;
+  return [
+    "Trial",
+    trial.ended ? `Ended ${formatDate(trial.endsAt)}` : `${formatDays(trial.daysLeft)} left of ${TRIAL_LENGTH_DAYS} (ends ${formatDate(trial.endsAt)})`
+  ];
 };
 var getLicenseStatusMessage = (license, tsd, now = Date.now()) => {
+  const licensing = ["Licensing", LICENSE_FAQ_URL];
+  const renew = ["Renew", LICENSE_RENEW_URL];
+  const licensedTo = "org" in license && license.org ? [["Licensed to", license.org]] : [];
   if (license.state === "licensed") {
     const daysLeft = Math.max(0, Math.ceil((license.expiresAt.getTime() - now) / DAY_IN_MS2));
-    const licensedTo = license.org ? `Licensed to ${license.org}` : "Licensed";
     if (daysLeft < LICENSE_REMINDER_DAYS) {
-      return {
-        title: "EventCatalog Commercial License",
+      return message({
+        title: "EventCatalog license",
         color: "yellow",
-        text: [
-          licensedTo,
-          `Your license expires in ${formatDays(daysLeft)}, on ${formatDate(license.expiresAt)}.`,
-          `Renew it to keep using EventCatalog commercially: ${LICENSE_RENEW_URL}`
-        ].join("\n")
-      };
+        headline: `Your commercial license expires in ${formatDays(daysLeft)}`,
+        rows: [...licensedTo, ["Expires", formatDate(license.expiresAt)]],
+        links: [renew]
+      });
     }
-    return {
-      title: "EventCatalog Commercial License",
+    return message({
+      title: "EventCatalog license",
       color: "green",
-      text: `${licensedTo}
-Valid until ${formatDate(license.expiresAt)} (${formatDays(daysLeft)} left)`
-    };
+      headline: "Commercial license active",
+      rows: [...licensedTo, ["Valid until", `${formatDate(license.expiresAt)} (${formatDays(daysLeft)} left)`]],
+      links: []
+    });
   }
   if (license.state === "plan") return;
-  const trialLine = getTrialLine(tsd, now);
+  const trialRow = getTrialRow(tsd, now);
+  const trialRows = trialRow ? [trialRow] : [];
   if (license.state === "none") {
-    if (!trialLine) return;
-    const ended = getTrialStatus(tsd, now)?.ended;
-    return {
+    const trial = getTrialStatus(tsd, now);
+    if (!trial || !trialRow) return;
+    return message({
       title: "EventCatalog trial",
-      color: ended ? "yellow" : "green",
-      text: `${trialLine}
-Learn about licensing: ${LICENSE_FAQ_URL}`
-    };
+      color: trial.ended ? "yellow" : "green",
+      headline: trial.ended ? "Your EventCatalog trial has ended" : `You're on the ${TRIAL_LENGTH_DAYS}-day EventCatalog trial`,
+      rows: trialRows,
+      links: trial.ended ? [["Get a license", LICENSE_RENEW_URL], licensing] : [licensing]
+    });
   }
   if (license.state === "expired") {
-    const expiredOn = license.expiresAt ? `expired on ${formatDate(license.expiresAt)} (${formatDays(Math.floor((now - license.expiresAt.getTime()) / DAY_IN_MS2))} ago)` : "has expired";
-    return {
-      title: "EventCatalog License Expired",
+    const expiredOn = license.expiresAt ? [
+      [
+        "Expired",
+        `${formatDate(license.expiresAt)} (${formatDays(Math.floor((now - license.expiresAt.getTime()) / DAY_IN_MS2))} ago)`
+      ]
+    ] : [];
+    return message({
+      title: "EventCatalog license",
       color: "yellow",
-      text: [
-        `Your EventCatalog commercial license${license.org ? ` for ${license.org}` : ""} ${expiredOn}.`,
-        `Renew it to keep using EventCatalog commercially: ${LICENSE_RENEW_URL}`,
-        trialLine,
-        `Learn about licensing: ${LICENSE_FAQ_URL}`
-      ].filter(Boolean).join("\n")
-    };
+      headline: "Your commercial license has expired",
+      rows: [...licensedTo, ...expiredOn, ...trialRows],
+      links: [renew, licensing]
+    });
   }
-  return {
+  return message({
     title: "EventCatalog license",
     color: "yellow",
-    text: [`Your license.jwt could not be verified: ${license.reason}.`, trialLine, `Learn about licensing: ${LICENSE_FAQ_URL}`].filter(Boolean).join("\n")
-  };
+    headline: "Your license.jwt couldn't be verified",
+    rows: [["Reason", license.reason.charAt(0).toUpperCase() + license.reason.slice(1)], ...trialRows],
+    links: [licensing]
+  });
 };
 var printLicenseStatus = (license, tsd) => {
-  const message = getLicenseStatusMessage(license, tsd);
-  if (!message) return;
+  const status = getLicenseStatusMessage(license, tsd);
+  if (!status) return;
   console.log(
-    boxen(message.text, {
-      padding: 1,
+    boxen(render(status, COLOURS), {
+      padding: { top: 1, bottom: 1, left: 2, right: 2 },
       margin: 1,
       borderStyle: "round",
-      borderColor: message.color,
-      title: message.title,
-      titleAlignment: "center"
+      borderColor: status.color,
+      title: status.title,
+      titleAlignment: "left"
     })
   );
 };

package/dist/chunk-CPW6G62V.js

@@ -0,0 +1,17 @@
+// src/analytics/telemetry.ts
+var TELEMETRY_REQUEST_TIMEOUT_MS = 2e3;
+var isOptOutEnvValue = (value) => {
+  if (typeof value !== "string") return false;
+  const normalized = value.trim().toLowerCase();
+  return normalized === "1" || normalized === "true";
+};
+var isTelemetryDisabled = (config, env) => {
+  if (isOptOutEnvValue(env.EVENTCATALOG_TELEMETRY_DISABLED)) return true;
+  if (isOptOutEnvValue(env.DO_NOT_TRACK)) return true;
+  return config?.telemetry === false;
+};
+
+export {
+  TELEMETRY_REQUEST_TIMEOUT_MS,
+  isTelemetryDisabled
+};

package/dist/{chunk-MDWB5HLO.js → chunk-ENAG6UH7.js}

@@ -13,6 +13,10 @@ var isOutputServer = async () => {
   const config = await getEventCatalogConfigFile(process.env.PROJECT_DIR || "");
   return config?.output === "server";
 };
+var isStudioEnabled = async () => {
+  const config = await getEventCatalogConfigFile(process.env.PROJECT_DIR || "");
+  return config?.output === "server" && config?.studio?.enabled === true;
+};
 var isIndexedSearchEnabled = async () => {
   const config = await getEventCatalogConfigFile(process.env.PROJECT_DIR || "");
   return config?.search?.type === "indexed";
@@ -26,6 +30,7 @@ var isAuthEnabled = async () => {
 export {
   getProjectOutDir,
   isOutputServer,
+  isStudioEnabled,
   isIndexedSearchEnabled,
   isAuthEnabled
 };

package/dist/{chunk-FARBIZ7Y.js → chunk-EUNQJO3J.js}

@@ -1,5 +1,5 @@
 // package.json
-var version = "5.0.0-beta.7";
+var version = "5.0.0-beta.9";
 
 // src/constants.ts
 var VERSION = version;

package/dist/{chunk-S7ODHVII.js → chunk-GAHKCOQM.js}

@@ -1,6 +1,6 @@
 import {
   VERSION
-} from "./chunk-FARBIZ7Y.js";
+} from "./chunk-EUNQJO3J.js";
 
 // src/utils/cli-logger.ts
 import pc from "picocolors";

package/dist/{chunk-BOKAG5XC.js → chunk-JQMYHZWI.js}

@@ -1,14 +1,18 @@
 import {
-  getLicenseAnalytics
-} from "./chunk-PIYJM642.js";
+  raiseEvent
+} from "./chunk-4CFZUHGG.js";
 import {
   countResources,
   hashCatalogContent,
   serializeCounts
 } from "./chunk-ZAZHAVKB.js";
 import {
-  raiseEvent
-} from "./chunk-3VBB2ZMP.js";
+  TELEMETRY_REQUEST_TIMEOUT_MS,
+  isTelemetryDisabled
+} from "./chunk-CPW6G62V.js";
+import {
+  getLicenseAnalytics
+} from "./chunk-AWOO63ME.js";
 import {
   getEventCatalogConfigFile,
   verifyRequiredFieldsAreInCatalogConfigFile
@@ -69,50 +73,69 @@ var toCloudResourceCounts = (counts) => ({
   customPages: counts.customPages || 0,
   customApis: counts.customApis || 0
 });
-var reportCloudResourceInventory = async (configFile, resourceCounts) => {
+var getEnabledCloudAnalytics = (configFile) => {
   const analytics = configFile.cloud?.analytics;
-  if (!analytics?.enabled || !analytics.trackingId || !analytics.writeKey) return;
+  if (!analytics?.enabled || !analytics.trackingId || !analytics.writeKey) return null;
+  return analytics;
+};
+var reportCloudResourceInventory = async (configFile, resourceCounts) => {
+  const analytics = getEnabledCloudAnalytics(configFile);
+  if (!analytics) return;
   const endpoint = analytics.endpoint || CLOUD_ANALYTICS_ENDPOINT;
-  await fetch(endpoint, {
-    method: "POST",
-    headers: {
-      "Content-Type": "application/json",
-      "X-EventCatalog-Analytics-Key": analytics.writeKey
-    },
-    body: JSON.stringify({
-      trackingId: analytics.trackingId,
-      event: "catalog.resource_inventory_reported",
-      timestamp: (/* @__PURE__ */ new Date()).toISOString(),
-      counts: toCloudResourceCounts(resourceCounts)
-    })
-  });
+  try {
+    await fetch(endpoint, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+        "X-EventCatalog-Analytics-Key": analytics.writeKey
+      },
+      body: JSON.stringify({
+        trackingId: analytics.trackingId,
+        event: "catalog.resource_inventory_reported",
+        timestamp: (/* @__PURE__ */ new Date()).toISOString(),
+        counts: toCloudResourceCounts(resourceCounts)
+      }),
+      signal: AbortSignal.timeout(TELEMETRY_REQUEST_TIMEOUT_MS)
+    });
+  } catch {
+  }
 };
 var main = async (projectDir, { command = "build", license } = {}) => {
   try {
     await verifyRequiredFieldsAreInCatalogConfigFile(projectDir);
     const configFile = await getEventCatalogConfigFile(projectDir);
+    if (isTelemetryDisabled(configFile, process.env)) {
+      if (getEnabledCloudAnalytics(configFile)) {
+        const resourceCounts2 = await countResources(projectDir);
+        await reportCloudResourceInventory(configFile, resourceCounts2);
+      }
+      return;
+    }
     const { cId, tsd, organizationName, generators = [] } = configFile;
     const generatorNames = generators.length > 0 ? generators.map((generator) => generator[0]) : ["none"];
     const features = await getFeatures(configFile);
     const resourceCounts = await countResources(projectDir);
     const contentHash = await hashCatalogContent(projectDir);
     await reportCloudResourceInventory(configFile, resourceCounts);
-    await raiseEvent({
-      command,
-      org: organizationName,
-      cId,
-      // Trial start date (unix ms) from eventcatalog.config.js
-      tsd,
-      // Commercial license or trial, and when each expires (unix ms)
-      ...getLicenseAnalytics(license, tsd),
-      // CI redeploys and human-run builds are different signals; tag rather than suppress
-      ci: process.env.CI ? "true" : "false",
-      contentHash,
-      generators: generatorNames.toString(),
-      features: Object.keys(features).map((feature) => `${feature}:${features[feature]}`).join(","),
-      directorySources: serializeDirectorySources(configFile),
-      resources: serializeCounts(resourceCounts)
-    });
+    await raiseEvent(
+      {
+        command,
+        org: organizationName,
+        cId,
+        // Trial start date (unix ms) from eventcatalog.config.js
+        tsd,
+        // Commercial license or trial, and when each expires (unix ms)
+        ...getLicenseAnalytics(license, tsd),
+        // CI redeploys and human-run builds are different signals; tag rather than suppress
+        ci: process.env.CI ? "true" : "false",
+        contentHash,
+        generators: generatorNames.toString(),
+        features: Object.keys(features).map((feature) => `${feature}:${features[feature]}`).join(","),
+        directorySources: serializeDirectorySources(configFile),
+        resources: serializeCounts(resourceCounts)
+      },
+      configFile
+    );
   } catch (error) {
   }
 };

package/dist/{chunk-SJJKWZYZ.js → chunk-TZVDMWQX.js}

@@ -1,6 +1,6 @@
 import {
   logger
-} from "./chunk-S7ODHVII.js";
+} from "./chunk-GAHKCOQM.js";
 import {
   cleanup,
   getEventCatalogConfigFile

package/dist/constants.cjs

@@ -25,7 +25,7 @@ __export(constants_exports, {
 module.exports = __toCommonJS(constants_exports);
 
 // package.json
-var version = "5.0.0-beta.7";
+var version = "5.0.0-beta.9";
 
 // src/constants.ts
 var VERSION = version;

package/dist/constants.js

@@ -1,6 +1,6 @@
 import {
   VERSION
-} from "./chunk-FARBIZ7Y.js";
+} from "./chunk-EUNQJO3J.js";
 export {
   VERSION
 };