@osano/osano-cmp-react-native 0.14.0 → 0.17.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@osano/osano-cmp-react-native",
-	"version": "0.14.0",
+	"version": "0.17.0",
 	"description": "Package and example for the react-native Osano CMP SDK",
 	"main": "lib/commonjs/index",
 	"module": "lib/module/index",
@@ -32,6 +32,8 @@
 	"scripts": {
 		"example": "yarn workspace osano-cmp-sdk-example",
 		"test": "jest src/services/__tests__/consent.test.ts src/__tests__/index.test.tsx src/services/__tests__/google-consent-mode.test.ts src/__tests__/OsanoLogger.test.ts",
+		"test:legacy": "REACT_NATIVE_NEW_ARCH_ENABLED=false jest src/services/__tests__/consent.test.ts src/__tests__/index.test.tsx src/services/__tests__/google-consent-mode.test.ts src/__tests__/OsanoLogger.test.ts",
+		"test:newarch": "REACT_NATIVE_NEW_ARCH_ENABLED=true jest src/services/__tests__/consent.test.ts src/__tests__/index.test.tsx src/services/__tests__/google-consent-mode.test.ts src/__tests__/OsanoLogger.test.ts",
 		"test:google-consent-mode": "jest src/services/__tests__/google-consent-mode.test.ts",
 		"typecheck": "tsc --noEmit",
 		"lint": "eslint \"**/*.{js,ts,tsx}\"",
@@ -39,7 +41,7 @@
 		"update:locale": "node ./scripts/updateLocalization.js",
 		"prepare": "bob build",
 		"release": "release-it",
-		"release:prod": "release-it minor --no-git --ci",
+		"release:prod": "release-it minor --no-git --ci -VV",
 		"doc:start": "docusaurus start ./documentation",
 		"doc:build": "docusaurus build ./documentation",
 		"doc:clear": "docusaurus clear ./documentation",
@@ -70,7 +72,6 @@
 		"@docusaurus/core": "3.5.2",
 		"@docusaurus/module-type-aliases": "3.5.2",
 		"@docusaurus/preset-classic": "3.5.2",
-		"@evilmartians/lefthook": "^1.12.2",
 		"@mdx-js/react": "^3.0.1",
 		"@react-native-community/cli": "^18.0.0",
 		"@testing-library/react-native": "^12.8.1",
@@ -83,12 +84,11 @@
 		"jest": "^29.7.0",
 		"prettier": "^3.0.3",
 		"prism-react-renderer": "^2.4.0",
-		"react": "19.1.0",
-		"react-native": "0.80.0",
-		"react-native-builder-bob": "^0.40.13",
-		"react-native-picker-modal-view": "^1.3.2",
+		"react": "18.3.1",
+		"react-native": "0.74.4",
+		"react-native-builder-bob": "^0.23.2",
 		"react-test-renderer": "^18.3.1",
-		"release-it": "^17.6.0",
+		"release-it": "^17.11.0",
 		"turbo": "^1.10.7",
 		"typescript": "^5.2.2"
 	},
@@ -101,7 +101,9 @@
 	},
 	"overrides": {
 		"axios": "^1.6.4",
-		"trim": "^1.0.1"
+		"trim": "^1.0.1",
+		"inflight": "^1.0.6",
+		"glob": "^9.3.5"
 	},
 	"workspaces": [
 		"example",
@@ -110,9 +112,21 @@
 	"packageManager": "yarn@3.6.4",
 	"jest": {
 		"preset": "react-native",
+		"setupFilesAfterEnv": [
+			"<rootDir>/src/__tests__/setup.ts"
+		],
 		"modulePathIgnorePatterns": [
 			"<rootDir>/example/node_modules",
 			"<rootDir>/lib/"
+		],
+		"transformIgnorePatterns": [
+			"node_modules/(?!(react-native|@react-native|react-native-svg|@testing-library/react-native)/)"
+		],
+		"collectCoverageFrom": [
+			"src/**/*.{ts,tsx}",
+			"!src/**/__tests__/**",
+			"!src/**/*.test.{ts,tsx}",
+			"!src/**/types.ts"
 		]
 	},
 	"commitlint": {
@@ -142,14 +156,18 @@
 			]
 		]
 	},
-	"dependencies": {
-		"js-sha512": "^0.9.0",
-		"react-native-svg": "^15.12.0",
-		"text-encoding": "^0.7.0"
-	},
 	"codegenConfig": {
 		"name": "RNOsanoCmpSdkSpec",
 		"type": "modules",
-		"jsSrcsDir": "src"
+		"jsSrcsDir": "src",
+		"android": {
+			"javaPackageName": "com.osano.cmp.sdk"
+		}
+	},
+	"dependencies": {
+		"js-sha512": "^0.9.0",
+		"react-native-picker-modal-view": "^1.3.2",
+		"react-native-svg": "^14.1.0",
+		"text-encoding": "^0.7.0"
 	}
 }

package/src/ConsentManager.ts

@@ -195,7 +195,7 @@ export class ConsentConfig extends EventEmitter {
 	load() {
 		if (!this._customerId || !this._configId) {
 			this.emit('loadFailure', CONFIG_ID_ERROR);
-			return Promise.reject(CONFIG_ID_ERROR);
+			return;
 		}
 		return fetchConfigWithRetries(this._customerId, this._configId)
 			.then((config: Config | null) => {
@@ -220,11 +220,9 @@ export class ConsentConfig extends EventEmitter {
 				this._config = merge(this._config, config) as Config;
 				storeConfig(this._configId, this._config);
 				this.emit('loadSuccess', this._config);
-				return this._config;
 			})
 			.catch((err) => {
 				this.emit('loadFailure', err);
-				throw err;
 			});
 	}
 	get config(): Config {
@@ -674,6 +672,41 @@ export class ConsentManager {
 		if (extUsrData) {
 			this._extUsrData = extUsrData;
 		}
+		// Optimized helper function to get device locale compatible with legacy and new architectures
+		const getDeviceLocale = (platform: string): string => {
+			const fallbackLocale = 'en-US';
+			
+			try {
+				if (platform === 'android') {
+					// I18nManager (legacy architecture)
+					const i18nLocale = NativeModules.I18nManager?.localeIdentifier;
+					if (i18nLocale) return i18nLocale;
+
+					// PlatformConstants (legacy architecture)
+					const platformLocale = NativeModules.PlatformConstants?.getConstants?.()?.Localization?.locale;
+					if (platformLocale) return platformLocale;
+
+				} else if (platform === 'ios') {
+					// SettingsManager (legacy architecture)
+					const appleLanguage = NativeModules.SettingsManager?.settings?.AppleLanguages?.[0];
+					if (appleLanguage) return appleLanguage;
+					
+					const appleLocale = NativeModules.SettingsManager?.settings?.AppleLocale;
+					if (appleLocale) return appleLocale;
+				}
+
+				// Intl API (works in both architectures)
+				if (global.Intl && Intl.DateTimeFormat) {
+					const intlLocale = Intl.DateTimeFormat().resolvedOptions().locale;
+					if (intlLocale) return intlLocale;
+				}
+			} catch (error) {
+				OsanoLogger.debug(`[ConsentManager] Locale detection failed: ${error}`);
+			}
+			
+			return fallbackLocale;
+		};
+
 		switch (Platform.OS) {
 			case 'android': {
 				try {
@@ -684,15 +717,7 @@ export class ConsentManager {
 						err instanceof Error ? err : undefined,
 					);
 				}
-				// Safely access I18nManager.localeIdentifier with null check
-				try {
-					this._locale =
-						NativeModules.I18nManager?.localeIdentifier ||
-						Translator.DEFAULT_LANGUAGE;
-				} catch (err) {
-					console.log(`Error getting locale from I18nManager: ${err}`);
-					this._locale = Translator.DEFAULT_LANGUAGE;
-				}
+				this._locale = getDeviceLocale('android');
 				break;
 			}
 			case 'ios': {
@@ -704,32 +729,10 @@ export class ConsentManager {
 						err instanceof Error ? err : undefined,
 					);
 				}
-				try {
-					this._locale =
-						NativeModules.SettingsManager?.settings?.AppleLanguages?.[0] || //iOS 13
-						NativeModules.SettingsManager?.settings?.AppleLocale ||
-						Translator.DEFAULT_LANGUAGE;
-				} catch (err) {
-					console.log(`Error getting locale from SettingsManager: ${err}`);
-					this._locale = Translator.DEFAULT_LANGUAGE;
-				}
+				this._locale = getDeviceLocale('ios');
 				break;
 			}
 			default: {
-				try {
-					getDeviceId().then(setDeviceId);
-				} catch (err) {
-					OsanoLogger.error(
-						`Error getting device id: ${err}`,
-						err instanceof Error ? err : undefined,
-					);
-				}
-				try {
-					this._locale = navigator.language;
-				} catch (err) {
-					console.log(`Error getting locale from I18nManager: ${err}`);
-					this._locale = Translator.DEFAULT_LANGUAGE;
-				}
 				break;
 			}
 		}
@@ -754,9 +757,9 @@ export class ConsentManager {
 		customerId?: string;
 		configId?: string;
 		onConfigLoadSuccess?: () => void;
-		onConfigLoadFailure?: (err: Error) => void;
+		onConfigLoadFailure?: () => void;
 		onLangLoadSuccess?: () => void;
-		onLangLoadFailure?: (err: Error) => void;
+		onLangLoadFailure?: () => void;
 	}) {
 		const {
 			customerId,
@@ -803,18 +806,12 @@ export class ConsentManager {
 			}
 		}
 		this._loaded = false;
-		const cancelPromise = new Promise((_, reject) => {
-			this._cancelLoading = reject;
-		});
-		this.config.customerId = customerId;
-		this.config.configId = configId;
-		this._loading = Promise.race([this._config.load(), cancelPromise])
-			.then(() => {
-				// If the config loads successfully, we can fetch the consent
-				onConfigLoadSuccess && onConfigLoadSuccess();
-				OsanoLogger.debug(
-					`ConsentManager: Config loaded successfully for customerId: ${customerId}, configId: ${configId}`,
-				);
+		this._loading = new Promise((resolveLoadConfig, rejectLoadConfig) => {
+			this._cancelLoading = rejectLoadConfig;
+
+			const handleConfigLoadSuccess = () => {
+				this._configLoadSuccessSubscription?.remove();
+				this._configLoadFailureSubscription?.remove();
 				const locale = this._locale;
 				if (this._overridePalette) {
 					this._config.palette = merge(
@@ -822,81 +819,65 @@ export class ConsentManager {
 						this._overridePalette,
 					) as Palette;
 				}
-				OsanoLogger.debug(`ConsentManager: Loading consent`);
-				return fetchConsent(this)
-					.catch(() => {
-						OsanoLogger.debug(
-							`ConsentManager: No stored consent found for customerId: ${customerId}, configId: ${configId}`,
-						);
-						// If no stored consent, return essential consent by default
-						// This is to ensure CMP can render even if no consent is stored
-						// Consent not found
-						return Promise.resolve([ConsentCategory.ESSENTIAL]);
-					})
-					.then((consent) => {
-						OsanoLogger.debug(
-							`ConsentManager: Consent loaded successfully for customerId: ${customerId}, configId: ${configId}, consent: ${JSON.stringify(consent)}`,
-						);
-						this.consent = consent;
-						this.triggerGoogleConsentUpdate(consent);
-						return this._translator
-							.load(locale, onLangLoadSuccess, onLangLoadFailure)
-							.then((results) => {
-								OsanoLogger.debug(
-									`ConsentManager: Locale loaded successfully for customerId: ${customerId}, configId: ${configId}, locale: ${locale}`,
-								);
-								delete this._cancelLoading;
-								delete this._loading;
-								const globalResult = results[0];
-								// As long as the global locale is loaded, we can render the CMP
-								if (globalResult?.status === 'fulfilled') {
-									this._loaded = true;
-									const globalLocale = globalResult?.value || locale;
-									return {
-										config: this._config,
-										customerId,
-										configId,
-										locale: globalLocale,
-										consent,
-									};
-								}
-								// If the global locale failed to load, we can't render the CMP
-								throw new Error(globalResult?.reason);
+				resolveLoadConfig(
+					new Promise((resolve, reject) => {
+						this._cancelLoading = reject;
+						fetchConsent(this)
+							.catch(() => {
+								// Consent not found
+								return Promise.resolve([ConsentCategory.ESSENTIAL]);
 							})
-							.catch((err) => {
-								this._loaded = false;
-								OsanoLogger.error(
-									`ConsentManager: Error loading locale for customerId: ${customerId}, configId: ${configId}: ${err}`,
-								);
-								delete this._cancelLoading;
-								delete this._loading;
-								onLangLoadFailure && onLangLoadFailure(err);
-								return {
-									config: this._config,
-									customerId,
-									configId,
-									locale,
-									consent,
-								};
+							.then((consent) => {
+								this.consent = consent;
+								this.triggerGoogleConsentUpdate(consent);
+								return this._translator
+									.load(locale, onLangLoadSuccess, onLangLoadFailure)
+									.then((results) => {
+										delete this._cancelLoading;
+										delete this._loading;
+										const globalResult = results[0];
+										// As long as the global locale is loaded, we can render the CMP
+										if (globalResult?.status === 'fulfilled') {
+											this._loaded = true;
+											const globalLocale = globalResult?.value || locale;
+											resolve({
+												config: this._config,
+												customerId,
+												configId,
+												locale: globalLocale,
+												consent,
+											});
+											return;
+										}
+										// If the global locale failed to load, we can't render the CMP
+										reject(new Error(globalResult?.reason));
+									});
 							});
-					});
-			})
-			.catch((err) => {
-				this._loaded = false;
-				OsanoLogger.error(
-					`ConsentManager: Error loading config for customerId: ${customerId}, configId: ${configId}: ${err}`,
+					}),
 				);
+				onConfigLoadSuccess && onConfigLoadSuccess();
+			};
+			const handleConfigLoadFailure = (err: Error) => {
+				this._loaded = false;
 				delete this._cancelLoading;
 				delete this._loading;
-				onConfigLoadFailure && onConfigLoadFailure(err);
-				return {
-					config: this._config,
-					customerId,
-					configId,
-					locale: this._translator.locale,
-					consent: [ConsentCategory.ESSENTIAL],
-				};
-			});
+				this._configLoadSuccessSubscription?.remove();
+				this._configLoadFailureSubscription?.remove();
+				onConfigLoadFailure && onConfigLoadFailure();
+				rejectLoadConfig(err);
+			};
+			this._configLoadSuccessSubscription = this._config.on(
+				'loadSuccess',
+				handleConfigLoadSuccess,
+			);
+			this._configLoadFailureSubscription = this._config.on(
+				'loadFailure',
+				handleConfigLoadFailure,
+			);
+			this.config.customerId = customerId;
+			this.config.configId = configId;
+			this._config.load();
+		});
 
 		return this._loading;
 	}

package/src/components/Button.tsx

@@ -252,4 +252,4 @@ export const SaveButton: React.FC<ButtonProps> = (props) => {
 			testID="Save"
 		/>
 	);
-};
+};

package/src/components/Locale.tsx

@@ -49,4 +49,4 @@ export const Locale = (props: LocaleProps = { path: '' }) => {
 	return translatedText ? <>{translatedText}</> : null;
 };
 
-export default Locale;
+export default Locale;

package/src/constants.ts

@@ -33,4 +33,4 @@ export const env = {
 	LOOKUPS_URI: OSANO_DEV === 'true'
 		? 'https://lookups-ci.api.osano.com'
 		: 'https://lookups.api.osano.com',
-};
+};

package/src/iab/constants.ts

@@ -1,3 +1,3 @@
 export const CMP_ID: number = 279;
-export const IAB_CMP_VERSION = 2023;
+export const IAB_CMP_VERSION = 2025;
 export const GDPR_COUNTRIES: string[] = [];

package/src/iab/tcf/consent.ts

@@ -4,12 +4,18 @@ import {
 	DisplayStatusCodes,
 	consentToPurpose,
 } from './constants';
-import type { IabInitOptions, TcData, TcfVersionType, Tcf_v2 } from './types';
+import type { 
+	IabInitOptions,
+	TcData,
+	TcfVersionType,
+	Tcf_v2, CoreField
+} from './types';
 import { get, set } from '../../utils';
 // TODO: Look at these
 // import { Locale, ScreenIds } from '../../constants';
 import {
 	getConsent,
+	getConsentString,
 	getCurrentScreen,
 	getPurposeConsents,
 	getPurposeOptOuts,
@@ -17,6 +23,7 @@ import {
 	getSavedConsent,
 	getSpecialFeatureOptIns,
 	getVendorOptOuts,
+	getUpdatedVendorDisclosures,
 	hasActed,
 	isSaved,
 } from './selectors';
@@ -159,6 +166,7 @@ export const makeParseConsentString =
 			version,
 			cmpId,
 			cmpVersion,
+			tcfPolicyVersion,
 		} = initOptions;
 		const segments = tcString.split('.');
 		const coreSegment = decode(segments[0]) as string;
@@ -166,7 +174,7 @@ export const makeParseConsentString =
 			...commonConsent,
 			cmpId,
 			cmpVersion,
-			tcfPolicyVersion: parseInt(version, 10),
+			tcfPolicyVersion,
 		};
 		coreFieldSequence.reduce(
 			(startBit, [field, numBits, { decode: decodeField }, dataField]) => {
@@ -262,6 +270,7 @@ export const makeConsentFromOptions =
 					state,
 					version,
 				),
+				vendorsDisclosed: getUpdatedVendorDisclosures(config.config, version),
 			},
 			specialFeatureOptins: getSpecialFeatureOptIns(state, version),
 			purpose: {
@@ -277,34 +286,40 @@ export const makeFormatConsentString =
 		const {
 			encoder: { encode },
 			coreFieldSequence,
+			disclosedVendorsFieldSequence,
 			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);
-				}
-				const encodedValue = encodeField(value, numBits);
-				return [bitString + encodedValue, startBit + encodedValue.length];
-			},
-			['', 0],
-		);
-		const newCoreString = encode(bitFields);
-		segments.unshift(newCoreString);
-		return segments.join('.');
+		
+		const encodeSequenceFields = (
+			[bitString, startBit]: [string, number],
+			[key, numBits, { encode: encodeField }, dataField = key]: CoreField
+		) => {
+			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] as [string, number];
+		};
+		const [coreBitFields] = coreFieldSequence.reduce(encodeSequenceFields, ['', 0] as [string, number]);
+		const [disclosedVendorsBitFields] = disclosedVendorsFieldSequence.reduce(encodeSequenceFields, [
+			'',
+			0,
+		] as [string, number]);
+
+		// Only update the CORE (1st) & disclosed vendors (2nd) segments of the TCString
+		// since the rest are optional and we do not handle them.
+		const newCoreString = encode(coreBitFields);
+		const newDisclosedVendorsString = encode(disclosedVendorsBitFields);
+		const [, , ...restOfSegments] = getConsentString(state, initOptions).split('.');
+
+		return [newCoreString, newDisclosedVendorsString, ...restOfSegments].join('.');
 	};
 
 export const makeReadFromStorage = (initOptions: IabInitOptions) => {

package/src/iab/tcf/middleware.ts

@@ -1,31 +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 { clearAllIABKeys, setAllIABKeys } from './iab-storage-utils';
-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 { osanoLogger } from '../../utils/OsanoLogger';
+import type { IabState } from '../types';
+import type { IabInitOptions } from './types';
 
 export const makeMiddleware: IabMiddlewareFactory = (
 	initOptions: IabInitOptions,
@@ -66,17 +66,42 @@ export const makeMiddleware: IabMiddlewareFactory = (
 						}
 						store.dispatch(setConsent(payload));
 					};
-					getStorage(`${gppSection}_${configId}`)
-						.then(resConsent)
-						.catch(() => {
-							// Consent not found
-							clearStorage(`${gppSection}_${configId}`);
-						});
+					switch (Platform.OS) {
+						case 'ios':
+						case 'android':
+							getStorage(`${gppSection}_${configId}`)
+								.then(resConsent)
+								.catch(() => {
+									// Consent not found
+									clearStorage(`${gppSection}_${configId}`);
+								});
+							break;
+						default:
+							try {
+								resConsent(
+									window.localStorage.getItem(`${gppSection}_${configId}`),
+								);
+							} catch (e) {
+								window.localStorage.removeItem(`${gppSection}_${configId}`);
+							}
+							break;
+					}
 					break;
 				}
 				case CLEAR_CONSENT: {
-					clearStorage(`${gppSection}_${configId}`);
-					clearAllIABKeys();
+					switch (Platform.OS) {
+						case 'ios':
+						case 'android':
+							clearStorage(`${gppSection}_${configId}`);
+
+							clearAllIABKeys();
+							break;
+						default:
+							try {
+								window.localStorage.removeItem(`${gppSection}_${configId}`);
+							} catch {}
+							break;
+					}
 					store.dispatch(setConsentData(gppSection, ''));
 					break;
 				}