@jitsu/js 1.9.10 → 1.9.12

package/dist/web/p.js.txt

@@ -1062,10 +1062,13 @@
       fetch: null,
       echoEvents: false,
       cookieDomain: undefined,
+      cookieCapture: {},
       runtime: undefined,
       fetchTimeoutMs: undefined,
       s2s: undefined,
       idEndpoint: undefined,
+      errorPolicy: "log",
+      defaultPayloadContext: {},
       privacy: {
           dontSend: false,
           disableUserIds: false,
@@ -1150,6 +1153,14 @@
       const parts = value.split(`; ${name}=`);
       return parts.length === 2 ? parts.pop().split(";").shift() : undefined;
   }
+  function getClientIds(runtime, customCookieCapture) {
+      const cookieCapture = Object.assign({ fbc: "_fbc", fbp: "_fbp" }, customCookieCapture);
+      const clientIds = Object.entries(cookieCapture).reduce((acc, [key, cookieName]) => {
+          acc[key] = runtime.getCookie(cookieName);
+          return acc;
+      }, {});
+      return Object.assign(Object.assign({}, clientIds), getGa4Ids(runtime));
+  }
   function getGa4Ids(runtime) {
       var _a;
       const allCookies = runtime.getCookies();
@@ -1227,6 +1238,10 @@
           getItem(key) {
               const cookieName = key2cookie[key] || key;
               const result = getCookie(cookieName);
+              if (key === "__anon_id") {
+                  //anonymous id must always be a string, so we don't parse it to preserve its exact value
+                  return result;
+              }
               if (typeof result === "undefined" && key === "__user_id") {
                   //backward compatibility with old jitsu cookie. get user id if from traits
                   const traits = parse(getCookie("__eventn_id_usr")) || {};
@@ -1402,18 +1417,19 @@
       return "/" + pathMatch;
   }
   function adjustPayload(payload, config, storage, s2s) {
-      var _a, _b, _c, _d, _e;
+      var _a, _b, _c, _d, _e, _f;
       const runtime = config.runtime || (isInBrowser() ? windowRuntime(config) : emptyRuntime(config));
       const url = runtime.pageUrl();
       const parsedUrl = safeCall(() => new URL(url), undefined);
       const query = parsedUrl ? parseQuery(parsedUrl.search) : {};
       const properties = payload.properties || {};
-      if (payload.type === "page" && url) {
-          properties.url = url.replace(hashRegex, "");
-          properties.path = fixPath(urlPath(url));
+      if (payload.type === "page" && (properties.url || url)) {
+          const targetUrl = properties.url || url;
+          properties.url = targetUrl.replace(hashRegex, "");
+          properties.path = fixPath(urlPath(targetUrl));
       }
-      const customContext = ((_a = payload.properties) === null || _a === void 0 ? void 0 : _a.context) || {};
-      (_b = payload.properties) === null || _b === void 0 ? true : delete _b.context;
+      const customContext = deepMerge(config.defaultPayloadContext, ((_a = payload.properties) === null || _a === void 0 ? void 0 : _a.context) || ((_b = payload.options) === null || _b === void 0 ? void 0 : _b.context) || {});
+      (_c = payload.properties) === null || _c === void 0 ? true : delete _c.context;
       const referrer = runtime.referrer();
       const context = {
           library: {
@@ -1421,7 +1437,7 @@
               version: jitsuVersion,
               env: isInBrowser() ? "browser" : "node",
           },
-          consent: ((_c = config.privacy) === null || _c === void 0 ? void 0 : _c.consentCategories)
+          consent: ((_d = config.privacy) === null || _d === void 0 ? void 0 : _d.consentCategories)
               ? {
                   categoryPreferences: config.privacy.consentCategories,
               }
@@ -1440,14 +1456,13 @@
               url: properties.url || url,
               encoding: properties.encoding || runtime.documentEncoding(),
           },
-          clientIds: !((_d = config.privacy) === null || _d === void 0 ? void 0 : _d.disableUserIds)
-              ? Object.assign({ fbc: runtime.getCookie("_fbc"), fbp: runtime.getCookie("_fbp") }, getGa4Ids(runtime)) : undefined,
+          clientIds: !((_e = config.privacy) === null || _e === void 0 ? void 0 : _e.disableUserIds) ? getClientIds(runtime, config.cookieCapture) : undefined,
           campaign: parseUtms(query),
       };
       const withContext = Object.assign(Object.assign({}, payload), { timestamp: new Date().toISOString(), sentAt: new Date().toISOString(), messageId: randomId(properties.path || (parsedUrl && parsedUrl.pathname)), writeKey: maskWriteKey(config.writeKey), groupId: storage.getItem("__group_id"), context: deepMerge(context, customContext) });
       delete withContext.meta;
       delete withContext.options;
-      if ((_e = config.privacy) === null || _e === void 0 ? void 0 : _e.disableUserIds) {
+      if ((_f = config.privacy) === null || _f === void 0 ? void 0 : _f.disableUserIds) {
           delete withContext.userId;
           delete withContext.anonymousId;
           delete withContext.context.traits;
@@ -1556,6 +1571,23 @@
       }
       return writeKey;
   }
+  function getErrorHandler(opts) {
+      const configuredHandler = opts.errorPolicy || "log";
+      if (typeof configuredHandler === "function") {
+          return configuredHandler;
+      }
+      else if (configuredHandler === "rethrow") {
+          return (msg, ...args) => {
+              //ignore args, not clear what to do with them
+              throw new Error(msg);
+          };
+      }
+      else {
+          return (msg, ...args) => {
+              console.error(msg, ...args);
+          };
+      }
+  }
   function send(method, payload, jitsuConfig, instance, store) {
       return __awaiter$1(this, void 0, void 0, function* () {
           var _a, _b;
@@ -1567,6 +1599,7 @@
           const url = s2s ? `${jitsuConfig.host}/api/s/s2s/${method}` : `${jitsuConfig.host}/api/s/${method}`;
           const fetch = jitsuConfig.fetch || globalThis.fetch;
           if (!fetch) {
+              //don't run it through error handler since error is critical and should be addressed
               throw new Error("Please specify fetch function in jitsu plugin initialization, fetch isn't available in global scope");
           }
           const debugHeader = jitsuConfig.debug ? { "X-Enable-Debug": "true" } : {};
@@ -1597,7 +1630,8 @@
               }
           }
           catch (e) {
-              throw new Error(`Calling ${url} failed: ${e.message}`);
+              getErrorHandler(jitsuConfig)(`Call to ${url} failed with error ${e.message}`);
+              return Promise.resolve();
           }
           let responseText;
           try {
@@ -1610,14 +1644,16 @@
               console.log(`[JITSU DEBUG] ${url} replied ${fetchResult.status}: ${responseText}. Original payload:\n${JSON.stringify(adjustedPayload, null, 2)}`);
           }
           if (!fetchResult.ok) {
-              throw new Error(`Jitsu ${url} replied ${fetchResult.status} - ${fetchResult.statusText}: ${responseText}`);
+              getErrorHandler(jitsuConfig)(`Call to ${url} failed with error: ${fetchResult.status} - ${fetchResult.statusText}: ${responseText}`);
+              return Promise.resolve();
           }
           let responseJson;
           try {
               responseJson = JSON.parse(responseText);
           }
           catch (e) {
-              return Promise.reject(`Can't parse JSON: ${responseText}: ${e === null || e === void 0 ? void 0 : e.message}`);
+              getErrorHandler(jitsuConfig)(`Can't parse JSON: ${responseText}: ${e === null || e === void 0 ? void 0 : e.message}`);
+              return Promise.resolve();
           }
           if (responseJson.destinations && responseJson.destinations.length > 0) {
               if (jitsuConfig.s2s) {
@@ -1636,6 +1672,22 @@
           return adjustedPayload;
       });
   }
+  const controllingTraits = ["$doNotSend"];
+  /**
+   * Remove all members of traits that controls identify/group behavior (see analytics.d.ts), and should not be recorded. Returns
+   * copy of the object with these members removed.
+   *
+   * Do not modify traits object, but creates one
+   * @param traits
+   */
+  function stripControllingTraits(traits) {
+      const res = Object.assign({}, traits);
+      // see Traits definition in analytics.d.ts. We cannot define const here, so here's a little code duplication
+      for (const key of controllingTraits) {
+          delete res[key];
+      }
+      return res;
+  }
   const jitsuAnalyticsPlugin = (jitsuOptions = {}, storage) => {
       // just to make sure that all undefined values are replaced with defaultConfig values
       mergeConfig(jitsuOptions, jitsuOptions);
@@ -1694,16 +1746,21 @@
               return send("track", payload, config, instance, storage);
           },
           identify: args => {
-              var _a, _b;
+              var _a, _b, _c;
               const { payload, config, instance } = args;
               if (((_a = config.privacy) === null || _a === void 0 ? void 0 : _a.dontSend) || ((_b = config.privacy) === null || _b === void 0 ? void 0 : _b.disableUserIds)) {
                   return;
               }
               // Store traits in cache to be able to use them in page and track events that run asynchronously with current identify.
               storage.setItem("__user_id", payload.userId);
+              const doNotSend = (_c = payload.traits) === null || _c === void 0 ? void 0 : _c.$doNotSend;
               if (payload.traits && typeof payload.traits === "object") {
+                  payload.traits = stripControllingTraits(payload.traits);
                   storage.setItem("__user_traits", payload.traits);
               }
+              if (doNotSend) {
+                  return Promise.resolve();
+              }
               return send("identify", payload, config, instance, storage);
           },
           reset: args => {
@@ -1748,9 +1805,14 @@
                   const userId = (options === null || options === void 0 ? void 0 : options.userId) || (user === null || user === void 0 ? void 0 : user.userId);
                   const anonymousId = (options === null || options === void 0 ? void 0 : options.anonymousId) || (user === null || user === void 0 ? void 0 : user.anonymousId) || storage.getItem("__anon_id");
                   storage.setItem("__group_id", groupId);
+                  const doNotSend = traits === null || traits === void 0 ? void 0 : traits.$doNotSend;
                   if (traits && typeof traits === "object") {
+                      traits = stripControllingTraits(traits);
                       storage.setItem("__group_traits", traits);
                   }
+                  if (doNotSend) {
+                      return Promise.resolve();
+                  }
                   return send("group", Object.assign(Object.assign({ type: "group", groupId, traits }, (anonymousId ? { anonymousId } : {})), (userId ? { userId } : {})), jitsuOptions, instance, storage);
               },
           },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jitsu/js",
-  "version": "1.9.10",
+  "version": "1.9.12",
   "description": "",
   "author": "Jitsu Dev Team <dev@jitsu.com>",
   "main": "dist/jitsu.cjs.js",
@@ -27,7 +27,7 @@
     "chalk": "^4.1.2",
     "cookie-parser": "^1.4.7",
     "ejs": "^3.1.8",
-    "express": "^4.21.1",
+    "express": "^4.21.2",
     "jest": "^29.2.2",
     "node-fetch-commonjs": "^3.3.2",
     "node-forge": "^1.3.1",
@@ -35,8 +35,8 @@
     "rollup": "^3.29.5",
     "ts-jest": "29.0.5",
     "typescript": "^5.6.3",
-    "@jitsu/protocols": "1.9.10",
-    "jsondiffpatch": "1.9.10"
+    "jsondiffpatch": "1.9.12",
+    "@jitsu/protocols": "1.9.12"
   },
   "dependencies": {
     "analytics": "0.8.9"

package/src/analytics-plugin.ts

@@ -1,15 +1,17 @@
 /* global analytics */
 
 import {
-  DynamicJitsuOptions,
-  JitsuOptions,
-  PersistentStorage,
-  RuntimeFacade,
   AnalyticsClientEvent,
   Callback,
+  DynamicJitsuOptions,
+  ErrorHandler,
   ID,
+  JitsuOptions,
   JSONObject,
   Options,
+  PersistentStorage,
+  RuntimeFacade,
+  Traits,
 } from "@jitsu/protocols/analytics";
 import parse from "./index";
 
@@ -31,10 +33,13 @@ const defaultConfig: Required<JitsuOptions> = {
   fetch: null,
   echoEvents: false,
   cookieDomain: undefined,
+  cookieCapture: {},
   runtime: undefined,
   fetchTimeoutMs: undefined,
   s2s: undefined,
   idEndpoint: undefined,
+  errorPolicy: "log",
+  defaultPayloadContext: {},
   privacy: {
     dontSend: false,
     disableUserIds: false,
@@ -138,6 +143,22 @@ function getCookie(name: string) {
   return parts.length === 2 ? parts.pop().split(";").shift() : undefined;
 }
 
+function getClientIds(runtime: RuntimeFacade, customCookieCapture: Record<string, string>) {
+  const cookieCapture = {
+    fbc: "_fbc",
+    fbp: "_fbp",
+    ...customCookieCapture,
+  };
+  const clientIds = Object.entries(cookieCapture).reduce((acc, [key, cookieName]) => {
+    acc[key] = runtime.getCookie(cookieName);
+    return acc;
+  }, {});
+  return {
+    ...clientIds,
+    ...getGa4Ids(runtime),
+  };
+}
+
 function getGa4Ids(runtime: RuntimeFacade) {
   const allCookies = runtime.getCookies();
   const clientId = allCookies["_ga"]?.split(".").slice(-2).join(".");
@@ -220,6 +241,10 @@ const cookieStorage: StorageFactory = (cookieDomain, key2cookie) => {
     getItem(key: string) {
       const cookieName = key2cookie[key] || key;
       const result = getCookie(cookieName);
+      if (key === "__anon_id") {
+        //anonymous id must always be a string, so we don't parse it to preserve its exact value
+        return result;
+      }
       if (typeof result === "undefined" && key === "__user_id") {
         //backward compatibility with old jitsu cookie. get user id if from traits
         const traits = parse(getCookie("__eventn_id_usr")) || {};
@@ -415,12 +440,16 @@ function adjustPayload(
   const query = parsedUrl ? parseQuery(parsedUrl.search) : {};
   const properties = payload.properties || {};
 
-  if (payload.type === "page" && url) {
-    properties.url = url.replace(hashRegex, "");
-    properties.path = fixPath(urlPath(url));
+  if (payload.type === "page" && (properties.url || url)) {
+    const targetUrl = properties.url || url;
+    properties.url = targetUrl.replace(hashRegex, "");
+    properties.path = fixPath(urlPath(targetUrl));
   }
 
-  const customContext = payload.properties?.context || {};
+  const customContext = deepMerge(
+    config.defaultPayloadContext,
+    payload.properties?.context || payload.options?.context || {}
+  );
   delete payload.properties?.context;
   const referrer = runtime.referrer();
   const context: AnalyticsClientEvent["context"] = {
@@ -448,13 +477,7 @@ function adjustPayload(
       url: properties.url || url,
       encoding: properties.encoding || runtime.documentEncoding(),
     },
-    clientIds: !config.privacy?.disableUserIds
-      ? {
-          fbc: runtime.getCookie("_fbc"),
-          fbp: runtime.getCookie("_fbp"),
-          ...getGa4Ids(runtime),
-        }
-      : undefined,
+    clientIds: !config.privacy?.disableUserIds ? getClientIds(runtime, config.cookieCapture) : undefined,
     campaign: parseUtms(query),
   };
   const withContext = {
@@ -627,6 +650,22 @@ function maskWriteKey(writeKey?: string): string | undefined {
   return writeKey;
 }
 
+function getErrorHandler(opts: JitsuOptions): ErrorHandler {
+  const configuredHandler = opts.errorPolicy || "log";
+  if (typeof configuredHandler === "function") {
+    return configuredHandler;
+  } else if (configuredHandler === "rethrow") {
+    return (msg, ...args) => {
+      //ignore args, not clear what to do with them
+      throw new Error(msg);
+    };
+  } else {
+    return (msg, ...args) => {
+      console.error(msg, ...args);
+    };
+  }
+}
+
 async function send(
   method,
   payload,
@@ -642,6 +681,7 @@ async function send(
   const url = s2s ? `${jitsuConfig.host}/api/s/s2s/${method}` : `${jitsuConfig.host}/api/s/${method}`;
   const fetch = jitsuConfig.fetch || globalThis.fetch;
   if (!fetch) {
+    //don't run it through error handler since error is critical and should be addressed
     throw new Error(
       "Please specify fetch function in jitsu plugin initialization, fetch isn't available in global scope"
     );
@@ -681,7 +721,8 @@ async function send(
       clearTimeout(abortTimeout);
     }
   } catch (e: any) {
-    throw new Error(`Calling ${url} failed: ${e.message}`);
+    getErrorHandler(jitsuConfig)(`Call to ${url} failed with error ${e.message}`);
+    return Promise.resolve();
   }
   let responseText;
   try {
@@ -701,14 +742,18 @@ async function send(
     );
   }
   if (!fetchResult.ok) {
-    throw new Error(`Jitsu ${url} replied ${fetchResult.status} - ${fetchResult.statusText}: ${responseText}`);
+    getErrorHandler(jitsuConfig)(
+      `Call to ${url} failed with error: ${fetchResult.status} - ${fetchResult.statusText}: ${responseText}`
+    );
+    return Promise.resolve();
   }
 
   let responseJson: any;
   try {
     responseJson = JSON.parse(responseText);
   } catch (e) {
-    return Promise.reject(`Can't parse JSON: ${responseText}: ${e?.message}`);
+    getErrorHandler(jitsuConfig)(`Can't parse JSON: ${responseText}: ${e?.message}`);
+    return Promise.resolve();
   }
 
   if (responseJson.destinations && responseJson.destinations.length > 0) {
@@ -730,6 +775,23 @@ async function send(
   return adjustedPayload;
 }
 
+const controllingTraits = ["$doNotSend"] as const;
+/**
+ * Remove all members of traits that controls identify/group behavior (see analytics.d.ts), and should not be recorded. Returns
+ * copy of the object with these members removed.
+ *
+ * Do not modify traits object, but creates one
+ * @param traits
+ */
+function stripControllingTraits(traits: Traits): Exclude<Traits, (typeof controllingTraits)[number]> {
+  const res = { ...traits };
+  // see Traits definition in analytics.d.ts. We cannot define const here, so here's a little code duplication
+  for (const key of controllingTraits) {
+    delete res[key];
+  }
+  return res;
+}
+
 export const jitsuAnalyticsPlugin = (jitsuOptions: JitsuOptions = {}, storage: PersistentStorage): AnalyticsPlugin => {
   // just to make sure that all undefined values are replaced with defaultConfig values
   mergeConfig(jitsuOptions, jitsuOptions);
@@ -792,9 +854,14 @@ export const jitsuAnalyticsPlugin = (jitsuOptions: JitsuOptions = {}, storage: P
       }
       // Store traits in cache to be able to use them in page and track events that run asynchronously with current identify.
       storage.setItem("__user_id", payload.userId);
+      const doNotSend = payload.traits?.$doNotSend;
       if (payload.traits && typeof payload.traits === "object") {
+        payload.traits = stripControllingTraits(payload.traits);
         storage.setItem("__user_traits", payload.traits);
       }
+      if (doNotSend) {
+        return Promise.resolve();
+      }
       return send("identify", payload, config, instance, storage);
     },
     reset: args => {
@@ -838,9 +905,14 @@ export const jitsuAnalyticsPlugin = (jitsuOptions: JitsuOptions = {}, storage: P
         const userId = options?.userId || user?.userId;
         const anonymousId = options?.anonymousId || user?.anonymousId || storage.getItem("__anon_id");
         storage.setItem("__group_id", groupId);
+        const doNotSend = traits?.$doNotSend;
         if (traits && typeof traits === "object") {
+          traits = stripControllingTraits(traits);
           storage.setItem("__group_traits", traits);
         }
+        if (doNotSend) {
+          return Promise.resolve();
+        }
         return send(
           "group",
           { type: "group", groupId, traits, ...(anonymousId ? { anonymousId } : {}), ...(userId ? { userId } : {}) },