File size: 2,938 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 |
import cookie from 'cookie';
import isCountryInGdprZone from './is-country-in-gdpr-zone';
import isRegionInCcpaZone from './is-region-in-ccpa-zone';
export const TRACKING_PREFS_COOKIE_V1 = 'sensitive_pixel_option';
export const TRACKING_PREFS_COOKIE_V2 = 'sensitive_pixel_options';
export type TrackingPrefs = {
ok: boolean;
buckets: {
essential: boolean;
analytics: boolean;
advertising: boolean;
};
};
const prefsDisallowAll: TrackingPrefs = {
ok: false,
buckets: {
essential: true, // essential bucket is always allowed
analytics: false,
advertising: false,
},
};
const prefsAllowAnalyticsGdpr: TrackingPrefs = {
ok: false, // false is important so the cookie banner is shown
buckets: {
essential: true,
analytics: true, // in GDPR zone, analytics is opt-out
advertising: false, // in GDPR zone, advertising is opt-in
},
};
const prefsAllowAll: TrackingPrefs = {
ok: true,
buckets: {
essential: true,
analytics: true,
advertising: true,
},
};
export const parseTrackingPrefs = (
cookieV2?: string,
cookieV1?: string,
defaultPrefs = prefsDisallowAll
): TrackingPrefs => {
const { ok, buckets }: Partial< TrackingPrefs > = cookieV2 ? JSON.parse( cookieV2 ) : {};
if ( typeof ok === 'boolean' ) {
return {
ok,
buckets: {
...defaultPrefs.buckets,
...buckets,
},
};
} else if ( cookieV1 && [ 'yes', 'no' ].includes( cookieV1 ) ) {
return {
ok: cookieV1 === 'yes',
buckets: prefsAllowAll.buckets,
};
}
return defaultPrefs;
};
/**
* Returns consents for every Cookie Jar bucket based on privacy driven approach
*
* WARNING: this function is meant to work on the client side. If not called
* from the client side then it defaults to allow all
* @returns Whether we may track the current user
*/
export default function getTrackingPrefs(): TrackingPrefs {
if ( typeof document === 'undefined' ) {
//throw new Error( 'getTrackingPrefs() can only be called on the client side' );
return prefsAllowAll;
}
const cookies = cookie.parse( document.cookie );
const isCountryGdpr = isCountryInGdprZone( cookies.country_code );
const isCountryCcpa = isRegionInCcpaZone( cookies.country_code, cookies.region );
if ( ! isCountryGdpr && ! isCountryCcpa ) {
return prefsAllowAll;
}
// default tracking mechanism for GDPR is opt-in for marketing and opt-out for anaytics, for CCPA is opt-out:
const defaultPrefs = isCountryGdpr ? prefsAllowAnalyticsGdpr : prefsAllowAll;
const { ok, buckets } = parseTrackingPrefs(
cookies[ TRACKING_PREFS_COOKIE_V2 ],
cookies[ TRACKING_PREFS_COOKIE_V1 ],
defaultPrefs
);
if ( isCountryCcpa ) {
// For CCPA, only the advertising bucket is relevant, the rest are always true
return {
ok,
buckets: {
...prefsAllowAll.buckets,
advertising: buckets.advertising,
},
};
}
// For CCPA, only the advertising bucket is relevant, the rest are always true
return { ok, buckets };
}
|