@jitsu/js 1.9.7-canary.903.20240731114701 → 1.9.8

package/dist/web/p.js.txt

@@ -1052,6 +1052,37 @@
       fetchTimeoutMs: undefined,
       s2s: undefined,
       idEndpoint: undefined,
+      privacy: {
+          dontSend: false,
+          disableUserIds: false,
+          ipPolicy: "keep",
+          consentCategories: undefined,
+      },
+  };
+  // mergeConfig merges newConfig into currentConfig also making sure that all undefined values are replaced with defaultConfig values
+  const mergeConfig = (current, newConfig) => {
+      for (const key of Object.keys(defaultConfig)) {
+          const value = newConfig[key];
+          if (key === "privacy") {
+              if (typeof value === "object") {
+                  current.privacy = Object.assign(Object.assign(Object.assign({}, defaultConfig.privacy), current.privacy), value);
+              }
+              else if (newConfig.hasOwnProperty("privacy") && typeof value === "undefined") {
+                  // explicitly set to undefined - reset to default
+                  current.privacy = Object.assign({}, defaultConfig.privacy);
+              }
+          }
+          else if (typeof value === "undefined") {
+              if (newConfig.hasOwnProperty(key) || !current.hasOwnProperty(key)) {
+                  // explicitly set to undefined - reset to default
+                  // or was not set at all - set to default
+                  current[key] = defaultConfig[key];
+              }
+          }
+          else {
+              current[key] = value;
+          }
+      }
   };
   const parseQuery = (qs) => {
       if (!qs) {
@@ -1159,10 +1190,19 @@
       __anon_id: "__eventn_id",
       __user_traits: "__eventn_id_usr",
       __user_id: "__eventn_uid",
+      __group_id: "__group_id",
+      __group_traits: "__group_traits",
   };
   const cookieStorage = (cookieDomain, key2cookie) => {
       return {
           setItem(key, val) {
+              if (typeof val === "undefined") {
+                  removeCookie(key2cookie[key] || key, {
+                      domain: cookieDomain,
+                      secure: window.location.protocol === "https:",
+                  });
+                  return;
+              }
               const strVal = typeof val === "object" && val !== null ? encodeURIComponent(JSON.stringify(val)) : val;
               const cookieName = key2cookie[key] || key;
               setCookie(cookieName, strVal, {
@@ -1270,7 +1310,12 @@
                   if (config.debug) {
                       console.log(`[JITSU EMPTY RUNTIME] Set storage item ${key}=${JSON.stringify(val)}`);
                   }
-                  storage[key] = val;
+                  if (typeof val === "undefined") {
+                      delete storage[key];
+                  }
+                  else {
+                      storage[key] = val;
+                  }
               },
               getItem(key) {
                   const val = storage[key];
@@ -1343,7 +1388,7 @@
       return "/" + pathMatch;
   }
   function adjustPayload(payload, config, storage, s2s) {
-      var _a, _b;
+      var _a, _b, _c, _d, _e;
       const runtime = config.runtime || (isInBrowser() ? windowRuntime(config) : emptyRuntime(config));
       const url = runtime.pageUrl();
       const parsedUrl = safeCall(() => new URL(url), undefined);
@@ -1360,8 +1405,13 @@
           library: {
               name: jitsuLibraryName,
               version: jitsuVersion,
-              env: s2s ? "node" : "browser",
+              env: isInBrowser() ? "browser" : "node",
           },
+          consent: ((_c = config.privacy) === null || _c === void 0 ? void 0 : _c.consentCategories)
+              ? {
+                  categoryPreferences: config.privacy.consentCategories,
+              }
+              : undefined,
           userAgent: runtime.userAgent(),
           locale: runtime.language(),
           screen: runtime.screen(),
@@ -1376,12 +1426,19 @@
               url: properties.url || url,
               encoding: properties.encoding || runtime.documentEncoding(),
           },
-          clientIds: Object.assign({ fbc: runtime.getCookie("_fbc"), fbp: runtime.getCookie("_fbp") }, getGa4Ids(runtime)),
+          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,
           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) {
+          delete withContext.userId;
+          delete withContext.anonymousId;
+          delete withContext.context.traits;
+          delete withContext.groupId;
+      }
       return withContext;
   }
   function isDiff(obj) {
@@ -1487,11 +1544,12 @@
   }
   function send(method, payload, jitsuConfig, instance, store) {
       return __awaiter$1(this, void 0, void 0, function* () {
+          var _a, _b;
           if (jitsuConfig.echoEvents) {
               console.log(`[JITSU DEBUG] sending '${method}' event:`, payload);
               return;
           }
-          const s2s = jitsuConfig.s2s === undefined ? !isInBrowser() : jitsuConfig.s2s;
+          const s2s = !!jitsuConfig.s2s;
           const url = s2s ? `${jitsuConfig.host}/api/s/s2s/${method}` : `${jitsuConfig.host}/api/s/${method}`;
           const fetch = jitsuConfig.fetch || globalThis.fetch;
           if (!fetch) {
@@ -1501,7 +1559,7 @@
           // if (jitsuConfig.debug) {
           //   console.log(`[JITSU] Sending event to ${url}: `, JSON.stringify(payload, null, 2));
           // }
-          const adjustedPayload = adjustPayload(payload, jitsuConfig, store, s2s);
+          const adjustedPayload = adjustPayload(payload, jitsuConfig, store);
           const abortController = jitsuConfig.fetchTimeoutMs ? new AbortController() : undefined;
           const abortTimeout = jitsuConfig.fetchTimeoutMs
               ? setTimeout(() => {
@@ -1509,11 +1567,14 @@
               }, jitsuConfig.fetchTimeoutMs)
               : undefined;
           const authHeader = jitsuConfig.writeKey ? { "X-Write-Key": jitsuConfig.writeKey } : {};
+          const ipHeader = typeof ((_a = jitsuConfig.privacy) === null || _a === void 0 ? void 0 : _a.ipPolicy) === "undefined" || ((_b = jitsuConfig.privacy) === null || _b === void 0 ? void 0 : _b.ipPolicy) === "keep"
+              ? {}
+              : { "X-IP-Policy": jitsuConfig.privacy.ipPolicy };
           let fetchResult;
           try {
               fetchResult = yield fetch(url, {
                   method: "POST",
-                  headers: Object.assign(Object.assign({ "Content-Type": "application/json" }, authHeader), debugHeader),
+                  headers: Object.assign(Object.assign(Object.assign({ "Content-Type": "application/json" }, authHeader), debugHeader), ipHeader),
                   body: JSON.stringify(adjustedPayload),
                   signal: abortController === null || abortController === void 0 ? void 0 : abortController.signal,
               });
@@ -1561,11 +1622,12 @@
           return adjustedPayload;
       });
   }
-  const jitsuAnalyticsPlugin = (pluginConfig = {}) => {
-      const instanceConfig = Object.assign(Object.assign({}, defaultConfig), pluginConfig);
+  const jitsuAnalyticsPlugin = (jitsuOptions = {}, storage) => {
+      // just to make sure that all undefined values are replaced with defaultConfig values
+      mergeConfig(jitsuOptions, jitsuOptions);
       return {
           name: "jitsu",
-          config: instanceConfig,
+          config: jitsuOptions,
           initialize: (args) => __awaiter$1(void 0, void 0, void 0, function* () {
               const { config } = args;
               if (config.debug) {
@@ -1602,17 +1664,28 @@
               }
           }),
           page: args => {
+              var _a;
               const { payload, config, instance } = args;
-              return send("page", payload, config, instance, pluginConfig.storageWrapper ? pluginConfig.storageWrapper(instance.storage) : instance.storage);
+              if ((_a = config.privacy) === null || _a === void 0 ? void 0 : _a.dontSend) {
+                  return;
+              }
+              return send("page", payload, config, instance, storage);
           },
           track: args => {
+              var _a;
               const { payload, config, instance } = args;
-              return send("track", payload, config, instance, pluginConfig.storageWrapper ? pluginConfig.storageWrapper(instance.storage) : instance.storage);
+              if ((_a = config.privacy) === null || _a === void 0 ? void 0 : _a.dontSend) {
+                  return;
+              }
+              return send("track", payload, config, instance, storage);
           },
           identify: args => {
+              var _a, _b;
               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.
-              const storage = pluginConfig.storageWrapper ? pluginConfig.storageWrapper(instance.storage) : instance.storage;
               storage.setItem("__user_id", payload.userId);
               if (payload.traits && typeof payload.traits === "object") {
                   storage.setItem("__user_traits", payload.traits);
@@ -1621,31 +1694,50 @@
           },
           reset: args => {
               const { config, instance } = args;
-              const storage = pluginConfig.storageWrapper ? pluginConfig.storageWrapper(instance.storage) : instance.storage;
-              storage === null || storage === void 0 ? void 0 : storage.reset();
+              storage.reset();
               if (config.debug) {
                   console.log("[JITSU DEBUG] Resetting Jitsu plugin storage");
               }
           },
           methods: {
               //analytics doesn't support group as a base method, so we need to add it manually
+              configure(newOptions) {
+                  var _a, _b, _c, _d;
+                  const idsWasDisabled = ((_a = jitsuOptions.privacy) === null || _a === void 0 ? void 0 : _a.disableUserIds) || ((_b = jitsuOptions.privacy) === null || _b === void 0 ? void 0 : _b.dontSend);
+                  mergeConfig(jitsuOptions, newOptions);
+                  const idsDisabledNow = ((_c = jitsuOptions.privacy) === null || _c === void 0 ? void 0 : _c.disableUserIds) || ((_d = jitsuOptions.privacy) === null || _d === void 0 ? void 0 : _d.dontSend);
+                  if (!idsDisabledNow && idsWasDisabled) {
+                      if (jitsuOptions.debug) {
+                          console.log("[JITSU] Enabling Anonymous ID. Generating new Id.");
+                      }
+                      const instance = this.instance;
+                      const newAnonymousId = uuid();
+                      const userState = instance.user();
+                      if (userState) {
+                          userState.anonymousId = newAnonymousId;
+                      }
+                      storage.setItem("__anon_id", newAnonymousId);
+                      instance.setAnonymousId(newAnonymousId);
+                  }
+              },
               group(groupId, traits, options, callback) {
+                  var _a, _b;
+                  if (((_a = jitsuOptions.privacy) === null || _a === void 0 ? void 0 : _a.dontSend) || ((_b = jitsuOptions.privacy) === null || _b === void 0 ? void 0 : _b.disableUserIds)) {
+                      return;
+                  }
                   if (typeof groupId === "number") {
                       //fix potential issues with group id being used incorrectly
                       groupId = groupId + "";
                   }
-                  const analyticsInstance = this.instance;
-                  const cacheWrap = pluginConfig.storageWrapper
-                      ? pluginConfig.storageWrapper(analyticsInstance.storage)
-                      : analyticsInstance.storage;
-                  const user = analyticsInstance.user();
+                  const instance = this.instance;
+                  const user = instance.user();
                   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) || cacheWrap.getItem("__anon_id");
-                  cacheWrap.setItem("__group_id", groupId);
+                  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);
                   if (traits && typeof traits === "object") {
-                      cacheWrap.setItem("__group_traits", traits);
+                      storage.setItem("__group_traits", traits);
                   }
-                  return send("group", Object.assign(Object.assign({ type: "group", groupId, traits }, (anonymousId ? { anonymousId } : {})), (userId ? { userId } : {})), instanceConfig, analyticsInstance, cacheWrap);
+                  return send("group", Object.assign(Object.assign({ type: "group", groupId, traits }, (anonymousId ? { anonymousId } : {})), (userId ? { userId } : {})), jitsuOptions, instance, storage);
               },
           },
       };
@@ -1660,6 +1752,15 @@
       return (((Math.random() * d * hash(hashString !== null && hashString !== void 0 ? hashString : "", getSeed())) % Number.MAX_SAFE_INTEGER).toString(36) +
           ((Math.random() * d * hash(hashString !== null && hashString !== void 0 ? hashString : "", getSeed())) % Number.MAX_SAFE_INTEGER).toString(36));
   }
+  function uuid() {
+      var u = "", m = "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx", i = 0, rb = (Math.random() * 0xffffffff) | 0;
+      while (i++ < 36) {
+          var c = m[i - 1], r = rb & 0xf, v = c == "x" ? r : (r & 0x3) | 0x8;
+          u += c == "-" || c == "4" ? c : v.toString(16);
+          rb = i % 8 == 0 ? (Math.random() * 0xffffffff) | 0 : rb >> 4;
+      }
+      return u;
+  }
   function hash(str, seed = 0) {
       let h1 = 0xdeadbeef ^ seed, h2 = 0x41c6ce57 ^ seed;
       for (let i = 0, ch; i < str.length; i++) {
@@ -1705,13 +1806,17 @@
       return value;
   }
   function createUnderlyingAnalyticsInstance(opts, rt, plugins = []) {
-      const storage = rt.store();
+      var _a, _b;
       const storageCache = {};
       // AnalyticsInstance's storage is async somewhere inside. So if we make 'page' call right after 'identify' call
       // 'page' call will load traits from storage before 'identify' call had a change to save them.
       // to avoid that we use in-memory cache for storage
       const cachingStorageWrapper = (persistentStorage) => ({
           setItem(key, val) {
+              var _a, _b;
+              if (((_a = opts.privacy) === null || _a === void 0 ? void 0 : _a.dontSend) || ((_b = opts.privacy) === null || _b === void 0 ? void 0 : _b.disableUserIds)) {
+                  return;
+              }
               if (opts.debug) {
                   console.log(`[JITSU DEBUG] Caching storage setItem: ${key}=${val}`);
               }
@@ -1719,6 +1824,10 @@
               persistentStorage.setItem(key, val);
           },
           getItem(key) {
+              var _a, _b;
+              if (((_a = opts.privacy) === null || _a === void 0 ? void 0 : _a.dontSend) || ((_b = opts.privacy) === null || _b === void 0 ? void 0 : _b.disableUserIds)) {
+                  return;
+              }
               const value = storageCache[key] || persistentStorage.getItem(key);
               if (opts.debug) {
                   console.log(`[JITSU DEBUG] Caching storage getItem: ${key}=${value}. Evicted from cache: ${!storageCache[key]}`);
@@ -1729,7 +1838,7 @@
               for (const key of [...Object.keys(storageCache)]) {
                   delete storageCache[key];
               }
-              storage.reset();
+              persistentStorage.reset();
           },
           removeItem(key) {
               if (opts.debug) {
@@ -1739,12 +1848,13 @@
               persistentStorage.removeItem(key);
           },
       });
+      const storage = cachingStorageWrapper(rt.store());
       const analytics = analyticsLib({
           debug: !!opts.debug,
           storage,
-          plugins: [jitsuAnalyticsPlugin(Object.assign(Object.assign({}, opts), { storageWrapper: cachingStorageWrapper })), ...plugins],
+          plugins: [jitsuAnalyticsPlugin(opts, storage), ...plugins],
       });
-      return Object.assign(Object.assign({}, analytics), { page: (...args) => {
+      const a = Object.assign(Object.assign({}, analytics), { page: (...args) => {
               if (args.length === 2 && typeof args[0] === "string" && typeof args[1] === "object") {
                   return analytics.page(Object.assign({ name: args[0] }, args[1]));
               }
@@ -1778,7 +1888,7 @@
               if (opts.debug) {
                   console.log("[JITSU DEBUG] Setting anonymous id to " + id);
               }
-              //Workaround for analytics.js bug. Underlying setAnonymousId doesn't work set the id immediately,
+              //Workaround for analytics.js bug. Underlying setAnonymousId doesn't  set the id immediately,
               //so we got to it manually here. See https://github.com/jitsucom/jitsu/issues/1060
               storage.setItem("__anon_id", id);
               const userState = analytics.user();
@@ -1799,6 +1909,22 @@
                   }
               });
           },
+          configure(options) {
+              return __awaiter(this, void 0, void 0, function* () {
+                  var _a, _b;
+                  if (opts.debug) {
+                      console.log("[JITSU DEBUG] Update Jitsu config with", JSON.stringify(options));
+                  }
+                  if (((_a = options.privacy) === null || _a === void 0 ? void 0 : _a.disableUserIds) || ((_b = options.privacy) === null || _b === void 0 ? void 0 : _b.dontSend)) {
+                      storage.reset();
+                  }
+                  for (const plugin of Object.values(analytics.plugins)) {
+                      if (typeof plugin["configure"] === "function") {
+                          plugin["configure"](options);
+                      }
+                  }
+              });
+          },
           group(groupId, traits, options, callback) {
               return __awaiter(this, void 0, void 0, function* () {
                   const results = [];
@@ -1812,13 +1938,20 @@
                   return results[0];
               });
           } });
+      if (((_a = opts.privacy) === null || _a === void 0 ? void 0 : _a.disableUserIds) || ((_b = opts.privacy) === null || _b === void 0 ? void 0 : _b.dontSend)) {
+          storage.reset();
+      }
+      return a;
   }
   /**
    * Fix common mistakes in jitsu configuration
    * @param opts
    */
   function fixOptions(opts) {
-      return Object.assign(Object.assign({}, opts), { host: opts.host.indexOf("https://") !== 0 && opts.host.indexOf("http://") !== 0 ? `https://${opts.host}` : opts.host });
+      var _a, _b;
+      return Object.assign(Object.assign({}, opts), { host: ((_a = opts.host) !== null && _a !== void 0 ? _a : "").indexOf("https://") !== 0 && ((_b = opts.host) !== null && _b !== void 0 ? _b : "").indexOf("http://") !== 0
+              ? `https://${opts.host}`
+              : opts.host });
   }
   function jitsuAnalytics(_opts) {
       const opts = fixOptions(_opts);
@@ -1848,35 +1981,53 @@
       //   result.loaded(createUnderlyingAnalyticsInstance(opts, rt));
       // }
   }
-  function uuid() {
-      var u = "", m = "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx", i = 0, rb = (Math.random() * 0xffffffff) | 0;
-      while (i++ < 36) {
-          var c = m[i - 1], r = rb & 0xf, v = c == "x" ? r : (r & 0x3) | 0x8;
-          u += c == "-" || c == "4" ? c : v.toString(16);
-          rb = i % 8 == 0 ? (Math.random() * 0xffffffff) | 0 : rb >> 4;
-      }
-      return u;
-  }
 
   function snakeToCamel(s) {
       return s.replace(/([-_][a-z])/gi, $1 => {
           return $1.toUpperCase().replace("-", "").replace("_", "");
       });
   }
-  const booleanParser = (arg) => arg === "true" || arg === "1" || arg === "yes";
+  const trimPrefix = (s, prefix) => s.replace(new RegExp(`^${prefix}`), "");
+  const defaultParser = (nestedPath = []) => ({
+      path: (name) => [
+          ...nestedPath,
+          snakeToCamel(nestedPath.length > 0 ? trimPrefix(name, nestedPath.join("-") + "-") : name),
+      ],
+      parse: (arg) => arg,
+  });
+  const booleanParser = (nestedPath = []) => (Object.assign(Object.assign({}, defaultParser(nestedPath)), { parse: (arg) => arg === "true" || arg === "1" || arg === "yes" }));
   const parsers = {
-      debug: booleanParser,
-      initOnly: booleanParser,
+      debug: booleanParser(),
+      "privacy-disable-user-ids": booleanParser(["privacy"]),
+      "privacy-dont-send": booleanParser(["privacy"]),
+      "privacy-ip-policy": defaultParser(["privacy"]),
+      "echo-events": booleanParser(),
+      "init-only": booleanParser(),
   };
   function getParser(name) {
-      return parsers[name] || (x => x);
+      return parsers[name] || defaultParser();
+  }
+  function setPath(obj, path, value) {
+      let current = obj;
+      let i = 0;
+      for (; i < path.length - 1; i++) {
+          const key = path[i];
+          current[key] = current[key] || {};
+          current = current[key];
+      }
+      current[path[i]] = value;
   }
   function getScriptAttributes(scriptElement) {
       return scriptElement
           .getAttributeNames()
           .filter(name => name.indexOf("data-") === 0)
           .map(name => name.substring("data-".length))
-          .reduce((res, name) => (Object.assign(Object.assign({}, res), { [snakeToCamel(name)]: getParser(snakeToCamel(name))(scriptElement.getAttribute(`data-${name}`)) })), {});
+          .reduce((res, name) => {
+          const parser = getParser(name);
+          const path = parser.path(name);
+          setPath(res, path, parser.parse(scriptElement.getAttribute(`data-${name}`)));
+          return res;
+      }, {});
   }
   function runCallback(callback, jitsu) {
       if (typeof callback === "function") {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jitsu/js",
-  "version": "1.9.7-canary.903.20240731114701",
+  "version": "1.9.8",
   "description": "",
   "author": "Jitsu Dev Team <dev@jitsu.com>",
   "main": "dist/jitsu.cjs.js",
@@ -12,6 +12,7 @@
   "license": "MIT",
   "private": false,
   "devDependencies": {
+    "tslib": "^2.6.3",
     "@playwright/test": "1.39.0",
     "@rollup/plugin-commonjs": "^23.0.2",
     "@rollup/plugin-json": "^5.0.1",
@@ -34,8 +35,8 @@
     "rollup": "^3.2.5",
     "ts-jest": "29.0.5",
     "typescript": "^5.5.4",
-    "jsondiffpatch": "1.9.7-canary.903.20240731114701",
-    "@jitsu/protocols": "1.9.7-canary.903.20240731114701"
+    "@jitsu/protocols": "1.9.8",
+    "jsondiffpatch": "1.9.8"
   },
   "dependencies": {
     "analytics": "0.8.9"