j1-template 2024.1.5 → 2024.2.1

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

@@ -46,7 +46,7 @@ regenerate:                             true
 
 {% comment %} Set config options (settings only)
 -------------------------------------------------------------------------------- {% endcomment %}
-{% assign lazy_loader_options = lazy_loader_defaults | merge: lazy_loader_settings %}
+{% assign lazy_loader_options  = lazy_loader_defaults | merge: lazy_loader_settings %}
 
 {% comment %} Detect prod mode
 -------------------------------------------------------------------------------- {% endcomment %}
@@ -78,7 +78,7 @@ regenerate:                             true
 /* eslint indent: "off"                                                       */
 // -----------------------------------------------------------------------------
 'use strict';
-j1.adapter.lazyLoader = (function (j1, window) {
+j1.adapter.lazyLoader = ((j1, window) => {
 
 {% comment %} Set global variables
 -------------------------------------------------------------------------------- {% endcomment %}
@@ -86,27 +86,35 @@ var environment     = '{{environment}}';
 var cookie_names    = j1.getCookieNames();
 var user_state      = j1.readCookie(cookie_names.user_state);
 var state           = 'not_started';
+
 var lazyLoaderDefaults;
 var lazyLoaderSettings;
 var lazyLoaderOptions;
 var frontmatterOptions;
+
 var _this;
 var logger;
 var logText;
 
+// date|time
+var startTime;
+var endTime;
+var startTimeModule;
+var endTimeModule;
+var timeSeconds;
+
   // ---------------------------------------------------------------------------
-  // Main object
+  // main
   // ---------------------------------------------------------------------------
   return {
 
     // -------------------------------------------------------------------------
-    // init()
     // adapter initializer
     // -------------------------------------------------------------------------
-    init: function (options) {
+    init: (options) => {
 
       // -----------------------------------------------------------------------
-      // Default module settings
+      // default module settings
       // -----------------------------------------------------------------------
       var settings = $.extend({
         module_name: 'j1.adapter.lazyLoader',
@@ -114,7 +122,7 @@ var logText;
       }, options);
 
       // -----------------------------------------------------------------------
-      // Global variable settings
+      // global variable settings
       // -----------------------------------------------------------------------
 
       // create settings object from module options
@@ -126,22 +134,31 @@ var logText;
       _this  = j1.adapter.lazyLoader;
       logger = log4javascript.getLogger('j1.adapter.lazyLoader');
 
-      var dependencies_met_lazy_loader = setInterval(function() {
-        var pageFinished = (j1.getState() == 'finished') ? true: false;
+      // -------------------------------------------------------------------------
+      // module initializer
+      // ---------------------------------------------------------------------
+      var dependency_met_j1_core_ready = setInterval(() => {
+        var j1CoreFinished = (j1.getState() === 'finished') ? true: false;
 
-        if (pageFinished) {
+        if (j1CoreFinished) {
+          startTimeModule = Date.now();
 
           _this.setState('started');
-          logger.info('\n' + 'initialize moodule lazyLoader: started');
+          logger.debug('\n' + 'set module state to: ' + _this.getState());
+          logger.info('\n' + 'initializing module: started');
 
           _this.registerLoaders(lazyLoaderOptions);
 
           _this.setState('finished');
-          logger.info('\n' + 'initialize moodule lazyLoader: finished');
-          clearInterval(dependencies_met_lazy_loader);
-        }
-      }, 10);
+          logger.debug('\n' + 'state: ' + _this.getState());
+          logger.info('\n' + 'initializing module: finished');
 
+          endTimeModule = Date.now();
+          logger.info('\n' + 'module initializing time: ' + (endTimeModule-startTimeModule) + 'ms');
+
+          clearInterval(dependency_met_j1_core_ready);
+        } // END if pageVisible
+      }, 10); // END dependency_met_j1_core_ready
     }, // END init
 
     // -------------------------------------------------------------------------
@@ -156,7 +173,7 @@ var logText;
     //
     // -------------------------------------------------------------------------
     //
-    registerLoaders: function () {
+    registerLoaders: () => {
       {% for loader in lazy_loader_options.loaders %} {% if loader.enabled %}
         j1.lazyCSS().observe({
           src:        '{{loader.src}}',
@@ -171,24 +188,26 @@ var logText;
     // messageHandler()
     // manage messages send from other J1 modules
     // -------------------------------------------------------------------------
-    messageHandler: function (sender, message) {
+    messageHandler: (sender, message) => {
       var json_message = JSON.stringify(message, undefined, 2);
 
       logText = '\n' + 'received message from ' + sender + ': ' + json_message;
       logger.debug(logText);
 
       // -----------------------------------------------------------------------
-      //  Process commands|actions
+      //  process commands|actions
       // -----------------------------------------------------------------------
       if (message.type === 'command' && message.action === 'module_initialized') {
+
         //
-        // Place handling of command|action here
+        // place handling of command|action here
         //
+
         logger.info('\n' + message.text);
       }
 
       //
-      // Place handling of other command|action here
+      // place handling of other command|action here
       //
 
       return true;
@@ -196,9 +215,9 @@ var logText;
 
     // -------------------------------------------------------------------------
     // setState()
-    // Sets the current (processing) state of the module
+    // sets the current (processing) state of the module
     // -------------------------------------------------------------------------
-    setState: function (stat) {
+    setState: (stat) => {
       _this.state = stat;
     }, // END setState
 
@@ -206,11 +225,11 @@ var logText;
     // getState()
     // Returns the current (processing) state of the module
     // -------------------------------------------------------------------------
-    getState: function () {
+    getState: () => {
       return _this.state;
     } // END getState
 
-  }; // END return
+  }; // END main (return)
 })(j1, window);
 
 {% endcapture %}

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

@@ -40,12 +40,12 @@ regenerate:                             true
 
 {% comment %} Set config data
 -------------------------------------------------------------------------------- {% endcomment %}
-{% assign lightbox_defaults  = modules.defaults.lightbox.defaults %}
-{% assign lightbox_settings  = modules.lightbox.settings %}
+{% assign lightbox_defaults = modules.defaults.lightbox.defaults %}
+{% assign lightbox_settings = modules.lightbox.settings %}
 
 {% comment %} Set config options
 -------------------------------------------------------------------------------- {% endcomment %}
-{% assign lightbox_options   = lightbox_defaults | merge: lightbox_settings %}
+{% assign lightbox_options  = lightbox_defaults | merge: lightbox_settings %}
 
 {% comment %} Detect prod mode
 -------------------------------------------------------------------------------- {% endcomment %}
@@ -82,36 +82,45 @@ regenerate:                             true
 /* eslint indent: "off"                                                       */
 // -----------------------------------------------------------------------------
 'use strict';
-j1.adapter.lightbox = (function (j1, window) {
+j1.adapter.lightbox = ((j1, window) => {
 
   {% comment %} Global variables
   ------------------------------------------------------------------------------ {% endcomment %}
-  var environment  = '{{environment}}';
-  var state        = 'not_started';
+  var environment       = '{{environment}}';
+  var state             = 'not_started';
+
   var lightboxDefaults;
   var lightboxSettings;
   var lightboxOptions;
   var frontmatterOptions;
+
   var _this;
   var logger;
   var logText;
 
+  // date|time
+  var startTime;
+  var endTime;
+  var startTimeModule;
+  var endTimeModule;
+  var timeSeconds;
+
   // ---------------------------------------------------------------------------
-  // Helper functions
+  // helper functions
   // ---------------------------------------------------------------------------
 
   // ---------------------------------------------------------------------------
-  // Main object
+  // main
   // ---------------------------------------------------------------------------
   return {
 
     // -------------------------------------------------------------------------
-    // Initializer
+    // adapter initializer
     // -------------------------------------------------------------------------
-    init: function (options) {
+    init: (options) => {
 
       // -----------------------------------------------------------------------
-      // Default module settings
+      // default module settings
       // -----------------------------------------------------------------------
       var settings = $.extend({
         module_name: 'j1.adapter.lightbox',
@@ -119,26 +128,30 @@ j1.adapter.lightbox = (function (j1, window) {
       }, options);
 
       // -----------------------------------------------------------------------
-      // Global variable settings
+      // global variable settings
       // -----------------------------------------------------------------------
       _this   = j1.adapter.lightbox;
       logger  = log4javascript.getLogger('j1.adapter.lightbox');
 
       // create settings object from frontmatter (page settings)
-      frontmatterOptions  = options != null ? $.extend({}, options) : {};
+      frontmatterOptions    = options !== null ? $.extend({}, options) : {};
 
-      // Load  module DEFAULTS|CONFIG
-      lightboxDefaults          = $.extend({}, {{lightbox_defaults | replace: 'nil', 'null' | replace: '=>', ':' }});
-      lightboxSettings          = $.extend({}, {{lightbox_settings | replace: 'nil', 'null' | replace: '=>', ':' }});
-      lightboxOptions           = $.extend(true, {}, lightboxDefaults, lightboxSettings, frontmatterOptions);
+      // Load module DEFAULTS|CONFIG
+      lightboxDefaults      = $.extend({}, {{lightbox_defaults | replace: 'nil', 'null' | replace: '=>', ':' }});
+      lightboxSettings      = $.extend({}, {{lightbox_settings | replace: 'nil', 'null' | replace: '=>', ':' }});
+      lightboxOptions       = $.extend(true, {}, lightboxDefaults, lightboxSettings, frontmatterOptions);
 
-      var dependencies_met_j1_finished = setInterval(function() {
-        var pageState     = $('#no_flicker').css("display");
-        var pageVisible   = (pageState == 'block') ? true: false;
-        var atticFinished = (j1.adapter.attic.getState() == 'finished') ? true: false;
+      // -----------------------------------------------------------------------
+      // module initializer
+      // -----------------------------------------------------------------------
+      var dependencies_met_page_ready = setInterval (() => {
+        var pageState      = $('#content').css("display");
+        var pageVisible    = (pageState === 'block') ? true: false;
+        var j1CoreFinished = (j1.getState() === 'finished') ? true : false;
+        var lbV2Finished   = ($('#lightbox').length) ? true : false;
 
-         if (j1.getState() == 'finished' && pageVisible) {
-//       if (j1.getState() == 'finished' && pageVisible && atticFinished) {
+         if (j1CoreFinished && pageVisible && lbV2Finished) {
+           startTimeModule = Date.now();
 
           _this.setState('started');
           logger.debug('\n' + 'state: ' + _this.getState());
@@ -159,55 +172,43 @@ j1.adapter.lightbox = (function (j1, window) {
             wrapAround:                   lightboxOptions.wrapAround
           });
 
-          // _this.setState('finished');
-          // logger.debug('\n' + 'state: ' + _this.getState());
-          // logger.info('\n' + 'initializing module finished');
-
-          clearInterval(dependencies_met_j1_finished);
-        } // END dependencies_met_j1_finished
-      }, 10);
-
-      // jadams, 2023-05-07: place CSS styles in GENERAL on a LIGHTBOX V2 doesn't help.
-      // a lightbox shoud restpect the individual IMAGE styles
-      // FixMe:
-      //
-      var dependencies_met_lb_v2_finished = setInterval(function() {
-        var lb_v2 = $('#lightbox').length;
-        if (lb_v2) {
           _this.setState('finished');
           logger.debug('\n' + 'state: ' + _this.getState());
           logger.info('\n' + 'initializing module finished');
 
-          // $('#lightbox').css("filter: grayscale(0.8) contrast(0.8) brightness(0.7) sepia(1)");
+          endTimeModule = Date.now();
+          logger.info('\n' + 'module initializing time: ' + (endTimeModule-startTimeModule) + 'ms');
 
-          clearInterval(dependencies_met_lb_v2_finished);
-        }
-      }, 10); // END dependencies_met_lb_v2_finished
+          clearInterval(dependencies_met_page_ready);
+        } // END if pageVisible
+      }, 10); // END dependencies_met_page_ready
 
     }, // END init lightbox
 
     // -------------------------------------------------------------------------
-    // messageHandler: MessageHandler for J1 CookieConsent module
-    // Manage messages send from other J1 modules
+    // messageHandler()
+    // manage messages send from other J1 modules
     // -------------------------------------------------------------------------
-    messageHandler: function (sender, message) {
+    messageHandler: (sender, message) => {
       var json_message = JSON.stringify(message, undefined, 2);
 
       logText = '\n' + 'received message from ' + sender + ': ' + json_message;
       logger.debug(logText);
 
       // -----------------------------------------------------------------------
-      //  Process commands|actions
+      //  process commands|actions
       // -----------------------------------------------------------------------
       if (message.type === 'command' && message.action === 'module_initialized') {
+
         //
-        // Place handling of command|action here
+        // place handling of command|action here
         //
+
         logger.info('\n' + message.text);
       }
 
       //
-      // Place handling of other command|action here
+      // place handling of other command|action here
       //
 
       return true;
@@ -215,9 +216,9 @@ j1.adapter.lightbox = (function (j1, window) {
 
     // -------------------------------------------------------------------------
     // setState()
-    // Sets the current (processing) state of the module
+    // sets the current (processing) state of the module
     // -------------------------------------------------------------------------
-    setState: function (stat) {
+    setState: (stat) => {
       _this.state = stat;
     }, // END setState
 
@@ -225,11 +226,11 @@ j1.adapter.lightbox = (function (j1, window) {
     // getState()
     // Returns the current (processing) state of the module
     // -------------------------------------------------------------------------
-    getState: function () {
+    getState: () => {
       return _this.state;
     } // END getState
 
-  }; // END return
+  }; // END main (return)
 })(j1, window);
 
 {% endcapture %}

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

@@ -28,8 +28,8 @@ regenerate:                             true
 
 {% comment %} Set global settings
 -------------------------------------------------------------------------------- {% endcomment %}
-{% assign environment       = site.environment %}
-{% assign template_version  = site.version %}
+{% assign environment           = site.environment %}
+{% assign template_version      = site.version %}
 
 {% comment %} Process YML config data
 ================================================================================ {% endcomment %}
@@ -82,11 +82,10 @@ regenerate:                             true
 /* eslint indent: "off"                                                       */
 // -----------------------------------------------------------------------------
 'use strict';
-j1.adapter.logger = (function (j1, window) {
+j1.adapter.logger = ((j1, window) => {
 
-  // ---------------------------------------------------------------------------
-  // globals
-  // ---------------------------------------------------------------------------
+  {% comment %} Global variables
+  ------------------------------------------------------------------------------ {% endcomment %}
   var environment           = '{{environment}}';
   var page_id               = j1.generateId(11);
   var cookie_names          = j1.getCookieNames();
@@ -94,13 +93,12 @@ j1.adapter.logger = (function (j1, window) {
   var state                 = 'not_started';
   var utilServerOptions     = {};
   var ajaxAppenderOptions   = {};
+
   var loggerDefaults;
   var loggerSettings;
   var loggerOptions;
   var user_session;
   var appDetected;
-  var _this;
-  var logger;
   var ajaxAppender;
   var consoleAppender;
   var jsonLayout;
@@ -110,9 +108,19 @@ j1.adapter.logger = (function (j1, window) {
   var nullLayout;
   var simpleLayout;
   var patternLayout;
-  var logText;
   var payloadURL;
 
+  var _this;
+  var logger;
+  var logText;
+
+  // date|time
+  var startTime;
+  var endTime;
+  var startTimeModule;
+  var endTimeModule;
+  var timeSeconds;
+
   // ---------------------------------------------------------------------------
   // helper functions
   //
@@ -122,7 +130,7 @@ j1.adapter.logger = (function (j1, window) {
   // throw a 'fake' exception to retrieve the stack trace and analyze
   // to find the line from which this function was called
   // ---------------------------------------------------------------------------
-  var getCustomData = function(layout, loggingReference) {
+  var getCustomData = (layout, loggingReference) => {
     var customData = [];
 
     try { (0)(); } catch (e) {
@@ -160,7 +168,7 @@ j1.adapter.logger = (function (j1, window) {
     return customData[0].value;
   };
 
-  var requestCallback = function(data) {
+  var requestCallback = (data) => {
     var xhrData = data;
     //
     // place handling of command|action here
@@ -169,19 +177,19 @@ j1.adapter.logger = (function (j1, window) {
   };
 
   // ---------------------------------------------------------------------------
-  // main object
-  //
+  // main
+  // ---------------------------------------------------------------------------
   return {
 
     // -------------------------------------------------------------------------
-    // initializer
+    // adapter initializer
     // -------------------------------------------------------------------------
-    init: function (options) {
+    init: (options) => {
       // initialize state flag
       j1.adapter.logger.state = 'started';
 
       // -----------------------------------------------------------------------
-      // Default module settings
+      // default module settings
       // -----------------------------------------------------------------------
       var settings = $.extend({
         module_name: 'j1.adapter.logger',
@@ -189,10 +197,10 @@ j1.adapter.logger = (function (j1, window) {
       }, options);
 
       // -----------------------------------------------------------------------
-      // Global variable settings
+      // global variable settings
       // -----------------------------------------------------------------------
-      _this       = j1.adapter.logger;
-      logger      = log4javascript.getLogger('j1.adapter.logger');
+      _this               = j1.adapter.logger;
+      logger              = log4javascript.getLogger('j1.adapter.logger');
 
       // Load  module DEFAULTS|CONFIG
       loggerDefaults      = $.extend({},   {{logger_defaults | replace: 'nil', 'null' | replace: '=>', ':' }});
@@ -204,21 +212,23 @@ j1.adapter.logger = (function (j1, window) {
       utilServerOptions   = $.extend({}, {{util_server_options | replace: '=>', ':' | replace: 'nil', '""'}});
       /* eslint-enable */
 
-      // wait until user_session.mode is detected by j1.init()
-      //
-      var dependencies_met_mode_detected = setInterval(function() {
-        user_session = j1.readCookie(cookie_names.user_session);
+      // -----------------------------------------------------------------------
+      // module initializer
+      // -----------------------------------------------------------------------
+      var dependencies_met_mode_detected = setInterval(() => {
+        var userSession  = j1.readCookie(cookie_names.user_session);
+        var sessionReady = (userSession.mode !== 'na') ? true : false;
 
-        if (user_session.mode !== 'na') {
-          clearInterval(dependencies_met_mode_detected);
-          logger.debug('\n' + 'met dependencies for: mode detected');
-          appDetected = user_session.mode === 'app' ? true : false;
+        if (sessionReady) {
+          startTimeModule = Date.now();
+
+          // appDetected = user_session.mode === 'app' ? true : false;
+          // if (appDetected) {
+          //   payloadURL = ajaxAppenderOptions.payload_url_app;
+          // } else {
+          //   payloadURL = ajaxAppenderOptions.payload_url_web;
+          // }
 
-          if (appDetected) {
-            payloadURL = ajaxAppenderOptions.payload_url_app;
-          } else {
-            payloadURL = ajaxAppenderOptions.payload_url_web;
-          }
           payloadURL = 'http://localhost:' + utilServerOptions.port + '/log2disk?request=write';
 
           // -------------------------------------------------------------------
@@ -241,23 +251,19 @@ j1.adapter.logger = (function (j1, window) {
           ajaxAppender.addHeader('X-TZ-Offset', loggerOptions.tz_offset);
 
           // success callback for testing (disabled for default)
-          //
           if (loggerRequestCallback) {
             ajaxAppender.setRequestSuccessCallback(requestCallback);
           }
 
-          // -----------------------------------------------------------------------
           // setup layouts
-          //
-          patternLayout       = new log4javascript.PatternLayout('[%d{HH:mm:ss.SSS}] [%f{4}] [%-5p] [%-60c] [%f{1}:%f{2}] %m%n[%f{3}]');
-          httpPostDataLayout  = new log4javascript.HttpPostDataLayout();
-          xmlLayout           = new log4javascript.XmlLayout();
-          jsonLayout          = new log4javascript.JsonLayout();
-          nullLayout          = new log4javascript.NullLayout();
-          simpleLayout        = new log4javascript.SimpleLayout();
-
-          // Use the method getLineNumber() as the value for the 0th custom field
-          //
+          patternLayout      = new log4javascript.PatternLayout('[%d{HH:mm:ss.SSS}] [%f{4}] [%-5p] [%-60c] [%f{1}:%f{2}] %m%n[%f{3}]');
+          httpPostDataLayout = new log4javascript.HttpPostDataLayout();
+          xmlLayout          = new log4javascript.XmlLayout();
+          jsonLayout         = new log4javascript.JsonLayout();
+          nullLayout         = new log4javascript.NullLayout();
+          simpleLayout       = new log4javascript.SimpleLayout();
+
+          // use the method getLineNumber() as the value for the 0th custom field
           patternLayout.setCustomField('file',    getCustomData);
           patternLayout.setCustomField('line',    getCustomData);
           patternLayout.setCustomField('path',    getCustomData);
@@ -267,24 +273,24 @@ j1.adapter.logger = (function (j1, window) {
           consoleAppender.setLayout(patternLayout);
           ajaxAppender.setLayout(httpPostDataLayout);
 
-          // -----------------------------------------------------------------------
           // setup log levels
-          //
-          if (environment == 'production') {
+          if (environment === 'production') {
             log4javascript.getLogger('j1').setLevel(log4javascript.Level.WARN);
           }
-          if (environment == 'development' || environment == 'devel' || environment == 'dev' || environment == 'test') {
+          if (environment === 'development' || environment == 'devel' || environment == 'dev' || environment == 'test') {
             log4javascript.getLogger('j1').setLevel(log4javascript.Level.DEBUG);
           } else {
             // fallback settings
             log4javascript.getLogger('j1').setLevel(log4javascript.Level.WARN);
           }
 
-          // -----------------------------------------------------------------------
           // setup (root) loggers
-          //
           log4javascript.getRootLogger().addAppender(consoleAppender);
 
+          _this.setState('started');
+          logger.debug('\n' + 'state: ' + _this.getState());
+          logger.info('\n' + 'module is being initialized');
+
           // to use the ajaxAppender (write logs to disk), the utility server
           // needs to be enabled (util_srv.yml) as well
           //
@@ -299,16 +305,20 @@ j1.adapter.logger = (function (j1, window) {
           logger.debug('\n' + 'state: ' + _this.getState());
           logger.info('\n' + 'module initialized successfully');
 
+          endTimeModule = Date.now();
+          logger.info('\n' + 'module initializing time: ' + (endTimeModule-startTimeModule) + 'ms');
+
+          clearInterval(dependencies_met_mode_detected);
           return true;
-        }
-      }, 10); // END 'mode detected'
+        } // END sessionReady
+      }, 10); // END dependencies_met_mode_detected
     }, // END init
 
     // -------------------------------------------------------------------------
-    // messageHandler: MessageHandler for J1 NAV module
-    // manage messages (paylods) send from other J1 modules
+    // messageHandler()
+    // manage messages send from other J1 modules
     // -------------------------------------------------------------------------
-    messageHandler: function (sender, message) {
+    messageHandler: (sender, message) => {
       var json_message = JSON.stringify(message, undefined, 2);
 
       logText = '\n' + 'received message from ' + sender + ': ' + json_message;
@@ -316,11 +326,13 @@ j1.adapter.logger = (function (j1, window) {
 
       // -----------------------------------------------------------------------
       //  process commands|actions
-      //
+      // -----------------------------------------------------------------------
       if (message.type === 'command' && message.action === 'module_initialized') {
+
         //
         // place handling of command|action here
         //
+
         logger.info('\n' + message.text);
       }
 
@@ -332,22 +344,22 @@ j1.adapter.logger = (function (j1, window) {
     }, // END messageHandler
 
     // -------------------------------------------------------------------------
-    // setState
-    // set the current (processing) state of the module
+    // setState()
+    // sets the current (processing) state of the module
     // -------------------------------------------------------------------------
-    setState: function (stat) {
-      j1.adapter.logger.state = stat;
+    setState: (stat) => {
+      _this.state = stat;
     }, // END setState
 
     // -------------------------------------------------------------------------
-    // getState
-    // return ;urns the current (processing) state of the module
+    // getState()
+    // Returns the current (processing) state of the module
     // -------------------------------------------------------------------------
-    getState: function () {
-      return j1.adapter.logger.state;
-    } // END state
+    getState: () => {
+      return _this.state;
+    } // END getState
 
-  }; // END return
+  }; // END main (return)
 })(j1, window);
 
 {% endcapture %}