@everymatrix/user-action-controller 1.0.0 → 1.0.70

package/dist/collection/components/user-action-controller/user-action-controller.js

@@ -1,335 +1,425 @@
-import { Component, h, Prop, Listen, State, Watch, Event } from '@stencil/core';
-import '@everymatrix/legislation-wrapper';
-import '@everymatrix/generic-user-consent';
+import { h } from "@stencil/core";
+import { getTranslations, translate } from "../../utils/locale.utils";
+import "../../../../../player-user-consents/dist/types/index";
 export class UserActionController {
-  constructor() {
-    /**
-     * Event name to be sent when the button is clicked
-     */
-    this.postMessageEvent = 'closeButtonClicked';
-    this.consentTitles = {
-      termsandconditions: "Terms and Conditions",
-      sms: "SMS marketing",
-      emailmarketing: "Email marketing"
-    };
-    /**
-     * Which actions are required in order to activate the "Apply" button. Other actions are considered optional.
-     */
-    this.queryFired = false;
-    this.readyActionsCount = 0;
-    this.receivedQueryResponses = 0;
-    this.mandatoryActions = ['termsandconditions'];
-    this.requiredActionsCount = 0;
-    this.expectedQueryResponses = 0;
-    this.userActions = [];
-  }
-  determineMandatoryActions() {
-    let url = new URL(`${this.endpoint}v1/player/consentRequirements`);
-    return fetch(url.href)
-      .then(res => res.json())
-      .then(data => {
-      data.items.forEach(action => {
-        action.mustAccept && this.mandatoryActions.push(action.tagCode);
-      });
-    });
-  }
-  handleQueryResponse() {
-    if (this.receivedQueryResponses === this.expectedQueryResponses) {
-      this.updateUserConsents();
+    constructor() {
+        //for now this variable is hardcoded bcs we have terms and conditions and privacy policy mandatory and we dont receive with these new functionality the mandatory actions
+        this.mandatoryActions = ['termsandconditions', 'privacypolicy'];
+        this.userActions = [];
+        this.consentTitles = {
+            termsandconditions: translate('termsAndConditionsTitle', this.lang),
+            sms: translate('smsTitle', this.lang),
+            emailmarketing: translate('emailMarketingTitle', this.lang),
+            privacypolicy: translate('privacyPolicyTitle', this.lang)
+        };
+        this.setClientStyling = () => {
+            let sheet = document.createElement('style');
+            sheet.innerHTML = this.clientStyling;
+            this.stylingContainer.prepend(sheet);
+        };
+        this.setClientStylingURL = () => {
+            let url = new URL(this.clientStylingUrl);
+            let cssFile = document.createElement('style');
+            fetch(url.href)
+                .then((res) => res.text())
+                .then((data) => {
+                this.clientStyling = data;
+                cssFile.innerHTML = data;
+                setTimeout(() => { this.stylingContainer.prepend(cssFile); }, 1);
+            })
+                .catch((err) => {
+                console.log('error ', err);
+            });
+        };
+        this.endpoint = undefined;
+        this.userSession = undefined;
+        this.userId = undefined;
+        this.lang = 'en';
+        this.includeSubmitButton = undefined;
+        this.gmVersion = '';
+        this.translationUrl = '';
+        this.clientStyling = '';
+        this.clientStylingUrl = '';
+        this.queryFired = false;
+        this.readyActionsCount = 0;
+        this.activeUserActions = [];
+        this.userActionsValidated = true;
+        this.receivedQueryResponses = 0;
+        this.limitStylingAppends = false;
+        this.isLoading = true;
+        this.mandatoryActionsChecked = 0;
+        this.mandatoryItems = undefined;
     }
-  }
-  updateUserConsents() {
-    const url = new URL(`${this.endpoint}v1/player/${this.userId}/consent`);
-    let body = {
-      items: this.userActions
-    };
-    let options = {
-      method: 'POST',
-      headers: {
-        'Content-Type': 'application/json',
-        'Accept': 'application/json',
-        'X-SessionId': `${this.userSession}`,
-      },
-      body: JSON.stringify(body)
-    };
-    fetch(url.href, options)
-      .then(res => res.json())
-      .then(() => {
-      /**
-       * @TODO document this
-       */
-      window.postMessage({ type: 'WidgetNotification', data: {
-          type: 'success',
-          message: 'Consent update successfull!'
-        } }, window.location.href);
-    })
-      .catch((err) => {
-      /**
-       * @TODO document this
-       */
-      window.postMessage({ type: 'WidgetNotification', data: {
-          type: 'error',
-          message: 'Server might not be responding',
-          err
-        } }, window.location.href);
-    })
-      .finally(() => {
-      window.postMessage({ type: "UserActionsCompleted" }, window.location.href);
-    });
-  }
-  handleApplyClick() {
-    this.queryFired = true;
-  }
-  handleClose() {
-    if (this.usePostmessage) {
-      window.postMessage({ type: this.postMessageEvent });
+    handleNewTranslations() {
+        getTranslations(this.translationUrl);
     }
-    this.closeButtonEvent.emit();
-  }
-  userLegislationConsentHandler(event) {
-    // Increase / Decrease the amount of mandatory actions taken
-    if (this.mandatoryActions.includes(event.detail.type)) {
-      if (event.detail.value)
-        this.readyActionsCount++;
-      else
-        this.readyActionsCount--;
+    handleQueryResponse() {
+        if (this.receivedQueryResponses === this.activeUserActions.length) {
+            this.updateUserConsents();
+        }
     }
-    // Register final user choices only if we're ready to update
-    if (this.queryFired) {
-      this.userActions.push({ tagCode: event.detail.type, status: event.detail.value ? 'Accepted' : 'Denied' });
-      this.receivedQueryResponses++;
+    userLegislationConsentHandler(event) {
+        const actionType = event.detail.type;
+        const actionTypeChecked = event.detail.value;
+        if (this.mandatoryActions.includes(actionType) && this.queryFired === false) {
+            actionTypeChecked === true ? this.mandatoryActionsChecked++ : this.mandatoryActionsChecked--;
+        }
+        // Register final user choices only if we're ready to update
+        if (this.queryFired) {
+            const determineStatus = (checked, version) => {
+                if (version === 'gm16') {
+                    return checked ? 1 : 0;
+                }
+                return checked ? 'Accepted' : 'Denied';
+            };
+            this.userActions.push(Object.assign({ tagCode: actionType, status: determineStatus(actionTypeChecked, this.gmVersion) }, (this.gmVersion === 'gm16' && { note: '' })));
+            this.receivedQueryResponses++;
+        }
     }
-  }
-  // Returning a promise here will ensure that the fetch completes before we render the component
-  componentWillLoad() {
-    return this.determineMandatoryActions();
-  }
-  render() {
-    const activeUAList = this.activeUserActions.replace(/ /g, '').split(',');
-    this.requiredActionsCount = activeUAList.filter(action => this.mandatoryActions.includes(action)).length;
-    this.expectedQueryResponses = activeUAList.length;
-    return (h("div", { class: "QueryReferenceContainer" },
-      h("div", { class: "UserActionController" },
-        this.showCloseButton &&
-          h("div", { class: "CloseButton", onClick: () => this.handleClose() },
-            h("svg", { xmlns: "http://www.w3.org/2000/svg", width: "25", height: "25", fill: "currentColor", viewBox: "0 0 16 16" },
-              h("path", { d: "M4.646 4.646a.5.5 0 0 1 .708 0L8 7.293l2.646-2.647a.5.5 0 0 1 .708.708L8.707 8l2.647 2.646a.5.5 0 0 1-.708.708L8 8.707l-2.646 2.647a.5.5 0 0 1-.708-.708L7.293 8 4.646 5.354a.5.5 0 0 1 0-.708z" }))),
-        h("h2", { class: "UserConsentNotice" }, this.userNoticeText),
-        h("legislation-wrapper", { "active-user-actions": this.activeUserActions }, activeUAList.map(item => (h("generic-user-consent", { slot: item, consentType: item, consentTitle: this.consentTitles[item], queried: this.queryFired, mandatory: this.mandatoryActions.includes(item) })))),
-        this.includeSubmitButton &&
-          h("button", { class: "ConsentSubmitButton", disabled: this.readyActionsCount === this.requiredActionsCount ? false : true, onClick: () => this.handleApplyClick() }, this.submitButtonText))));
-  }
-  static get is() { return "user-action-controller"; }
-  static get encapsulation() { return "shadow"; }
-  static get originalStyleUrls() { return {
-    "$": ["user-action-controller.scss"]
-  }; }
-  static get styleUrls() { return {
-    "$": ["user-action-controller.css"]
-  }; }
-  static get properties() { return {
-    "endpoint": {
-      "type": "string",
-      "mutable": false,
-      "complexType": {
-        "original": "string",
-        "resolved": "string",
-        "references": {}
-      },
-      "required": true,
-      "optional": false,
-      "docs": {
-        "tags": [],
-        "text": "the endpoint required for the update call"
-      },
-      "attribute": "endpoint",
-      "reflect": false
-    },
-    "userSession": {
-      "type": "string",
-      "mutable": false,
-      "complexType": {
-        "original": "string",
-        "resolved": "string",
-        "references": {}
-      },
-      "required": true,
-      "optional": false,
-      "docs": {
-        "tags": [],
-        "text": "user session required for the update call"
-      },
-      "attribute": "user-session",
-      "reflect": false
-    },
-    "userId": {
-      "type": "string",
-      "mutable": false,
-      "complexType": {
-        "original": "string",
-        "resolved": "string",
-        "references": {}
-      },
-      "required": true,
-      "optional": false,
-      "docs": {
-        "tags": [],
-        "text": "user id required for the update call"
-      },
-      "attribute": "user-id",
-      "reflect": false
-    },
-    "includeSubmitButton": {
-      "type": "boolean",
-      "mutable": false,
-      "complexType": {
-        "original": "boolean",
-        "resolved": "boolean",
-        "references": {}
-      },
-      "required": true,
-      "optional": false,
-      "docs": {
-        "tags": [],
-        "text": "wether or not to include the submit button (in case we want to compose a different )"
-      },
-      "attribute": "include-submit-button",
-      "reflect": false
-    },
-    "submitButtonText": {
-      "type": "string",
-      "mutable": false,
-      "complexType": {
-        "original": "string",
-        "resolved": "string",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [],
-        "text": "the text of the button, if button is enabled"
-      },
-      "attribute": "submit-button-text",
-      "reflect": false
-    },
-    "userNoticeText": {
-      "type": "string",
-      "mutable": false,
-      "complexType": {
-        "original": "string",
-        "resolved": "string",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [],
-        "text": "the title of the action group"
-      },
-      "attribute": "user-notice-text",
-      "reflect": false
-    },
-    "activeUserActions": {
-      "type": "string",
-      "mutable": false,
-      "complexType": {
-        "original": "string",
-        "resolved": "string",
-        "references": {}
-      },
-      "required": true,
-      "optional": false,
-      "docs": {
-        "tags": [],
-        "text": "which user action widgets are included"
-      },
-      "attribute": "active-user-actions",
-      "reflect": false
-    },
-    "showCloseButton": {
-      "type": "boolean",
-      "mutable": false,
-      "complexType": {
-        "original": "boolean",
-        "resolved": "boolean",
-        "references": {}
-      },
-      "required": true,
-      "optional": false,
-      "docs": {
-        "tags": [],
-        "text": "Property used to display the close/cancel button"
-      },
-      "attribute": "show-close-button",
-      "reflect": false
-    },
-    "usePostmessage": {
-      "type": "boolean",
-      "mutable": false,
-      "complexType": {
-        "original": "boolean",
-        "resolved": "boolean",
-        "references": {}
-      },
-      "required": true,
-      "optional": false,
-      "docs": {
-        "tags": [],
-        "text": "Use postMessage event to communicate"
-      },
-      "attribute": "use-postmessage",
-      "reflect": false
-    },
-    "postMessageEvent": {
-      "type": "string",
-      "mutable": false,
-      "complexType": {
-        "original": "string",
-        "resolved": "string",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [],
-        "text": "Event name to be sent when the button is clicked"
-      },
-      "attribute": "post-message-event",
-      "reflect": false,
-      "defaultValue": "'closeButtonClicked'"
+    determineUserActionsCore() {
+        const url = new URL(`${this.endpoint}/v1/player/${this.userId}/consent`);
+        const headers = new Headers();
+        headers.append('X-SessionId', this.userSession);
+        let requestOptions = {
+            method: 'GET',
+            headers
+        };
+        return fetch(url.href, requestOptions)
+            .then(res => res.json())
+            .then(data => {
+            const actionItems = data.items;
+            actionItems.forEach(element => {
+                if (element.status === 'Expired') {
+                    this.activeUserActions.push(element.tagCode);
+                }
+            });
+            this.isLoading = false;
+        })
+            .catch(error => {
+            console.error('Error fetching data:', error);
+            this.isLoading = false;
+        }).finally(() => {
+            this.calcMandatoryActions();
+            window.postMessage({ type: 'UserActionsExists', displayUserActions: this.mandatoryItems > 0 ? true : false }, window.location.href);
+        });
+    }
+    determineUserActions16() {
+        const url = new URL(`${this.endpoint}/v1/player/${this.userId}/legislation/consents`);
+        const headers = new Headers();
+        headers.append('X-SessionId', this.userSession);
+        let requestOptions = {
+            method: 'GET',
+            headers
+        };
+        return fetch(url.href, requestOptions)
+            .then(res => res.json())
+            .then(data => {
+            const actionItems = data.consents;
+            actionItems.forEach(element => {
+                if (element.status === 2 && element.tagCode !== 'pepconsent') {
+                    this.activeUserActions.push(element.tagCode);
+                }
+            });
+            this.isLoading = false;
+        })
+            .catch(error => {
+            console.error('Error fetching data:', error);
+            this.isLoading = false;
+        }).finally(() => {
+            this.calcMandatoryActions();
+            window.postMessage({ type: 'UserActionsExists', displayUserActions: this.mandatoryItems > 0 ? true : false }, window.location.href);
+        });
+    }
+    updateUserConsents() {
+        const url = (this.gmVersion === 'gmcore')
+            ? new URL(`${this.endpoint}/v1/player/${this.userId}/consent`)
+            : new URL(`${this.endpoint}/v1/player/${this.userId}/legislation/consents`);
+        const body = {
+            consents: this.userActions
+        };
+        let requestOptions = {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+                'Accept': 'application/json',
+                'X-SessionId': `${this.userSession}`,
+            },
+            body: JSON.stringify(body)
+        };
+        fetch(url.href, requestOptions)
+            .then(res => res.json())
+            .then(() => {
+            window.postMessage({
+                type: 'WidgetNotification',
+                data: {
+                    type: 'success',
+                    message: 'Consent update successful!'
+                }
+            }, window.location.href);
+        })
+            .catch((err) => {
+            window.postMessage({
+                type: 'WidgetNotification',
+                data: {
+                    type: 'error',
+                    message: 'Server might not be responding',
+                    err
+                }
+            }, window.location.href);
+        })
+            .finally(() => {
+            window.postMessage({ type: 'UserActionsCompleted' }, window.location.href);
+        });
+    }
+    handleApplyClick() {
+        this.queryFired = true;
+    }
+    async componentWillLoad() {
+        if (this.gmVersion === 'gmcore') {
+            this.determineUserActionsCore();
+        }
+        if (this.gmVersion === 'gm16') {
+            this.determineUserActions16();
+        }
+        if (this.translationUrl.length > 2) {
+            await getTranslations(this.translationUrl);
+        }
+    }
+    componentDidRender() {
+        // start custom styling area
+        if (!this.limitStylingAppends && this.stylingContainer) {
+            if (this.clientStyling)
+                this.setClientStyling();
+            if (this.clientStylingUrl)
+                this.setClientStylingURL();
+            this.limitStylingAppends = true;
+        }
+        // end custom styling area
+    }
+    calcMandatoryActions() {
+        this.mandatoryItems = 0;
+        this.mandatoryActions.map(action => {
+            const isPresent = this.activeUserActions.includes(action);
+            if (isPresent) {
+                this.mandatoryItems++;
+            }
+        });
+    }
+    render() {
+        if (this.mandatoryItems > 0) {
+            this.userActionsValidated = this.mandatoryActionsChecked === this.mandatoryItems;
+            return (h("div", { class: "QueryReferenceContainer", ref: el => this.stylingContainer = el }, this.isLoading ? (h("slot", { name: 'spinner' })
+                &&
+                    h("svg", { class: "spinner", viewBox: "0 0 50 50" }, h("circle", { class: "path", cx: "25", cy: "25", r: "20", fill: "none", "stroke-width": "5" }))) : (h("div", { class: "UserActionController" }, h("h2", { class: "UserConsentNotice" }, translate('userNoticeText', this.lang)), h("div", { class: "PlayerLegislationWrapper" }, this.activeUserActions.map(action => (h("slot", { name: action }, h("player-user-consents", { lang: this.lang, "gm-version": this.gmVersion, "translation-url": this.translationUrl, consentType: action, consentTitle: this.consentTitles[action], queried: this.queryFired, mandatory: this.mandatoryActions.includes(action), "client-styling": this.clientStyling }))))), this.includeSubmitButton &&
+                h("button", { class: "ConsentSubmitButton", disabled: !this.userActionsValidated, onClick: () => this.handleApplyClick() }, translate('submitButtonText', this.lang))))));
+        }
+        else {
+            return;
+        }
+    }
+    static get is() { return "user-action-controller"; }
+    static get encapsulation() { return "shadow"; }
+    static get originalStyleUrls() {
+        return {
+            "$": ["user-action-controller.scss"]
+        };
+    }
+    static get styleUrls() {
+        return {
+            "$": ["user-action-controller.css"]
+        };
+    }
+    static get properties() {
+        return {
+            "endpoint": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string",
+                    "references": {}
+                },
+                "required": true,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "the endpoint required for the update call"
+                },
+                "attribute": "endpoint",
+                "reflect": true
+            },
+            "userSession": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string",
+                    "references": {}
+                },
+                "required": true,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "user session required for the update call"
+                },
+                "attribute": "user-session",
+                "reflect": true
+            },
+            "userId": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string",
+                    "references": {}
+                },
+                "required": true,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "user id required for the update call"
+                },
+                "attribute": "user-id",
+                "reflect": true
+            },
+            "lang": {
+                "type": "string",
+                "mutable": true,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "Language"
+                },
+                "attribute": "lang",
+                "reflect": true,
+                "defaultValue": "'en'"
+            },
+            "includeSubmitButton": {
+                "type": "boolean",
+                "mutable": false,
+                "complexType": {
+                    "original": "boolean",
+                    "resolved": "boolean",
+                    "references": {}
+                },
+                "required": true,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "whether or not to include the submit button (in case we want to compose a different )"
+                },
+                "attribute": "include-submit-button",
+                "reflect": true
+            },
+            "gmVersion": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "Select GM version"
+                },
+                "attribute": "gm-version",
+                "reflect": false,
+                "defaultValue": "''"
+            },
+            "translationUrl": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "Translation url"
+                },
+                "attribute": "translation-url",
+                "reflect": true,
+                "defaultValue": "''"
+            },
+            "clientStyling": {
+                "type": "string",
+                "mutable": true,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "Client custom styling via inline style"
+                },
+                "attribute": "client-styling",
+                "reflect": true,
+                "defaultValue": "''"
+            },
+            "clientStylingUrl": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "Client custom styling via url"
+                },
+                "attribute": "client-styling-url",
+                "reflect": true,
+                "defaultValue": "''"
+            }
+        };
+    }
+    static get states() {
+        return {
+            "queryFired": {},
+            "readyActionsCount": {},
+            "activeUserActions": {},
+            "userActionsValidated": {},
+            "receivedQueryResponses": {},
+            "limitStylingAppends": {},
+            "isLoading": {},
+            "mandatoryActionsChecked": {},
+            "mandatoryItems": {}
+        };
+    }
+    static get watchers() {
+        return [{
+                "propName": "translationUrl",
+                "methodName": "handleNewTranslations"
+            }, {
+                "propName": "receivedQueryResponses",
+                "methodName": "handleQueryResponse"
+            }];
+    }
+    static get listeners() {
+        return [{
+                "name": "userLegislationConsent",
+                "method": "userLegislationConsentHandler",
+                "target": undefined,
+                "capture": false,
+                "passive": false
+            }];
     }
-  }; }
-  static get states() { return {
-    "queryFired": {},
-    "readyActionsCount": {},
-    "receivedQueryResponses": {}
-  }; }
-  static get events() { return [{
-      "method": "closeButtonEvent",
-      "name": "closeButtonClicked",
-      "bubbles": true,
-      "cancelable": true,
-      "composed": true,
-      "docs": {
-        "tags": [],
-        "text": "Event emitted when the close button is clicked"
-      },
-      "complexType": {
-        "original": "any",
-        "resolved": "any",
-        "references": {}
-      }
-    }]; }
-  static get watchers() { return [{
-      "propName": "receivedQueryResponses",
-      "methodName": "handleQueryResponse"
-    }]; }
-  static get listeners() { return [{
-      "name": "userLegislationConsent",
-      "method": "userLegislationConsentHandler",
-      "target": undefined,
-      "capture": false,
-      "passive": false
-    }]; }
 }