j1-template 2022.0.10 → 2022.0.11

data/assets/themes/j1/adapter/js/comments.js

@@ -0,0 +1,387 @@
+---
+regenerate:                             true
+---
+
+{% capture cache %}
+
+{% comment %}
+ # -----------------------------------------------------------------------------
+ # ~/assets/themes/j1/adapter/js/comments.js
+ # Liquid template to adapt the Comments module
+ #
+ # Product/Info:
+ # https://jekyll.one
+ # Copyright (C) 2021 Juergen Adams
+ #
+ # J1 Template is licensed under the MIT License.
+ # For details, see https://jekyll.one
+ # -----------------------------------------------------------------------------
+ # Test data:
+ #  {{ liquid_var | debug }}
+ #  comments_options:  {{ comments_options | debug }}
+ # -----------------------------------------------------------------------------
+{% endcomment %}
+
+{% comment %} Liquid procedures
+-------------------------------------------------------------------------------- {% endcomment %}
+
+{% comment %} Set global settings
+-------------------------------------------------------------------------------- {% endcomment %}
+{% assign environment       = site.environment %}
+{% assign asset_path        = "/assets/themes/j1" %}
+
+{% comment %} Process YML config data
+================================================================================ {% endcomment %}
+
+{% comment %} Set config files
+-------------------------------------------------------------------------------- {% endcomment %}
+{% assign template_config    = site.data.j1_config %}
+{% assign blocks             = site.data.blocks %}
+{% assign modules            = site.data.modules %}
+
+{% comment %} Set config data (settings only)
+-------------------------------------------------------------------------------- {% endcomment %}
+{% assign comments_defaults = modules.defaults.comments.defaults %}
+{% assign comments_settings = modules.comments.settings %}
+
+{% comment %} Set config options (settings only)
+-------------------------------------------------------------------------------- {% endcomment %}
+{% assign comments_options  = comments_defaults | merge: comments_settings %}
+
+{% comment %} Variables
+-------------------------------------------------------------------------------- {% endcomment %}
+{% assign comments          = comments_options.enabled %}
+{% assign comments_provider = comments_options.provider %}
+
+{% if comments_provider == 'disqus' %}
+  {% assign site_id = comments_options.disqus.site_id %}
+{% elsif comments_provider == 'hyvor' %}
+  {% assign site_id = comments_options.hyvor.site_id %}
+{% elsif comments_provider == 'commento' %}
+  {% assign site_id = comments_options.commento.site_id %}
+{% elsif comments_provider == 'just-comments' %}
+  {% assign site_id = comments_options.just-comments.site_id %}
+{% elsif comments_provider == 'facebook' %}
+  {% assign site_id = comments_options.facebook.site_id %}
+{% else %}
+  {% assign site_id = false %}
+{% endif %}
+
+{% comment %} language detection
+-------------------------------------------------------------------------------- {% endcomment %}
+{% if site.language == "en" %}
+  {% assign language = "en" %}
+{% elsif site.language == "de"%}
+  {% assign language = "de" %}
+{% else %}
+  {% assign language = "en" %}
+{% endif %}
+
+{% if language == "en" %}
+  {% assign comments_headline = comments_options.comments_headline.en %}
+{% endif %}
+
+{% if language == "de" %}
+  {% assign comments_headline = comments_options.comments_headline.de %}
+{% endif %}
+
+{% assign production = false %}
+{% if environment == 'prod' or environment == 'production' %}
+  {% assign production = true %}
+{% endif %}
+
+/*
+ # -----------------------------------------------------------------------------
+ # ~/assets/themes/j1/adapter/js/comments.js
+ # J1 Adapter for the comments module
+ #
+ # Product/Info:
+ # https://jekyll.one
+ #
+ # Copyright (C) 2021 Juergen Adams
+ #
+ # J1 Template is licensed under the MIT License.
+ # For details, see https://jekyll.one
+ # -----------------------------------------------------------------------------
+ #  Adapter generated: {{site.time}}
+ # -----------------------------------------------------------------------------
+*/
+
+// -----------------------------------------------------------------------------
+// ESLint shimming
+// -----------------------------------------------------------------------------
+/* eslint indent: "off"                                                       */
+// -----------------------------------------------------------------------------
+'use strict';
+j1.adapter.comments = (function (j1, window) {
+
+{% comment %} Set global variables
+-------------------------------------------------------------------------------- {% endcomment %}
+var environment       = '{{environment}}';
+var comments_provider = '{{comments_provider}}';
+var dqApiScript       = document.createElement('script');
+var hvApiScript       = document.createElement('script');
+var hvCallbackScript  = document.createElement('script');
+var siteID            = '{{site_id}}';
+var comments_headline = '{{comments_headline}}';
+var cookie_names      = j1.getCookieNames();
+var user_consent;
+var _this;
+var logger;
+var logText;
+
+  // ---------------------------------------------------------------------------
+  // Main object
+  // ---------------------------------------------------------------------------
+  return {
+
+    // -------------------------------------------------------------------------
+    // init()
+    // adapter initializer
+    // -------------------------------------------------------------------------
+    init: function (options) {
+
+    {% if comments %}
+      // [INFO   ] [j1.adapter.comments                    ] [ detected comments provider (j1_config): {{comments_provider}}} ]
+      // [INFO   ] [j1.adapter.comments                    ] [ start processing load region head, layout: {{page.layout}} ]
+
+      // default module settings
+      // ----------------------------------------------------------------------
+      var settings = $.extend({
+        module_name: 'j1.adapter.comments',
+        generated:   '2021-12-18 18:55:38 +0000'
+      }, options);
+
+      {% if site_id %}
+
+      _this = j1.adapter.comments;
+      logger = log4javascript.getLogger('j1.adapter.comments');
+
+      {% case comments_provider %}
+      {% when "hyvor" %}
+      // [INFO   ] [j1.adapter.comments                    ] [ place provider: Hyvor Talk ]
+      var dependencies_met_page_ready = setInterval(function() {
+        if (j1.getState() == 'finished') {
+
+          // initialize state flag, issue init message
+          // -------------------------------------------------------------------
+          _this.setState('started');
+          logger.info('\n' + 'state: ' + _this.getState());
+          logger.info('\n' + 'module is being initialized for provider: ' + comments_provider);
+
+          // place|remove initialization code
+          // -------------------------------------------------------------------
+          user_consent  = j1.readCookie(cookie_names.user_consent);
+          if (user_consent.personalization) {
+            // enable Hyvor Talk
+            // -----------------------------------------------------------------
+            $('#main-content').append('<h2 id="leave-a-comment" class="mt-4">{{comments_headline}}</h2>');
+            logger.info('\n' + 'user consent on comments: ' + user_consent.personalization);
+            logger.info('\n' + 'enable comments provider' + ' {{comments_provider}} on siteID: ' + siteID);
+
+            // add Hyvor Talk Web API
+            // NOTE: don't change the script id
+            // -----------------------------------------------------------------
+            hvApiScript.id    = 'hyvor-embed';
+            hvApiScript.src   = '//talk.hyvor.com/web-api/embed.js';
+            hvApiScript.async = true;
+            document.head.appendChild(hvApiScript);
+
+            // add Hyvor Talk callback script
+            // -----------------------------------------------------------------
+            hvCallbackScript.id   = 'hyvor-callback';
+            hvCallbackScript.text  = '\n';
+            hvCallbackScript.text += 'var HYVOR_TALK_WEBSITE = ' + siteID + '\n';
+            hvCallbackScript.text += 'var HYVOR_TALK_CONFIG = {' + '\n';
+            hvCallbackScript.text += '		  url: false,' + '\n';
+            hvCallbackScript.text += '      id: false' + '\n';
+            hvCallbackScript.text += '	  };' + '\n';
+            document.head.appendChild(hvCallbackScript);
+
+            // add Hyvor Talk comment container
+            // NOTE: don't change the div id
+            // -----------------------------------------------------------------
+            $('#main-content').append('<div id="hyvor-talk-view"></div>');
+
+            // add recommended title to the comments iframe for SEO optimization
+            // -------------------------------------------------------------------
+            var dependencies_met_load_provider_finished = setInterval (function () {
+              if ($('#hyvor-talk-view').children().length) {
+                $('#hyvor-talk-iframe').prop('title', 'Hyvor comments iframe');
+                clearInterval(dependencies_met_load_provider_finished);
+              }
+            }, 25);
+          } else {
+            // disable Hyvor Talk
+            // -----------------------------------------------------------------
+            logger.info('\n' + 'user consent on comments: ' + user_consent.personalization);
+            logger.warn('\n' + 'disable comments provider' + ' {{comments_provider}} on siteID: ' + siteID);
+
+            // remove Hyvor Talk resources
+            // -----------------------------------------------------------------
+            $('#leave-a-comment').remove();
+            $('#hyvor-embed').remove();
+            $('#hyvor-callback').remove();
+            $('#hyvor-talk-view').remove();
+          }
+          clearInterval(dependencies_met_page_ready);
+        } // END if getState 'finished'
+      }, 25);
+
+      {% when "disqus" %}
+      // [INFO   ] [j1.adapter.comments                    ] [ place provider: Disqus ]
+      var dependencies_met_page_ready = setInterval(function() {
+        if (j1.getState() == 'finished') {
+
+          // initialize state flag, issue init message
+          // -------------------------------------------------------------------
+          _this.setState('started');
+          logger.info('\n' + 'state: ' + _this.getState());
+          logger.info('\n' + 'module is being initialized for provider: ' + comments_provider);
+
+          // place|remove initialization code
+          // -------------------------------------------------------------------
+          user_consent  = j1.readCookie(cookie_names.user_consent);
+          if (user_consent.personalization) {
+            $('#main-content').append('<h2 id="leave-a-comment" class="mt-4">{{comments_headline}}</h2>');
+            logger.info('\n' + 'user consent on comments: ' + user_consent.personalization);
+            logger.info('\n' + 'enable comments provider' + ' {{comments_provider}} on siteID: ' + siteID);
+
+            // old Disqus Web API init
+            // -----------------------------------------------------------------
+            // var disqus_shortname = '{{site_id}}';
+            // // -----------------------------------------------------------------
+            // // RECOMMENDED CONFIGURATION VARIABLES: EDIT AND UNCOMMENT THE
+            // // SECTION BELOW TO INSERT DYNAMIC VALUES FROM YOUR PLATFORM OR CMS.
+            // // LEARN WHY DEFINING THESE VARIABLES IS IMPORTANT:
+            // // https://disqus.com/admin/universalcode/#configuration-variables
+            // // -----------------------------------------------------------------
+            // //
+            // // var disqus_config = function () {
+            // // this.page.url = PAGE_URL;  // Replace PAGE_URL with your page's canonical URL variable
+            // // Replace PAGE_IDENTIFIER with your page's unique
+            // // identifier variable
+            // // this.page.identifier = PAGE_IDENTIFIER;
+            // // };
+            // //
+            // // DON'T EDIT BELOW THIS LINE
+            // // -----------------------------------------------------------------
+            // (function() {
+            //     var d = document,
+            //         s = d.createElement('script');
+            //     s.src = '//' + disqus_shortname + '.disqus.com/embed.js';
+            //     s.setAttribute('data-timestamp', +new Date());
+            //     (d.head || d.body).appendChild(s);
+            // })();
+
+            // add|initialize Disqus Web API
+            // -----------------------------------------------------------------
+            var d = new Date();
+            var currDate = d.toString().slice(0, 33);                           // extract the data part
+
+            dqApiScript.id    = 'dq-web-api';
+            dqApiScript.src   = '//' + siteID + '.disqus.com/embed.js";'
+            dqApiScript.setAttribute("data-timestamp", '"' + currDate + '"');
+            document.head.appendChild(dqApiScript);
+
+            // add Disqus comment container
+            // -----------------------------------------------------------------
+            $('#main-content').append('<div id="disqus_thread"></div>');
+          } else {
+            logger.info('\n' + 'user consent on comments: ' + user_consent.personalization);
+            logger.warn('\n' + 'disable comments provider' + ' {{comments_provider}} on siteID: ' + siteID);
+            $('#leave-a-comment').remove();
+            $('#dq-web-api').remove();
+            $('#hdisqus_thread').remove();
+          }
+
+          // add recommended title to the comments iframe for SEO optimization
+          // -------------------------------------------------------------------
+          // var dependencies_met_load_provider_finished = setInterval (function () {
+          //   if ($('#disqus_thread').children().length) {
+          //     $('#hyvor-talk-iframe').prop('title', 'Disqus comments iframe');
+          //     clearInterval(dependencies_met_load_provider_finished);
+          //   }
+          // }, 25);
+
+          clearInterval(dependencies_met_page_ready);
+        } // END if getState 'finished'
+      }, 25);
+
+      {% endcase %}
+      // [INFO   ] [j1.adapter.comments                    ] [ end processing ]
+      {% else %}
+      var dependencies_met_page_ready = setInterval(function() {
+        if (j1.getState() == 'finished') {
+          logger = log4javascript.getLogger('j1.adapter.comments');
+          logger.warn('\n' + 'provider or site ID for comment services wrong or not set');
+          clearInterval(dependencies_met_page_ready);
+        }
+      }, 25);
+      {% endif %}
+
+      {% else %}
+      var dependencies_met_page_ready = setInterval(function() {
+        if (j1.getState() == 'finished') {
+          logger = log4javascript.getLogger('j1.adapter.comments');
+          logger.info('\n' + 'comment services: disabled');
+          clearInterval(dependencies_met_page_ready);
+        }
+      }, 25);
+      {% endif %}
+      return;
+    }, // END init
+
+    // -------------------------------------------------------------------------
+    // messageHandler()
+    // manage messages send from other J1 modules
+    // -------------------------------------------------------------------------
+    messageHandler: function (sender, message) {
+      var json_message = JSON.stringify(message, undefined, 2);
+
+      logText = '\n' + 'received message from ' + sender + ': ' + json_message;
+      logger.debug(logText);
+
+      // -----------------------------------------------------------------------
+      //  Process commands|actions
+      // -----------------------------------------------------------------------
+      if (message.type === 'command' && message.action === 'module_initialized') {
+        //
+        // Place handling of command|action here
+        //
+        logger.info('\n' + message.text);
+      }
+
+      //
+      // Place handling of other command|action here
+      //
+
+      return true;
+    }, // END messageHandler
+
+    // -------------------------------------------------------------------------
+    // setState()
+    // Sets the current (processing) state of the module
+    // -------------------------------------------------------------------------
+    setState: function (stat) {
+      _this.state = stat;
+    }, // END setState
+
+    // -------------------------------------------------------------------------
+    // getState()
+    // Returns the current (processing) state of the module
+    // -------------------------------------------------------------------------
+    getState: function () {
+      return _this.state;
+    } // END getState
+
+  }; // END return
+})(j1, window);
+
+{% endcapture %}
+{% if production %}
+  {{ cache | minifyJS }}
+{% else %}
+  {{ cache | strip_empty_lines }}
+{% endif %}
+{% assign cache = nil %}

data/assets/themes/j1/adapter/js/cookieConsent.js

@@ -78,10 +78,7 @@ regenerate:                             true
 /* eslint quotes: "off"                                                       */
 // -----------------------------------------------------------------------------
 'use strict';
-
-{% comment %} Main
--------------------------------------------------------------------------------- {% endcomment %}
-j1.adapter['cookieConsent'] = (function (j1, window) {
+j1.adapter.cookieConsent = (function (j1, window) {
 
   var environment       = '{{environment}}';
   var tracking_enabled  = ('{{tracking_enabled}}' === 'true') ? true: false;
@@ -259,8 +256,8 @@ j1.adapter['cookieConsent'] = (function (j1, window) {
 
     // -------------------------------------------------------------------------
     // cbCookie()
-    // Called by CookieConsent module after the user has
-    // made his selection (callback)
+    // Called (callback) by CookieConsent module after the user has
+    // made his selection
     // -------------------------------------------------------------------------
     cbCookie: function () {
       var gaCookies           = j1.findCookie('_ga');
@@ -297,24 +294,30 @@ j1.adapter['cookieConsent'] = (function (j1, window) {
       // Manage Google Analytics OptIn/Out
       // See: https://github.com/luciomartinez/gtag-opt-in/wiki
       if (tracking_enabled && tracking_id_valid) {
-        GTagOptIn.register(tracking_id);
-        if (user_consent.analysis)  {
-          logger.info('\n' + 'enable: GA');
-          GTagOptIn.optIn();
-        } else {
-          logger.warn('\n' + 'disable: GA');
-          GTagOptIn.optOut();
-
-          if (!user_agent.includes('iPad')) {
-            gaCookies.forEach(function (item) {
-              logger.warn('\n' + 'delete GA cookie: ' + item);
-              j1.removeCookie({ name: item, domain: cookie_domain });
-            });
-          }
-        }
-
-        // Managing providers using personalization OptIn/Out
-        // (Comments|Ads|Translation)
+        // jadams, 2021-12-20:  GA OptIn|Out handling moved to (new)
+        // analytics adapter (adapter/js/analytics.js)
+        // ---------------------------------------------------------------------
+        // GTagOptIn.register(tracking_id);
+        // if (user_consent.analysis)  {
+        //   logger.info('\n' + 'enable: GA');
+        //   GTagOptIn.optIn();
+        // } else {
+        //   logger.warn('\n' + 'disable: GA');
+        //   GTagOptIn.optOut();
+        //
+        //   if (!user_agent.includes('iPad')) {
+        //     gaCookies.forEach(function (item) {
+        //       logger.warn('\n' + 'delete GA cookie: ' + item);
+        //       j1.removeCookie({ name: item, domain: cookie_domain });
+        //     });
+        //   }
+        // }
+
+        // Managing cookie life-time. If cookie settings allows only
+        // "required" cookies, all "persistent" cookies (Comments|Ads|Translation)
+        // get expired to "session" for better GDPR compliance. The GDPR
+        // regulations|privacy does NOT require any consent on using cookies
+        // for session-only cookies.
         //
         if (!user_consent.analysis || !user_consent.personalization) {
 
@@ -331,6 +334,7 @@ j1.adapter['cookieConsent'] = (function (j1, window) {
           });
 
           // expire permanent cookies to session
+          // -------------------------------------------------------------------
           j1.expireCookie({ name: cookie_names.user_state });
           j1.expireCookie({ name: cookie_names.user_consent });
           j1.expireCookie({ name: cookie_names.user_translate });
@@ -341,7 +345,7 @@ j1.adapter['cookieConsent'] = (function (j1, window) {
         }
       } else {
         // jadams, 2021-08-10: remove cookies on invalid GA config or left
-        // cookies from previous session if they exists
+        // cookies from previous session/page view if they exists
         // ---------------------------------------------------------------------
         gaCookies.forEach(function (item) {
           // Skip cookies from Google Ads
@@ -352,8 +356,11 @@ j1.adapter['cookieConsent'] = (function (j1, window) {
           }
         });
 
-        // Managing providers using personalization OptIn/Out
-        // (Comments|Ads|Translation)
+        // Managing cookie life-time. If cookie settings allows only
+        // "required" cookies, all "persistent" cookies (Comments|Ads|Translation)
+        // get expired to "session" for better GDPR compliance. The GDPR
+        // regulations|privacy does NOT require any consent on using cookies
+        // for session-only cookies.
         //
         if (!user_consent.analysis || !user_consent.personalization) {
           // overload cookie consent settings
@@ -369,6 +376,7 @@ j1.adapter['cookieConsent'] = (function (j1, window) {
           });
 
           // expire permanent cookies to session
+          // -------------------------------------------------------------------
           j1.expireCookie({ name: cookie_names.user_state });
           j1.expireCookie({ name: cookie_names.user_consent });
           j1.expireCookie({ name: cookie_names.user_translate });

data/assets/themes/j1/adapter/js/fab.js

@@ -78,8 +78,8 @@ regenerate:                             true
 /* eslint indent: "off"                                                       */
 // -----------------------------------------------------------------------------
 'use strict';
+j1.adapter.fab = (function (j1, window) {
 
-j1.adapter['fab'] = (function (j1, window) {
   // ---------------------------------------------------------------------------
   // globals
   // ---------------------------------------------------------------------------

data/assets/themes/j1/adapter/js/framer.js

@@ -78,10 +78,7 @@ regenerate:                             false
 /* eslint indent: "off"                                                       */
 // -----------------------------------------------------------------------------
 'use strict';
-
-{% comment %} Main
--------------------------------------------------------------------------------- {% endcomment %}
-j1.adapter['framer'] = (function (j1, window) {
+j1.adapter.framer = (function (j1, window) {
 
   {% comment %} Set global variables
   ------------------------------------------------------------------------------ {% endcomment %}