feat: ✨ add consent api

src/consent/get-all-checkboxes.ts

@@ -0,0 +1,8 @@
+import { getZaraz } from '../helpers/get-zaraz';
+
+/**
+ * Returns an object with the checkbox status of all purposes.
+ */
+export function getAllCheckboxes(): { [key: string]: boolean } {
+  return getZaraz().consent.getAllCheckboxes();
+}

src/consent/get-all.ts

@@ -0,0 +1,8 @@
+import { getZaraz } from '../helpers/get-zaraz';
+
+/**
+ * Returns an object with the consent status of all purposes.
+ */
+export function getAll(): { [key: string]: boolean } {
+  return getZaraz().consent.getAll();
+}

src/consent/get-purposes.ts

@@ -0,0 +1,14 @@
+import { getZaraz } from '../helpers/get-zaraz';
+
+type Purpose = {
+  name: string;
+  description: string;
+  order: number;
+};
+
+/**
+ * An object containing all configured purposes, with their ID, name, description, and order.
+ */
+export function getPurposes(): { [key: string]: Purpose } {
+  return getZaraz().consent.purposes;
+}

src/consent/get.ts

@@ -0,0 +1,14 @@
+import { getZaraz } from '../helpers/get-zaraz';
+
+/**
+ * Get the current consent status for a purpose using the purpose ID.
+ *
+ * ```
+ * true: The consent was granted.
+ * false: The consent was not granted.
+ * undefined: The purpose does not exist.
+ * ```
+ */
+export function get(purposeId: string): boolean | undefined {
+  return getZaraz().consent.get(purposeId);
+}

src/consent/index.ts

@@ -0,0 +1,19 @@
+import { get } from './get';
+import { getAll } from './get-all';
+import { getAllCheckboxes } from './get-all-checkboxes';
+import { sendQueuedEvents } from './send-queued-events';
+import { set } from './set';
+import { setAll } from './set-all';
+import { setAllCheckboxes } from './set-all-checkboxes';
+import { setCheckboxes } from './set-checkboxes';
+
+export const consent = {
+  get,
+  set,
+  getAll,
+  setAll,
+  getAllCheckboxes,
+  setCheckboxes,
+  setAllCheckboxes,
+  sendQueuedEvents,
+};

src/consent/send-queued-events.ts

@@ -0,0 +1,8 @@
+import { getZaraz } from '../helpers/get-zaraz';
+
+/**
+ * If some Pageview-based events were not sent due to a lack of consent, they can be sent using this method after consent was granted.
+ */
+export function sendQueuedEvents(): void {
+  getZaraz().consent.sendQueuedEvents();
+}

src/consent/set-all-checkboxes.ts

@@ -0,0 +1,8 @@
+import { getZaraz } from '../helpers/get-zaraz';
+
+/**
+ * Set the checkboxStatus status for all purposes in the consent modal at once.
+ */
+export function setAllCheckboxes(checkboxStatus: boolean): void {
+  getZaraz().consent.setAllCheckboxes(checkboxStatus);
+}

src/consent/set-all.ts

@@ -0,0 +1,8 @@
+import { getZaraz } from '../helpers/get-zaraz';
+
+/**
+ * Set the consent status for all purposes at once.
+ */
+export function setAll(consentStatus: boolean): void {
+  getZaraz().consent.setAll(consentStatus);
+}

src/consent/set-checkboxes.ts

@@ -0,0 +1,10 @@
+import { getZaraz } from '../helpers/get-zaraz';
+
+/**
+ * Set the consent status for some purposes using the purpose ID.
+ */
+export function setCheckboxes(checkboxesStatus: {
+  [key: string]: boolean;
+}): void {
+  getZaraz().consent.setCheckboxes(checkboxesStatus);
+}

src/consent/set.ts

@@ -0,0 +1,8 @@
+import { getZaraz } from '../helpers/get-zaraz';
+
+/**
+ * Set the consent status for some purposes using the purpose ID.
+ */
+export function set(consentPreferences: { [key: string]: boolean }): void {
+  getZaraz().consent.set(consentPreferences);
+}

src/index.ts

@@ -1,5 +1,6 @@
 /* istanbul ignore file */
 
+import { consent } from './consent';
 import { ecommerce } from './ecommerce';
 import { set } from './set';
 import { track } from './track';
@@ -15,9 +16,11 @@ export const zaraz = {
   track,
   set,
   ecommerce,
+  consent,
 };
 
 // Export typing etc.
+export * from './consent';
 export * from './ecommerce';
 export * from './set';
 export * from './track';