@osano/osano-cmp-react-native 0.11.0 → 0.13.0

package/src/commands.ts

@@ -7,17 +7,17 @@ import {
 	SAVE_SUCCESS,
 } from './actions';
 import type { ConsentManager } from './ConsentManager';
-import type { OsanoAction, OsanoState } from './types/store';
 import {
 	getConsent,
 	hasFetchedDisclosuresForCategory,
 	isLoadingDisclosures,
 } from './selectors';
+import type { OsanoAction, OsanoState } from './types/store';
 
 import { type ConsentCategory as ConsentCategoryType } from './constants';
-import { fetchDisclosures } from './services/disclosures';
-import { recordConsent } from './services/consent';
 import type { AsyncAction } from './hooks/useThunkReducer';
+import { recordConsent } from './services/consent';
+import { fetchDisclosures } from './services/disclosures';
 
 export const toggleDisclosure =
 	(payload: {
@@ -47,7 +47,7 @@ export const toggleDisclosure =
 				customerId,
 				configId,
 				undefined /* category */,
-				state.locale
+				state.locale,
 			)
 				.then((response) => {
 					const disclosureResults = response || [];
@@ -70,7 +70,7 @@ export const toggleDisclosure =
 
 export const saveConsent =
 	(
-		cmp: ConsentManager
+		cmp: ConsentManager,
 	): AsyncAction<
 		OsanoState,
 		OsanoAction<
@@ -87,9 +87,12 @@ export const saveConsent =
 		const consent = getConsent(state);
 		dispatch({ type: SAVE_BEGIN });
 		return recordConsent(cmp, consent)
-			.then((newConsent: ConsentCategoryType[] | null) =>
-				dispatch({ type: SAVE_SUCCESS, payload: newConsent })
-			)
+			.then((newConsent: ConsentCategoryType[] | null) => {
+				dispatch({ type: SAVE_SUCCESS, payload: newConsent });
+				if (newConsent) {
+					cmp.triggerGoogleConsentUpdate(newConsent);
+				}
+			})
 			.catch(() => {
 				dispatch({ type: SAVE_FAILURE, payload: oldConsent });
 			});

package/src/components/Button.tsx

@@ -1,24 +1,24 @@
-import { Path, Polygon, Svg } from 'react-native-svg';
+import React, { useCallback, useContext, useMemo } from 'react';
 import {
 	Pressable,
 	type PressableProps,
 	type StyleProp,
 	Text,
 	type TextStyle,
-	type ViewStyle,
 	type View,
+	type ViewStyle,
 } from 'react-native';
-import React, { useCallback, useContext, useMemo } from 'react';
+import { Path, Polygon, Svg } from 'react-native-svg';
 import { acceptAll, close, denyAll, goBack, showDrawer } from '../actions';
 import { saveConsent } from '../commands';
 
-import Locale from './Locale';
 import { OsanoPrivateContext } from '../context';
 import {
 	setAllPurposeConsent,
 	setAllSpecialFeatureConsent,
 	setAllVendorConsent,
 } from '../iab/tcf/actions';
+import Locale from './Locale';
 
 type ButtonProps = React.PropsWithoutRef<
 	Omit<PressableProps, 'style' | 'title'> & {
@@ -44,7 +44,7 @@ export const Button: React.FC<ButtonProps> = (props) => {
 			paddingHorizontal: 16,
 			flexBasis: 'auto',
 		}),
-		[buttonBackgroundColor, buttonForegroundColor]
+		[buttonBackgroundColor, buttonForegroundColor],
 	);
 	const buttonText: StyleProp<TextStyle> = useMemo(
 		() => ({
@@ -52,7 +52,7 @@ export const Button: React.FC<ButtonProps> = (props) => {
 			fontSize: 16,
 			fontWeight: 'bold',
 		}),
-		[buttonForegroundColor]
+		[buttonForegroundColor],
 	);
 
 	return (
@@ -71,7 +71,7 @@ export const Button: React.FC<ButtonProps> = (props) => {
 
 export const DenyButton = (props: ButtonProps) => {
 	const { cmp, dispatch } = useContext(OsanoPrivateContext);
-	const { onPress, title , testID} = props;
+	const { onPress, title, testID } = props;
 
 	const handleReject = useCallback(() => {
 		dispatch(setAllVendorConsent(false));
@@ -84,9 +84,9 @@ export const DenyButton = (props: ButtonProps) => {
 
 	return Button({
 		...props,
-		title: title || `buttons.deny`,
+		title: title || 'buttons.denyNonEssential',
 		onPress: onPress || handleReject,
-		testID: testID || 'Deny'
+		testID: testID || 'DenyNonEssential',
 	});
 };
 
@@ -104,7 +104,7 @@ export const AcceptButton = (props: ButtonProps) => {
 		...props,
 		title: title || 'buttons.accept',
 		onPress: onPress || handleAcceptConsent,
-		testID: 'Accept'
+		testID: 'Accept',
 	});
 };
 
@@ -113,7 +113,7 @@ export const CloseButton = React.forwardRef(
 		props: PressableProps & {
 			color?: string;
 		},
-		ref: React.Ref<View>
+		ref: React.Ref<View>,
 	) => {
 		const { color = '#fafafa', onPress, ...remain } = props;
 		const { cmp, dispatch } = useContext(OsanoPrivateContext);
@@ -134,13 +134,13 @@ export const CloseButton = React.forwardRef(
 				</Svg>
 			</Pressable>
 		);
-	}
+	},
 );
 
 export const BackButton = (
 	props: PressableProps & {
 		color?: string;
-	}
+	},
 ) => {
 	const { color = '#fafafa', onPress, ...remain } = props;
 	const { dispatch } = useContext(OsanoPrivateContext);
@@ -169,7 +169,7 @@ export const ManagePreferencesButton = (props: ButtonProps) => {
 		onPress: onPress || handleShowDrawer,
 		title: `buttons.dialog.openDrawer.${config?.jurisdiction}`,
 		defaultPhrase: 'buttons.managePreferences',
-		testID: `Manage Preferences`
+		testID: `Manage Preferences`,
 	});
 };
 
@@ -179,7 +179,7 @@ export const RejectAllButton = (props: ButtonProps) => {
 		...props,
 		title: `buttons.dialog.denyAll.${config?.jurisdiction}`,
 		defaultPhrase: 'buttons.denyAll',
-		testID: `Reject All`
+		testID: `Reject All`,
 	});
 };
 
@@ -196,7 +196,7 @@ export const SaveButton = (props: ButtonProps) => {
 		...props,
 		title: title || `buttons.save`,
 		onPress: onPress || handleSave,
-		testID: `Save`
+		testID: `Save`,
 	});
 };
 
@@ -216,6 +216,6 @@ export const AcceptAllButton = (props: ButtonProps) => {
 		...remain,
 		onPress: onPress || handleAcceptAllConsent,
 		title: `buttons.acceptAll`,
-		testID: `Accept All`
+		testID: `Accept All`,
 	});
 };

package/src/context.ts

@@ -5,14 +5,15 @@ import type {
 	Store,
 	ThunkDispatch,
 } from './hooks/useThunkReducer';
+import type { GoogleConsentModeCallback } from './types/google-consent-mode';
 import type { OsanoAction, OsanoState } from './types/store';
 
-import { ConsentCategory } from './constants';
 import React from 'react';
-import Translator from './utils/Translator';
-import { createSharedStyles } from './styles';
+import { ConsentCategory } from './constants';
 import { initialState } from './reducer';
+import { createSharedStyles } from './styles';
 import { noop } from './utils';
+import Translator from './utils/Translator';
 
 type OsanoPublicContextType = {
 	locale: string;
@@ -20,23 +21,24 @@ type OsanoPublicContextType = {
 	getDeviceId: () => string;
 	clearConsent: () => void;
 	consent: (
-		consent?: ConsentCategory | ConsentCategory[]
+		consent?: ConsentCategory | ConsentCategory[],
 	) => Promise<ConsentCategory[]>;
 	setLocale: (locale: string) => void;
 	showBanner: () => void;
 	showDrawer: () => void;
+	isReady: boolean;
 };
 
 type OsanoPrivateContextType = {
 	addMiddleware: (
 		m: (
-			store: Store<OsanoState, OsanoAction>
-		) => (next: MiddlewareNext<OsanoAction>) => MiddlewareNext<OsanoAction>
+			store: Store<OsanoState, OsanoAction>,
+		) => (next: MiddlewareNext<OsanoAction>) => MiddlewareNext<OsanoAction>,
 	) => void;
 	removeMiddleware: (
 		m: (
-			store: Store<OsanoState, OsanoAction>
-		) => (next: MiddlewareNext<OsanoAction>) => MiddlewareNext<OsanoAction>
+			store: Store<OsanoState, OsanoAction>,
+		) => (next: MiddlewareNext<OsanoAction>) => MiddlewareNext<OsanoAction>,
 	) => void;
 	cmp?: ConsentManager;
 	config?: ConsentConfig;
@@ -47,6 +49,7 @@ type OsanoPrivateContextType = {
 	locale: string;
 	sharedStyles: ReturnType<typeof createSharedStyles>;
 	translate: Translator['translate'];
+	setGoogleConsentModeCallback: (callback: GoogleConsentModeCallback) => void;
 };
 
 export const OsanoPublicContext = React.createContext<OsanoPublicContextType>({
@@ -60,6 +63,7 @@ export const OsanoPublicContext = React.createContext<OsanoPublicContextType>({
 	setLocale: noop,
 	showBanner: noop,
 	showDrawer: noop,
+	isReady: false,
 });
 
 export const OsanoPrivateContext = React.createContext<OsanoPrivateContextType>(
@@ -75,5 +79,6 @@ export const OsanoPrivateContext = React.createContext<OsanoPrivateContextType>(
 		locale: 'en',
 		sharedStyles: createSharedStyles(),
 		translate: () => '',
-	}
+		setGoogleConsentModeCallback: noop,
+	},
 );

package/src/iab/tcf/consent.ts

@@ -38,7 +38,7 @@ export const commonConsent = {
 export const getVendorConsents = (
 	config: ConsentConfig,
 	state: OsanoState & IabState,
-	apiVersion: TcfVersionType
+	apiVersion: TcfVersionType,
 ) => {
 	const vendors = config.getVendors();
 	/*
@@ -53,7 +53,7 @@ export const getVendorConsents = (
 	 */
 	const purposeConsent = consentToPurpose(
 		getSavedConsent(state) || getConsent(state),
-		apiVersion
+		apiVersion,
 	);
 
 	const consents: Record<string, boolean> = Object.entries(vendors).reduce(
@@ -81,7 +81,7 @@ export const getVendorConsents = (
 			}
 			return vendorConsents;
 		},
-		{} as Record<string, boolean>
+		{} as Record<string, boolean>,
 	);
 	return consents;
 };
@@ -89,7 +89,7 @@ export const getVendorConsents = (
 export const getVendorLegitimateInterests = (
 	config: ConsentConfig,
 	state: IabState & OsanoState,
-	apiVersion: TcfVersionType
+	apiVersion: TcfVersionType,
 ) => {
 	/*
 	 *  Unless a use has specifically opted out of a vendor, the consent
@@ -131,7 +131,7 @@ export const getVendorLegitimateInterests = (
 					// If any legIntPurposes is not opted out
 					(legIntPurposes &&
 						legIntPurposes.some(
-							(purposeId) => !optOutPurposes[`${purposeId}`]
+							(purposeId) => !optOutPurposes[`${purposeId}`],
 						)) ||
 					/**
 					 * Per June 2021 Policy change, Vendors declaring only
@@ -145,7 +145,7 @@ export const getVendorLegitimateInterests = (
 					vendorLegitimateInterests[`${vendorId}`] = true;
 				}
 			}
-		}
+		},
 	);
 	return vendorLegitimateInterests;
 };
@@ -181,7 +181,7 @@ export const makeParseConsentString =
 				set(tcData, fieldName, decodedValue);
 				return startBit + bitLength;
 			},
-			0
+			0,
 		);
 		return tcData as unknown as TcData;
 	};
@@ -231,7 +231,7 @@ export const makeConsentFromOptions =
 				acc[`${field}`] = getter(initOptions, state);
 				return acc;
 			},
-			{} as Record<string, any>
+			{} as Record<string, any>,
 		);
 		return {
 			version: staticFields.version,
@@ -260,7 +260,7 @@ export const makeConsentFromOptions =
 				legitimateInterests: getVendorLegitimateInterests(
 					config,
 					state,
-					version
+					version,
 				),
 			},
 			specialFeatureOptins: getSpecialFeatureOptIns(state, version),
@@ -287,7 +287,7 @@ export const makeFormatConsentString =
 		const [bitFields] = coreFieldSequence.reduce(
 			(
 				[bitString, startBit],
-				[key, numBits, { encode: encodeField }, dataField = key]
+				[key, numBits, { encode: encodeField }, dataField = key],
 			) => {
 				let value;
 				if (Object.hasOwnProperty.call(staticFields, dataField)) {
@@ -297,15 +297,10 @@ export const makeFormatConsentString =
 				} 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]
+			['', 0],
 		);
 		const newCoreString = encode(bitFields);
 		segments.unshift(newCoreString);

package/src/iab/tcf/constants.ts

@@ -21,6 +21,52 @@ export const DisplayStatusCodes = {
 	DISABLED: 'disabled',
 };
 
+export const IABKeys = {
+	LEGACY: {
+		CMP_PRESENT: 'IABConsent_CMPPresent',
+		SUBJECT_TO_GDPR: 'IABConsent_SubjectToGDPR',
+		CONSENT_STRING: 'IABConsent_ConsentString',
+		PARSED_PURPOSE_CONSENTS: 'IABConsent_ParsedPurposeConsents',
+		PARSED_VENDOR_CONSENTS: 'IABConsent_ParsedVendorConsents',
+	},
+	IABTCF: {
+		CMP_SDK_ID: 'IABTCF_CmpSdkID',
+		CMP_SDK_VERSION: 'IABTCF_CmpSdkVersion',
+		POLICY_VERSION: 'IABTCF_PolicyVersion',
+		GDPR_APPLIES: 'IABTCF_gdprApplies',
+		PUBLISHER_CC: 'IABTCF_PublisherCC',
+		PURPOSE_ONE_TREATMENT: 'IABTCF_PurposeOneTreatment',
+		USE_NON_STANDARD_TEXTS: 'IABTCF_UseNonStandardTexts',
+		TC_STRING: 'IABTCF_TCString',
+		VENDOR_CONSENTS: 'IABTCF_VendorConsents',
+		VENDOR_LEGITIMATE_INTERESTS: 'IABTCF_VendorLegitimateInterests',
+		PURPOSE_CONSENTS: 'IABTCF_PurposeConsents',
+		PURPOSE_LEGITIMATE_INTERESTS: 'IABTCF_PurposeLegitimateInterests',
+		SPECIAL_FEATURES_OPT_INS: 'IABTCF_SpecialFeaturesOptIns',
+		ADDTL_CONSENT: 'IABTCF_AddtlConsent',
+		ENABLE_ADVERTISER_CONSENT_MODE: 'IABTCF_EnableAdvertiserConsentMode',
+	},
+} as const;
+
+export const getAllIABKeys = () => [
+	...Object.values(IABKeys.LEGACY),
+	...Object.values(IABKeys.IABTCF),
+];
+
+export const DEFAULT_STORAGE_KEYS = {
+	LEGACY: Object.values(IABKeys.LEGACY),
+	IABTCF: [
+		IABKeys.IABTCF.GDPR_APPLIES,
+		IABKeys.IABTCF.TC_STRING,
+		IABKeys.IABTCF.PURPOSE_CONSENTS,
+		IABKeys.IABTCF.VENDOR_CONSENTS,
+		IABKeys.IABTCF.ADDTL_CONSENT,
+		IABKeys.IABTCF.ENABLE_ADVERTISER_CONSENT_MODE,
+	],
+} as const;
+
+export const CUSTOM_STORAGE_KEYS = Object.values(IABKeys.IABTCF);
+
 export const purposeIds = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11];
 export const purposeMap: Record<ConsentCategoryType, number[]> = {
 	[ConsentCategory.ESSENTIAL]: [1],

package/src/iab/tcf/iab-storage-utils.ts

@@ -0,0 +1,166 @@
+import {
+	clearStorage,
+	clearStorageFromDefault,
+	setIntStorageToDefault,
+	setStorage,
+	setStorageToDefault,
+} from '../../native/OsanoCmp';
+import { osanoLogger } from '../../utils/OsanoLogger';
+import {
+	CUSTOM_STORAGE_KEYS,
+	DEFAULT_STORAGE_KEYS,
+	IABKeys,
+} from './constants';
+
+export interface IABConsentData {
+	tcString: string;
+	cmpId: number;
+	cmpVersion: number;
+	policyVersion: string;
+	publisherCC: string;
+	gdprApplies: boolean;
+	purposeOneTreatment: boolean;
+	useNonStandardStacks: boolean;
+	vendorConsentsString: string;
+	vendorLegitimateInterestsString: string;
+	purposeConsentsString: string;
+	purposeLegitimateInterestsString: string;
+	specialFeatureOptinsString: string;
+	enableAdvertiserConsentMode?: boolean;
+}
+
+export const clearAllIABKeys = (): void => {
+	osanoLogger.info('🧹 Clearing all IAB consent keys...');
+
+	Object.values(IABKeys.LEGACY).forEach((key) => {
+		clearStorageFromDefault(key);
+	});
+
+	DEFAULT_STORAGE_KEYS.IABTCF.forEach((key) => {
+		clearStorageFromDefault(key);
+	});
+
+	CUSTOM_STORAGE_KEYS.forEach((key) => {
+		clearStorage(key);
+	});
+
+	osanoLogger.info(
+		'✅ All IAB consent keys cleared from both custom and default storage',
+	);
+};
+
+export const setAllIABKeys = (consentData: IABConsentData): void => {
+	const {
+		tcString,
+		cmpId,
+		cmpVersion,
+		policyVersion,
+		publisherCC,
+		gdprApplies,
+		purposeOneTreatment,
+		useNonStandardStacks,
+		vendorConsentsString,
+		vendorLegitimateInterestsString,
+		purposeConsentsString,
+		purposeLegitimateInterestsString,
+		specialFeatureOptinsString,
+		enableAdvertiserConsentMode,
+	} = consentData;
+
+	osanoLogger.info('💾 Setting IAB consent keys to storage...');
+
+	const subjectToGDPR = gdprApplies ? '1' : '0';
+
+	// === Save to Custom Storage ===
+	setStorage(IABKeys.IABTCF.CMP_SDK_ID, cmpId.toString());
+	setStorage(IABKeys.IABTCF.CMP_SDK_VERSION, cmpVersion.toString());
+	setStorage(IABKeys.IABTCF.POLICY_VERSION, policyVersion);
+	setStorage(IABKeys.IABTCF.PUBLISHER_CC, publisherCC);
+	setStorage(IABKeys.IABTCF.GDPR_APPLIES, subjectToGDPR);
+	setStorage(
+		IABKeys.IABTCF.PURPOSE_ONE_TREATMENT,
+		purposeOneTreatment ? '1' : '0',
+	);
+	setStorage(
+		IABKeys.IABTCF.USE_NON_STANDARD_TEXTS,
+		useNonStandardStacks ? '1' : '0',
+	);
+	setStorage(IABKeys.IABTCF.VENDOR_CONSENTS, vendorConsentsString);
+	setStorage(
+		IABKeys.IABTCF.VENDOR_LEGITIMATE_INTERESTS,
+		vendorLegitimateInterestsString,
+	);
+	setStorage(IABKeys.IABTCF.PURPOSE_CONSENTS, purposeConsentsString);
+	setStorage(
+		IABKeys.IABTCF.PURPOSE_LEGITIMATE_INTERESTS,
+		purposeLegitimateInterestsString,
+	);
+	setStorage(
+		IABKeys.IABTCF.SPECIAL_FEATURES_OPT_INS,
+		specialFeatureOptinsString,
+	);
+
+	// === Save to Default Storage for AdMob Compatibility ===
+
+	setStorageToDefault(IABKeys.LEGACY.CMP_PRESENT, 'true');
+	setStorageToDefault(IABKeys.LEGACY.SUBJECT_TO_GDPR, subjectToGDPR);
+	setStorageToDefault(IABKeys.LEGACY.CONSENT_STRING, tcString);
+	setStorageToDefault(
+		IABKeys.LEGACY.PARSED_PURPOSE_CONSENTS,
+		purposeConsentsString,
+	);
+	setStorageToDefault(
+		IABKeys.LEGACY.PARSED_VENDOR_CONSENTS,
+		vendorConsentsString,
+	);
+
+	setIntStorageToDefault(IABKeys.IABTCF.GDPR_APPLIES, gdprApplies ? 1 : 0);
+	setStorageToDefault(IABKeys.IABTCF.TC_STRING, tcString);
+	setStorageToDefault(IABKeys.IABTCF.PURPOSE_CONSENTS, purposeConsentsString);
+	setStorageToDefault(IABKeys.IABTCF.VENDOR_CONSENTS, vendorConsentsString);
+	setStorageToDefault(IABKeys.IABTCF.ADDTL_CONSENT, '');
+
+	// Handle Google Consent Mode integration
+	if (enableAdvertiserConsentMode !== undefined) {
+		setIntStorageToDefault(
+			IABKeys.IABTCF.ENABLE_ADVERTISER_CONSENT_MODE,
+			enableAdvertiserConsentMode ? 1 : 0,
+		);
+
+		const status = enableAdvertiserConsentMode ? 'enabled' : 'disabled';
+		const reason = enableAdvertiserConsentMode
+			? '(both Google Consent Mode and IAB TCF are applicable)'
+			: '(Google Consent Mode or IAB TCF not applicable)';
+
+		osanoLogger.info(
+			`🔗 Google TCF integration ${status}: ${IABKeys.IABTCF.ENABLE_ADVERTISER_CONSENT_MODE} = ${enableAdvertiserConsentMode ? 1 : 0} ${reason}`,
+		);
+	}
+
+	osanoLogger.info(
+		'✅ IAB consent keys saved to both custom and default storage for AdMob compatibility',
+	);
+	osanoLogger.debug(
+		`📊 Updated IAB keys: CMP=true, SubjectToGDPR=${subjectToGDPR}, PurposeConsents=${purposeConsentsString.length} chars, VendorConsents=${vendorConsentsString.length} chars`,
+	);
+};
+
+export const setCustomIABKey = (key: string, value: string): void => {
+	setStorage(key, value);
+};
+
+export const setDefaultIABKey = (key: string, value: string): void => {
+	setStorageToDefault(key, value);
+};
+
+export const setDefaultIABKeyAsInt = (key: string, value: number): void => {
+	setIntStorageToDefault(key, value);
+};
+
+export const clearCustomIABKey = (key: string): void => {
+	clearStorage(key);
+};
+
+export const clearDefaultIABKey = (key: string): void => {
+	clearStorageFromDefault(key);
+};