@osano/osano-cmp-react-native 0.17.3 → 0.18.1

package/src/native/OsanoCmp.ts

@@ -1,7 +1,10 @@
 import { NativeModules, Platform } from 'react-native';
-import OsanoCmpSdkTurboModule from './OsanoCmpSdkSpec';
+
 import { ExpoDetector } from '../utils/ExpoDetector';
 import { ExpoGoMemoryStorage } from '../utils/ExpoGoMemoryStorage';
+import { WebStorage } from '../utils/WebStorage';
+
+const isWeb = Platform.OS === 'web';
 
 const LINKING_ERROR =
 	`The package 'osano-cmp-react-native' doesn't seem to be linked. Make sure: \n\n` +
@@ -9,69 +12,95 @@ const LINKING_ERROR =
 	'- You rebuilt the app after installing the package\n' +
 	'- You are not using Expo Go\n';
 
-const OsanoCmp = OsanoCmpSdkTurboModule || NativeModules.OsanoCmpSdk || new Proxy(
-	{},
-	{
-		get(_, prop) {
-			throw new Error(`${LINKING_ERROR}\nAttempted to call: ${String(prop)}`);
-		},
-	},
-);
+// Lazy-load the TurboModule spec to avoid calling TurboModuleRegistry.get() on web
+// where it doesn't exist. The native module is only needed on iOS/Android.
+let _nativeModule: any;
+function getNativeModule() {
+	if (_nativeModule === undefined) {
+		if (isWeb) {
+			_nativeModule = null;
+		} else {
+			// eslint-disable-next-line @typescript-eslint/no-require-imports
+			const OsanoCmpSdkTurboModule = require('./OsanoCmpSdkSpec').default;
+			_nativeModule =
+				OsanoCmpSdkTurboModule ||
+				NativeModules.OsanoCmpSdk ||
+				new Proxy(
+					{},
+					{
+						get(_, prop) {
+							throw new Error(
+								`${LINKING_ERROR}\nAttempted to call: ${String(prop)}`,
+							);
+						},
+					},
+				);
+		}
+	}
+	return _nativeModule;
+}
+
+function getFallback() {
+	if (isWeb) return WebStorage;
+	if (ExpoDetector.isExpoGo()) return ExpoGoMemoryStorage;
+	return null;
+}
 
 export function getDeviceId(): Promise<string | null | undefined> {
-	if (ExpoDetector.isExpoGo()) {
-		return ExpoGoMemoryStorage.getDeviceId();
-	}
-	return OsanoCmp.getDeviceId();
+	const fallback = getFallback();
+	if (fallback) return fallback.getDeviceId();
+	return getNativeModule().getDeviceId();
 }
 export function setStorage(key: string, value: string): Promise<string> {
-	if (ExpoDetector.isExpoGo()) {
-		return ExpoGoMemoryStorage.setStorage(key, value);
-	}
-	return OsanoCmp.setStorage(key, value);
+	const fallback = getFallback();
+	if (fallback) return fallback.setStorage(key, value);
+	return getNativeModule().setStorage(key, value);
 }
 export function getStorage(key: string): Promise<string | null | undefined> {
-	if (ExpoDetector.isExpoGo()) {
-		return ExpoGoMemoryStorage.getStorage(key);
-	}
-	return OsanoCmp.getStorage(key);
+	const fallback = getFallback();
+	if (fallback) return fallback.getStorage(key);
+	return getNativeModule().getStorage(key);
 }
 export function clearStorage(key: string): Promise<void> {
-	if (ExpoDetector.isExpoGo()) {
-		return ExpoGoMemoryStorage.clearStorage(key);
-	}
-	return OsanoCmp.clearStorage(key);
+	const fallback = getFallback();
+	if (fallback) return fallback.clearStorage(key);
+	return getNativeModule().clearStorage(key);
 }
 export function setStorageToDefault(
 	key: string,
 	value: string,
 ): Promise<string> {
-	if (ExpoDetector.isExpoGo()) {
-		return ExpoGoMemoryStorage.setStorageToDefault(key, value);
-	}
-	return OsanoCmp.setStorageToDefault?.(key, value) ?? Promise.resolve(value);
+	const fallback = getFallback();
+	if (fallback) return fallback.setStorageToDefault(key, value);
+	return (
+		getNativeModule().setStorageToDefault?.(key, value) ??
+		Promise.resolve(value)
+	);
 }
 export function setIntStorageToDefault(
 	key: string,
 	value: number,
 ): Promise<number> {
-	if (ExpoDetector.isExpoGo()) {
-		return ExpoGoMemoryStorage.setIntStorageToDefault(key, value);
-	}
-	return OsanoCmp.setIntStorageToDefault?.(key, value) ?? Promise.resolve(value);
+	const fallback = getFallback();
+	if (fallback) return fallback.setIntStorageToDefault(key, value);
+	return (
+		getNativeModule().setIntStorageToDefault?.(key, value) ??
+		Promise.resolve(value)
+	);
 }
 export function setBoolStorageToDefault(
 	key: string,
 	value: boolean,
 ): Promise<boolean> {
-	if (ExpoDetector.isExpoGo()) {
-		return ExpoGoMemoryStorage.setBoolStorageToDefault(key, value);
-	}
-	return OsanoCmp.setBoolStorageToDefault?.(key, value) ?? Promise.resolve(value);
+	const fallback = getFallback();
+	if (fallback) return fallback.setBoolStorageToDefault(key, value);
+	return (
+		getNativeModule().setBoolStorageToDefault?.(key, value) ??
+		Promise.resolve(value)
+	);
 }
 export function clearStorageFromDefault(key: string): Promise<void> {
-	if (ExpoDetector.isExpoGo()) {
-		return ExpoGoMemoryStorage.clearStorageFromDefault(key);
-	}
-	return OsanoCmp.clearStorageFromDefault?.(key) ?? Promise.resolve();
+	const fallback = getFallback();
+	if (fallback) return fallback.clearStorageFromDefault(key);
+	return getNativeModule().clearStorageFromDefault?.(key) ?? Promise.resolve();
 }

package/src/native/OsanoCmpSdkSpec.ts

@@ -2,24 +2,24 @@ import type { TurboModule } from 'react-native';
 import { TurboModuleRegistry } from 'react-native';
 
 export interface Spec extends TurboModule {
-  // Core storage methods
-  setStorage(key: string, value: string): Promise<string>;
-  getStorage(key: string): Promise<string | null>;
-  clearStorage(key: string): Promise<void>;
-  
-  // Default storage methods (iOS specific functionality)
-  setStorageToDefault(key: string, value: string): Promise<string>;
-  setIntStorageToDefault(key: string, value: number): Promise<number>;
-  setBoolStorageToDefault(key: string, value: boolean): Promise<boolean>;
-  clearStorageFromDefault(key: string): Promise<void>;
-  
-  // Device identification
-  getDeviceId(): Promise<string>;
-  
-  // Constants only (no synchronous methods for TurboModule compatibility)
-  getConstants(): {
-    IS_OFFICIAL_SAMPLE: boolean;
-  };
+	// Core storage methods
+	setStorage(key: string, value: string): Promise<string>;
+	getStorage(key: string): Promise<string | null>;
+	clearStorage(key: string): Promise<void>;
+
+	// Default storage methods (iOS specific functionality)
+	setStorageToDefault(key: string, value: string): Promise<string>;
+	setIntStorageToDefault(key: string, value: number): Promise<number>;
+	setBoolStorageToDefault(key: string, value: boolean): Promise<boolean>;
+	clearStorageFromDefault(key: string): Promise<void>;
+
+	// Device identification
+	getDeviceId(): Promise<string>;
+
+	// Constants only (no synchronous methods for TurboModule compatibility)
+	getConstants(): {
+		IS_OFFICIAL_SAMPLE: boolean;
+	};
 }
 
-export default TurboModuleRegistry.get<Spec>('OsanoCmpSdk');
+export default TurboModuleRegistry.get<Spec>('OsanoCmpSdk');

package/src/reducer.ts

@@ -7,7 +7,7 @@ import {
 	GO_BACK,
 	RELOAD,
 	REVERT_CONSENT,
-	SAVE_SUCCESS,
+	SAVE_BEGIN,
 	SET_ALL_CONSENT,
 	SET_CONFIG,
 	SET_LOCALE,
@@ -19,89 +19,57 @@ import {
 } from './actions';
 import {
 	ConsentCategory,
-	ConsentCategory as ConsentCategoryType,
+	initialState,
+	makeConsentFromCategories,
+	OsanoCategories,
+	type ConsentCategoryType,
 } from './constants';
-import { ConsentConfig, ConsentManager } from './ConsentManager';
 import type { Disclosure, OsanoAction, OsanoState } from './types/store';
-import { getFinalOptOutValue, getSavedConsent } from './iab/tcf/selectors';
-import { isAnalyticsAlwaysAllowed, shouldUseGPCOptOut } from './selectors';
-
-export const OsanoCategories = Object.values(ConsentCategory);
+import {
+	getFinalOptOutValue,
+	getPriorConsent,
+	isAnalyticsAlwaysAllowed,
+	shouldUseGPCOptOut,
+} from './selectors';
 
-export const initialState: OsanoState = {
-	config: undefined,
-	configId: '',
-	consent: {
-		[ConsentCategory.ESSENTIAL]: true,
-		[ConsentCategory.STORAGE]: false,
-		[ConsentCategory.MARKETING]: false,
-		[ConsentCategory.PERSONALIZATION]: false,
-		[ConsentCategory.ANALYTICS]: false,
-		[ConsentCategory.OPT_OUT]: false,
-	} as Record<ConsentCategoryType, boolean | undefined>,
-	consentTimestamp: 0,
-	customerId: '',
-	dialogOpen: false,
-	disclosures: {
-		fetched: [],
-		loading: false,
-		results: {},
-	},
-	locale: 'en',
-	ready: {
-		consent: false,
-	},
-	savedConsent: null,
-	scrollToType: '',
-	scrollToId: -1,
-	stack: [],
-};
+import { ConsentConfig } from './ConsentManager';
 
 export const init = (initialArgs: OsanoState & any): OsanoState => {
 	const { consent, ...reloadProps } = initialArgs;
+	const consentRecord = consent
+		? Array.isArray(consent)
+			? makeConsentFromCategories(consent)
+			: { ...consent }
+		: initialState.consent;
 	return {
 		...initialState,
 		...reloadProps,
-		consent: consent
-			? Array.isArray(consent)
-				? OsanoCategories.reduce(
-						(newConsent, category) => {
-							newConsent[`${category}`] = consent.includes(category);
-							return newConsent;
-						},
-						{} as Record<ConsentCategoryType, boolean | undefined>
-					)
-				: { ...consent }
-			: initialState.consent,
+		consent: consentRecord,
+		savedConsent: consent
+			? ({ ...consentRecord } as Record<ConsentCategoryType, boolean>)
+			: null,
 	};
 };
 
 const setAllConsent = (acceptOrDeny: boolean) => (state: OsanoState) => {
-	function formatStatus(category: ConsentCategoryType, status: boolean) {
-		const useGPC = shouldUseGPCOptOut(state, !status);
+	function isAccepted(category: ConsentCategoryType) {
+		const useGPC = shouldUseGPCOptOut(state, !acceptOrDeny);
 		switch (category) {
 			case 'ESSENTIAL': {
 				return true;
 			}
 			case 'OPT_OUT': {
 				// This is inverted because we would assume consent to all would be DENY for OPT_OUT
-				return useGPC || !status;
+				return useGPC || !acceptOrDeny;
 			}
 			case 'MARKETING': {
 				// Never set marketing to true if GPC is detected
-				return status && !useGPC;
+				return acceptOrDeny && !useGPC;
 			}
 		}
-		return status;
+		return acceptOrDeny;
 	}
-	const newConsent = OsanoCategories.reduce(
-		(consent, category) => {
-			const status = formatStatus(category, acceptOrDeny);
-			consent[`${category}`] = status;
-			return consent;
-		},
-		{} as Record<ConsentCategoryType, boolean | undefined>
-	);
+	const newConsent = makeConsentFromCategories(OsanoCategories, isAccepted);
 	return {
 		...state,
 		consent: newConsent as Record<ConsentCategoryType, boolean | undefined>,
@@ -134,31 +102,24 @@ export function reducer(state: OsanoState, action: OsanoAction): OsanoState {
 				...state,
 				locale: action.payload,
 			};
-		case SAVE_SUCCESS: {
+		/**
+		 * Why SAVE_BEGIN? Because we are going to save the consent regardless of SUCCESS OR FAILURE.
+		 * The only thing we do on FAILURE is we store an indicator that the record failed, and then
+		 * we will retry later. The consent state should reflect the user's choices immediately.
+		 */
+		case SAVE_BEGIN: {
 			const consentedCategories: ConsentCategoryType[] = action.payload;
-			const consent = OsanoCategories.reduce(
-				(consent, category) => {
-					consent[`${category}`] = consentedCategories.includes(category);
-					return consent;
-				},
-				{} as Record<ConsentCategoryType, boolean>
-			);
-
-			consent[ConsentCategory.ESSENTIAL] = true;
-			if (consent[ConsentCategory.OPT_OUT]) {
-				consent[ConsentCategory.MARKETING] = false;
-			}
+			const consent = makeConsentFromCategories(consentedCategories);
 			return {
 				...state,
 				consent,
 				savedConsent: { ...consent },
-				stack: [],
 			};
 		}
 		case CLEAR_CONSENT: {
 			const optOutStatus = getFinalOptOutValue(
 				state,
-				initialState.consent[ConsentCategory.OPT_OUT]
+				initialState.consent[ConsentCategory.OPT_OUT],
 			);
 
 			return {
@@ -175,20 +136,7 @@ export function reducer(state: OsanoState, action: OsanoAction): OsanoState {
 			};
 		}
 		case REVERT_CONSENT: {
-			const previousConsent = {
-				...(getSavedConsent(state) || initialState.consent),
-			};
-			if (!getSavedConsent(state)) {
-				previousConsent[ConsentCategory.OPT_OUT] = getFinalOptOutValue(
-					state,
-					previousConsent[ConsentCategory.OPT_OUT]
-				);
-				previousConsent[ConsentCategory.ANALYTICS] = isAnalyticsAlwaysAllowed(
-					state
-				)
-					? true
-					: false;
-			}
+			const previousConsent = getPriorConsent(state);
 			return {
 				...state,
 				consent: previousConsent,
@@ -293,26 +241,18 @@ export function reducer(state: OsanoState, action: OsanoAction): OsanoState {
 			};
 		}
 		case CLOSE: {
-			const cmp = action.payload as ConsentManager;
-			const consent = Object.keys(state.consent).reduce(
-				(newConsent, category) => {
-					newConsent[`${category as ConsentCategoryType}`] =
-						cmp.consent?.includes(category as ConsentCategoryType);
-					return newConsent;
-				},
-				{} as Record<ConsentCategoryType, boolean | undefined>
-			);
-			if (state.stack.length > 0) {
+			const previousConsent = getPriorConsent(state);
+			if (state.stack.length > 1) {
 				return {
 					...state,
-					consent,
+					consent: previousConsent,
 					stack: [],
 				};
 			}
 			return {
 				...state,
+				consent: previousConsent,
 				dialogOpen: false,
-				consent,
 				stack: [],
 			};
 		}
@@ -357,7 +297,7 @@ export function reducer(state: OsanoState, action: OsanoAction): OsanoState {
 			>(
 				(
 					categories: Partial<Record<ConsentCategoryType, Disclosure[]>>,
-					disclosure: Disclosure
+					disclosure: Disclosure,
 				) => {
 					const { classification: categoryName } = disclosure || {};
 					if (!disclosure || !categoryName) {
@@ -370,7 +310,7 @@ export function reducer(state: OsanoState, action: OsanoAction): OsanoState {
 					categoryDisclosures.push({ type: 'cookie', ...disclosure });
 					return categories;
 				},
-				{ ...results }
+				{ ...results },
 			);
 			const newResults = Object.entries(disclosuresByCategory)
 				.filter(([cat]) => fetched.push(cat as ConsentCategoryType))
@@ -390,11 +330,11 @@ export function reducer(state: OsanoState, action: OsanoAction): OsanoState {
 										: false;
 								})
 								.sort((a, b) =>
-									`${a.type}:${a.name}`.localeCompare(`${b.type}:${b.name}`)
+									`${a.type}:${a.name}`.localeCompare(`${b.type}:${b.name}`),
 								);
 						return validCategories;
 					},
-					{} as Record<ConsentCategoryType, Disclosure[]>
+					{} as Record<ConsentCategoryType, Disclosure[]>,
 				);
 			return {
 				...state,
@@ -402,7 +342,7 @@ export function reducer(state: OsanoState, action: OsanoAction): OsanoState {
 					...state.disclosures,
 					results: newResults,
 					fetched: fetched.filter(
-						(cat, index, list) => list.indexOf(cat) === index
+						(cat, index, list) => list.indexOf(cat) === index,
 					),
 					loading: false,
 				},

package/src/selectors.ts

@@ -1,7 +1,7 @@
-// @ts-nocheck
 import {
+	initialState,
 	ConsentCategory,
-	ConsentCategory as ConsentCategoryType,
+	type ConsentCategoryType,
 } from './constants';
 import type { Disclosure, OsanoState } from './types/store';
 
@@ -55,6 +55,41 @@ export function getConsent(state: OsanoState, category?: ConsentCategoryType) {
 		.filter(([_key, value]) => value)
 		.map(([key]) => key);
 }
+export function getFinalOptOutValue(
+	state?: OsanoState,
+	pendingNewValue?: boolean,
+) {
+	if (pendingNewValue === true) {
+		return true;
+	} else if (pendingNewValue === undefined) {
+		const existingOptOut =
+			get(state, ['consent', ConsentCategory.OPT_OUT]) ||
+			initialState.consent[ConsentCategory.OPT_OUT];
+		return existingOptOut;
+	}
+
+	return false;
+}
+export function getSavedConsent(state: OsanoState) {
+	return get(state, 'savedConsent', null);
+}
+export function getPriorConsent(
+	state: OsanoState,
+): Record<ConsentCategoryType, boolean | undefined> {
+	const previousConsent = {
+		...(getSavedConsent(state) || initialState.consent),
+	};
+	if (!getSavedConsent(state)) {
+		previousConsent[ConsentCategory.OPT_OUT] = getFinalOptOutValue(
+			state,
+			previousConsent[ConsentCategory.OPT_OUT],
+		);
+		previousConsent[ConsentCategory.ANALYTICS] = isAnalyticsAlwaysAllowed(state)
+			? true
+			: false;
+	}
+	return previousConsent;
+}
 export const getConsentTimestamp = (state: OsanoState): number =>
 	get(state, 'consentTimestamp') || 0;