@jitsu/js 1.0.0-canary-20230219230011 → 1.1.0-canary.14.20230602211353

package/dist/jitsu.cjs.js

@@ -67,7 +67,50 @@ function analyticsLib() {
   return ke(_objectSpread2(_objectSpread2({}, defaultSettings), opts));
 }
 
-var __awaiter$1 = (undefined && undefined.__awaiter) || function (thisArg, _arguments, P, generator) {
+function findScript(src) {
+    const scripts = Array.prototype.slice.call(window.document.querySelectorAll("script"));
+    return scripts.find(s => s.src === src);
+}
+function loadScript(src, attributes) {
+    const found = findScript(src);
+    if (found !== undefined) {
+        const status = found === null || found === void 0 ? void 0 : found.getAttribute("status");
+        if (status === "loaded") {
+            return Promise.resolve(found);
+        }
+        if (status === "loading") {
+            return new Promise((resolve, reject) => {
+                found.addEventListener("load", () => resolve(found));
+                found.addEventListener("error", err => reject(err));
+            });
+        }
+    }
+    return new Promise((resolve, reject) => {
+        var _a;
+        const script = window.document.createElement("script");
+        script.type = "text/javascript";
+        script.src = src;
+        script.async = true;
+        script.setAttribute("status", "loading");
+        for (const [k, v] of Object.entries(attributes !== null && attributes !== void 0 ? attributes : {})) {
+            script.setAttribute(k, v);
+        }
+        script.onload = () => {
+            script.onerror = script.onload = null;
+            script.setAttribute("status", "loaded");
+            resolve(script);
+        };
+        script.onerror = () => {
+            script.onerror = script.onload = null;
+            script.setAttribute("status", "error");
+            reject(new Error(`Failed to load ${src}`));
+        };
+        const tag = window.document.getElementsByTagName("script")[0];
+        (_a = tag.parentElement) === null || _a === void 0 ? void 0 : _a.insertBefore(script, tag);
+    });
+}
+
+var __awaiter$3 = (undefined && undefined.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
         function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
@@ -76,18 +119,10 @@ var __awaiter$1 = (undefined && undefined.__awaiter) || function (thisArg, _argu
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-function satisfyFilter(filter, subject) {
-    return filter === "*" || filter.toLowerCase().trim() === (subject || "").trim().toLowerCase();
-}
-function applyFilters(event, creds) {
-    const { hosts = ["*"], events = ["*"] } = creds;
-    return (!!hosts.find(hostFilter => { var _a; return satisfyFilter(hostFilter, (_a = event.context) === null || _a === void 0 ? void 0 : _a.host); }) &&
-        !!events.find(eventFilter => satisfyFilter(eventFilter, event.type)));
-}
 const tagPlugin = {
     id: "tag",
     handle(config, payload) {
-        return __awaiter$1(this, void 0, void 0, function* () {
+        return __awaiter$3(this, void 0, void 0, function* () {
             if (!applyFilters(payload, config)) {
                 return;
             }
@@ -155,53 +190,221 @@ function execJs(code, event) {
 function replaceMacro(code, event) {
     return code.replace(/{{\s*event\s*}}/g, JSON.stringify(event));
 }
-const internalDestinationPlugins = {
-    [tagPlugin.id]: tagPlugin,
-};
 
-function findScript(src) {
-    const scripts = Array.prototype.slice.call(window.document.querySelectorAll("script"));
-    return scripts.find(s => s.src === src);
+var __awaiter$2 = (undefined && undefined.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+const logrocketPlugin = {
+    id: "logrocket",
+    handle(config, payload) {
+        return __awaiter$2(this, void 0, void 0, function* () {
+            if (!applyFilters(payload, config)) {
+                return;
+            }
+            initLogrocketIfNeeded(config.appId);
+            const action = logRocket => {
+                if (payload.type === "identify" && payload.userId) {
+                    logRocket.identify(payload.userId, payload.traits || {});
+                }
+            };
+            getLogRocketQueue().push(action);
+            if (getLogRocketState() === "loaded") {
+                flushLogRocketQueue(window["LogRocket"]);
+            }
+        });
+    },
+};
+function getLogRocketState() {
+    return window["__jitsuLrState"] || "fresh";
 }
-function loadScript(src, attributes) {
-    const found = findScript(src);
-    if (found !== undefined) {
-        const status = found === null || found === void 0 ? void 0 : found.getAttribute("status");
-        if (status === "loaded") {
-            return Promise.resolve(found);
+function setLogRocketState(s) {
+    window["__jitsuLrState"] = s;
+}
+function getLogRocketQueue() {
+    return window["__jitsuLrQueue"] || (window["__jitsuLrQueue"] = []);
+}
+function flushLogRocketQueue(lr) {
+    const queue = getLogRocketQueue();
+    while (queue.length > 0) {
+        const method = queue.shift();
+        try {
+            const res = method(lr);
+            if (res) {
+                res.catch(e => console.warn(`Async LogRocket method failed: ${e.message}`, e));
+            }
         }
-        if (status === "loading") {
-            return new Promise((resolve, reject) => {
-                found.addEventListener("load", () => resolve(found));
-                found.addEventListener("error", err => reject(err));
-            });
+        catch (e) {
+            console.warn(`LogRocket method failed: ${e.message}`, e);
         }
     }
-    return new Promise((resolve, reject) => {
-        var _a;
-        const script = window.document.createElement("script");
-        script.type = "text/javascript";
-        script.src = src;
-        script.async = true;
-        script.setAttribute("status", "loading");
-        for (const [k, v] of Object.entries(attributes !== null && attributes !== void 0 ? attributes : {})) {
-            script.setAttribute(k, v);
+}
+function initLogrocketIfNeeded(appId) {
+    return __awaiter$2(this, void 0, void 0, function* () {
+        if (getLogRocketState() !== "fresh") {
+            return;
         }
-        script.onload = () => {
-            script.onerror = script.onload = null;
-            script.setAttribute("status", "loaded");
-            resolve(script);
-        };
-        script.onerror = () => {
-            script.onerror = script.onload = null;
-            script.setAttribute("status", "error");
-            reject(new Error(`Failed to load ${src}`));
+        setLogRocketState("loading");
+        loadScript(`https://cdn.lr-ingest.io/LogRocket.min.js`, { crossOrigin: "anonymous" })
+            .then(() => {
+            if (window["LogRocket"]) {
+                try {
+                    window["LogRocket"].init(appId);
+                }
+                catch (e) {
+                    console.warn(`LogRocket (id=${appId}) init failed: ${e.message}`, e);
+                    setLogRocketState("failed");
+                }
+                setLogRocketState("loaded");
+                flushLogRocketQueue(window["LogRocket"]);
+            }
+        })
+            .catch(e => {
+            console.warn(`LogRocket (id=${appId}) init failed: ${e.message}`, e);
+            setLogRocketState("failed");
+        });
+    });
+}
+
+var __awaiter$1 = (undefined && undefined.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+const defaultScriptSrc = "https://www.googletagmanager.com/gtag/js";
+const gtmPlugin = {
+    id: "gtm",
+    handle(config, payload) {
+        var _a, _b;
+        return __awaiter$1(this, void 0, void 0, function* () {
+            if (!applyFilters(payload, config)) {
+                return;
+            }
+            yield initGtmIfNeeded(config);
+            const dataLayer = window[config.dataLayerName || "dataLayer"];
+            switch (payload.type) {
+                case "page":
+                    const { properties: pageProperties, context } = payload;
+                    const pageEvent = {
+                        event: "page_view",
+                        url: pageProperties.url,
+                        title: pageProperties.title,
+                        referer: (_b = (_a = context === null || context === void 0 ? void 0 : context.page) === null || _a === void 0 ? void 0 : _a.referrer) !== null && _b !== void 0 ? _b : "",
+                    };
+                    if (config.debug) {
+                        console.log("gtag push", pageEvent);
+                    }
+                    dataLayer.push(pageEvent);
+                    break;
+                case "track":
+                    const { properties: trackProperties } = payload;
+                    const trackEvent = Object.assign({ event: payload.event }, trackProperties);
+                    if (payload.userId) {
+                        trackEvent.userId = payload.userId;
+                    }
+                    if (payload.anonymousId) {
+                        trackEvent.anonymousId = payload.anonymousId;
+                    }
+                    if (config.debug) {
+                        console.log("gtag push", trackEvent);
+                    }
+                    dataLayer.push(trackEvent);
+                    break;
+                case "identify":
+                    const { traits } = payload;
+                    const identifyEvent = Object.assign({ event: "identify" }, traits);
+                    if (payload.userId) {
+                        identifyEvent.userId = payload.userId;
+                    }
+                    if (payload.anonymousId) {
+                        identifyEvent.anonymousId = payload.anonymousId;
+                    }
+                    if (config.debug) {
+                        console.log("gtag push", identifyEvent);
+                    }
+                    dataLayer.push(identifyEvent);
+                    break;
+            }
+        });
+    },
+};
+function getGtmState() {
+    return window["__jitsuGtmState"] || "fresh";
+}
+function setGtmState(s) {
+    window["__jitsuGtmState"] = s;
+}
+function initGtmIfNeeded(config) {
+    return __awaiter$1(this, void 0, void 0, function* () {
+        if (getGtmState() !== "fresh") {
+            return;
+        }
+        setGtmState("loading");
+        const dlName = config.dataLayerName || "dataLayer";
+        const dlParam = dlName !== "dataLayer" ? "&l=" + dlName : "";
+        const previewParams = config.preview
+            ? `&gtm_preview=${config.preview}&gtm_auth=${config.auth}&gtm_cookies_win=x`
+            : "";
+        const scriptSrc = `${config.customScriptSrc || defaultScriptSrc}?id=${config.containerId}${dlParam}${previewParams}`;
+        window[dlName] = window[dlName] || [];
+        const gtag = function () {
+            window[dlName].push(arguments);
         };
-        const tag = window.document.getElementsByTagName("script")[0];
-        (_a = tag.parentElement) === null || _a === void 0 ? void 0 : _a.insertBefore(script, tag);
+        // @ts-ignore
+        gtag("js", new Date());
+        // @ts-ignore
+        gtag("config", config.containerId);
+        loadScript(scriptSrc)
+            .then(() => {
+            setGtmState("loaded");
+        })
+            .catch(e => {
+            console.warn(`GTM (containerId=${config.containerId}) init failed: ${e.message}`, e);
+            setGtmState("failed");
+        });
     });
 }
 
+function satisfyFilter(filter, subject) {
+    return filter === "*" || filter.toLowerCase().trim() === (subject || "").trim().toLowerCase();
+}
+function satisfyDomainFilter(filter, subject) {
+    if (filter === "*") {
+        return true;
+    }
+    subject = subject || "";
+    if (filter.startsWith("*.")) {
+        return subject.endsWith(filter.substring(1));
+    }
+    else {
+        return filter === subject;
+    }
+}
+function applyFilters(event, creds) {
+    const { hosts = "*", events = "*" } = creds;
+    const eventsArray = events.split("\n");
+    return (!!hosts.split("\n").find(hostFilter => { var _a; return satisfyDomainFilter(hostFilter, (_a = event.context) === null || _a === void 0 ? void 0 : _a.host); }) &&
+        (!!eventsArray.find(eventFilter => satisfyFilter(eventFilter, event.type)) ||
+            !!eventsArray.find(eventFilter => satisfyFilter(eventFilter, event.event))));
+}
+const internalDestinationPlugins = {
+    [tagPlugin.id]: tagPlugin,
+    [gtmPlugin.id]: gtmPlugin,
+    [logrocketPlugin.id]: logrocketPlugin,
+};
+
+var name = "@jitsu/js";
+var version = "0.0.0";
+
 /* global analytics */
 var __awaiter = (undefined && undefined.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
@@ -212,7 +415,7 @@ var __awaiter = (undefined && undefined.__awaiter) || function (thisArg, _argume
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-const config = {
+const defaultConfig = {
     /* Your segment writeKey */
     writeKey: null,
     /* Disable anonymous MTU */
@@ -220,6 +423,8 @@ const config = {
     debug: false,
     fetch: null,
     echoEvents: false,
+    cookieDomain: undefined,
+    runtime: undefined,
 };
 const parseQuery = (qs) => {
     if (!qs) {
@@ -437,13 +642,13 @@ function adjustPayload(payload, config, storage) {
     const referrer = runtime.referrer();
     const context = {
         library: {
-            name: "jitsu-js",
-            version: "1.0.0",
+            name: name,
+            version: version,
         },
         userAgent: runtime.userAgent(),
         locale: runtime.language(),
         screen: runtime.screen(),
-        traits: payload.type != "identify" ? Object.assign({}, (restoreTraits(storage) || {})) : undefined,
+        traits: payload.type != "identify" && payload.type != "group" ? Object.assign({}, (restoreTraits(storage) || {})) : undefined,
         page: {
             path: properties.path || (parsedUrl && parsedUrl.pathname),
             referrer: referrer,
@@ -452,11 +657,11 @@ function adjustPayload(payload, config, storage) {
             search: properties.search || (parsedUrl && parsedUrl.search),
             title: properties.title || runtime.pageTitle(),
             url: properties.url || url,
-            enconding: properties.enconding || runtime.documentEncoding(),
+            encoding: properties.encoding || runtime.documentEncoding(),
         },
         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: config.writeKey, context: deepMerge(context, customContext) });
+    const withContext = Object.assign(Object.assign({}, payload), { timestamp: new Date().toISOString(), sentAt: new Date().toISOString(), messageId: randomId(properties.path || (parsedUrl && parsedUrl.pathname)), writeKey: validateWriteKey(config.writeKey), context: deepMerge(context, customContext) });
     delete withContext.meta;
     delete withContext.options;
     return withContext;
@@ -465,11 +670,12 @@ function processDestinations(destinations, method, event, debug, analyticsInstan
     return __awaiter(this, void 0, void 0, function* () {
         const promises = [];
         for (const destination of destinations) {
+            const credentials = Object.assign(Object.assign({}, destination.credentials), destination.options);
             if (destination.deviceOptions.type === "internal-plugin") {
                 const plugin = internalDestinationPlugins[destination.deviceOptions.name];
                 if (plugin) {
                     try {
-                        promises.push(plugin.handle(destination.credentials, event));
+                        promises.push(plugin.handle(credentials, event));
                     }
                     catch (e) {
                         console.warn(`[JITSU] Error processing event with internal plugin '${destination.deviceOptions.name}': ${e === null || e === void 0 ? void 0 : e.message}`, e);
@@ -488,7 +694,7 @@ function processDestinations(destinations, method, event, debug, analyticsInstan
                 else {
                     let pluginInstance;
                     try {
-                        pluginInstance = (typeof plugin === "function" ? plugin : plugin.init)(destination.credentials);
+                        pluginInstance = (typeof plugin === "function" ? plugin : plugin.init)(credentials);
                     }
                     catch (e) {
                         console.warn(`[JITSU] Error creating plugin '${destination.deviceOptions.moduleVarName}@${destination.deviceOptions.packageCdn}' for destination '${destination.id}': ${e === null || e === void 0 ? void 0 : e.message}`, e);
@@ -516,6 +722,18 @@ function processDestinations(destinations, method, event, debug, analyticsInstan
         }
     });
 }
+function looksLikeCuid(id) {
+    return id.length === 25 && id.charAt(0) === "c";
+}
+function validateWriteKey(writeKey) {
+    if (writeKey) {
+        const [, secret] = writeKey.split(":", 2);
+        if (!secret && !looksLikeCuid(writeKey)) {
+            throw new Error(`Legacy write key detected - ${writeKey}! This format doesn't work anymore, it should be 'key:secret'. Please download a new key from Jitsu UI`);
+        }
+    }
+    return writeKey;
+}
 function send(method, payload, jitsuConfig, instance, store) {
     if (jitsuConfig.echoEvents) {
         console.log(`[JITSU] sending '${method}' event:`, payload);
@@ -526,12 +744,12 @@ function send(method, payload, jitsuConfig, instance, store) {
     if (!fetch) {
         throw new Error("Please specify fetch function in jitsu plugin initialization, fetch isn't available in global scope");
     }
-    const authHeader = {};
     const debugHeader = jitsuConfig.debug ? { "X-Enable-Debug": "true" } : {};
     // if (jitsuConfig.debug) {
     //   console.log(`[JITSU] Sending event to ${url}: `, JSON.stringify(payload, null, 2));
     // }
     const adjustedPayload = adjustPayload(payload, jitsuConfig, store);
+    const authHeader = jitsuConfig.writeKey ? { "X-Write-Key": validateWriteKey(jitsuConfig.writeKey) } : {};
     return fetch(url, {
         method: "POST",
         headers: Object.assign(Object.assign({ "Content-Type": "application/json" }, authHeader), debugHeader),
@@ -558,7 +776,7 @@ function send(method, payload, jitsuConfig, instance, store) {
         }
         if (response.destinations) {
             if (jitsuConfig.debug) {
-                console.log(`[JITSU] Processing device destianations: `, JSON.stringify(response.destinations, null, 2));
+                console.log(`[JITSU] Processing device destinations: `, JSON.stringify(response.destinations, null, 2));
             }
             return processDestinations(response.destinations, method, adjustedPayload, !!jitsuConfig.debug, instance);
         }
@@ -587,9 +805,10 @@ const jitsuAnalyticsPlugin = (pluginConfig = {}) => {
             persistentStorage.removeItem(key);
         },
     });
+    const instanceConfig = Object.assign(Object.assign({}, defaultConfig), pluginConfig);
     return {
         name: "jitsu",
-        config: Object.assign(Object.assign({}, config), pluginConfig),
+        config: instanceConfig,
         initialize: args => {
             const { config } = args;
             if (config.debug) {
@@ -617,6 +836,16 @@ const jitsuAnalyticsPlugin = (pluginConfig = {}) => {
             //clear storage cache
             Object.keys(storageCache).forEach(key => delete storageCache[key]);
         },
+        methods: {
+            //analytics doesn't support group as a base method, so we need to add it manually
+            group(groupId, traits, options, callback) {
+                const analyticsInstance = this.instance;
+                const user = analyticsInstance.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);
+                return send("group", Object.assign(Object.assign({ type: "group", groupId, traits }, (anonymousId ? { anonymousId } : {})), (userId ? { userId } : {})), instanceConfig, analyticsInstance, cachingStorageWrapper(analyticsInstance.storage));
+            },
+        },
     };
 };
 function getSeed() {
@@ -664,6 +893,14 @@ function parse(input) {
     }
     return value;
 }
+const emptyAnalytics = {
+    track: () => Promise.resolve(),
+    page: () => Promise.resolve(),
+    user: () => ({}),
+    identify: () => Promise.resolve({}),
+    group: () => Promise.resolve({}),
+    reset: () => Promise.resolve({}),
+};
 function createUnderlyingAnalyticsInstance(opts, rt, plugins = []) {
     const analytics = analyticsLib({
         app: "test",
@@ -680,7 +917,14 @@ function createUnderlyingAnalyticsInstance(opts, rt, plugins = []) {
             return originalPage(...args);
         }
     };
-    return analytics;
+    return Object.assign(Object.assign({}, analytics), { group(groupId, traits, options, callback) {
+            for (const plugin of Object.values(analytics.plugins)) {
+                if (plugin["group"]) {
+                    plugin["group"](groupId, traits, options, callback);
+                }
+            }
+            return Promise.resolve({});
+        } });
 }
 function jitsuAnalytics(opts) {
     const inBrowser = isInBrowser();
@@ -710,6 +954,7 @@ function jitsuAnalytics(opts) {
     // }
 }
 
+exports.emptyAnalytics = emptyAnalytics;
 exports.emptyRuntime = emptyRuntime;
 exports.getTopLevelDomain = getTopLevelDomain;
 exports.isInBrowser = isInBrowser;

package/dist/jitsu.d.ts

@@ -15,7 +15,7 @@ type JitsuOptions = {
      */
     debug?: boolean;
     /**
-     * Explicitely specify cookie domain. If not set, cookie domain will be set to top level
+     * Explicitly specify cookie domain. If not set, cookie domain will be set to top level
      * of the current domain. Example: if JS lives on "app.example.com", cookie domain will be
      * set to ".example.com". If it lives on "example.com", cookie domain will be set to ".example.com" too
      */