Merge pull request #27 from sandstorm/task/callback-methods

[TASK] Allow configuration of callback methods for onInit, onAccept a…
sandstorm · Dec 11, 2024 · f3ba00b · f3ba00b
2 parents 01268ab + e6e254d
commit f3ba00b
Show file tree

Hide file tree

Showing 23 changed files with 4,411 additions and 2,304 deletions.
diff --git a/Configuration/Settings.Translations.yaml b/Configuration/Settings.Translations.yaml
@@ -15,13 +15,16 @@ Sandstorm:
         title: Sandstorm.CookiePunch:Klaro:consentModal.title
       consentNotice:
         changeDescription: Sandstorm.CookiePunch:Klaro:consentNotice.changeDescription
+        title: Sandstorm.CookiePunch:Klaro:consentNotice.title
         description: Sandstorm.CookiePunch:Klaro:consentNotice.description
         learnMore: Sandstorm.CookiePunch:Klaro:consentNotice.learnMore
         testing: Sandstorm.CookiePunch:Klaro:consentNotice.testing
       contextualConsent:
         acceptAlways: Sandstorm.CookiePunch:Klaro:contextualConsent.acceptAlways
         acceptOnce: Sandstorm.CookiePunch:Klaro:contextualConsent.acceptOnce
         description: Sandstorm.CookiePunch:Klaro:contextualConsent.description
+        descriptionEmptyStore: Sandstorm.CookiePunch:Klaro:contextualConsent.descriptionEmptyStore
+        modalLinkText: Sandstorm.CookiePunch:Klaro:contextualConsent.modalLinkText
       decline: Sandstorm.CookiePunch:Klaro:decline
       ok: Sandstorm.CookiePunch:Klaro:ok
       poweredBy: Sandstorm.CookiePunch:Klaro:poweredBy

diff --git a/Examples/Settings.CookiePunch.FullServiceConfig.yaml b/Examples/Settings.CookiePunch.FullServiceConfig.yaml
@@ -47,3 +47,9 @@ Sandstorm:
           # If "onlyOnce" is set to true, the service will only be executed
           # once regardless how often the user toggles it on and off.
           onlyOnce: true
+          # JavaScript code to execute when the service is initialized.
+          onInit: "console.log('init');"
+          # JavaScript code to execute when the user gives consent.
+          onAccept: "console.log('accept');"
+          # JavaScript code to execute when the user declines consent.
+          onDecline: "console.log('decline');"
diff --git a/Resources/Private/Fusion/Config.Translations.fusion b/Resources/Private/Fusion/Config.Translations.fusion
@@ -10,12 +10,15 @@ prototype(Sandstorm.CookiePunch:Config.Translations) < prototype(Neos.Fusion:Dat
     consentModal.description = ${CookiePunchConfig.translate("Sandstorm.CookiePunch.translations.consentModal.description")}
     consentModal.title = ${CookiePunchConfig.translate("Sandstorm.CookiePunch.translations.consentModal.title")}
     consentNotice.changeDescription = ${CookiePunchConfig.translate("Sandstorm.CookiePunch.translations.consentNotice.changeDescription")}
+    consentNotice.title = ${CookiePunchConfig.translate("Sandstorm.CookiePunch.translations.consentNotice.title")}
     consentNotice.description = ${CookiePunchConfig.translate("Sandstorm.CookiePunch.translations.consentNotice.description")}
     consentNotice.learnMore = ${CookiePunchConfig.translate("Sandstorm.CookiePunch.translations.consentNotice.learnMore")}
     consentNotice.testing = ${CookiePunchConfig.translate("Sandstorm.CookiePunch.translations.consentNotice.testing")}
     contextualConsent.acceptAlways = ${CookiePunchConfig.translate("Sandstorm.CookiePunch.translations.contextualConsent.acceptAlways")}
     contextualConsent.acceptOnce = ${CookiePunchConfig.translate("Sandstorm.CookiePunch.translations.contextualConsent.acceptOnce")}
     contextualConsent.description = ${CookiePunchConfig.translate("Sandstorm.CookiePunch.translations.contextualConsent.description")}
+    contextualConsent.descriptionEmptyStore = ${CookiePunchConfig.translate("Sandstorm.CookiePunch.translations.contextualConsent.descriptionEmptyStore")}
+    contextualConsent.modalLinkText = ${CookiePunchConfig.translate("Sandstorm.CookiePunch.translations.contextualConsent.modalLinkText")}
     decline = ${CookiePunchConfig.translate("Sandstorm.CookiePunch.translations.decline")}
     ok = ${CookiePunchConfig.translate("Sandstorm.CookiePunch.translations.ok")}
     poweredBy = ${CookiePunchConfig.translate("Sandstorm.CookiePunch.translations.poweredBy")}

diff --git a/Resources/Private/Fusion/Config.fusion b/Resources/Private/Fusion/Config.fusion
@@ -50,6 +50,9 @@ prototype(Sandstorm.CookiePunch:Config) < prototype(Neos.Fusion:DataStructure) {
                 required = ${item.required}
                 optOut = ${item.optOut}
                 onlyOnce = ${item.onlyOnce}
+                onInit = ${item.onInit}
+                onAccept = ${item.onAccept}
+                onDecline = ${item.onDecline}
             }
         }
 

diff --git a/Resources/Private/JavaScript/Helper/buildKlaroConfig.ts b/Resources/Private/JavaScript/Helper/buildKlaroConfig.ts
@@ -131,6 +131,18 @@ function buildKlaroServicesConfig(
     if (typeof cookiePunchService.onlyOnce === "boolean")
       klaroService.onlyOnce = cookiePunchService.onlyOnce;
 
+    if (cookiePunchService.onInit) {
+      klaroService.onInit = eval("(function() { " + cookiePunchService.onInit + " })");
+    }
+
+    if (cookiePunchService.onAccept) {
+      klaroService.onAccept = eval("(function() { " + cookiePunchService.onAccept + " })");
+    }
+
+    if (cookiePunchService.onDecline) {
+      klaroService.onDecline = eval("(function() { " + cookiePunchService.onDecline + " })");
+    }
+
     result.push(klaroService);
   });
 

diff --git a/Resources/Private/JavaScript/Types/types.ts b/Resources/Private/JavaScript/Types/types.ts
@@ -13,12 +13,15 @@ export type CookiePunchService = {
   optOut?: boolean;
   cookies?: CookiePunchServiceCookies;
   onlyOnce?: boolean;
+  onInit?: string;
+  onAccept?: string;
+  onDecline?: string;
 };
 
 export type CookiePunchPurpose = {
   title?: string;
   description?: string;
-}
+};
 
 export type CookiePunchServiceCookies = {
   pattern: string;
@@ -44,7 +47,7 @@ export type CookiePunchConfig = {
     htmlTexts: boolean;
     embedded: false;
     groupByPurpose: boolean;
-    storageMethod: 'cookie' | 'localStorage';
+    storageMethod: "cookie" | "localStorage";
     cookieName: string;
     cookieExpiresAfterDays: number;
     default: boolean;
@@ -58,7 +61,7 @@ export type CookiePunchConfig = {
     cookiePath?: string;
     cookieDomain?: string;
 
-    purposes: CookiePunchPurposes
+    purposes: CookiePunchPurposes;
     services: CookiePunchServices;
     translations: {
       [key: string]: any;
@@ -99,6 +102,9 @@ export type KlaroService = {
   required?: boolean;
   optOut?: boolean;
   onlyOnce?: boolean;
+  onInit?: () => void;
+  onAccept?: () => void;
+  onDecline?: () => void;
 };
 
 export type KlaroServiceCookies = ((RegExp | string)[] | string | RegExp)[];
@@ -114,7 +120,7 @@ export type KlaroConfig = {
   htmlTexts: boolean;
   embedded: false;
   groupByPurpose: boolean;
-  storageMethod: 'cookie' | 'localStorage';
+  storageMethod: "cookie" | "localStorage";
   cookieName: string;
   cookieExpiresAfterDays: number;
   default: boolean;