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

package/src/iab/gpp/encoders/FixedIntegerRangeEncoder.ts

@@ -0,0 +1,102 @@
+/**
+ * Adapted from IABTechLab's GPP JavaScript Reference Implementation
+ *
+ * https://github.com/IABTechLab/iabgpp-es/blob/42060d7ac2b6d0ee70fc1b5bcd33fc447bf5123c/modules/cmpapi/src/encoder/datatype/encoder/FixedIntegerRangeEncoder.ts
+ *
+ * @license
+ * Copyright 2023 IABTechLab
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License. You may obtain a copy of
+ * the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ */
+
+import {
+	decode as intDecode,
+	encode as intEncode,
+} from './FixedIntegerEncoder';
+
+import { InvalidBitStringError } from './errors';
+import { decode as boolDecode } from './BooleanEncoder';
+
+export const encode = (value: number[]) => {
+	value.sort((n1, n2) => n1 - n2);
+
+	const groups = [];
+
+	let groupStartIndex = 0;
+	while (groupStartIndex < value.length) {
+		let groupEndIndex = groupStartIndex;
+		while (
+			groupEndIndex < value.length - 1 &&
+			value[groupEndIndex]! + 1 === value[groupEndIndex + 1]
+		) {
+			groupEndIndex++;
+		}
+
+		groups.push(value.slice(groupStartIndex, groupEndIndex + 1));
+
+		groupStartIndex = groupEndIndex + 1;
+	}
+
+	let bitString = intEncode(groups.length, 12);
+	for (let i = 0; i < groups.length; i++) {
+		const group = groups[i]!;
+		if (group.length > 0) {
+			if (group.length === 1) {
+				bitString += '0' + intEncode(group[0]!, 16);
+			} else {
+				bitString +=
+					'1' +
+					intEncode(group[0]!, 16) +
+					intEncode(group[group.length - 1]!, 16);
+			}
+		}
+	}
+	return bitString;
+};
+
+export const decode = (bitString: string) => {
+	if (!/^[01]{12,}$/.test(bitString)) {
+		throw new InvalidBitStringError(bitString);
+	}
+
+	const value = [];
+	const count = intDecode(bitString.substring(0, 12));
+	let startIndex = 12;
+	for (let i = 0; i < count; i++) {
+		const group = boolDecode(bitString.substring(startIndex, startIndex + 1));
+		startIndex++;
+
+		if (group === true) {
+			const start = intDecode(bitString.substring(startIndex, startIndex + 16));
+			startIndex += 16;
+
+			const end = intDecode(bitString.substring(startIndex, startIndex + 16));
+			startIndex += 16;
+
+			for (let j = start; j <= end; j++) {
+				value.push(j);
+			}
+		} else {
+			const val = intDecode(bitString.substring(startIndex, startIndex + 16));
+			value.push(val);
+			startIndex += 16;
+		}
+	}
+
+	return value;
+};
+
+export default {
+	decode,
+	encode,
+};

package/src/iab/gpp/encoders/FixedStringEncoder.ts

@@ -0,0 +1,74 @@
+/**
+ * Adapted from IABTechLab's GPP JavaScript Reference Implementation
+ *
+ * https://github.com/IABTechLab/iabgpp-es/blob/42060d7ac2b6d0ee70fc1b5bcd33fc447bf5123c/modules/cmpapi/src/encoder/datatype/encoder/FixedStringEncoder.ts
+ *
+ * @license
+ * Copyright 2023 IABTechLab
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License. You may obtain a copy of
+ * the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ */
+
+import { InvalidBitStringError, InvalidStringCharacterError } from './errors';
+import {
+	decode as intDecode,
+	encode as intEncode,
+} from './FixedIntegerEncoder';
+import type { Codable } from './types';
+
+export const encode = (value: string, stringLength: number) => {
+	// String.prototype.padEnd causes CoreJS to include a polyfill for it.
+	value =
+		value.length >= stringLength
+			? value
+			: value + ' '.repeat(stringLength - value.length);
+
+	let bitString = '';
+	for (let i = 0; i < value.length; i++) {
+		const code = value.charCodeAt(i);
+		if (code === 32) {
+			// space
+			bitString += intEncode(63, 6);
+		} else if (code >= 65) {
+			bitString += intEncode(value.charCodeAt(i) - 65, 6);
+		} else {
+			throw new InvalidStringCharacterError(value);
+		}
+	}
+
+	return bitString;
+};
+
+export const decode = (bitString: string) => {
+	if (!/^[01]*$/.test(bitString) || bitString.length % 6 !== 0) {
+		throw new InvalidBitStringError(bitString);
+	}
+
+	let value = '';
+
+	for (let i = 0; i < bitString.length; i += 6) {
+		const code = intDecode(bitString.substring(i, i + 6));
+		if (code === 63) {
+			value += ' ';
+		} else {
+			value += String.fromCharCode(code + 65);
+		}
+	}
+
+	return value.trim();
+};
+
+export default {
+	decode,
+	encode,
+} as Codable;

package/src/iab/gpp/encoders/LICENSE-IABTechLab

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/src/iab/gpp/encoders/TraditionalBase64UrlEncoder.ts

@@ -0,0 +1,38 @@
+/**
+ * Adapted from IABTechLab's GPP JavaScript Reference Implementation
+ *
+ * https://github.com/IABTechLab/iabgpp-es/blob/42060d7ac2b6d0ee70fc1b5bcd33fc447bf5123c/modules/cmpapi/src/encoder/datatype/encoder/TraditionalBase64UrlEncoder.ts
+ *
+ * @license
+ * Copyright 2023 IABTechLab
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License. You may obtain a copy of
+ * the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ */
+
+import { decode, makeEncode } from './AbstractBase64UrlEncoder';
+
+const pad = (bitString: string) => {
+	while (bitString.length % 24 > 0) {
+		bitString += '0';
+	}
+	return bitString;
+};
+
+export const encode = makeEncode(pad);
+
+export { decode } from './AbstractBase64UrlEncoder';
+
+export default {
+	decode,
+	encode,
+};

package/src/iab/gpp/encoders/errors.ts

@@ -0,0 +1,41 @@
+export class InvalidBitStringError extends Error {
+	constructor(value: string | undefined) {
+		super(value);
+		this.name = 'InvalidBitStringError';
+	}
+}
+
+export class InvalidBase64UrlError extends Error {
+	constructor(value: string | undefined) {
+		super(value);
+		this.name = 'InvalidBase64UrlError';
+	}
+}
+
+export class InvalidSizeError extends Error {
+	constructor(value: number, bits: number) {
+		super(`Value ${value} does not fit in ${bits} bits`);
+		this.name = 'InvalidSizeError';
+	}
+}
+
+export class BitStringParametersMatchError extends Error {
+	constructor(
+		bitString: string,
+		parameters: { elementBitStringLength: number; numElements: number },
+	) {
+		super(
+			`'${bitString}' does not match given parameters ${JSON.stringify(
+				parameters,
+			)}`,
+		);
+		this.name = 'BitStringParameterMatchError';
+	}
+}
+
+export class InvalidStringCharacterError extends Error {
+	constructor(value: string | undefined) {
+		super(value);
+		this.name = 'InvalidStringCharacterError';
+	}
+}

package/src/iab/gpp/encoders/index.ts

@@ -0,0 +1,15 @@
+export type { Codable } from './types';
+export { default as AbstractBase64UrlEncoder } from './AbstractBase64UrlEncoder';
+export { default as BooleanEncoder } from './BooleanEncoder';
+export { default as CompressedBase64UrlEncoder } from './CompressedBase64UrlEncoder';
+export { default as DatetimeEncoder } from './DatetimeEncoder';
+export { default as EncodableOptimizedFixedRange } from './EncodableOptimizedFixedRange';
+export { default as FibonacciIntegerEncoder } from './FibonacciIntegerEncoder';
+export { default as FibonacciIntegerRangeEncoder } from './FibonacciIntegerRangeEncoder';
+export { default as FixedBitfieldEncoder } from './FixedBitfieldEncoder';
+export { default as FixedIdBitMapEncoder } from './FixedIdBitMapEncoder';
+export { default as FixedIntegerEncoder } from './FixedIntegerEncoder';
+export { default as FixedIntegerListEncoder } from './FixedIntegerListEncoder';
+export { default as FixedIntegerRangeEncoder } from './FixedIntegerRangeEncoder';
+export { default as FixedStringEncoder } from './FixedStringEncoder';
+export { default as TraditionalBase64UrlEncoder } from './TraditionalBase64UrlEncoder';

package/src/iab/gpp/encoders/types.ts

@@ -0,0 +1,5 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+export interface Codable {
+	encode: (...args: any[]) => string;
+	decode: (...args: any[]) => unknown;
+}

package/src/iab/gpp/index.js

@@ -0,0 +1,9 @@
+import reducer from './reducer';
+import v1_0 from './v1';
+
+export default {
+	reducer,
+	versions: {
+		v1_0,
+	},
+};

package/src/iab/gpp/reducer.js

@@ -0,0 +1,7 @@
+import { genericReducer } from '../../redux/helpers';
+
+export const initialState = {
+	iab: {},
+};
+
+export default genericReducer(initialState, {});

package/src/iab/gpp/selectors.js

@@ -0,0 +1,21 @@
+import { SECTIONS } from './constants';
+import { ScreenIds } from '../../constants';
+import { get } from '../../utils';
+
+export const isUiVisible = state =>
+	get(state, 'ui.currentScreen', ScreenIds.None) !== ScreenIds.None;
+export const getSupportedApis = state =>
+	// We check state to filter out any unloaded section (e.g. if this is the
+	// non-IAB build then 'tcfeuv2' should not be returned because it's not
+	// available) and then use the SECTIONS constant to filter out any
+	// consentStrings that aren't in the spec.
+	Object.keys(get(state, 'iab.consentStrings', {})).filter(
+		section => !!SECTIONS[`${section}`],
+	);
+export const doesGDPRApply = state =>
+	get(state, 'config.gdprApplies', false).toString() === 'true';
+export const isBrowsingFrom = (state, jurisdiction) =>
+	get(state, 'config.jurisdiction', '').substring(0, jurisdiction.length) ===
+	jurisdiction;
+export const getConsentString = (state, section) =>
+	get(state, `iab.consentStrings.${section}`, undefined);

package/src/iab/gpp/types.ts

@@ -0,0 +1,3 @@
+export type Gpp = unknown;
+
+export type Gpp_v2 = Gpp;

package/src/iab/gpp/v1/constants.js

@@ -0,0 +1,7 @@
+export const apiName = '__gpp';
+// gppSection is the key in redux state that stores the consent string.
+export const gppSection = 'gpp';
+export const iframeName = '__gppLocator';
+export const version = '1.0';
+
+export const initOptions = { gppSection, version };

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

@@ -0,0 +1,73 @@
+import { apiName, gppSection, iframeName, initOptions } from './constants';
+import { getConsentString, getSupportedApis, isUiVisible } from '../selectors';
+
+import { types as ActionTypes } from '../../../redux/actions';
+import { EventNames } from '../constants';
+import makeApi from '../api';
+import { makeFormatPingData } from '../consent';
+import postMessageEventHandler from '../../iframe';
+import { setConsentData } from '../../actions';
+
+const formatPingData = makeFormatPingData(initOptions);
+
+export function createMiddleware({ dispatchEvent } = {}) {
+	return store => next => action => {
+		const previousState = store.getState();
+		const result = next(action);
+		const { payload, type } = action;
+		const newState = store.getState();
+		const pingData = formatPingData(newState);
+
+		switch (type) {
+			case setConsentData.type: {
+				const sectionIsSupported = getSupportedApis(newState).includes(
+					payload.gppSection,
+				);
+
+				if (
+					dispatchEvent &&
+					sectionIsSupported &&
+					getConsentString(previousState, payload.gppSection) !== payload.value
+				) {
+					dispatchEvent({
+						eventName: EventNames.SECTION_CHANGED,
+						data: payload.gppSection,
+						pingData,
+					});
+				}
+				break;
+			}
+			case ActionTypes.showDialog:
+			case ActionTypes.showDrawer:
+			case ActionTypes.showDoNotSell:
+			case ActionTypes.hideDialog:
+			case ActionTypes.hideDrawer:
+			case ActionTypes.hideDoNotSell:
+			case ActionTypes.hideAll: {
+				if (
+					dispatchEvent &&
+					isUiVisible(previousState) !== isUiVisible(newState)
+				) {
+					dispatchEvent({
+						eventName: EventNames.CMP_DISPLAY_STATUS_CHANGED,
+						data: pingData.cmpDisplayStatus,
+						pingData,
+					});
+				}
+				break;
+			}
+		}
+		return result;
+	};
+}
+
+const v1 = {
+	api: makeApi(initOptions),
+	apiName,
+	createMiddleware,
+	gppSection,
+	iframeName,
+	postMessageEventHandler: postMessageEventHandler(apiName),
+};
+
+export default v1;

package/src/iab/usp/api.js

@@ -0,0 +1,56 @@
+import { getConsentDataObject, makeGetField } from './consent';
+
+export default function makeApi(initOptions) {
+	function bind(store) {
+		/**
+		 * USPAPI implementation
+		 * @function
+		 * @name __uspapi
+		 * @param {string} command - The command to be executed by the API
+		 * @param {number} version - The version number that the response should adhere to
+		 * @param {requestCallback} callback - The callback method that should be called with the command result
+		 * @param {string} [parameter] - Optional parameter to be passed to the `command`
+		 */
+		return function uspApi(command, version, callback, parameter) {
+			const state = store.getState();
+			const getField = makeGetField(initOptions);
+
+			const getUSPData = (
+				providedState,
+				apiVersion = initOptions.apiVersion,
+			) => {
+				try {
+					const consentData = getConsentDataObject({
+						...initOptions,
+						version: apiVersion,
+					})(providedState);
+					return consentData;
+				} catch (error) {
+					// Could not retrieve data
+					return undefined;
+				}
+			};
+
+			switch (command) {
+				case 'getUSPData': {
+					if (typeof callback === 'function') {
+						const uspData = getUSPData(state, version);
+						callback(uspData, !!uspData);
+					}
+					break;
+				}
+
+				case 'getField': {
+					const field = parameter;
+					return getField(state, field);
+				}
+
+				case 'getSection': {
+					return getUSPData(state, version);
+				}
+			}
+		};
+	}
+
+	return { bind };
+}