@osano/osano-cmp-react-native 0.1.0 → 0.3.0

package/src/iab/tcf/actions.js

@@ -1,52 +0,0 @@
-import {
-	createActionCreator,
-	namedParameters,
-	noParameters,
-	singleParameter,
-} from '../../redux/helpers';
-
-const prefix = 'OsanoCMP_IAB-TCF';
-export const setPurposeConsent = createActionCreator(
-	`${prefix}/SET_PURPOSE_CONSENT`,
-	namedParameters('purposeId', 'acceptOrDeny'),
-);
-export const setAllPurposeConsent = createActionCreator(
-	`${prefix}/SET_ALL_PURPOSE_CONSENT`,
-	namedParameters('acceptOrDeny'),
-);
-export const setVendorConsent = createActionCreator(
-	`${prefix}/SET_VENDOR_CONSENT`,
-	namedParameters('vendorId', 'acceptOrDeny'),
-);
-export const setAllVendorConsent = createActionCreator(
-	`${prefix}/SET_ALL_VENDOR_CONSENT`,
-	namedParameters('acceptOrDeny'),
-);
-export const setSpecialFeatureConsent = createActionCreator(
-	`${prefix}/SET_SPECIAL_FEATURE_CONSENT`,
-	namedParameters('specialFeatureId', 'acceptOrDeny'),
-);
-export const setAllSpecialFeatureConsent = createActionCreator(
-	`${prefix}/SET_ALL_SPECIAL_FEATURE_CONSENT`,
-	namedParameters('acceptOrDeny'),
-);
-export const setGdprApplies = createActionCreator(
-	`${prefix}/SET_GDPR_APPLIES`,
-	singleParameter,
-);
-export const updatePurposeList = createActionCreator(
-	`${prefix}/UPDATE_PURPOSE_LIST`,
-	namedParameters('purposeList', 'language'),
-);
-export const updateVendorListBegin = createActionCreator(
-	`${prefix}/UPDATE_VENDOR_LIST_BEGIN`,
-	noParameters,
-);
-export const updateVendorListSuccess = createActionCreator(
-	`${prefix}/UPDATE_VENDOR_LIST_SUCCESS`,
-	singleParameter,
-);
-export const updateVendorListFailure = createActionCreator(
-	`${prefix}/UPDATE_VENDOR_LIST_FAILURE`,
-	singleParameter,
-);

package/src/iab/tcf/index.js

@@ -1,7 +0,0 @@
-import reducer from './reducer';
-import versions from './v2.0';
-
-export default {
-	reducer,
-	versions,
-};

package/src/iab/tcf/reducer.js

@@ -1,59 +0,0 @@
-import { types as ActionTypes } from '../../redux/actions';
-import { genericReducer } from '../../redux/helpers';
-import { merge } from '../../utils';
-import { setGdprApplies } from './actions';
-import { initialState as v2_initialState } from './v2.0/reducer';
-
-export const initialState = merge({}, v2_initialState);
-
-const updateOptions = (state, options) => {
-	const { config } = options || {};
-	const {
-		config: {
-			gdprApplies: providedGdprApplies,
-			iabEnabled: providedIABEnabled,
-		} = {},
-	} = state;
-	const { gdprApplies = providedGdprApplies, iabEnabled = providedIABEnabled } =
-		config || {};
-	const newState = merge(
-		{ ...state },
-		{
-			iab: {
-				tcf: {
-					enabled:
-						typeof iabEnabled === 'string'
-							? iabEnabled === 'true'
-							: !!iabEnabled,
-					gdprApplies:
-						typeof gdprApplies === 'string'
-							? gdprApplies === 'true'
-							: !!gdprApplies,
-				},
-			},
-		},
-	);
-	return newState;
-};
-
-export default genericReducer(initialState, {
-	[ActionTypes.init]: updateOptions,
-	[ActionTypes.updateConfig]: (state, config) =>
-		updateOptions(state, { config }),
-	[setGdprApplies.type]: (state, gdprApplies) => {
-		const newState = merge(
-			{ ...state },
-			{
-				iab: {
-					tcf: {
-						gdprApplies:
-							typeof gdprApplies === 'string'
-								? gdprApplies === 'true'
-								: !!gdprApplies,
-					},
-				},
-			},
-		);
-		return newState;
-	},
-});

package/src/iab/tcf/selectors.js

@@ -1,151 +0,0 @@
-import { consentToPurpose, purposeIds } from './constants';
-import {
-	getConsent,
-	getCountryCode,
-	getSavedConsent,
-} from '../../redux/selectors';
-
-import { GDPR_COUNTRIES } from '@osano-cmp';
-import { ScreenIds } from '../../constants';
-import { get } from '../../utils';
-import { isBrowsingFrom } from '../gpp/selectors';
-
-export const DOMAIN = 'iab.tcf';
-
-export const isIABEnabled = state => !!get(state, 'config.iabEnabled');
-
-export const getStore = state => get(state, DOMAIN, {});
-export const getApiData = (state, apiVersion = 2) =>
-	get(getStore(state), [`v${parseInt(apiVersion, 10)}`], {});
-
-export const getCurrentScreen = state =>
-	get(state, 'ui.currentScreen', ScreenIds.None);
-
-// Expects that `iab.tcf.gdprApplies` will always be a boolean under real usage.
-// The fallback (`GDPR_COUNTRIES.includes`) is meant ONLY for preview (webapp).
-export const doesGDPRApply = state =>
-	!!get(
-		getStore(state),
-		'gdprApplies',
-		GDPR_COUNTRIES.includes(getCountryCode(state)),
-	);
-
-export const getConsentLanguage = state => {
-	return get(state, 'config.lang', 'en').slice(0, 2).toUpperCase();
-};
-export const getConsentString = (state, { gppSection, tcString }) => {
-	return get(state, ['iab', 'consentStrings', gppSection], tcString);
-};
-export const getPublisherCountryCode = state =>
-	// This must be a Two-Letter code
-	(
-		get(getStore(state), 'publisherCC') ||
-		getCountryCode(state) ||
-		'US'
-	).toUpperCase();
-
-// API Specific Data
-export const getPublisherLegitimateInterests = (/* state, apiVersion */) => {
-	// Placeholder
-	return {};
-};
-export const getPurposeIds = () => [...purposeIds];
-export const getPurposeOptOuts = (state, apiVersion) =>
-	get(getApiData(state, apiVersion), 'purposeOptouts') || {};
-export const getPurposeConsents = (state, apiVersion) => {
-	const consent = getSavedConsent(state) || getConsent(state);
-	const optOutPurposes = getPurposeOptOuts(state, apiVersion);
-	return Object.entries(consentToPurpose(consent, apiVersion)).reduce(
-		(purposeConsents, [purposeId, hasConsented]) => {
-			purposeConsents[`${purposeId}`] =
-				hasConsented && !optOutPurposes[`${purposeId}`];
-			return purposeConsents;
-		},
-		{},
-	);
-};
-// Established legitimate interest per purpose
-export const getPurposesLITransparency = (state, apiVersion) => {
-	/*
-	 *  PurposesLITransparency
-	 *  For the purposes of a TCString, this indicates that the end user
-	 *  has been given notification of the consent purposes and the
-	 *  opportunity to accept or deny them, or object individually.
-	 */
-	const purposeConsents = getPurposeConsents(state, apiVersion);
-	const purposeLITransparency = {};
-	const optOutPurposes = getPurposeOptOuts(state, apiVersion);
-	Object.entries(purposeConsents).forEach(([purposeId]) => {
-		// We are only indicating that the user has been given transparency
-		if (!optOutPurposes[`${purposeId}`]) {
-			// If a user has not specifically objected, we mark the purpose true
-			purposeLITransparency[`${purposeId}`] = true;
-		}
-	});
-	/**
-	 * Purpose 1 is never allowed to be true for legitimate interest transparency
-	 */
-	delete purposeLITransparency[`${1}`];
-	return purposeLITransparency;
-};
-export const getSpecialFeatureOptIns = (state, apiVersion) =>
-	get(getApiData(state, apiVersion), 'specialFeatureOptins') || {};
-export const getVendors = (state, apiVersion) =>
-	get(getApiData(state, apiVersion), 'vendors') || {};
-export const getVendorData = (state, { apiVersion, vendorId }) =>
-	get(getVendors(state, apiVersion), `${vendorId}`) || {};
-export const getVendorIds = (state, apiVersion) =>
-	Object.keys(getVendors(state, apiVersion)).map(vendorId =>
-		parseInt(vendorId, 10),
-	) || [];
-export const getVendorOptOuts = (state, apiVersion) =>
-	get(getApiData(state, apiVersion), 'vendorOptouts') || {};
-export const getVendorListError = (state, apiVersion) =>
-	get(getApiData(state, apiVersion), 'vendorListError', 0);
-export const getVendorListVersion = (state, apiVersion) =>
-	get(getApiData(state, apiVersion), 'vendorListVersion');
-
-// This is the same value as v2.0/constants.js/gppSection but duplicating it
-// prevents having to import that file which keeps the bundle size a lot
-// smaller.
-const TCF_GPP_SECTION = 'tcfeuv2';
-export const getStorageConsent = state => {
-	return {
-		iab: {
-			v2: {
-				p: getPurposeOptOuts(state, '2.0'),
-				v: getVendorOptOuts(state, '2.0'),
-			},
-			// If we rename this property, we need to update the reducer
-			// (src/iab/tcf/v2.0/reducer.js) for `setConsent` which extracts it
-			// so that we honor previously-saved values.
-			euconsent: getConsentString(state, { gppSection: TCF_GPP_SECTION }),
-		},
-	};
-};
-
-/**
- * Indicates if any action has been taken by the user in regards to consent
- *
- * @param {import('../../redux/selectors.js').ReduxState} state
- * @param {string} gppSection The gppSection location in Redux that we store the TCString in.
- * @returns {boolean} TRUE if a consent action has been taken, FALSE if it has not
- */
-export const hasActed = (state, gppSection) =>
-	!!get(state, ['iab', 'hasActed', gppSection]);
-export const hasConsentedToSpecialFeature = (
-	state,
-	{ apiVersion, specialFeatureId },
-) => !!getSpecialFeatureOptIns(state, apiVersion)[`${specialFeatureId}`];
-export const hasOptedOutOfVendor = (state, { apiVersion, vendorId }) =>
-	!!getVendorOptOuts(state, apiVersion)[`${vendorId}`];
-export const hasOptedOutOfPurpose = (state, { apiVersion, purposeId }) =>
-	!!getPurposeOptOuts(state, apiVersion)[`${purposeId}`];
-
-export const isTcfApplicable = state =>
-	(doesGDPRApply(state) || isBrowsingFrom(state, 'ca')) &&
-	!!get(getStore(state), 'enabled', isIABEnabled(state));
-export const isVendorListLoaded = (state, apiVersion) =>
-	!!get(getApiData(state, apiVersion), 'vendorListLoaded');
-export const isVendorListLoading = (state, apiVersion) =>
-	!!get(getApiData(state, apiVersion), 'vendorListLoading');

package/src/iab/tcf/tcfcav1-api.js

@@ -1,39 +0,0 @@
-import { get } from '../../utils';
-import { makeGetConsentDataObject } from './consent';
-
-export default function makeApi(initOptions) {
-	const getConsentDataObject = makeGetConsentDataObject(initOptions);
-	const buildTcData = state => {
-		const consentDataObj = getConsentDataObject(state);
-		return initOptions.coreFieldSequence.reduce(
-			(tcData, [tcDataField, length, , consentDataField, formatter]) => {
-				const value = get(consentDataObj, consentDataField);
-				tcData[`${tcDataField}`] = formatter ? formatter(value, length) : value;
-				return tcData;
-			},
-			{},
-		);
-	};
-
-	function bind(store) {
-		return function tcfApi(command, callback, parameter) {
-			const state = store.getState();
-			switch (command) {
-				case 'getField': {
-					const field = parameter;
-					const tcData = buildTcData(state);
-					return tcData[`${field}`];
-				}
-
-				case 'getSection': {
-					const tcData = buildTcData(state);
-					return tcData;
-				}
-			}
-		};
-	}
-
-	return {
-		bind,
-	};
-}

package/src/iab/tcf/tcfeuv2-api.js

@@ -1,264 +0,0 @@
-import { makeGetConsentDataObject, makeGetField } from './consent';
-
-import { MAX_DATE } from '../../constants';
-import { getConsentString } from './selectors';
-import { setGdprApplies } from './actions';
-
-/**
- * Extracts the TCData fields from a consentDataObj
- * @param {object} consentDataObj - Data object returned from getConsentDataObject()
- */
-function consentToTcData(consentDataObj) {
-	const {
-		tcString,
-		tcfPolicyVersion,
-		cmpVersion,
-		cmpId,
-		gdprApplies,
-		cmpLoaded,
-		eventStatus,
-		cmpStatus,
-		displayStatus,
-		isServiceSpecific,
-		purposeOneTreatment,
-		useNonStandardStacks,
-		publisherCC,
-		purpose,
-		vendor,
-		specialFeatureOptins,
-		publisher,
-	} = consentDataObj;
-	return gdprApplies
-		? {
-				tcString,
-				tcfPolicyVersion,
-				cmpVersion,
-				cmpId,
-				gdprApplies,
-				cmpLoaded,
-				eventStatus,
-				cmpStatus,
-				displayStatus,
-				isServiceSpecific,
-				purposeOneTreatment,
-				useNonStandardStacks,
-				publisherCC: `${publisherCC}`.toUpperCase(),
-				purpose,
-				vendor,
-				specialFeatureOptins,
-				publisher,
-			}
-		: {
-				tcfPolicyVersion,
-				cmpVersion,
-				cmpId,
-				gdprApplies,
-				eventStatus,
-			};
-}
-
-const callbacks = {};
-
-const makeDispatch = apiVersion =>
-	function dispatch(data) {
-		const tcData = consentToTcData(data);
-		Object.entries(callbacks).forEach(([listenerId, { version, callback }]) => {
-			parseInt(apiVersion, 10) === parseInt(version, 10) &&
-				callback(
-					{
-						...tcData,
-						listenerId: parseInt(listenerId, 10),
-					},
-					true,
-				);
-		});
-	};
-
-/**
- * TCFAPI implementation
- * @function
- * @name __tcfapi
- * @param {string} command - The command to be executed by the API
- * @param {string} [parameter] - Optional parameter to be passed to the `command`
- * @param {number} version - The version number that the response should adhere to
- * @param {requestCallback} callback - The callback method that should be called with the command result
- */
-export default function makeApi(initOptions) {
-	const getTCData = (state, version) => {
-		try {
-			const consentDataObj = makeGetConsentDataObject({
-				...initOptions,
-				version,
-			})(state);
-			return consentToTcData(consentDataObj);
-		} catch {
-			// could not retrieve data
-			return undefined;
-		}
-	};
-
-	const getField = makeGetField(initOptions);
-
-	function bind(store) {
-		return function tcfApi(...args) {
-			const state = store.getState();
-			const [command] = args;
-			const [, requestedApiVersion] = args;
-			let apiVersion =
-				requestedApiVersion === null
-					? initOptions.version
-					: parseFloat(`${requestedApiVersion}`);
-			if (typeof apiVersion === 'number') {
-				// Floating point precision for numeric requests
-				if (isNaN(apiVersion)) {
-					apiVersion = 0;
-				} else {
-					const apiString = `${apiVersion}`.split('.');
-					apiVersion =
-						apiString.length === 1
-							? `${apiVersion}.0`
-							: `${apiString[0]}.${apiString[1][0]}`;
-				}
-			}
-			const version = parseInt(apiVersion, 10);
-
-			switch (command) {
-				case 'setGdprApplies': {
-					/**
-					 * shortcut to set gdprApplies if the publisher
-					 * knows that they apply GDPR rules to all
-					 * traffic (see the section on "What does the
-					 * gdprApplies value mean" for more
-					 */
-					let [, , callback, gdprApplies] = args;
-					if (typeof callback === 'function') {
-						switch (version) {
-							case 2: {
-								// Version 2
-								if (args.length > 3 && typeof gdprApplies === 'boolean') {
-									store.dispatch(setGdprApplies(gdprApplies));
-									callback('set', true);
-									return;
-								}
-							}
-						}
-						callback(undefined, false);
-					}
-					break;
-				}
-
-				case 'ping': {
-					const [, , callback] = args;
-					if (typeof callback === 'function') {
-						try {
-							const {
-								cmpId,
-								cmpLoaded,
-								cmpStatus,
-								cmpVersion,
-								displayStatus,
-								gdprApplies,
-								gvlVersion,
-								tcfPolicyVersion,
-							} = makeGetConsentDataObject({
-								...initOptions,
-								version: apiVersion,
-							})(state);
-							callback({
-								// Returned apiVersion is a string
-								apiVersion: `${apiVersion}`,
-								cmpId,
-								cmpLoaded,
-								cmpStatus,
-								cmpVersion,
-								displayStatus,
-								gdprApplies,
-								gvlVersion,
-								tcfPolicyVersion,
-							});
-						} catch (error) {
-							// Could not retrieve data
-							callback(undefined, false);
-						}
-					}
-					break;
-				}
-
-				case 'getField': {
-					const consentString = getConsentString(state, initOptions);
-					const [, , , field] = args;
-					// The spec uses 'TcfPolicyVersion' but the GPP reference
-					// implementation uses 'PolicyVersion' for tcfeuv2 and
-					// TcfPolicyVersion for tcfcav1. We support both.
-					if (field === 'TcfPolicyVersion') {
-						return getField(consentString, 'PolicyVersion');
-					}
-					return getField(consentString, field);
-				}
-
-				case 'getSection': {
-					return getTCData(state, apiVersion);
-				}
-
-				case 'getTCData': {
-					const [, , callback] = args;
-					if (typeof callback === 'function') {
-						const tcData = getTCData(state, apiVersion);
-						callback(tcData, !!tcData);
-					}
-					break;
-				}
-
-				case 'addEventListener': {
-					const [, , callback] = args;
-					if (typeof callback === 'function') {
-						try {
-							let inc = 0;
-							// listenerId must be a number: https://github.com/InteractiveAdvertisingBureau/GDPR-Transparency-and-Consent-Framework/blob/master/TCFv2/IAB%20Tech%20Lab%20-%20CMP%20API%20v2.md#tcdata
-							let listenerId = MAX_DATE - Date.now();
-							do {
-								listenerId -= inc++;
-							} while (callbacks[`${listenerId}`]);
-
-							callbacks[`${listenerId}`] = { version, callback };
-							const consentDataObj = makeGetConsentDataObject({
-								...initOptions,
-								version: apiVersion,
-							})(state);
-							const returnObject = {
-								...consentToTcData(consentDataObj),
-								listenerId,
-							};
-
-							callback(returnObject, true);
-						} catch (error) {
-							// Could not retrieve data
-							callback(undefined, false);
-						}
-					}
-					break;
-				}
-
-				case 'removeEventListener': {
-					const [, , callback, listenerId] = args;
-					delete callbacks[`${listenerId}`];
-					if (typeof callback === 'function') {
-						callback(true);
-					}
-					break;
-				}
-			}
-		};
-	}
-
-	return {
-		bind,
-		dispatch: makeDispatch(initOptions.version),
-	};
-}
-/**
- * This callback is part of __tcfapi API
- * @callback __tcfapi~requestCallback
- * @param {import('./constants').TCFData} uspData
- * @param {boolean} success
- */

package/src/iab/tcf/v2.0/formatters.js

@@ -1,14 +0,0 @@
-export const idsOnlyArrayFormatter = value =>
-	Object.entries(value)
-		.filter(([, v]) => v)
-		.map(([k]) => parseInt(k, 10));
-
-export const fixedValuesArrayFormatter = (idValueMap, length) => {
-	const array = Array.from({ length }).fill(false);
-	Object.entries(idValueMap).forEach(([k, v]) => {
-		array[k - 1] = v;
-	});
-	return array;
-};
-
-export const dateFormatter = timestamp => new Date(timestamp * 100);

package/src/iab/tcf/v2.0/helpers.ts

@@ -1,23 +0,0 @@
-/*
- * TCF Amendment - 21 December 2021
- *  Created and LastUpdated fields have been updated to have the same value
- *  corresponding to the ** day-level ** timestamp of when the TC String
- *  was last updated. Timestamp should maintain 36bit depth (deciseconds),
- *  but hours, minutes, seconds and milliseconds should be 0.
- */
-
-/**
- * Creates a timestamp in deciseconds
- */
-export const createUTCTimestampInDeciseconds = (
-	timestamp: number | string | Date,
-) => {
-	const consentDate = new Date(timestamp);
-	const utc = Date.UTC(
-		consentDate.getUTCFullYear(),
-		consentDate.getUTCMonth(),
-		consentDate.getUTCDate(),
-	);
-	// Make sure the timestamp is > 0 otherwise the TCF Int parser fails
-	return Math.round(Math.max(0, utc) / 100);
-};

package/src/iab/tcf/v2.0/index.js

@@ -1,36 +0,0 @@
-import {
-	apiName,
-	iframeName,
-	initOptions as tcfeuv2InitOptions,
-} from './tcfeuv2-constants';
-
-import makeCreateMiddleware from './middleware';
-import makeReducer from './reducer';
-import makeTcfcav1Api from '../tcfcav1-api';
-import makeTcfeuv2Api from '../tcfeuv2-api';
-import postMessageEventHandler from '../../iframe';
-import { initOptions as tcfcav1InitOptions } from './tcfcav1-constants';
-
-/**
- * TCF-Canada v1 is nearly identical to TCF-EU v2, just with a few fields left
- * out and some renamed. As such, it makes use of the same state data as
- * tcfeuv2, so there is an implicit dependency on tcfeuv2's reducer.
- */
-
-const tcfeuv2 = {
-	api: makeTcfeuv2Api(tcfeuv2InitOptions),
-	apiName,
-	createMiddleware: makeCreateMiddleware(tcfeuv2InitOptions),
-	gppSection: tcfeuv2InitOptions.gppSection,
-	iframeName,
-	postMessageEventHandler: postMessageEventHandler(apiName, true),
-	reducer: makeReducer(tcfeuv2InitOptions),
-};
-
-const tcfcav1 = {
-	api: makeTcfcav1Api(tcfcav1InitOptions),
-	createMiddleware: makeCreateMiddleware(tcfcav1InitOptions),
-	gppSection: tcfcav1InitOptions.gppSection,
-};
-
-export default { tcfeuv2, tcfcav1 };