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

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);
+};

package/src/iab/tcf/middleware.ts

@@ -1,29 +1,31 @@
 // @ts-nocheck
 import { CLEAR_CONSENT, CLOSE, RELOAD, SET_CONFIG } from '../../actions';
-import type { IabMiddlewareFactory, Tcf_v2 } from './types';
+import { clearStorage, getStorage, setStorage } from '../../native/OsanoCmp';
 import type { OsanoAction, OsanoState } from '../../types/store';
+import { osanoLogger } from '../../utils/OsanoLogger';
+import { SET_CONSENT_DATA, setConsentData } from '../actions';
 import {
 	SET_ALL_PURPOSE_CONSENT,
 	SET_ALL_SPECIAL_FEATURE_CONSENT,
 	SET_ALL_VENDOR_CONSENT,
 	setConsent,
 } from './actions';
-import { SET_CONSENT_DATA, setConsentData } from '../actions';
-import { clearStorage, getStorage, setStorage } from '../../native/OsanoCmp';
-import { getConsentString, getPurposeIds } from './selectors';
+import { makeFormatConsentString, makeParseConsentString } from './consent';
 import {
 	idRecordToBinaryString,
 	updatePurposeOptOuts,
 	updateSpecialFeatureOptIns,
 	updateVendorOptOuts,
 } from './helpers';
-import { makeFormatConsentString, makeParseConsentString } from './consent';
+import { clearAllIABKeys, setAllIABKeys } from './iab-storage-utils';
+import { getConsentString, getPurposeIds } from './selectors';
+import type { IabMiddlewareFactory, Tcf_v2 } from './types';
 
-import type { ConsentManager } from '../../ConsentManager';
-import type { IabInitOptions } from './types';
-import type { IabState } from '../types';
 import { Platform } from 'react-native';
+import type { ConsentManager } from '../../ConsentManager';
 import type { Store } from '../../hooks/useThunkReducer';
+import type { IabState } from '../types';
+import type { IabInitOptions } from './types';
 
 export const makeMiddleware: IabMiddlewareFactory = (
 	initOptions: IabInitOptions,
@@ -91,6 +93,8 @@ export const makeMiddleware: IabMiddlewareFactory = (
 						case 'ios':
 						case 'android':
 							clearStorage(`${gppSection}_${configId}`);
+
+							clearAllIABKeys();
 							break;
 						default:
 							try {
@@ -160,52 +164,40 @@ export const makeMiddleware: IabMiddlewareFactory = (
 							// no change
 							break;
 						}
-						console.log(`\nSetting new consent string\n -> ${value}`);
+						osanoLogger.info(`Setting new consent string -> ${value}`);
 						const consent = parseConsentString(value);
+
 						setStorage(storageKey, value);
-						setStorage('IABTCF_CmpSdkID', cmpId.toString());
-						setStorage('IABTCF_CmpSdkVersion', cmpVersion.toString());
-						setStorage('IABTCF_PolicyVersion', version);
-						setStorage('IABTCF_PublisherCC', consent.publisherCC);
-						setStorage('IABTCF_gdprApplies', consent.gdprApplies ? '1' : '0');
-						setStorage(
-							'IABTCF_PurposeOneTreatment',
-							consent.purposeOneTreatment ? '1' : '0',
-						);
-						setStorage(
-							'IABTCF_UseNonStandardTexts',
-							consent.useNonStandardStacks ? '1' : '0',
-						);
 
-						// The following all have to be binary strings
-						setStorage(
-							'IABTCF_VendorConsents',
-							idRecordToBinaryString(consent.vendor.consents),
-						);
-						setStorage(
-							'IABTCF_VendorLegitimateInterests',
-							idRecordToBinaryString(consent.vendor.legitimateInterests),
-						);
-						setStorage(
-							'IABTCF_PurposeConsents',
-							idRecordToBinaryString(consent.purpose.consents),
-						);
-						setStorage(
-							'IABTCF_PurposeLegitimateInterests',
-							idRecordToBinaryString(consent.purpose.legitimateInterests),
-						);
-						setStorage(
-							'IABTCF_SpecialFeaturesOptIns',
-							idRecordToBinaryString(consent.specialFeatureOptins),
-						);
-						// Publisher restrictions are not yet supported
-						/*
-							'IABTCF_PublisherRestrictions',
-							'IABTCF_PublisherConsent'
-							'IABTCF_PublisherLegitimateInterests'
-							'IABTCF_PublisherCustomPurposesConsents'
-							'IABTCF_PublisherCustomPurposesLegitimateInterests'
-						*/
+						const consentData = {
+							tcString: value,
+							cmpId,
+							cmpVersion,
+							policyVersion: version,
+							publisherCC: consent.publisherCC,
+							gdprApplies: consent.gdprApplies,
+							purposeOneTreatment: consent.purposeOneTreatment,
+							useNonStandardStacks: consent.useNonStandardStacks,
+							vendorConsentsString: idRecordToBinaryString(
+								consent.vendor.consents,
+							),
+							vendorLegitimateInterestsString: idRecordToBinaryString(
+								consent.vendor.legitimateInterests,
+							),
+							purposeConsentsString: idRecordToBinaryString(
+								consent.purpose.consents,
+							),
+							purposeLegitimateInterestsString: idRecordToBinaryString(
+								consent.purpose.legitimateInterests,
+							),
+							specialFeatureOptinsString: idRecordToBinaryString(
+								consent.specialFeatureOptins,
+							),
+							enableAdvertiserConsentMode:
+								config?.googleConsent && config?.tcfIsApplicable,
+						};
+
+						setAllIABKeys(consentData);
 					}
 				}
 			}

package/src/index.tsx

@@ -1,7 +1,5 @@
-import type { OsanoAction, OsanoState } from './types/store';
-import { OsanoCategories, init, reducer } from './reducer';
-import { Platform, UIManager } from 'react-native';
 import React, { memo, useCallback, useEffect, useMemo, useRef } from 'react';
+import { Platform, UIManager } from 'react-native';
 import {
 	CLEAR_CONSENT,
 	reload,
@@ -10,20 +8,30 @@ import {
 	showDialog,
 	showDrawer,
 } from './actions';
+import { OsanoCategories, init, reducer } from './reducer';
+import type { OsanoAction, OsanoState } from './types/store';
 
-import { ConsentCategory } from './constants';
 import { ConsentManager } from './ConsentManager';
 import { ConsentUiBuilder } from './ConsentUiBuilder';
-import type { OsanoProps } from './types';
+import { ConsentCategory } from './constants';
 import { OsanoPublicContext } from './context';
+import { usePrevious } from './hooks/usePrevious';
+import useThunkReducer, { type Store } from './hooks/useThunkReducer';
 import { addIabReducers } from './iab';
+import type { IabFramework, IabState } from './iab/types';
 import { getConsent } from './selectors';
 import { recordConsent } from './services/consent';
-import useThunkReducer, { type Store } from './hooks/useThunkReducer';
-import type { IabFramework, IabState } from './iab/types';
-import { usePrevious } from './hooks/usePrevious';
+import type { OsanoProps } from './types';
+import { osanoLogger as OsanoLogger } from './utils/OsanoLogger';
 
 export { OsanoPublicContext as OsanoContext } from './context';
+export { GoogleConsentModeMapper } from './services/google-consent-mode-mapper';
+export type {
+	GoogleConsentMap,
+	GoogleConsentModeCallback,
+	GoogleConsentParameter,
+	GoogleConsentStatus,
+} from './types/google-consent-mode';
 
 if (Platform.OS === 'android') {
 	if (UIManager.setLayoutAnimationEnabledExperimental) {
@@ -44,14 +52,20 @@ export const Osano: React.FunctionComponent<
 			onConfigLoadSuccess,
 			onLangLoadFailure,
 			onLangLoadSuccess,
+			onGoogleConsentUpdate,
 			overrides,
 			extUsrData,
+			setLoggingEnabled = true,
 		} = props;
 		const { flavor, iabEnabled } = overrides || {};
 		const consentManager = useRef<ConsentManager>(
 			new ConsentManager(overrides, extUsrData),
 		);
 
+		useEffect(() => {
+			OsanoLogger.setEnabled(setLoggingEnabled);
+		}, [setLoggingEnabled]);
+
 		const [_state, store] = useThunkReducer<OsanoState, OsanoAction>(
 			reducer,
 			{ configId, customerId },
@@ -91,6 +105,9 @@ export const Osano: React.FunctionComponent<
 
 		const handleClearConsent = useCallback(() => {
 			dispatch({ type: CLEAR_CONSENT });
+			consentManager.current.triggerGoogleConsentUpdate([
+				ConsentCategory.ESSENTIAL,
+			]);
 		}, []);
 
 		const retryWithBackoff = async (
@@ -177,6 +194,15 @@ export const Osano: React.FunctionComponent<
 			consentManager.current.config.type = flavor;
 		}, [flavor]);
 
+		// Set up Google Consent Mode callback if provided
+		useEffect(() => {
+			if (onGoogleConsentUpdate) {
+				consentManager.current.setGoogleConsentModeCallback(
+					onGoogleConsentUpdate,
+				);
+			}
+		}, [onGoogleConsentUpdate]);
+
 		const iabLoaded = useRef(false);
 		const iabChanged = usePrevious(iabEnabled) !== iabEnabled;
 		useEffect(() => {
@@ -235,6 +261,7 @@ export const Osano: React.FunctionComponent<
 			prev.hideUI === next.hideUI &&
 			prev.hideDisclosures === next.hideDisclosures &&
 			prev.children === next.children &&
+			prev.setLoggingEnabled === next.setLoggingEnabled &&
 			flavor === nextFlavor &&
 			iabEnabled === nextIabEnabled
 		);