posthog-js-lite 3.6.0 → 4.0.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Next
 
+# 4.0.0 - 2025-06-10
+
+## Removed
+
+1. Remove `captureMode` in favor of `json` capture mode only
+2. Remove deprecated `personProperties` and `groupProperties` in favor of `setPersonPropertiesForFlags` and `setGroupPropertiesForFlags`
+
 # 3.6.0 – 2025-06-05
 
 ## Added

package/lib/index.cjs

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var version = "3.6.0";
+var version = "4.0.0";
 
 var PostHogPersistedProperty;
 (function (PostHogPersistedProperty) {
@@ -32,6 +32,12 @@ var PostHogPersistedProperty;
     PostHogPersistedProperty["Surveys"] = "surveys";
     PostHogPersistedProperty["RemoteConfig"] = "remote_config";
 })(PostHogPersistedProperty || (PostHogPersistedProperty = {}));
+// Any key prefixed with `attr__` can be added
+var Compression;
+(function (Compression) {
+    Compression["GZipJS"] = "gzip-js";
+    Compression["Base64"] = "base64";
+})(Compression || (Compression = {}));
 var SurveyPosition;
 (function (SurveyPosition) {
     SurveyPosition["Left"] = "left";
@@ -377,436 +383,33 @@ function allSettled(promises) {
     return Promise.all(promises.map((p) => (p ?? Promise.resolve()).then((value) => ({ status: 'fulfilled', value }), (reason) => ({ status: 'rejected', reason }))));
 }
 
-// Copyright (c) 2013 Pieroxy <pieroxy@pieroxy.net>
-// This work is free. You can redistribute it and/or modify it
-// under the terms of the WTFPL, Version 2
-// For more information see LICENSE.txt or http://www.wtfpl.net/
-//
-// For more information, the home page:
-// http://pieroxy.net/blog/pages/lz-string/testing.html
-//
-// LZ-based compression algorithm, version 1.4.4
-// private property
-const f = String.fromCharCode;
-const keyStrBase64 = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=';
-const baseReverseDic = {};
-function getBaseValue(alphabet, character) {
-    if (!baseReverseDic[alphabet]) {
-        baseReverseDic[alphabet] = {};
-        for (let i = 0; i < alphabet.length; i++) {
-            baseReverseDic[alphabet][alphabet.charAt(i)] = i;
-        }
-    }
-    return baseReverseDic[alphabet][character];
+/**
+ * Older browsers and some runtimes don't support this yet
+ * This API (as of 2025-05-07) is not available on React Native.
+ */
+function isGzipSupported() {
+    return 'CompressionStream' in globalThis;
 }
-const LZString = {
-    compressToBase64: function (input) {
-        if (input == null) {
-            return '';
-        }
-        const res = LZString._compress(input, 6, function (a) {
-            return keyStrBase64.charAt(a);
-        });
-        switch (res.length % 4 // To produce valid Base64
-        ) {
-            default: // When could this happen ?
-            case 0:
-                return res;
-            case 1:
-                return res + '===';
-            case 2:
-                return res + '==';
-            case 3:
-                return res + '=';
-        }
-    },
-    decompressFromBase64: function (input) {
-        if (input == null) {
-            return '';
-        }
-        if (input == '') {
-            return null;
-        }
-        return LZString._decompress(input.length, 32, function (index) {
-            return getBaseValue(keyStrBase64, input.charAt(index));
-        });
-    },
-    compress: function (uncompressed) {
-        return LZString._compress(uncompressed, 16, function (a) {
-            return f(a);
-        });
-    },
-    _compress: function (uncompressed, bitsPerChar, getCharFromInt) {
-        if (uncompressed == null) {
-            return '';
-        }
-        const context_dictionary = {}, context_dictionaryToCreate = {}, context_data = [];
-        let i, value, context_c = '', context_wc = '', context_w = '', context_enlargeIn = 2, // Compensate for the first entry which should not count
-        context_dictSize = 3, context_numBits = 2, context_data_val = 0, context_data_position = 0, ii;
-        for (ii = 0; ii < uncompressed.length; ii += 1) {
-            context_c = uncompressed.charAt(ii);
-            if (!Object.prototype.hasOwnProperty.call(context_dictionary, context_c)) {
-                context_dictionary[context_c] = context_dictSize++;
-                context_dictionaryToCreate[context_c] = true;
-            }
-            context_wc = context_w + context_c;
-            if (Object.prototype.hasOwnProperty.call(context_dictionary, context_wc)) {
-                context_w = context_wc;
-            }
-            else {
-                if (Object.prototype.hasOwnProperty.call(context_dictionaryToCreate, context_w)) {
-                    if (context_w.charCodeAt(0) < 256) {
-                        for (i = 0; i < context_numBits; i++) {
-                            context_data_val = context_data_val << 1;
-                            if (context_data_position == bitsPerChar - 1) {
-                                context_data_position = 0;
-                                context_data.push(getCharFromInt(context_data_val));
-                                context_data_val = 0;
-                            }
-                            else {
-                                context_data_position++;
-                            }
-                        }
-                        value = context_w.charCodeAt(0);
-                        for (i = 0; i < 8; i++) {
-                            context_data_val = (context_data_val << 1) | (value & 1);
-                            if (context_data_position == bitsPerChar - 1) {
-                                context_data_position = 0;
-                                context_data.push(getCharFromInt(context_data_val));
-                                context_data_val = 0;
-                            }
-                            else {
-                                context_data_position++;
-                            }
-                            value = value >> 1;
-                        }
-                    }
-                    else {
-                        value = 1;
-                        for (i = 0; i < context_numBits; i++) {
-                            context_data_val = (context_data_val << 1) | value;
-                            if (context_data_position == bitsPerChar - 1) {
-                                context_data_position = 0;
-                                context_data.push(getCharFromInt(context_data_val));
-                                context_data_val = 0;
-                            }
-                            else {
-                                context_data_position++;
-                            }
-                            value = 0;
-                        }
-                        value = context_w.charCodeAt(0);
-                        for (i = 0; i < 16; i++) {
-                            context_data_val = (context_data_val << 1) | (value & 1);
-                            if (context_data_position == bitsPerChar - 1) {
-                                context_data_position = 0;
-                                context_data.push(getCharFromInt(context_data_val));
-                                context_data_val = 0;
-                            }
-                            else {
-                                context_data_position++;
-                            }
-                            value = value >> 1;
-                        }
-                    }
-                    context_enlargeIn--;
-                    if (context_enlargeIn == 0) {
-                        context_enlargeIn = Math.pow(2, context_numBits);
-                        context_numBits++;
-                    }
-                    delete context_dictionaryToCreate[context_w];
-                }
-                else {
-                    value = context_dictionary[context_w];
-                    for (i = 0; i < context_numBits; i++) {
-                        context_data_val = (context_data_val << 1) | (value & 1);
-                        if (context_data_position == bitsPerChar - 1) {
-                            context_data_position = 0;
-                            context_data.push(getCharFromInt(context_data_val));
-                            context_data_val = 0;
-                        }
-                        else {
-                            context_data_position++;
-                        }
-                        value = value >> 1;
-                    }
-                }
-                context_enlargeIn--;
-                if (context_enlargeIn == 0) {
-                    context_enlargeIn = Math.pow(2, context_numBits);
-                    context_numBits++;
-                }
-                // Add wc to the dictionary.
-                context_dictionary[context_wc] = context_dictSize++;
-                context_w = String(context_c);
-            }
-        }
-        // Output the code for w.
-        if (context_w !== '') {
-            if (Object.prototype.hasOwnProperty.call(context_dictionaryToCreate, context_w)) {
-                if (context_w.charCodeAt(0) < 256) {
-                    for (i = 0; i < context_numBits; i++) {
-                        context_data_val = context_data_val << 1;
-                        if (context_data_position == bitsPerChar - 1) {
-                            context_data_position = 0;
-                            context_data.push(getCharFromInt(context_data_val));
-                            context_data_val = 0;
-                        }
-                        else {
-                            context_data_position++;
-                        }
-                    }
-                    value = context_w.charCodeAt(0);
-                    for (i = 0; i < 8; i++) {
-                        context_data_val = (context_data_val << 1) | (value & 1);
-                        if (context_data_position == bitsPerChar - 1) {
-                            context_data_position = 0;
-                            context_data.push(getCharFromInt(context_data_val));
-                            context_data_val = 0;
-                        }
-                        else {
-                            context_data_position++;
-                        }
-                        value = value >> 1;
-                    }
-                }
-                else {
-                    value = 1;
-                    for (i = 0; i < context_numBits; i++) {
-                        context_data_val = (context_data_val << 1) | value;
-                        if (context_data_position == bitsPerChar - 1) {
-                            context_data_position = 0;
-                            context_data.push(getCharFromInt(context_data_val));
-                            context_data_val = 0;
-                        }
-                        else {
-                            context_data_position++;
-                        }
-                        value = 0;
-                    }
-                    value = context_w.charCodeAt(0);
-                    for (i = 0; i < 16; i++) {
-                        context_data_val = (context_data_val << 1) | (value & 1);
-                        if (context_data_position == bitsPerChar - 1) {
-                            context_data_position = 0;
-                            context_data.push(getCharFromInt(context_data_val));
-                            context_data_val = 0;
-                        }
-                        else {
-                            context_data_position++;
-                        }
-                        value = value >> 1;
-                    }
-                }
-                context_enlargeIn--;
-                if (context_enlargeIn == 0) {
-                    context_enlargeIn = Math.pow(2, context_numBits);
-                    context_numBits++;
-                }
-                delete context_dictionaryToCreate[context_w];
-            }
-            else {
-                value = context_dictionary[context_w];
-                for (i = 0; i < context_numBits; i++) {
-                    context_data_val = (context_data_val << 1) | (value & 1);
-                    if (context_data_position == bitsPerChar - 1) {
-                        context_data_position = 0;
-                        context_data.push(getCharFromInt(context_data_val));
-                        context_data_val = 0;
-                    }
-                    else {
-                        context_data_position++;
-                    }
-                    value = value >> 1;
-                }
-            }
-            context_enlargeIn--;
-            if (context_enlargeIn == 0) {
-                context_enlargeIn = Math.pow(2, context_numBits);
-                context_numBits++;
-            }
-        }
-        // Mark the end of the stream
-        value = 2;
-        for (i = 0; i < context_numBits; i++) {
-            context_data_val = (context_data_val << 1) | (value & 1);
-            if (context_data_position == bitsPerChar - 1) {
-                context_data_position = 0;
-                context_data.push(getCharFromInt(context_data_val));
-                context_data_val = 0;
-            }
-            else {
-                context_data_position++;
-            }
-            value = value >> 1;
-        }
-        // Flush the last char
-        while (true) {
-            context_data_val = context_data_val << 1;
-            if (context_data_position == bitsPerChar - 1) {
-                context_data.push(getCharFromInt(context_data_val));
-                break;
-            }
-            else {
-                context_data_position++;
-            }
-        }
-        return context_data.join('');
-    },
-    decompress: function (compressed) {
-        if (compressed == null) {
-            return '';
-        }
-        if (compressed == '') {
-            return null;
-        }
-        return LZString._decompress(compressed.length, 32768, function (index) {
-            return compressed.charCodeAt(index);
-        });
-    },
-    _decompress: function (length, resetValue, getNextValue) {
-        const dictionary = [], result = [], data = { val: getNextValue(0), position: resetValue, index: 1 };
-        let enlargeIn = 4, dictSize = 4, numBits = 3, entry = '', i, w, bits, resb, maxpower, power, c;
-        for (i = 0; i < 3; i += 1) {
-            dictionary[i] = i;
-        }
-        bits = 0;
-        maxpower = Math.pow(2, 2);
-        power = 1;
-        while (power != maxpower) {
-            resb = data.val & data.position;
-            data.position >>= 1;
-            if (data.position == 0) {
-                data.position = resetValue;
-                data.val = getNextValue(data.index++);
-            }
-            bits |= (resb > 0 ? 1 : 0) * power;
-            power <<= 1;
-        }
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        switch ((bits)) {
-            case 0:
-                bits = 0;
-                maxpower = Math.pow(2, 8);
-                power = 1;
-                while (power != maxpower) {
-                    resb = data.val & data.position;
-                    data.position >>= 1;
-                    if (data.position == 0) {
-                        data.position = resetValue;
-                        data.val = getNextValue(data.index++);
-                    }
-                    bits |= (resb > 0 ? 1 : 0) * power;
-                    power <<= 1;
-                }
-                c = f(bits);
-                break;
-            case 1:
-                bits = 0;
-                maxpower = Math.pow(2, 16);
-                power = 1;
-                while (power != maxpower) {
-                    resb = data.val & data.position;
-                    data.position >>= 1;
-                    if (data.position == 0) {
-                        data.position = resetValue;
-                        data.val = getNextValue(data.index++);
-                    }
-                    bits |= (resb > 0 ? 1 : 0) * power;
-                    power <<= 1;
-                }
-                c = f(bits);
-                break;
-            case 2:
-                return '';
-        }
-        dictionary[3] = c;
-        w = c;
-        result.push(c);
-        while (true) {
-            if (data.index > length) {
-                return '';
-            }
-            bits = 0;
-            maxpower = Math.pow(2, numBits);
-            power = 1;
-            while (power != maxpower) {
-                resb = data.val & data.position;
-                data.position >>= 1;
-                if (data.position == 0) {
-                    data.position = resetValue;
-                    data.val = getNextValue(data.index++);
-                }
-                bits |= (resb > 0 ? 1 : 0) * power;
-                power <<= 1;
-            }
-            switch ((c = bits)) {
-                case 0:
-                    bits = 0;
-                    maxpower = Math.pow(2, 8);
-                    power = 1;
-                    while (power != maxpower) {
-                        resb = data.val & data.position;
-                        data.position >>= 1;
-                        if (data.position == 0) {
-                            data.position = resetValue;
-                            data.val = getNextValue(data.index++);
-                        }
-                        bits |= (resb > 0 ? 1 : 0) * power;
-                        power <<= 1;
-                    }
-                    dictionary[dictSize++] = f(bits);
-                    c = dictSize - 1;
-                    enlargeIn--;
-                    break;
-                case 1:
-                    bits = 0;
-                    maxpower = Math.pow(2, 16);
-                    power = 1;
-                    while (power != maxpower) {
-                        resb = data.val & data.position;
-                        data.position >>= 1;
-                        if (data.position == 0) {
-                            data.position = resetValue;
-                            data.val = getNextValue(data.index++);
-                        }
-                        bits |= (resb > 0 ? 1 : 0) * power;
-                        power <<= 1;
-                    }
-                    dictionary[dictSize++] = f(bits);
-                    c = dictSize - 1;
-                    enlargeIn--;
-                    break;
-                case 2:
-                    return result.join('');
-            }
-            if (enlargeIn == 0) {
-                enlargeIn = Math.pow(2, numBits);
-                numBits++;
-            }
-            if (dictionary[c]) {
-                entry = dictionary[c];
-            }
-            else {
-                if (c === dictSize) {
-                    entry = w + w.charAt(0);
-                }
-                else {
-                    return null;
-                }
-            }
-            result.push(entry);
-            // Add w+entry[0] to the dictionary.
-            dictionary[dictSize++] = w + entry.charAt(0);
-            enlargeIn--;
-            w = entry;
-            if (enlargeIn == 0) {
-                enlargeIn = Math.pow(2, numBits);
-                numBits++;
-            }
+/**
+ * Gzip a string using Compression Streams API if it's available
+ */
+async function gzipCompress(input, isDebug = true) {
+    try {
+        // Turn the string into a stream using a Blob, and then compress it
+        const dataStream = new Blob([input], {
+            type: 'text/plain',
+        }).stream();
+        const compressedStream = dataStream.pipeThrough(new CompressionStream('gzip'));
+        // Using a Response to easily extract the readablestream value. Decoding into a string for fetch
+        return await new Response(compressedStream).blob();
+    }
+    catch (error) {
+        if (isDebug) {
+            console.error('Failed to gzip compress data', error);
         }
-    },
-};
+        return null;
+    }
+}
 
 class SimpleEventEmitter {
     constructor() {
@@ -1306,7 +909,6 @@ class PostHogCoreStateless {
         this.maxBatchSize = Math.max(this.flushAt, options?.maxBatchSize ?? 100);
         this.maxQueueSize = Math.max(this.flushAt, options?.maxQueueSize ?? 1000);
         this.flushInterval = options?.flushInterval ?? 10000;
-        this.captureMode = options?.captureMode || 'json';
         this.preloadFeatureFlags = options?.preloadFeatureFlags ?? true;
         // If enable is explicitly set to false we override the optout
         this.defaultOptIn = options?.defaultOptIn ?? true;
@@ -1325,6 +927,7 @@ class PostHogCoreStateless {
         // Init promise allows the derived class to block calls until it is ready
         this._initPromise = Promise.resolve();
         this._isInitialized = true;
+        this.disableCompression = !isGzipSupported() || (options?.disableCompression ?? false);
     }
     logMsgIfDebug(fn) {
         if (this.isDebug) {
@@ -1746,22 +1349,17 @@ class PostHogCoreStateless {
             data.historical_migration = true;
         }
         const payload = JSON.stringify(data);
-        const url = this.captureMode === 'form'
-            ? `${this.host}/e/?ip=1&_=${currentTimestamp()}&v=${this.getLibraryVersion()}`
-            : `${this.host}/batch/`;
-        const fetchOptions = this.captureMode === 'form'
-            ? {
-                method: 'POST',
-                mode: 'no-cors',
-                credentials: 'omit',
-                headers: { ...this.getCustomHeaders(), 'Content-Type': 'application/x-www-form-urlencoded' },
-                body: `data=${encodeURIComponent(LZString.compressToBase64(payload))}&compression=lz64`,
-            }
-            : {
-                method: 'POST',
-                headers: { ...this.getCustomHeaders(), 'Content-Type': 'application/json' },
-                body: payload,
-            };
+        const url = `${this.host}/batch/`;
+        const gzippedPayload = !this.disableCompression ? await gzipCompress(payload, this.isDebug) : null;
+        const fetchOptions = {
+            method: 'POST',
+            headers: {
+                ...this.getCustomHeaders(),
+                'Content-Type': 'application/json',
+                ...(gzippedPayload !== null && { 'Content-Encoding': 'gzip' }),
+            },
+            body: gzippedPayload || payload,
+        };
         try {
             await this.fetchWithRetry(url, fetchOptions);
         }
@@ -1885,22 +1483,17 @@ class PostHogCoreStateless {
                 data.historical_migration = true;
             }
             const payload = JSON.stringify(data);
-            const url = this.captureMode === 'form'
-                ? `${this.host}/e/?ip=1&_=${currentTimestamp()}&v=${this.getLibraryVersion()}`
-                : `${this.host}/batch/`;
-            const fetchOptions = this.captureMode === 'form'
-                ? {
-                    method: 'POST',
-                    mode: 'no-cors',
-                    credentials: 'omit',
-                    headers: { ...this.getCustomHeaders(), 'Content-Type': 'application/x-www-form-urlencoded' },
-                    body: `data=${encodeURIComponent(LZString.compressToBase64(payload))}&compression=lz64`,
-                }
-                : {
-                    method: 'POST',
-                    headers: { ...this.getCustomHeaders(), 'Content-Type': 'application/json' },
-                    body: payload,
-                };
+            const url = `${this.host}/batch/`;
+            const gzippedPayload = !this.disableCompression ? await gzipCompress(payload, this.isDebug) : null;
+            const fetchOptions = {
+                method: 'POST',
+                headers: {
+                    ...this.getCustomHeaders(),
+                    'Content-Type': 'application/json',
+                    ...(gzippedPayload !== null && { 'Content-Encoding': 'gzip' }),
+                },
+                body: gzippedPayload || payload,
+            };
             const retryOptions = {
                 retryCheck: (err) => {
                     // don't automatically retry on 413 errors, we want to reduce the batch size first
@@ -1945,11 +1538,21 @@ class PostHogCoreStateless {
         const body = options.body ? options.body : '';
         let reqByteLength = -1;
         try {
-            reqByteLength = Buffer.byteLength(body, STRING_FORMAT);
+            if (body instanceof Blob) {
+                reqByteLength = body.size;
+            }
+            else {
+                reqByteLength = Buffer.byteLength(body, STRING_FORMAT);
+            }
         }
         catch {
-            const encoded = new TextEncoder().encode(body);
-            reqByteLength = encoded.length;
+            if (body instanceof Blob) {
+                reqByteLength = body.size;
+            }
+            else {
+                const encoded = new TextEncoder().encode(body);
+                reqByteLength = encoded.length;
+            }
         }
         return await retriable(async () => {
             let res = null;
@@ -2303,10 +1906,6 @@ class PostHogCore extends PostHogCoreStateless {
             this.setPersistedProperty(PostHogPersistedProperty.PersonProperties, null);
         });
     }
-    /** @deprecated - Renamed to setPersonPropertiesForFlags */
-    personProperties(properties) {
-        return this.setPersonPropertiesForFlags(properties);
-    }
     setGroupPropertiesForFlags(properties) {
         this.wrap(() => {
             // Get persisted group properties
@@ -2332,12 +1931,6 @@ class PostHogCore extends PostHogCoreStateless {
             this.setPersistedProperty(PostHogPersistedProperty.GroupProperties, null);
         });
     }
-    /** @deprecated - Renamed to setGroupPropertiesForFlags */
-    groupProperties(properties) {
-        this.wrap(() => {
-            this.setGroupPropertiesForFlags(properties);
-        });
-    }
     async remoteConfigAsync() {
         await this._initPromise;
         if (this._remoteConfigResponsePromise) {
@@ -2411,6 +2004,9 @@ class PostHogCore extends PostHogCoreStateless {
                     else if (this.preloadFeatureFlags !== false) {
                         this.reloadFeatureFlags();
                     }
+                    if (!response.supportedCompression?.includes(Compression.GZipJS)) {
+                        this.disableCompression = true;
+                    }
                     remoteConfig = response;
                 }
                 return remoteConfig;