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

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,19 +52,25 @@ export const Osano: React.FunctionComponent<
 			onConfigLoadSuccess,
 			onLangLoadFailure,
 			onLangLoadSuccess,
+			onGoogleConsentUpdate,
 			overrides,
-			extUsrData
+			extUsrData,
+			setLoggingEnabled = true,
 		} = props;
 		const { flavor, iabEnabled } = overrides || {};
 		const consentManager = useRef<ConsentManager>(
-			new ConsentManager(overrides, extUsrData)
+			new ConsentManager(overrides, extUsrData),
 		);
 
+		useEffect(() => {
+			OsanoLogger.setEnabled(setLoggingEnabled);
+		}, [setLoggingEnabled]);
+
 		const [_state, store] = useThunkReducer<OsanoState, OsanoAction>(
 			reducer,
 			{ configId, customerId },
 			init,
-			[consentManager.current.middleware]
+			[consentManager.current.middleware],
 		);
 		const { addMiddleware, dispatch, getState, removeMiddleware } = store;
 
@@ -81,24 +95,50 @@ export const Osano: React.FunctionComponent<
 					).filter((cat) => OsanoCategories.includes(cat));
 					consentedCategories = OsanoCategories.filter(
 						(cat) =>
-							cat === ConsentCategory.ESSENTIAL || categories.includes(cat)
+							cat === ConsentCategory.ESSENTIAL || categories.includes(cat),
 					);
 				}
 				return recordConsent(consentManager.current, consentedCategories);
 			},
-			[]
+			[],
 		);
 
 		const handleClearConsent = useCallback(() => {
 			dispatch({ type: CLEAR_CONSENT });
+			consentManager.current.triggerGoogleConsentUpdate([
+				ConsentCategory.ESSENTIAL,
+			]);
 		}, []);
 
-		const handleShowDialog = useCallback(() => {
-			dispatch(showDialog());
+		const retryWithBackoff = async (
+			callback: () => void,
+			retries: number,
+			delay: number,
+		) => {
+			for (let attempt = 1; attempt <= retries; attempt++) {
+				try {
+					if (consentManager.current.loaded) {
+						await callback();
+						return;
+					} else {
+						throw new Error('Consent manager not loaded');
+					}
+				} catch (error) {
+					if (attempt === retries) {
+						throw error;
+					}
+					await new Promise((resolve) => setTimeout(resolve, delay));
+					delay *= 2; // Exponential backoff
+				}
+			}
+		};
+
+		const handleShowDialog = useCallback(async () => {
+			await retryWithBackoff(() => dispatch(showDialog()), 3, 100);
 		}, []);
 
-		const handleShowDrawer = useCallback(() => {
-			dispatch(showDrawer());
+		const handleShowDrawer = useCallback(async () => {
+			await retryWithBackoff(() => dispatch(showDrawer()), 3, 100);
 		}, []);
 
 		const handleSetLocale = useCallback((value: string) => {
@@ -141,13 +181,28 @@ export const Osano: React.FunctionComponent<
 				setLocale: handleSetLocale,
 				showBanner: handleShowDialog,
 				showDrawer: handleShowDrawer,
+				isReady: consentManager.current.loaded,
 			};
-		}, [configId, customerId, consentManager.current.translator.locale]);
+		}, [
+			configId,
+			customerId,
+			consentManager.current.translator.locale,
+			consentManager.current.loaded,
+		]);
 
 		useEffect(() => {
 			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(() => {
@@ -165,7 +220,7 @@ export const Osano: React.FunctionComponent<
 				// a config republish.
 				iabLoaded.current = true;
 				addIabReducers(frameworks)(
-					store as unknown as Store<OsanoState & IabState, OsanoAction>
+					store as unknown as Store<OsanoState & IabState, OsanoAction>,
 				);
 			}
 			consentManager.current.config.iabEnabled = iabEnabled ?? undefined;
@@ -176,9 +231,8 @@ export const Osano: React.FunctionComponent<
 						config: consentManager.current.config,
 						customerId,
 						configId,
-					})
+					}),
 				);
-
 		}, [iabEnabled]);
 
 		return (
@@ -207,8 +261,9 @@ 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
 		);
-	}
+	},
 );