feat: add support of custom page/screen event name in mixpanel

src/v0/destinations/mp/transform.js

@@ -37,6 +37,7 @@ const {
   groupEventsByEndpoint,
   batchEvents,
   trimTraits,
+  generatePageOrScreenCustomEventName,
 } = require('./util');
 const { CommonUtils } = require('../../../util/common');
 
@@ -298,17 +299,25 @@ const processIdentifyEvents = async (message, type, destination) => {
 };
 
 const processPageOrScreenEvents = (message, type, destination) => {
+  const {
+    token,
+    identityMergeApi,
+    useUserDefinedPageEventName,
+    userDefinedPageEventString,
+    useUserDefinedScreenEventName,
+    userDefinedScreenEventString,
+  } = destination.Config;
   const mappedProperties = constructPayload(message, mPEventPropertiesConfigJson);
   let properties = {
     ...get(message, 'context.traits'),
     ...message.properties,
     ...mappedProperties,
-    token: destination.Config.token,
+    token,
     distinct_id: message.userId || message.anonymousId,
     time: toUnixTimestampInMS(message.timestamp || message.originalTimestamp),
     ...buildUtmParams(message.context?.campaign),
   };
-  if (destination.Config?.identityMergeApi === 'simplified') {
+  if (identityMergeApi === 'simplified') {
     properties = {
       ...properties,
       distinct_id: message.userId || `$device:${message.anonymousId}`,
@@ -327,7 +336,18 @@ const processPageOrScreenEvents = (message, type, destination) => {
     properties.$browser = browser.name;
     properties.$browser_version = browser.version;
   }
-  const eventName = type === 'page' ? 'Loaded a Page' : 'Loaded a Screen';
+
+  let eventName;
+  if (type === 'page') {
+    eventName = useUserDefinedPageEventName
+      ? generatePageOrScreenCustomEventName(message, userDefinedPageEventString)
+      : 'Loaded a Page';
+  } else {
+    eventName = useUserDefinedScreenEventName
+      ? generatePageOrScreenCustomEventName(message, userDefinedScreenEventString)
+      : 'Loaded a Screen';
+  }
+
   const payload = {
     event: eventName,
     properties,

src/v0/destinations/mp/util.js

@@ -301,6 +301,32 @@ function trimTraits(traits, contextTraits, setOnceProperties) {
   };
 }
 
+/**
+ * Generates a custom event name for a page or screen.
+ *
+ * @param {Object} message - The message object.
+ * @param {string} userDefinedEventString - The user-defined event string.
+ * @returns {string} - The generated custom event name.
+ * @throws {InstrumentationError} - If the event does not contain the configured path.
+ * @example
+ *
+ * const message = {name: 'Home'};
+ * const userDefinedEventString = 'Viewed a {{ name }} page';
+ * -> Viewed a Home page
+ */
+const generatePageOrScreenCustomEventName = (message, userDefinedEventString) => {
+  const getMessagePath = userDefinedEventString?.match(/{\s*([^{}]+)\s*}/)?.[1]?.trim();
+  if (!getMessagePath) return userDefinedEventString;
+
+  const value = get(message, getMessagePath);
+  if (!value) {
+    throw new InstrumentationError(
+      `'Use Custom Page/Screen Event Name' setting is enabled but the event does not contain the ${getMessagePath} configured in 'Page/Screen Event Name Format' setting`,
+    );
+  }
+  return userDefinedEventString?.trim().replaceAll(/{{([^{}]+)}}/g, value);
+};
+
 module.exports = {
   createIdentifyResponse,
   isImportAuthCredentialsAvailable,
@@ -309,4 +335,5 @@ module.exports = {
   generateBatchedPayloadForArray,
   batchEvents,
   trimTraits,
+  generatePageOrScreenCustomEventName,
 };