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

package/src/iab/tcf/selectors.ts

@@ -2,12 +2,13 @@ import type { TcfVersion, TcfVersionType, Tcf_v2 } from './types';
 import { consentToPurpose, purposeIds } from './constants';
 
 import type { Config } from '../../types/consent-config';
-import { ConsentCategory } from '../../constants';
+import { ConsentCategory, type ConsentCategoryType } from '../../constants';
 import type { IabState } from '../types';
 import type { OsanoState } from '../../types/store';
 import { get } from '../../utils';
-import { initialState } from '../../reducer';
+import { initialState } from '../../constants';
 import { isBrowsingFrom } from '../gpp/selectors';
+import { getFinalOptOutValue, getSavedConsent } from '../../selectors';
 
 const DOMAIN = 'iab.tcf';
 
@@ -22,12 +23,12 @@ export const getConfigData = (config: Config, apiVersion = `2`) =>
 	get(config, `${DOMAIN}.v${parseInt(apiVersion, 10)}`, {});
 export const getStateData = <V extends TcfVersionType>(
 	state: Partial<IabState>,
-	apiVersion?: V
+	apiVersion?: V,
 ) =>
 	get(
 		state,
 		`${DOMAIN}.v${parseInt(apiVersion ?? '2', 10)}`,
-		{}
+		{},
 	) as TcfVersion<V>;
 
 export const getCurrentScreen = (state: OsanoState) =>
@@ -35,7 +36,10 @@ export const getCurrentScreen = (state: OsanoState) =>
 
 export const getConsentString = (
 	state: IabState,
-	{ gppSection, tcString = '' }: { gppSection?: string; tcString?: string } = {}
+	{
+		gppSection,
+		tcString = '',
+	}: { gppSection?: string; tcString?: string } = {},
 ) => {
 	return (
 		(gppSection &&
@@ -53,12 +57,12 @@ export const getPublisherLegitimateInterests = (/* state, apiVersion */) => {
 export const getPurposeIds = () => [...purposeIds];
 export const getPurposeOptOuts = (
 	state: IabState,
-	apiVersion?: TcfVersionType
+	apiVersion?: TcfVersionType,
 ): Record<string, boolean> =>
 	get(getStateData(state, apiVersion), 'purposeOptouts') || {};
 export const getPurposeConsents = (
 	state: OsanoState & IabState,
-	apiVersion?: TcfVersionType
+	apiVersion?: TcfVersionType,
 ): Record<string, boolean> => {
 	const consent = getSavedConsent(state) || getConsent(state);
 	const optOutPurposes = getPurposeOptOuts(state, apiVersion);
@@ -68,13 +72,13 @@ export const getPurposeConsents = (
 				hasConsented && !optOutPurposes[`${purposeId}`];
 			return purposeConsents;
 		},
-		{} as Record<string, boolean>
+		{} as Record<string, boolean>,
 	);
 };
 // Established legitimate interest per purpose
 export const getPurposesLITransparency = (
 	state: OsanoState & IabState,
-	apiVersion?: TcfVersionType
+	apiVersion?: TcfVersionType,
 ) => {
 	/*
 	 *  PurposesLITransparency
@@ -101,7 +105,7 @@ export const getPurposesLITransparency = (
 };
 export const getSpecialFeatureOptIns = (
 	state: IabState,
-	apiVersion?: TcfVersionType
+	apiVersion?: TcfVersionType,
 ): Record<string, boolean> =>
 	get(getStateData(state, apiVersion), 'specialFeatureOptins') || {};
 export const getVendors = (config: Config, apiVersion?: string) =>
@@ -109,30 +113,30 @@ export const getVendors = (config: Config, apiVersion?: string) =>
 		{}) as Tcf_v2['vendors'];
 export const getVendorData = (
 	state: Config,
-	{ apiVersion, vendorId }: { apiVersion?: string; vendorId: string }
+	{ apiVersion, vendorId }: { apiVersion?: string; vendorId: string },
 ) => get(getVendors(state, apiVersion), `${vendorId}`) || {};
 export const getVendorIds = (config: Config, apiVersion?: string) =>
 	Object.keys(getVendors(config, apiVersion)).map((vendorId) =>
-		Number.parseInt(vendorId, 10)
+		Number.parseInt(vendorId, 10),
 	) || [];
 export const getActiveVendorIds = (config: Config, apiVersion?: string) => {
 	const vendors = getVendors(config, apiVersion);
 	return Object.values(vendors)
-	.filter(v => !v.deletedDate)
-	.map(v => Number(v.id));
+		.filter((v) => !v.deletedDate)
+		.map((v) => Number(v.id));
 };
 export const getVendorOptOuts = (
 	state: Partial<IabState>,
-	apiVersion?: TcfVersionType
+	apiVersion?: TcfVersionType,
 ): Record<string, boolean> =>
 	get(getStateData(state, apiVersion), 'vendorOptouts') || {};
 export const getVendorListError = (
 	state: IabState,
-	apiVersion?: TcfVersionType
+	apiVersion?: TcfVersionType,
 ) => get(getStateData(state, apiVersion), 'vendorListError', 0);
 export const getVendorListVersion = (
 	config: Config,
-	apiVersion?: TcfVersionType
+	apiVersion?: TcfVersionType,
 ) => get(getConfigData(config, apiVersion), 'vendorListVersion');
 
 export const hasActed = (state: OsanoState, gppSection: string) =>
@@ -142,15 +146,15 @@ export const hasConsentedToSpecialFeature = (
 	{
 		apiVersion,
 		specialFeatureId,
-	}: { apiVersion?: TcfVersionType; specialFeatureId: string }
+	}: { apiVersion?: TcfVersionType; specialFeatureId: string },
 ) => !!getSpecialFeatureOptIns(state, apiVersion)[`${specialFeatureId}`];
 export const hasOptedOutOfVendor = (
 	state: IabState,
-	{ apiVersion, vendorId }: { apiVersion?: TcfVersionType; vendorId: string }
+	{ apiVersion, vendorId }: { apiVersion?: TcfVersionType; vendorId: string },
 ) => !!getVendorOptOuts(state, apiVersion)[`${vendorId}`];
 export const hasOptedOutOfPurpose = (
 	state: IabState,
-	{ apiVersion, purposeId }: { apiVersion?: TcfVersionType; purposeId: string }
+	{ apiVersion, purposeId }: { apiVersion?: TcfVersionType; purposeId: string },
 ) => !!getPurposeOptOuts(state, apiVersion)[`${purposeId}`];
 
 export const isTcfApplicable = (state: Config) =>
@@ -158,46 +162,30 @@ export const isTcfApplicable = (state: Config) =>
 	!!get(getStore(state), 'enabled', isIABEnabled(state));
 export const isVendorListLoaded = (
 	state: Config,
-	apiVersion?: TcfVersionType
+	apiVersion?: TcfVersionType,
 ) => !!get(getStateData(state, apiVersion), 'vendorListLoaded');
 export const isVendorListLoading = (
 	state: Config,
-	apiVersion?: TcfVersionType
+	apiVersion?: TcfVersionType,
 ) => !!get(getStateData(state, apiVersion), 'vendorListLoading');
 
 export const getCountryCode = (config: Config) =>
 	`${config.country}`.substring(0, 2).toUpperCase() || null;
-export const getSavedConsent = (state: OsanoState) =>
-	get(state, 'savedConsent', null);
 export const isSaved = (state: OsanoState) => !!getSavedConsent(state);
 
-export const 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 const getConsent = (state?: OsanoState) => {
-	const consent: Record<ConsentCategory, boolean | undefined> = {
+	const consent: Record<ConsentCategoryType, boolean | undefined> = {
 		...(get(state, 'consent') || initialState.consent),
 	};
-	// eslint-disable-next-line security/detect-object-injection
 	// TODO implement this
 	consent[ConsentCategory.OPT_OUT] = getFinalOptOutValue(state);
 	return consent;
 };
 
-export const getUpdatedVendorDisclosures = (config: Config, apiVersion?: string) => {
+export const getUpdatedVendorDisclosures = (
+	config: Config,
+	apiVersion?: string,
+) => {
 	const activeVendors = getActiveVendorIds(config, apiVersion);
 	const disclosures: Record<string, boolean> = {};
 	for (const vendorId of activeVendors) {

package/src/iab/tcf/types.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-unsafe-function-type */
 import type { GvlVendor_v2, IabState } from '../types';
 import type { OsanoAction, OsanoState } from '../../types/store';
 
@@ -63,7 +64,7 @@ export type TcfState = {
 export type AdaptedCodable = {
 	decode: (
 		bitString: string,
-		numBits: number
+		numBits: number,
 	) => { bitLength: number; value: unknown };
 	encode: (...args: any[]) => string;
 };
@@ -92,28 +93,28 @@ export type IabInitOptions = {
 };
 
 export type IabMiddlewareFactory = (
-	initOptions: IabInitOptions
+	initOptions: IabInitOptions,
 ) => (
-	store: Store<OsanoState & IabState, OsanoAction>
+	store: Store<OsanoState & IabState, OsanoAction>,
 ) => (
-	next: (action: OsanoAction) => OsanoState & IabState
+	next: (action: OsanoAction) => OsanoState & IabState,
 ) => (action: OsanoAction) => OsanoState & IabState;
 
 export type TcfController = IabInitOptions & {
 	consentFromOptions: (
 		config: ConsentConfig,
-		state: OsanoState & IabState
+		state: OsanoState & IabState,
 	) => TcData;
 	formatConsentString: (
 		config: ConsentConfig,
-		state: OsanoState & IabState
+		state: OsanoState & IabState,
 	) => string;
 	parseConsentString: (tcString: string) => TcData;
 	readFromStorage: (storage: Partial<Tcf_v2>) => TcfState;
 	middleware?: ReturnType<IabMiddlewareFactory>;
 	reducer?: (
 		state: OsanoState & IabState,
-		action: OsanoAction
+		action: OsanoAction,
 	) => OsanoState & IabState;
 	selectors?: Record<string, Function>;
 };

package/src/iab/tcf/v2.0/formatters.ts

@@ -5,7 +5,7 @@ export const idsOnlyArrayFormatter = (value: Record<number, boolean>) =>
 
 export const fixedValuesArrayFormatter = (
 	idValueMap: Record<number, boolean>,
-	length: number
+	length: number,
 ) => {
 	const array: boolean[] = new Array(length).fill(false);
 	for (const [k, v] of Object.entries(idValueMap)) {

package/src/iab/tcf/v2.0/shared-constants.ts

@@ -29,22 +29,22 @@ export const baseInitOptions = {
 				purposeOptouts: (state
 					? Object.fromEntries(
 							Object.entries(
-								selectors.getPurposeOptOuts(state, version)
-							).filter(([, value]) => !!value)
+								selectors.getPurposeOptOuts(state, version),
+							).filter(([, value]) => !!value),
 						)
 					: {}) as Record<string | number, boolean>,
 				specialFeatureOptins: (state
 					? Object.fromEntries(
 							Object.entries(
-								selectors.getSpecialFeatureOptIns(state, version)
-							).filter(([, value]) => !!value)
+								selectors.getSpecialFeatureOptIns(state, version),
+							).filter(([, value]) => !!value),
 						)
 					: {}) as Record<string | number, boolean>,
 				vendorOptouts: (state
 					? Object.fromEntries(
 							Object.entries(selectors.getVendorOptOuts(state, version)).filter(
-								([, value]) => !!value
-							)
+								([, value]) => !!value,
+							),
 						)
 					: {}) as Record<string | number, boolean>,
 			},

package/src/iab/tcf/v2.0/tcfcav1-constants.ts

@@ -79,21 +79,21 @@ const coreFieldSequence: CoreField[] = [
 		idsOnlyArrayFormatter,
 	],
 	// This is not supported in TcfCA v1, HOWEVER, it's still listed and required in the spec doc, and should always be 0
-    ['PubRestrictions', 12, IntEncoder, 'numPubRestrictions'],
+	['PubRestrictions', 12, IntEncoder, 'numPubRestrictions'],
 ];
 
 /**
  * The fields for the disclosed vendors segment of the TCString for TCF-Canada v1.
  */
 const disclosedVendorsFieldSequence: CoreField[] = [
-    ['DisclosedVendorsSegmentType', 3, IntEncoder],
-    [
-        'DisclosedVendors',
-        Number.POSITIVE_INFINITY,
-        EncodableOptimizedFixedRange,
-        'vendor.vendorsDisclosed',
-        idsOnlyArrayFormatter,
-    ],
+	['DisclosedVendorsSegmentType', 3, IntEncoder],
+	[
+		'DisclosedVendors',
+		Number.POSITIVE_INFINITY,
+		EncodableOptimizedFixedRange,
+		'vendor.vendorsDisclosed',
+		idsOnlyArrayFormatter,
+	],
 ];
 
 const version = Number.parseInt(baseInitOptions.version, 10);
@@ -104,7 +104,7 @@ const staticFields = {
 	tcfPolicyVersion,
 	useNonStandardStacks: false,
 	DisclosedVendorsSegmentType: 1,
-    numPubRestrictions: 0,
+	numPubRestrictions: 0,
 };
 
 const dynamicFields = {
@@ -114,9 +114,9 @@ const dynamicFields = {
 
 export const initOptions = {
 	...baseInitOptions,
-    tcfPolicyVersion,
-    coreFieldSequence,
-    disclosedVendorsFieldSequence,
+	tcfPolicyVersion,
+	coreFieldSequence,
+	disclosedVendorsFieldSequence,
 	gppSection,
 	tcString: BOOTSTRAP_TCSTRING,
 	staticFields,

package/src/iab/tcf/v2.0/tcfeuv2-constants.ts

@@ -84,16 +84,15 @@ const coreFieldSequence: CoreField[] = [
  * The fields for the disclosed vendors segment of the TCString in the order they appear in the TCString
  */
 const disclosedVendorsFieldSequence: CoreField[] = [
-    ['vendorsDisclosedSegmentType', 3, IntEncoder],
-    [
-        'vendorsDisclosed',
-        Number.POSITIVE_INFINITY,
-        EncodableOptimizedFixedRange,
-        'vendor.vendorsDisclosed',
-    ],
+	['vendorsDisclosedSegmentType', 3, IntEncoder],
+	[
+		'vendorsDisclosed',
+		Number.POSITIVE_INFINITY,
+		EncodableOptimizedFixedRange,
+		'vendor.vendorsDisclosed',
+	],
 ];
 
-
 const version = Number.parseInt(baseInitOptions.version, 10);
 const staticFields = {
 	version,

package/src/iab/types.ts

@@ -77,7 +77,7 @@ export type IabFrameworkType = 'tcf' | 'usp' | 'gpp';
 export type IabFramework = {
 	reducer?: (
 		state: OsanoState & IabState,
-		action: OsanoAction
+		action: OsanoAction,
 	) => OsanoState & IabState;
 	versions: TcfController[];
 };

package/src/iab/usp/consent.js

@@ -5,7 +5,7 @@ import { merge } from '../../utils';
 
 export const makeParseConsentString =
 	({ version: providedVersion = 1 } = {}) =>
-	uspString => {
+	(uspString) => {
 		const [version = providedVersion, notified, optOut, signatory] = (
 			uspString || ''
 		)
@@ -92,7 +92,7 @@ export const makeFormatConsentString =
  * @param {Object} data
  * @returns {import('./constants').USPConsent} Properly formatted USPConsent object
  */
-export const makeConsentFromOptions = initOptions => (data, state) => {
+export const makeConsentFromOptions = (initOptions) => (data, state) => {
 	const {
 		version: storeVersion,
 		notified: storeNotified,
@@ -127,7 +127,7 @@ export const makeConsentFromOptions = initOptions => (data, state) => {
  * @param {number} version
  * @returns {import('./constants').USPData} Properly formatted USPData object
  */
-export const getConsentDataObject = initOptions => state => {
+export const getConsentDataObject = (initOptions) => (state) => {
 	const { version } = initOptions;
 	switch (version) {
 		// Supported versions

package/src/iab/usp/constants.js

@@ -33,8 +33,8 @@
  * @property {Window} source - The window which posted the message
  */
 
-export const toYesNoUnFromBool = b => (b === undefined ? '-' : b ? 'Y' : 'N');
-export const toBoolFromYesNoUn = yn =>
+export const toYesNoUnFromBool = (b) => (b === undefined ? '-' : b ? 'Y' : 'N');
+export const toBoolFromYesNoUn = (yn) =>
 	yn === '-' || yn === undefined
 		? undefined
 		: !!((yn || 'N').toUpperCase() === 'Y');

package/src/iab/usp/reducer.js

@@ -73,7 +73,7 @@ export default genericReducer(initialState, {
 		}
 		return state;
 	},
-	[ActionTypes.revertConsent]: state => {
+	[ActionTypes.revertConsent]: (state) => {
 		const { [OPT_OUT]: optOut } = getSavedConsent(state) || {};
 		return merge(
 			{
@@ -84,7 +84,7 @@ export default genericReducer(initialState, {
 			},
 		);
 	},
-	[ActionTypes.acceptAllConsent]: state =>
+	[ActionTypes.acceptAllConsent]: (state) =>
 		merge(
 			{
 				...state,
@@ -94,7 +94,7 @@ export default genericReducer(initialState, {
 				iab: { usp: { optOut: formatOptOut(state, false) } },
 			},
 		),
-	[ActionTypes.denyAllConsent]: state =>
+	[ActionTypes.denyAllConsent]: (state) =>
 		merge(
 			{
 				...state,

package/src/iab/usp/selectors.js

@@ -4,8 +4,8 @@ import { toYesNoUnFromBool } from './constants';
 
 export const DOMAIN = 'iab.usp';
 
-export const getStore = state => get(state, DOMAIN, {});
-export const doesCCPAApply = state =>
+export const getStore = (state) => get(state, DOMAIN, {});
+export const doesCCPAApply = (state) =>
 	!!get(state, 'iab.usp.ccpaApplies', isBrowsingFromUS(state));
 
 export const getConsentString = (
@@ -28,4 +28,4 @@ export const getConsentString = (
 				.join('')}`
 		: `${parseInt(version.toString(), 10)}---`;
 };
-export const getOptOut = state => getStore(state).optOut;
+export const getOptOut = (state) => getStore(state).optOut;

package/src/iab/usp/v1/index.js

@@ -12,7 +12,7 @@ const consentFromOptions = makeConsentFromOptions(initOptions);
 const formatConsentString = makeFormatConsentString(initOptions);
 
 function createMiddleware() {
-	return store => next => action => {
+	return (store) => (next) => (action) => {
 		const result = next(action);
 		const { type } = action;
 		const state = store.getState();

package/src/index.tsx

@@ -8,12 +8,17 @@ import {
 	showDialog,
 	showDrawer,
 } from './actions';
-import { OsanoCategories, init, reducer } from './reducer';
+import { init, reducer } from './reducer';
 import type { OsanoAction, OsanoState } from './types/store';
 
 import { ConsentManager } from './ConsentManager';
 import { ConsentUiBuilder } from './ConsentUiBuilder';
-import { ConsentCategory } from './constants';
+import {
+	ConsentCategory,
+	formatConsentArray,
+	makeConsentFromCategories,
+	type ConsentCategoryType,
+} from './constants';
 import { OsanoPublicContext } from './context';
 import { usePrevious } from './hooks/usePrevious';
 import useThunkReducer, { type Store } from './hooks/useThunkReducer';
@@ -74,7 +79,7 @@ export const Osano: React.FunctionComponent<
 		);
 		const { addMiddleware, dispatch, getState, removeMiddleware } = store;
 
-		const handleGetConsent = useCallback((category?: ConsentCategory) => {
+		const handleGetConsent = useCallback((category?: ConsentCategoryType) => {
 			if (typeof category === 'string') {
 				return consentManager.current.hasConsent(category);
 			}
@@ -82,7 +87,7 @@ export const Osano: React.FunctionComponent<
 		}, []);
 
 		const handleRecordConsent = useCallback(
-			(category?: ConsentCategory | ConsentCategory[]) => {
+			(category?: ConsentCategoryType | ConsentCategoryType[]) => {
 				let consentedCategories = getConsent(getState());
 				if (category !== undefined) {
 					/*
@@ -90,12 +95,9 @@ export const Osano: React.FunctionComponent<
 					 *	1. Check if all categories provided are valid
 					 *	2. Store them locally
 					 */
-					const categories = (
-						Array.isArray(category) ? category : [category]
-					).filter((cat) => OsanoCategories.includes(cat));
-					consentedCategories = OsanoCategories.filter(
-						(cat) =>
-							cat === ConsentCategory.ESSENTIAL || categories.includes(cat),
+					const categories = Array.isArray(category) ? category : [category];
+					consentedCategories = formatConsentArray(
+						makeConsentFromCategories(categories),
 					);
 				}
 				return recordConsent(consentManager.current, consentedCategories);
@@ -156,22 +158,6 @@ export const Osano: React.FunctionComponent<
 		}, []);
 
 		const context = useMemo(() => {
-			consentManager.current
-				.load({
-					customerId,
-					configId,
-					onConfigLoadSuccess,
-					onConfigLoadFailure,
-					onLangLoadSuccess,
-					onLangLoadFailure,
-				})
-				.then((reloadProps) => {
-					// We need to reset the state when the configId or customerId changes
-					dispatch(reload(reloadProps));
-				})
-				.catch(() => {
-					// TODO: Handle error
-				});
 			return {
 				locale: consentManager.current.translator.locale,
 				getConsent: handleGetConsent,
@@ -190,6 +176,32 @@ export const Osano: React.FunctionComponent<
 			consentManager.current.loaded,
 		]);
 
+		useEffect(() => {
+			consentManager.current
+				.load({
+					customerId,
+					configId,
+					onConfigLoadSuccess,
+					onConfigLoadFailure,
+					onLangLoadSuccess,
+					onLangLoadFailure,
+				})
+				.then((reloadProps) => {
+					// We need to reset the state when the configId or customerId changes
+					dispatch(
+						reload({
+							configId: reloadProps.configId,
+							customerId: reloadProps.customerId,
+							consent: reloadProps.consent,
+						}),
+					);
+					return reloadProps;
+				})
+				.catch(() => {
+					// TODO: Handle error
+				});
+		}, [configId, customerId]);
+
 		useEffect(() => {
 			consentManager.current.config.type = flavor;
 		}, [flavor]);