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

package/src/iab/tcf/{consent.js → consent.ts}

@@ -4,29 +4,26 @@ import {
 	DisplayStatusCodes,
 	consentToPurpose,
 } from './constants';
-import { Locale, ScreenIds } from '../../constants';
+import type { IabInitOptions, TcData, TcfVersionType, Tcf_v2 } from './types';
+import { get, set } from '../../utils';
+// TODO: Look at these
+// import { Locale, ScreenIds } from '../../constants';
 import {
-	doesGDPRApply,
-	getConsentString,
+	getConsent,
 	getCurrentScreen,
-	getPublisherCountryCode,
 	getPurposeConsents,
 	getPurposeOptOuts,
 	getPurposesLITransparency,
+	getSavedConsent,
 	getSpecialFeatureOptIns,
-	getStore,
-	getVendorListVersion,
 	getVendorOptOuts,
-	getVendors,
 	hasActed,
-} from './selectors';
-import { get, merge, set } from '../../utils';
-import {
-	getConsent,
-	getSavedConsent,
-	isConsentReady,
 	isSaved,
-} from '../../redux/selectors';
+} from './selectors';
+
+import type { ConsentConfig } from '../../ConsentManager';
+import type { IabState } from '../types';
+import type { OsanoState } from '../../types/store';
 
 export const commonConsent = {
 	consentLanguage: 'en',
@@ -38,8 +35,12 @@ export const commonConsent = {
 	purposeOneTreatment: false,
 };
 
-export const getVendorConsents = (state, apiVersion) => {
-	const vendors = getVendors(state, apiVersion);
+export const getVendorConsents = (
+	config: ConsentConfig,
+	state: OsanoState & IabState,
+	apiVersion: TcfVersionType
+) => {
+	const vendors = config.getVendors();
 	/*
 	 *  Unless a user has specifically opted out of a vendor, the consent
 	 *  is determined by purposes and specialFeatures.
@@ -52,10 +53,11 @@ export const getVendorConsents = (state, apiVersion) => {
 	 */
 	const purposeConsent = consentToPurpose(
 		getSavedConsent(state) || getConsent(state),
-		apiVersion,
+		apiVersion
 	);
-	const consents = Object.entries(vendors).reduce(
-		(vendorConsents, [vendorId, { purposes = [], deletedDate } = {}]) => {
+
+	const consents: Record<string, boolean> = Object.entries(vendors).reduce(
+		(vendorConsents, [vendorId, { purposes = [], deletedDate = '' } = {}]) => {
 			// We also need to apply IAB rules found here:
 			//   https://github.com/InteractiveAdvertisingBureau/iabtcf-es/blob/dfc427d015d63d1f5d745c41e77eaae6c5dec2d4/modules/core/src/encoder/SemanticPreEncoder.ts
 			//   These may need to be updated from time to time.
@@ -72,19 +74,23 @@ export const getVendorConsents = (state, apiVersion) => {
 				const vendorHasConsent =
 					// If all indicated purposes have been consented to
 					purposes.length > 0 &&
-					purposes.every(purposeId => purposeConsent[`${purposeId}`]);
+					purposes.every((purposeId) => purposeConsent[`${purposeId}`]);
 				if (vendorHasConsent) {
 					vendorConsents[`${vendorId}`] = !optOutVendors[`${vendorId}`];
 				}
 			}
 			return vendorConsents;
 		},
-		{},
+		{} as Record<string, boolean>
 	);
 	return consents;
 };
 
-export const getVendorLegitimateInterests = (state, apiVersion) => {
+export const getVendorLegitimateInterests = (
+	config: ConsentConfig,
+	state: IabState & OsanoState,
+	apiVersion: TcfVersionType
+) => {
 	/*
 	 *  Unless a use has specifically opted out of a vendor, the consent
 	 *  is determined by LI.
@@ -96,8 +102,8 @@ export const getVendorLegitimateInterests = (state, apiVersion) => {
 	 *  marked as true.
 	 */
 	const optOutPurposes = getPurposeOptOuts(state, apiVersion);
-	const vendors = getVendors(state, apiVersion);
-	const vendorLegitimateInterests = {};
+	const vendors = config.getVendors();
+	const vendorLegitimateInterests: Record<string, boolean> = {};
 	Object.entries(vendors).forEach(
 		([
 			vendorId,
@@ -105,7 +111,7 @@ export const getVendorLegitimateInterests = (state, apiVersion) => {
 				legIntPurposes = [],
 				purposes = [],
 				specialPurposes = [],
-				deletedDate,
+				deletedDate = '',
 			} = {},
 		]) => {
 			// We also need to apply IAB rules found here:
@@ -125,7 +131,7 @@ export const getVendorLegitimateInterests = (state, apiVersion) => {
 					// If any legIntPurposes is not opted out
 					(legIntPurposes &&
 						legIntPurposes.some(
-							purposeId => !optOutPurposes[`${purposeId}`],
+							(purposeId) => !optOutPurposes[`${purposeId}`]
 						)) ||
 					/**
 					 * Per June 2021 Policy change, Vendors declaring only
@@ -139,87 +145,74 @@ export const getVendorLegitimateInterests = (state, apiVersion) => {
 					vendorLegitimateInterests[`${vendorId}`] = true;
 				}
 			}
-		},
+		}
 	);
 	return vendorLegitimateInterests;
 };
 
-export const makeParseConsentString = initOptions => tcString => {
-	const {
-		encoder: { decode },
-		coreFieldSequence,
-		version,
-		cmpId,
-		cmpVersion,
-		specFieldMode = false,
-	} = initOptions;
-	const segments = tcString.split('.');
-	const coreSegment = decode(segments[0]);
-	const tcData = specFieldMode
-		? {}
-		: {
-				...commonConsent,
-				cmpId,
-				cmpVersion,
-				consentLanguage: Locale.locale.slice(0, 2).toUpperCase(),
-				tcfPolicyVersion: parseInt(version, 10),
-			};
-	coreFieldSequence.reduce(
-		(startBit, [field, numBits, { decode: decodeField }, dataField]) => {
-			const value = isFinite(numBits)
-				? coreSegment.slice(startBit, startBit + numBits)
-				: // It's a non-fixed vector, so we need to use rest of the segment
-					coreSegment.slice(startBit);
+export const makeParseConsentString =
+	(initOptions: IabInitOptions) =>
+	(tcString: string): TcData => {
+		const {
+			encoder: { decode },
+			coreFieldSequence,
+			version,
+			cmpId,
+			cmpVersion,
+		} = initOptions;
+		const segments = tcString.split('.');
+		const coreSegment = decode(segments[0]) as string;
+		const tcData = {
+			...commonConsent,
+			cmpId,
+			cmpVersion,
+			tcfPolicyVersion: parseInt(version, 10),
+		};
+		coreFieldSequence.reduce(
+			(startBit, [field, numBits, { decode: decodeField }, dataField]) => {
+				const value = isFinite(numBits)
+					? coreSegment.slice(startBit, startBit + numBits)
+					: // It's a non-fixed vector, so we need to use rest of the segment
+						coreSegment.slice(startBit);
 
-			const { bitLength, value: decodedValue } = decodeField(value, numBits);
+				const { bitLength, value: decodedValue } = decodeField(value, numBits);
 
-			// The TCF string spec uses PascalCase names for fields, but the TCData object uses camelCase
-			// Reference: https://github.com/IABTechLab/iabgpp-es/blob/42060d7ac2b6d0ee70fc1b5bcd33fc447bf5123c/modules/cmpapi/src/encoder/field/TcfEuV2Field.ts
-			const fieldName = specFieldMode
-				? field[0].toUpperCase() + field.substring(1) // Capitalize first letter
-				: dataField || field;
-			set(tcData, fieldName, decodedValue);
-			return startBit + bitLength;
-		},
-		0,
-	);
-	return tcData;
-};
+				const fieldName = dataField || field;
+				set(tcData, fieldName, decodedValue);
+				return startBit + bitLength;
+			},
+			0
+		);
+		return tcData as unknown as TcData;
+	};
 
-export const makeGetField = initOptions => {
+export const makeGetField = (initOptions: IabInitOptions) => {
 	const parseConsentString = makeParseConsentString({
 		...initOptions,
 		specFieldMode: true,
 	});
-	return (tcString, requestedField) =>
+	return (tcString: string, requestedField: string) =>
 		get(tcString ? parseConsentString(tcString) : {}, requestedField);
 };
 
-/**
- * TCFAPI consentFromOptions implementation
- * @function
- * @param {import('./constants').IABInitOptions} initOptions
- * @returns {import('./constants').TCDataDeterminateField} Properly formatted TCData object
- */
 export const makeConsentFromOptions =
-	({
-		version = '2.0',
-		cmpId,
-		cmpVersion,
-		fallbackGvlVersion,
-		gppSection,
-		staticFields,
-		dynamicFields = {},
-	}) =>
-	(data = {}, state) => {
-		const { gdprApplies } = merge(getStore(state), data);
-		const publisherCC = getPublisherCountryCode(state);
+	(initOptions: IabInitOptions) =>
+	(config: ConsentConfig, state: OsanoState & IabState) => {
+		const {
+			version = '2.0',
+			cmpId,
+			cmpVersion,
+			fallbackGvlVersion,
+			gppSection,
+			staticFields,
+			dynamicFields = {},
+		} = initOptions;
+		const { gdprApplies } = config;
+		const publisherCC = config.country;
 		const currentScreen = getCurrentScreen(state);
-		const isShowingUi = currentScreen !== ScreenIds.None;
+		const isShowingUi = currentScreen !== 0;
 		const willShowUi = !isSaved(state) || isShowingUi;
-		const cmpStatus = isConsentReady(state)
-			? CMPStatusCodes.LOADED
-			: CMPStatusCodes.STUB;
+		const cmpStatus = CMPStatusCodes.LOADED;
 
 		/**
 		 * The vendor list version should be in the customer's config because
@@ -227,8 +220,7 @@ export const makeConsentFromOptions =
 		 * a way to know what it should be. The TCF spec doesn't cover this case
 		 * and we can't encode 'undefined', so we'll use a fallback version.
 		 */
-		const gvlVersion =
-			getVendorListVersion(state, version) || fallbackGvlVersion;
+		const gvlVersion = config.vendorListVersion || fallbackGvlVersion;
 
 		/**
 		 *  Since `consentFromOptions` is used for multiple callbacks, all TCDataDeterminateField
@@ -236,10 +228,10 @@ export const makeConsentFromOptions =
 		 */
 		const dynamicConsent = Object.entries(dynamicFields).reduce(
 			(acc, [field, getter]) => {
-				acc[`${field}`] = getter(data, state);
+				acc[`${field}`] = getter(initOptions, state);
 				return acc;
 			},
-			{},
+			{} as Record<string, any>
 		);
 		return {
 			version: staticFields.version,
@@ -259,87 +251,74 @@ export const makeConsentFromOptions =
 			cmpId,
 			cmpVersion,
 			gvlVersion,
-			consentLanguage: Locale.locale.slice(0, 2).toUpperCase(),
+			consentLanguage: config.language.slice(0, 2).toUpperCase(),
 			publisherCC,
 			tcfPolicyVersion: staticFields.tcfPolicyVersion,
-			gdprApplies:
-				gdprApplies !== undefined ? gdprApplies : doesGDPRApply(state),
+			gdprApplies,
 			vendor: {
-				consents: getVendorConsents(state, version),
-				legitimateInterests: getVendorLegitimateInterests(state, version),
+				consents: getVendorConsents(config, state, version),
+				legitimateInterests: getVendorLegitimateInterests(
+					config,
+					state,
+					version
+				),
 			},
 			specialFeatureOptins: getSpecialFeatureOptIns(state, version),
 			purpose: {
 				consents: getPurposeConsents(state, version),
 				legitimateInterests: getPurposesLITransparency(state, version),
 			},
-		};
+		} as TcData;
 	};
 
-/**
- * TCFAPI formatConsentString implementation
- * @function
- * @param {Object} data
- * @returns {string} Properly formatted TCFData string
- */
-export const makeFormatConsentString = initOptions => (data, state) => {
-	const {
-		encoder: { encode },
-		coreFieldSequence,
-		staticFields,
-	} = initOptions;
-	const tcData = makeConsentFromOptions(initOptions)(data, state);
-	const segments = getConsentString(state, initOptions).split('.');
-	// Only update the CORE string
-	segments.shift();
-	const [bitFields] = coreFieldSequence.reduce(
-		(
-			[bitString, startBit],
-			[key, numBits, { encode: encodeField }, dataField = key],
-		) => {
-			let value;
-			if (Object.hasOwnProperty.call(staticFields, dataField)) {
-				// We should skip this field
-				const staticValue = staticFields[`${dataField}`];
-				value = staticValue;
-			} else {
-				value = get(tcData, dataField);
-			}
-			const encodedValue = encodeField(value, numBits);
-			return [bitString + encodedValue, startBit + encodedValue.length];
-		},
-		['', 0],
-	);
-	const newCoreString = encode(bitFields);
-	segments.unshift(newCoreString);
-	return segments.join('.');
-};
-
-/**
- * TCFAPI getConsentDataObject implementation
- * @function
- * @param {number} version
- * @returns {import('./constants').TCData} Properly formatted TCData object
- */
-export const makeGetConsentDataObject = initOptions => state => {
-	const { defaultTimestamp, version } = initOptions;
-	switch (parseInt(version, 10)) {
-		// Supported versions
-		case 2: {
-			break;
-		}
-
-		default: {
-			throw new Error('Unsupported version');
-		}
-	}
-
-	// `defaultTimestamp` will be used for the created and lastUpdated fields if
-	// a consent timestamp is not available yet.
-	const data = { defaultTimestamp };
+export const makeFormatConsentString =
+	(initOptions: IabInitOptions) =>
+	(config: ConsentConfig, state: OsanoState & IabState) => {
+		const {
+			encoder: { encode },
+			coreFieldSequence,
+			staticFields,
+			tcString,
+		} = initOptions;
+		const tcData = makeConsentFromOptions(initOptions)(config, state);
+		const segments = `${tcString}`.split('.').filter(Boolean);
+		// Only update the CORE string
+		segments.shift();
+		const [bitFields] = coreFieldSequence.reduce(
+			(
+				[bitString, startBit],
+				[key, numBits, { encode: encodeField }, dataField = key]
+			) => {
+				let value;
+				if (Object.hasOwnProperty.call(staticFields, dataField)) {
+					// We should skip this field
+					const staticValue = staticFields[`${dataField}`];
+					value = staticValue;
+				} else {
+					value = get(tcData, dataField);
+				}
+				// if (process.env.NODE_ENV === 'development') {
+				// 	console.log(
+				// 		`TCString encode: ${dataField} -> ${JSON.stringify(value)} :: ${numBits} bits`
+				// 	);
+				// }
+				const encodedValue = encodeField(value, numBits);
+				return [bitString + encodedValue, startBit + encodedValue.length];
+			},
+			['', 0]
+		);
+		const newCoreString = encode(bitFields);
+		segments.unshift(newCoreString);
+		return segments.join('.');
+	};
 
-	return {
-		...makeConsentFromOptions(initOptions)(data, state),
-		tcString: makeFormatConsentString(initOptions)(data, state),
+export const makeReadFromStorage = (initOptions: IabInitOptions) => {
+	const { version } = initOptions;
+	return (storage: Partial<Tcf_v2>) => {
+		return {
+			tcf: {
+				[`v${parseInt(version, 10)}`]: storage ?? {},
+			},
+		};
 	};
 };

package/src/iab/tcf/constants.ts

@@ -21,13 +21,13 @@ export const DisplayStatusCodes = {
 	DISABLED: 'disabled',
 };
 
-export const purposeIds = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
+export const purposeIds = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11];
 export const purposeMap: Record<ConsentCategoryType, number[]> = {
-	[ConsentCategory.ESSENTIAL]: [],
-	[ConsentCategory.ANALYTICS]: [8, 10],
+	[ConsentCategory.ESSENTIAL]: [1],
+	[ConsentCategory.ANALYTICS]: [7, 8, 9, 10],
 	[ConsentCategory.STORAGE]: [1],
-	[ConsentCategory.MARKETING]: [2, 7, 9],
-	[ConsentCategory.PERSONALIZATION]: [3, 4, 5, 6],
+	[ConsentCategory.MARKETING]: [2, 3, 4],
+	[ConsentCategory.PERSONALIZATION]: [5, 6, 11],
 	[ConsentCategory.OPT_OUT]: [],
 };
 
@@ -38,7 +38,7 @@ export const consentToPurpose = (
 	if (parseInt(apiVersion, 10) <= 2) {
 		return Object.entries(purposeMap).reduce(
 			(consents, [category, purposes]) => {
-				purposes.forEach(purpose => {
+				purposes.forEach((purpose) => {
 					consents[`${purpose}`] =
 						!!consent[`${category as ConsentCategoryType}`];
 				});

package/src/iab/tcf/helpers.ts

@@ -0,0 +1,95 @@
+import type { IabInitOptions, TcfVersionType } from './types';
+import {
+	getPurposeOptOuts,
+	getSpecialFeatureOptIns,
+	getVendorOptOuts,
+} from './selectors';
+
+import type { IabState } from '../types';
+import type { OsanoState } from '../../types/store';
+import { fixedValuesArrayFormatter } from './v2.0/formatters';
+import { getConsentTimestamp } from '../../selectors';
+
+/*
+ * 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.
+ */
+
+export const createUTCTimestampInDeciseconds = (
+	{ defaultTimestamp = 0 }: IabInitOptions,
+	state: OsanoState
+) => {
+	const consentDate = new Date(getConsentTimestamp(state) || defaultTimestamp);
+	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);
+};
+
+export const idRecordToBinaryString = (records: Record<string, boolean>) =>
+	fixedValuesArrayFormatter(
+		records,
+		Object.keys(records)
+			.map((key) => parseInt(key, 10))
+			.reduce((a, b) => Math.max(a, b), 0)
+	)
+		.map((value) => (value ? '1' : '0'))
+		.join('');
+
+export const updateSpecialFeatureOptIns = (
+	state: IabState,
+	version: TcfVersionType,
+	specialFeatureIds: number[],
+	acceptOrDeny: boolean
+) => {
+	const specialFeatureOptins = { ...getSpecialFeatureOptIns(state, version) };
+	for (const specialFeatureId of specialFeatureIds) {
+		if (acceptOrDeny) {
+			specialFeatureOptins[`${specialFeatureId}`] = true;
+		} else {
+			delete specialFeatureOptins[`${specialFeatureId}`];
+		}
+	}
+	return specialFeatureOptins;
+};
+
+export const updatePurposeOptOuts = (
+	state: IabState,
+	version: TcfVersionType,
+	purposeIds: number[],
+	acceptOrDeny: boolean
+) => {
+	const purposeOptOuts = { ...getPurposeOptOuts(state, version) };
+	// ACCEPT on "I Object" means OptOut is TRUE
+	for (const purposeId of purposeIds) {
+		if (acceptOrDeny) {
+			purposeOptOuts[`${purposeId}`] = true;
+		} else {
+			delete purposeOptOuts[`${purposeId}`];
+		}
+	}
+	return purposeOptOuts;
+};
+
+export const updateVendorOptOuts = (
+	state: IabState,
+	version: TcfVersionType,
+	vendorIds: number[],
+	acceptOrDeny: boolean
+) => {
+	const vendorOptOuts = { ...getVendorOptOuts(state, version) };
+	for (const vendorId of vendorIds) {
+		if (acceptOrDeny === false) {
+			vendorOptOuts[`${vendorId}`] = true;
+		} else {
+			delete vendorOptOuts[`${vendorId}`];
+		}
+	}
+	return vendorOptOuts;
+};

package/src/iab/tcf/index.ts

@@ -0,0 +1,8 @@
+import * as selectors from './selectors';
+
+import versions from './v2.0';
+
+export default {
+	...versions,
+	selectors,
+};