@webiny/telemetry 6.0.0-alpha.5 → 6.0.0-rc.0

package/README.md

@@ -1 +1,11 @@
 # @webiny/telemetry
+
+> [!NOTE]
+> This package is part of the [Webiny](https://www.webiny.com) monorepo.
+> It’s **included in every Webiny project by default** and is not meant to be used as a standalone package.
+
+📘 **Documentation:** [https://www.webiny.com/docs](https://www.webiny.com/docs)
+
+---
+
+_This README file is automatically generated during the publish process._

package/cli.d.ts

@@ -0,0 +1,12 @@
+export declare interface SendEventParams {
+    event: string;
+    user?: string;
+    version?: string;
+    properties: Record<string, any>;
+}
+
+export declare function sendEvent(params: SendEventParams): Promise<void>;
+
+export declare function isEnabled(): boolean;
+export declare function enable(): boolean;
+export declare function disable(): boolean;

package/cli.js

@@ -1,9 +1,11 @@
-const { globalConfig } = require("@webiny/global-config");
-const { isCI } = require("ci-info");
-const { WTS } = require("wts-client/node");
-const baseSendEvent = require("./sendEvent");
+import { globalConfig } from "@webiny/global-config";
+import { isCI } from "ci-info";
+import { WTS } from "wts-client/node.js";
+import baseSendEvent from "./sendEvent.js";
+import { loadJsonFileSync } from "load-json-file";
+import path from "path";
 
-const sendEvent = async ({ event, user, version, properties }) => {
+export const sendEvent = async ({ event, user, version, properties }) => {
     const shouldSend = isEnabled();
     if (!shouldSend) {
         return;
@@ -18,13 +20,16 @@ const sendEvent = async ({ event, user, version, properties }) => {
         wcpProperties.wcpProjectId = wcpProjectId;
     }
 
+    const packageJsonPath = path.join(import.meta.dirname, "package.json");
+    const packageJson = loadJsonFileSync(packageJsonPath);
+
     return baseSendEvent({
         event,
         user: user || globalConfig.get("id"),
         properties: {
             ...properties,
             ...wcpProperties,
-            version: version || require("./package.json").version,
+            version: version || packageJson.version,
             ci: isCI,
             newUser: Boolean(globalConfig.get("newUser"))
         },
@@ -41,15 +46,15 @@ const getWcpOrgProjectId = () => {
     return [];
 };
 
-const enable = () => {
+export const enable = () => {
     globalConfig.set("telemetry", true);
 };
 
-const disable = () => {
+export const disable = () => {
     globalConfig.set("telemetry", false);
 };
 
-const isEnabled = () => {
+export const isEnabled = () => {
     const config = globalConfig.get();
 
     if (config.telemetry === false) {
@@ -59,5 +64,3 @@ const isEnabled = () => {
     // `tracking` is left here for backwards compatibility with previous versions of Webiny.
     return config.tracking !== false;
 };
-
-module.exports = { sendEvent, enable, disable, isEnabled };

package/package.json

@@ -1,17 +1,19 @@
 {
 	"name": "@webiny/telemetry",
-	"version": "6.0.0-alpha.5",
+	"version": "6.0.0-rc.0",
+	"type": "module",
 	"license": "MIT",
 	"dependencies": {
-		"@webiny/global-config": "6.0.0-alpha.5",
-		"ci-info": "4.2.0",
-		"jsesc": "3.0.2",
+		"@webiny/global-config": "6.0.0-rc.0",
+		"ci-info": "4.4.0",
+		"jsesc": "3.1.0",
+		"load-json-file": "7.0.1",
 		"strip-ansi": "6.0.1",
-		"wts-client": "1.0.1"
+		"wts-client": "2.0.0"
 	},
 	"publishConfig": {
 		"access": "public",
 		"directory": "."
 	},
-	"gitHead": "b7e120541b093e91f214904a9f13e4c2c4640978"
+	"gitHead": "0f2aa699f4642e550ab62c96fcd050e8d02345c9"
 }

package/react.js

@@ -1,7 +1,7 @@
-const baseSendEvent = require("./sendEvent");
-const { WTS } = require("wts-client/admin");
+import baseSendEvent from "./sendEvent.js";
+import { WTS } from "wts-client/admin.js";
 
-const sendEvent = async (event, properties = {}) => {
+export const sendEvent = async (event, properties = {}) => {
     const shouldSend = process.env.REACT_APP_WEBINY_TELEMETRY !== "false";
     if (!shouldSend) {
         return;
@@ -38,5 +38,3 @@ const getWcpOrgProjectId = () => {
     }
     return [];
 };
-
-module.exports = { sendEvent };

package/sendEvent.js

@@ -1,11 +1,12 @@
-const stripAnsi = require("strip-ansi");
-const jsesc = require("jsesc");
+import stripAnsi from "strip-ansi";
+import jsesc from "jsesc";
+
 /**
  * The main `sendEvent` function.
  * NOTE: don't use this in your app directly. Instead, use the one from `cli.js` or `react.js` files accordingly.
  */
-module.exports = ({ event, user, properties, wts } = {}) => {
-    // 1. Check for existence of required base parameters.
+export default ({ event, user, properties, wts } = {}) => {
+    // 1. Check for the existence of required base parameters.
     if (!event) {
         throw new Error(`Cannot send event - missing "event" name.`);
     }