@osano/osano-cmp-react-native 0.1.0 → 0.3.0

package/src/iab/tcf/types.ts

@@ -1,4 +1,42 @@
-import type { GvlVendor_v2 } from '../types';
+import type { GvlVendor_v2, IabState } from '../types';
+import type { OsanoAction, OsanoState } from '../../types/store';
+
+import type { Codable } from '../gpp/encoders';
+import type { ConsentConfig } from '../../ConsentManager';
+import type { Store } from '../../hooks/useThunkReducer';
+
+export type TcData = {
+	tcString?: string;
+	tcfPolicyVersion: number;
+	cmpId: number;
+	cmpVersion: number;
+	gdprApplies: boolean;
+	cmpStatus: string;
+	eventStatus: string;
+	isServiceSpecific: boolean;
+	useNonStandardStacks: boolean;
+	publisherCC: string;
+	purposeOneTreatment: boolean;
+	outOfBand?: {
+		allowedVendors: Record<string, boolean>;
+		discloseVendors: Record<string, boolean>;
+	};
+	purpose: {
+		consents: Record<string, boolean>;
+		legitimateInterests: Record<string, boolean>;
+	};
+	vendor: {
+		consents: Record<string, boolean>;
+		legitimateInterests: Record<string, boolean>;
+	};
+	specialFeatureOptins: Record<string, boolean>;
+	publisher?: {
+		consents: Record<string, boolean>;
+		legitimateInterests: Record<string, boolean>;
+		customPurpose: Record<string, boolean>;
+		restrictions: Record<string, Record<string, number>>;
+	};
+};
 
 export type Tcf = {
 	gdprApplies: boolean;
@@ -7,7 +45,73 @@ export type Tcf = {
 export type Tcf_v2 = Tcf & {
 	vendors: Record<number, GvlVendor_v2>;
 	vendorListVersion: number;
-	purposeOptouts: Record<number, boolean>;
-	specialFeatureOptouts: Record<number, boolean>;
-	vendorOptouts: Record<number, boolean>;
+	purposeOptouts: Record<number | string, boolean>;
+	specialFeatureOptins: Record<number | string, boolean>;
+	vendorOptouts: Record<number | string, boolean>;
+};
+
+export type GppVersionType = '1';
+export type TcfVersionType = '2' | '2.0' | '2.1';
+export type UspVersionType = '1';
+export type TcfVersion<V> = V extends '2' | '2.0' | '2.1' ? Tcf_v2 : never;
+
+export type TcfState = {
+	gdprApplies?: boolean;
+	v2?: Partial<Tcf_v2>;
+};
+
+export type AdaptedCodable = {
+	decode: (
+		bitString: string,
+		numBits: number
+	) => { bitLength: number; value: unknown };
+	encode: (...args: any[]) => string;
+};
+export type CoreField = [string, number, AdaptedCodable, string?, Function?];
+
+export type IabInitOptions = {
+	defaultTimestamp: number;
+	storageKey: string;
+	version: TcfVersionType;
+	cmpId: number;
+	cmpVersion: number;
+	coreFieldSequence: CoreField[];
+	createConsentPayload: (state?: IabState) => Partial<TcfState>;
+	tcString: string;
+	fallbackGvlVersion: number;
+	gppSection: string;
+	specFieldMode?: boolean;
+	staticFields: Record<string, any>;
+	dynamicFields: Record<
+		string,
+		(initOptions: IabInitOptions, state: OsanoState & IabState) => any
+	>;
+	encoder: Codable;
+};
+
+export type IabMiddlewareFactory = (
+	initOptions: IabInitOptions
+) => (
+	store: Store<OsanoState & IabState, OsanoAction>
+) => (
+	next: (action: OsanoAction) => OsanoState & IabState
+) => (action: OsanoAction) => OsanoState & IabState;
+
+export type TcfController = IabInitOptions & {
+	consentFromOptions: (
+		config: ConsentConfig,
+		state: OsanoState & IabState
+	) => TcData;
+	formatConsentString: (
+		config: ConsentConfig,
+		state: OsanoState & IabState
+	) => string;
+	parseConsentString: (tcString: string) => TcData;
+	readFromStorage: (storage: Partial<Tcf_v2>) => TcfState;
+	middleware?: ReturnType<IabMiddlewareFactory>;
+	reducer?: (
+		state: OsanoState & IabState,
+		action: OsanoAction
+	) => OsanoState & IabState;
+	selectors?: Record<string, Function>;
 };

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

@@ -9,22 +9,13 @@ import {
 
 export { EncodableOptimizedFixedRange } from '../../gpp/encoders';
 
-/**
- * @typedef Encoder
- * @type {object}
- * @property {function(string, number?, ...params): {bitLength: number, value: any}} decode
- * @property {function(any, number?, ...params): string} encode
- */
-
-// This provides a consistent structure on decode()
-const adaptEncoder = (encoder: Codable) =>
-	({
-		decode: (bitString: string, numBits: number) => ({
-			bitLength: numBits,
-			value: encoder.decode(bitString, numBits),
-		}),
-		encode: encoder.encode,
-	}) as Codable;
+const adaptEncoder = (encoder: Codable) => ({
+	decode: (bitString: string, numBits: number) => ({
+		bitLength: numBits,
+		value: encoder.decode(bitString, numBits),
+	}),
+	encode: encoder.encode,
+});
 
 export const BitEncoder = adaptEncoder(BooleanEncoder);
 export const DateEncoder = adaptEncoder(DatetimeEncoder);

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

@@ -0,0 +1,18 @@
+export const idsOnlyArrayFormatter = (value: Record<number, boolean>) =>
+	Object.entries(value)
+		.filter(([, v]) => v)
+		.map(([k]) => parseInt(k, 10));
+
+export const fixedValuesArrayFormatter = (
+	idValueMap: Record<number, boolean>,
+	length: number
+) => {
+	const array: boolean[] = new Array(length).fill(false);
+	for (const [k, v] of Object.entries(idValueMap)) {
+		array[parseInt(k, 10) - 1] = v;
+	}
+	return array;
+};
+
+export const dateFormatter = (deciseconds: number) =>
+	new Date(deciseconds * 100);

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

@@ -0,0 +1,40 @@
+import {
+	makeConsentFromOptions,
+	makeFormatConsentString,
+	makeParseConsentString,
+	makeReadFromStorage,
+} from '../consent';
+
+import type { TcfController } from '../types';
+import makeMiddleware from '../middleware';
+import makeReducer from '../reducer';
+import { initOptions as tcfcav1InitOptions } from './tcfcav1-constants';
+import { initOptions as tcfeuv2InitOptions } from './tcfeuv2-constants';
+
+/**
+ * TCF-Canada v1 is nearly identical to TCF-EU v2, just with a few fields left
+ * out and some renamed. As such, it makes use of the same state data as
+ * tcfeuv2, so there is an implicit dependency on tcfeuv2's reducer.
+ */
+
+const tcfeuv2 = {
+	...tcfeuv2InitOptions,
+	middleware: makeMiddleware(tcfeuv2InitOptions),
+	reducer: makeReducer(tcfeuv2InitOptions),
+	consentFromOptions: makeConsentFromOptions(tcfeuv2InitOptions),
+	formatConsentString: makeFormatConsentString(tcfeuv2InitOptions),
+	parseConsentString: makeParseConsentString(tcfeuv2InitOptions),
+	readFromStorage: makeReadFromStorage(tcfeuv2InitOptions),
+} as TcfController;
+
+const tcfcav1 = {
+	...tcfcav1InitOptions,
+	middleware: makeMiddleware(tcfcav1InitOptions),
+	reducer: makeReducer(tcfcav1InitOptions),
+	consentFromOptions: makeConsentFromOptions(tcfcav1InitOptions),
+	formatConsentString: makeFormatConsentString(tcfcav1InitOptions),
+	parseConsentString: makeParseConsentString(tcfcav1InitOptions),
+	readFromStorage: makeReadFromStorage(tcfcav1InitOptions),
+} as TcfController;
+
+export default { tcfeuv2, tcfcav1 };

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

@@ -0,0 +1,53 @@
+import * as selectors from '../selectors';
+
+import { CMP_ID, IAB_CMP_VERSION } from '../../constants';
+import type { TcfState, TcfVersionType } from '../types';
+
+import type { IabState } from '../../types';
+
+const version: TcfVersionType = '2.0';
+const storageKey = 'IABTCF_TCString';
+/**
+ * We'll use this value of the GVL when the customer's config doesn't contain
+ * one. It's from March 2023.
+ */
+const FALLBACK_GVL_VERSION = 187;
+
+export const baseInitOptions = {
+	storageKey,
+	version,
+	cmpId: CMP_ID,
+	cmpVersion: IAB_CMP_VERSION,
+	fallbackGvlVersion: FALLBACK_GVL_VERSION,
+	defaultTimestamp: Date.now(),
+	selectors: {
+		...selectors,
+	},
+	createConsentPayload(state?: IabState): Partial<TcfState> {
+		return {
+			v2: {
+				purposeOptouts: (state
+					? Object.fromEntries(
+							Object.entries(
+								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)
+						)
+					: {}) as Record<string | number, boolean>,
+				vendorOptouts: (state
+					? Object.fromEntries(
+							Object.entries(selectors.getVendorOptOuts(state, version)).filter(
+								([, value]) => !!value
+							)
+						)
+					: {}) as Record<string | number, boolean>,
+			},
+		};
+	},
+};

package/src/iab/tcf/v2.0/{tcfcav1-constants.js → tcfcav1-constants.ts}

@@ -12,9 +12,10 @@ import {
 	idsOnlyArrayFormatter,
 } from './formatters';
 
+import type { CoreField } from '../types';
 import { baseInitOptions } from './shared-constants';
 import compressedBase64UrlEncoder from '../../gpp/encoders/CompressedBase64UrlEncoder';
-import { createUTCTimestampInDeciseconds } from './helpers';
+import { createUTCTimestampInDeciseconds } from '../helpers';
 
 // gppSection is the key in redux state that stores the consent string.
 const gppSection = 'tcfcav1';
@@ -25,22 +26,10 @@ const gppSection = 'tcfcav1';
  */
 const BOOTSTRAP_TCSTRING = 'COsdsoAOsdsoAAAAAAAAAACAAAAAAAAAAAAAAAAA';
 
-/**
- * @typedef CoreField
- * @type {array}
- * @property {string} 0 - The name of the field in the GPPModel
- * <https://github.com/IABTechLab/iabgpp-es/blob/42060d7ac2b6d0ee70fc1b5bcd33fc447bf5123c/README.md#fields>
- * @property {number} 1 - The number of bits to encode the field
- * @property {Encoder} 2 - The encoder to use for this field
- * @property {string} 3 - The path to the value in our TCF object
- * @property {string} [4] - The formatter to use for this field for the client API calls
- */
-
 /**
  * The core fields of the TCString for TCF-Canada v1.
- * @type {CoreField[]}
  */
-const coreFieldSequence = [
+const coreFieldSequence: CoreField[] = [
 	['Version', 6, IntEncoder, 'version'],
 	['Created', 36, DateEncoder, 'created', dateFormatter],
 	['LastUpdated', 36, DateEncoder, 'lastUpdated', dateFormatter],
@@ -90,7 +79,7 @@ const coreFieldSequence = [
 	],
 ];
 
-const version = parseInt(baseInitOptions.version, 10);
+const version = Number.parseInt(baseInitOptions.version, 10);
 const staticFields = {
 	version,
 	cmpId: baseInitOptions.cmpId,

package/src/iab/tcf/v2.0/{tcfeuv2-constants.js → tcfeuv2-constants.ts}

@@ -7,8 +7,9 @@ import {
 	LangEncoder,
 } from './encoders';
 
+import type { CoreField } from '../types';
 import { baseInitOptions } from './shared-constants';
-import { createUTCTimestampInDeciseconds } from './helpers';
+import { createUTCTimestampInDeciseconds } from '../helpers';
 import traditionalBase64UrlEncoder from '../../gpp/encoders/TraditionalBase64UrlEncoder';
 
 export const apiName = '__tcfapi';
@@ -32,24 +33,13 @@ const gppSection = 'tcfeuv2';
  */
 const BOOTSTRAP_TCSTRING = 'CPpshUAPpshUAEXABAENAACwAIBAAAAAAAAAAAAAAAAA';
 
-/**
- * @typedef CoreField
- * @type {array}
- * @property {string} 0 - The name of the field in the TCModel
- * <https://github.com/InteractiveAdvertisingBureau/iabtcf-es/blob/e952844c689351a51b15d71b9dd43ee085c2f7f3/modules/core/src/TCModel.ts>
- * @property {number} 1 - The number of bits to encode the field
- * @property {Encoder} 2 - The encoder to use for this field
- * @property {string} [3] - The path to the value in our TCF object if it is different from the TCModel
- */
-
 /**
  * The core fields of the TCString in the order they appear in the TCString
  * Reference spec doc: https://github.com/InteractiveAdvertisingBureau/GDPR-Transparency-and-Consent-Framework/blob/master/TCFv2/IAB%20Tech%20Lab%20-%20Consent%20string%20and%20vendor%20list%20formats%20v2.md#the-core-string
  *
  * Note: some field names conflict with the TCModel<https://github.com/IABTechLab/iabgpp-es/blob/42060d7ac2b6d0ee70fc1b5bcd33fc447bf5123c/modules/cmpapi/src/encoder/field/TcfEuV2Field.ts>. We may need to resolve these conflicts. See comments below for specific fields.
- * @type {CoreField[]}
  */
-const coreFieldSequence = [
+const coreFieldSequence: CoreField[] = [
 	['version', 6, IntEncoder],
 	['created', 36, DateEncoder],
 	['lastUpdated', 36, DateEncoder],
@@ -89,7 +79,7 @@ const coreFieldSequence = [
 	['numPubRestrictions', 12, IntEncoder], // This is a meta field and shouldn't be exposed directly via an API
 ];
 
-const version = parseInt(baseInitOptions.version, 10);
+const version = Number.parseInt(baseInitOptions.version, 10);
 const staticFields = {
 	version,
 	cmpId: baseInitOptions.cmpId,

package/src/iab/types.ts

@@ -1,5 +1,7 @@
+import type { OsanoAction, OsanoState } from '../types/store';
+import type { TcfController, TcfState, Tcf_v2 } from './tcf/types';
+
 import type { Gpp_v2 } from './gpp/types';
-import type { Tcf_v2 } from './tcf/types';
 import type { Usp } from './usp/types';
 
 type GvlVendor = {
@@ -17,6 +19,7 @@ type GvlVendor = {
 	cookieRefresh?: boolean;
 	usesNonCookieAccess?: boolean;
 	deviceStorageDisclosureUrl?: string;
+	deletedDate?: string;
 };
 
 export type GvlUrl = {
@@ -42,7 +45,9 @@ export type GvlVendor_v3 = GvlVendor & {
 };
 
 export type Iab = {
+	consentStrings?: Record<string, string>;
 	enabled?: boolean;
+	hasActed?: Record<string, boolean>;
 	notified?: boolean;
 	signatory?: boolean;
 	hideOptOut?: boolean;
@@ -52,10 +57,7 @@ export type Iab = {
 		vendors?: number[]; // The vendor ids that are enabled
 	};
 	gpp?: Gpp_v2;
-	tcf?: {
-		enabled: boolean;
-		v2?: Tcf_v2;
-	};
+	tcf?: TcfState;
 	usp?: Usp;
 };
 
@@ -65,3 +67,17 @@ export type IabDisclosureType = {
 	descriptionLegal: string;
 	illustrations?: Record<string, string>;
 };
+
+export type IabState = {
+	iab: Iab;
+};
+
+export type IabFrameworkType = 'tcf' | 'usp' | 'gpp';
+
+export type IabFramework = {
+	reducer?: (
+		state: OsanoState & IabState,
+		action: OsanoAction
+	) => OsanoState & IabState;
+	versions: TcfController[];
+};