whale-cmp 0.25.2 → 0.26.0

package/index.d.ts

@@ -6,12 +6,29 @@ export interface OpenTouUIOptions {
     touCallback?: () => void;
 }
 
+export interface OpenAgreementUIOptions {
+    /**
+     * Called after the user presses Consent or Do not consent and the page closes.
+     * Back and exit do not dismiss a page opened with openAgreementUI.
+     */
+    agreementCallback?: (result?: { consent: boolean }) => void;
+}
+
+export interface ConsentDataReady {
+    /** 0 Do not consent, 1 Consent, 2 Management options completed */
+    status: 0 | 1 | 2;
+}
+
 export interface WhaleCMPOptions {
     ele?: Element;
     language?: SupportedLanguage;
     cpId?: string;
     /** @deprecated use cpId */
     cpid?: string;
+    /**
+     * Fired after Consent, Do not consent, or a completed QR management flow.
+     */
+    consentCallback?: (data: ConsentDataReady) => void;
     [key: string]: unknown;
 }
 
@@ -65,6 +82,12 @@ export declare class WhaleCMP {
      */
     openTouUI(options?: OpenTouUIOptions): void;
 
+    /**
+     * Open the personalized-ads consent page directly.
+     * Back and exit are ignored. Consent / Do not consent are reported through agreementCallback.
+     */
+    openAgreementUI(options?: OpenAgreementUIOptions): void;
+
     /**
      * Force-close TouchUI even when exit blocking is enabled.
      */

package/index.html

@@ -20,6 +20,7 @@
     // cmp.openTouUI({touCallback: e=>{
     //     console.log(e)
     // }})
+    // cmp.openAgreementUI({ agreementCallback: (result) => console.log(result) })
     cmp.open()
     document.addEventListener("keydown", e => {
         cmp.onKeydown(e)