posthog-js/lib/src/consent.js

Posthog-js allows you to automatically capture usage and send events to PostHog.

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.ConsentManager = exports.ConsentStatus = void 0;
var constants_1 = require("./constants");
var globals_1 = require("@posthog/browser-common/utils/globals");
var globals_2 = require("./utils/globals");
var storage_1 = require("./storage");
var core_1 = require("@posthog/core");
var OPT_OUT_PREFIX = '__ph_opt_in_out_';
exports.ConsentStatus = {
    PENDING: -1,
    DENIED: 0,
    GRANTED: 1,
};
/**
 * ConsentManager provides tools for managing user consent as configured by the application.
 */
var ConsentManager = /** @class */ (function () {
    function ConsentManager(_instance) {
        this._instance = _instance;
    }
    Object.defineProperty(ConsentManager.prototype, "_config", {
        get: function () {
            return this._instance.config;
        },
        enumerable: false,
        configurable: true
    });
    Object.defineProperty(ConsentManager.prototype, "consent", {
        get: function () {
            if (this._getDnt()) {
                return exports.ConsentStatus.DENIED;
            }
            return this._storedConsent;
        },
        enumerable: false,
        configurable: true
    });
    ConsentManager.prototype.isOptedOut = function () {
        if (this._config.cookieless_mode === constants_1.COOKIELESS_ALWAYS) {
            return true;
        }
        // we are opted out if we are rejected, or if consent is pending and we are in cookieless mode "on_reject"
        return (this.isRejected() ||
            (this.consent === exports.ConsentStatus.PENDING && this._config.cookieless_mode === constants_1.COOKIELESS_ON_REJECT));
    };
    ConsentManager.prototype.isOptedIn = function () {
        return !this.isOptedOut();
    };
    ConsentManager.prototype.isExplicitlyOptedOut = function () {
        return this.consent === exports.ConsentStatus.DENIED;
    };
    ConsentManager.prototype.isRejected = function () {
        return (this.consent === exports.ConsentStatus.DENIED ||
            (this.consent === exports.ConsentStatus.PENDING && this._config.opt_out_capturing_by_default));
    };
    ConsentManager.prototype.optInOut = function (isOptedIn) {
        this._storage._set(this._storageKey, isOptedIn ? 1 : 0, this._config.cookie_expiration, this._config.cross_subdomain_cookie, this._config.secure_cookie);
    };
    ConsentManager.prototype.reset = function () {
        this._storage._remove(this._storageKey, this._config.cross_subdomain_cookie);
    };
    Object.defineProperty(ConsentManager.prototype, "_storageKey", {
        get: function () {
            var _a = this._instance.config, token = _a.token, opt_out_capturing_cookie_prefix = _a.opt_out_capturing_cookie_prefix, consent_persistence_name = _a.consent_persistence_name;
            if (consent_persistence_name) {
                return consent_persistence_name;
            }
            else if (opt_out_capturing_cookie_prefix) {
                // Deprecated, but we still support it for backwards compatibility.
                // This was deprecated because it differed in behaviour from storage.ts, and appends the token.
                // This meant it was not possible to share the same consent state across multiple PostHog instances,
                // and made it harder for people to migrate from other systems.
                return opt_out_capturing_cookie_prefix + token;
            }
            else {
                return OPT_OUT_PREFIX + token;
            }
        },
        enumerable: false,
        configurable: true
    });
    Object.defineProperty(ConsentManager.prototype, "_storedConsent", {
        get: function () {
            var value = this._storage._get(this._storageKey);
            // be somewhat permissive in what we accept as yes/opt-in, to make it easier for people to migrate from other systems
            return (0, core_1.isYesLike)(value) ? exports.ConsentStatus.GRANTED : (0, core_1.isNoLike)(value) ? exports.ConsentStatus.DENIED : exports.ConsentStatus.PENDING;
        },
        enumerable: false,
        configurable: true
    });
    Object.defineProperty(ConsentManager.prototype, "_storage", {
        get: function () {
            // Re-evaluate the store on every access so that a config change after the first
            // access (e.g. init() called after _dom_loaded() fires in bundled apps) is picked
            // up and any value already stored under the old backend is migrated across.
            var persistenceType = this._config.opt_out_capturing_persistence_type;
            var preferredStore = persistenceType === 'localStorage' ? storage_1.localStore : storage_1.cookieStore;
            // Neither backend exists in contexts like a `data:` URL, where Chrome disables
            // localStorage and cookies alike. Consent reads and writes there could only ever
            // fail, logging SecurityError noise on every capture, so fall back to in-memory
            // consent for the pageview instead of a store that cannot hold anything.
            var expectedStore = preferredStore._is_supported() ? preferredStore : storage_1.memoryStore;
            if (!this._persistentStore || this._persistentStore !== expectedStore) {
                this._persistentStore = expectedStore;
                var otherStorage = persistenceType === 'localStorage' ? storage_1.cookieStore : storage_1.localStore;
                if (otherStorage._get(this._storageKey)) {
                    if (!this._persistentStore._get(this._storageKey)) {
                        // This indicates we have moved to a new storage format so we migrate the value over
                        this.optInOut((0, core_1.isYesLike)(otherStorage._get(this._storageKey)));
                    }
                    otherStorage._remove(this._storageKey, this._config.cross_subdomain_cookie);
                }
            }
            return this._persistentStore;
        },
        enumerable: false,
        configurable: true
    });
    ConsentManager.prototype._getDnt = function () {
        if (!this._config.respect_dnt) {
            return false;
        }
        return [
            globals_1.navigator === null || globals_1.navigator === void 0 ? void 0 : globals_1.navigator.doNotTrack, // standard
            globals_1.navigator === null || globals_1.navigator === void 0 ? void 0 : globals_1.navigator['msDoNotTrack'],
            globals_2.assignableWindow['doNotTrack'],
            // DNT replacement, EFF Privacy Badger, Firefox 120+. Possibly legally required
            globals_1.navigator === null || globals_1.navigator === void 0 ? void 0 : globals_1.navigator.globalPrivacyControl,
        ].some(function (dntValue) { return (0, core_1.isYesLike)(dntValue); });
    };
    return ConsentManager;
}());
exports.ConsentManager = ConsentManager;
//# sourceMappingURL=consent.js.map