umberto 4.2.2 → 4.2.4

package/CHANGELOG.md

@@ -1,6 +1,18 @@
 Changelog
 =========
 
+## [4.2.4](https://github.com/cksource/umberto/compare/v4.2.3...v4.2.4) (2024-07-17)
+
+Internal changes only (updated dependencies, documentation, etc.).
+
+
+## [4.2.3](https://github.com/cksource/umberto/compare/v4.2.2...v4.2.3) (2024-07-10)
+
+### Other changes
+
+* Replaced Goptimize with VWO. Closes [#1196](https://github.com/cksource/umberto/issues/1196). ([commit](https://github.com/cksource/umberto/commit/6390d8a56b74a202ed81d68764a087c3a2d09f0c))
+
+
 ## [4.2.2](https://github.com/cksource/umberto/compare/v4.2.1...v4.2.2) (2024-06-25)
 
 ### Other changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "umberto",
-  "version": "4.2.2",
+  "version": "4.2.4",
   "description": "CKSource Documentation builder",
   "main": "src/index.js",
   "files": [

package/src/hexo/filter/project-locals.js

@@ -20,6 +20,7 @@ const umbertoVersion = require( '../../../package.json' ).version;
  * @param {Object} googleoptimize Google Optimize config.
  * @param {Object} googletagmanager Google Tag Manager config.
  * @param {Object} googleanalytics Google Analytics config.
+ * @param {Object} vwo Visual Website Optimizer config.
  * @param {Object} feedbackWidget Feedback widget config
  * @param {Array} extraStylePaths Paths to extra external css.
  * @param {Array} extraScriptsPaths Paths to extra external js.
@@ -34,6 +35,7 @@ module.exports = ( ctx, {
 	googleoptimize,
 	googletagmanager,
 	googleanalytics,
+	vwo,
 	feedbackWidget,
 	extraStylePaths,
 	extraScriptsPaths,
@@ -98,6 +100,7 @@ module.exports = ( ctx, {
 		locals.googleoptimize = googleoptimize;
 		locals.googletagmanager = googletagmanager;
 		locals.googleanalytics = googleanalytics;
+		locals.vwo = vwo;
 		locals.feedbackWidget = feedbackWidget;
 		locals.mainName = ctx.projectGlobals.common.mainName ? ctx.projectGlobals.common.mainName : '';
 		locals.mainLogo = ctx.projectGlobals.common.mainLogo ? ctx.projectGlobals.common.mainLogo : '';

package/src/index.js

@@ -61,7 +61,8 @@ module.exports = {
 					googleanalytics: pConfig.googleanalytics,
 					feedbackWidget: pConfig.feedbackWidget,
 					isSingleProject: true,
-					canonicalUrlBeginning: pConfig.canonicalUrlBeginning
+					canonicalUrlBeginning: pConfig.canonicalUrlBeginning,
+					vwo: pConfig.vwo
 				}
 			}
 		) )

package/src/tasks/build-documentation.js

@@ -138,6 +138,7 @@ module.exports = options => {
 				googleoptimize: mainConfig.googleoptimize,
 				googletagmanager: mainConfig.googletagmanager,
 				googleanalytics: mainConfig.googleanalytics,
+				vwo: mainConfig.vwo,
 				feedbackWidget: mainConfig.feedbackWidget,
 				extraStyles,
 				extraScripts,
@@ -309,6 +310,7 @@ function buildProjects( rootPath, projectPaths, options = {} ) {
 				googleoptimize: options.googleoptimize,
 				googletagmanager: options.googletagmanager,
 				googleanalytics: options.googleanalytics,
+				vwo: options.vwo,
 				feedbackWidget: options.feedbackWidget,
 				og: options.og,
 				canonicalUrlBeginning: options.canonicalUrlBeginning,
@@ -327,6 +329,7 @@ function buildProjects( rootPath, projectPaths, options = {} ) {
 			googleoptimize: options.googleoptimize,
 			googletagmanager: options.googletagmanager,
 			googleanalytics: options.googleanalytics,
+			vwo: options.vwo,
 			feedbackWidget: options.feedbackWidget,
 			og: options.og,
 			canonicalUrlBeginning: options.canonicalUrlBeginning,
@@ -379,6 +382,7 @@ function buildProjects( rootPath, projectPaths, options = {} ) {
 			googleoptimize: options.googleoptimize,
 			googletagmanager: options.googletagmanager,
 			googleanalytics: options.googleanalytics,
+			vwo: options.vwo,
 			feedbackWidget: options.feedbackWidget,
 			extraStylePaths: extraStyles,
 			extraScriptsPaths: extraScripts,
@@ -482,6 +486,7 @@ function buildApis( projectConfigs, options = {} ) {
 				googleoptimize: options.googleoptimize,
 				googletagmanager: options.googletagmanager,
 				googleanalytics: options.googleanalytics,
+				vwo: options.vwo,
 				feedbackWidget: options.feedbackWidget,
 				pathJoin: upath.join,
 				mainOg: options.og || {}
@@ -550,6 +555,7 @@ function buildSdks( projectConfigs, options = {} ) {
 				googleoptimize: options.googleoptimize,
 				googletagmanager: options.googletagmanager,
 				googleanalytics: options.googleanalytics,
+				vwo: options.vwo,
 				feedbackWidget: options.feedbackWidget,
 				pathJoin: upath.join,
 				mainOg: options.og || {}

package/themes/umberto/layout/_partial/head.pug

@@ -60,7 +60,7 @@ if projectLocals
 if page.isSnippetPage
 	//UMBERTO: SNIPPET: CSS
 
-include google-optimize
+include vwo
 include google-tag-manager
 include google-analytics
 

package/themes/umberto/layout/_partial/vwo.pug

@@ -0,0 +1,11 @@
+if vwo
+  link(rel="preconnect", href="https://dev.visualwebsiteoptimizer.com")
+  script#vwoCode(type="text/javascript").
+
+    window._vwo_code || (function() {
+    var account_id='!{ vwo.config.trackingId }',
+    version=2.1,
+    settings_tolerance=2000,
+    hide_element='body',
+    hide_element_style = 'opacity:0 !important;filter:alpha(opacity=0) !important;background:none !important',
+    f=false,w=window,d=document,v=d.querySelector('#vwoCode'),cK='_vwo_'+account_id+'_settings',cc={};try{var c=JSON.parse(localStorage.getItem('_vwo_'+account_id+'_config'));cc=c&&typeof c==='object'?c:{}}catch(e){}var stT=cc.stT==='session'?w.sessionStorage:w.localStorage;code={use_existing_jquery:function(){return typeof use_existing_jquery!=='undefined'?use_existing_jquery:undefined},library_tolerance:function(){return typeof library_tolerance!=='undefined'?library_tolerance:undefined},settings_tolerance:function(){return cc.sT||settings_tolerance},hide_element_style:function(){return'{'+(cc.hES||hide_element_style)+'}'},hide_element:function(){if(performance.getEntriesByName('first-contentful-paint')[0]){return''}return typeof cc.hE==='string'?cc.hE:hide_element},getVersion:function(){return version},finish:function(e){if(!f){f=true;var t=d.getElementById('_vis_opt_path_hides');if(t)t.parentNode.removeChild(t);if(e)(new Image).src='https://dev.visualwebsiteoptimizer.com/ee.gif?a='+account_id+e}},finished:function(){return f},addScript:function(e){var t=d.createElement('script');t.type='text/javascript';if(e.src){t.src=e.src}else{t.text=e.text}d.getElementsByTagName('head')[0].appendChild(t)},load:function(e,t){var i=this.getSettings(),n=d.createElement('script'),r=this;t=t||{};if(i){n.textContent=i;d.getElementsByTagName('head')[0].appendChild(n);if(!w.VWO||VWO.caE){stT.removeItem(cK);r.load(e)}}else{var o=new XMLHttpRequest;o.open('GET',e,true);o.withCredentials=!t.dSC;o.responseType=t.responseType||'text';o.onload=function(){if(t.onloadCb){return t.onloadCb(o,e)}if(o.status===200){_vwo_code.addScript({text:o.responseText})}else{_vwo_code.finish('&e=loading_failure:'+e)}};o.onerror=function(){if(t.onerrorCb){return t.onerrorCb(e)}_vwo_code.finish('&e=loading_failure:'+e)};o.send()}},getSettings:function(){try{var e=stT.getItem(cK);if(!e){return}e=JSON.parse(e);if(Date.now()>e.e){stT.removeItem(cK);return}return e.s}catch(e){return}},init:function(){if(d.URL.indexOf('__vwo_disable__')>-1)return;var e=this.settings_tolerance();w._vwo_settings_timer=setTimeout(function(){_vwo_code.finish();stT.removeItem(cK)},e);var t;if(this.hide_element()!=='body'){t=d.createElement('style');var i=this.hide_element(),n=i?i+this.hide_element_style():'',r=d.getElementsByTagName('head')[0];t.setAttribute('id','_vis_opt_path_hides');v&&t.setAttribute('nonce',v.nonce);t.setAttribute('type','text/css');if(t.styleSheet)t.styleSheet.cssText=n;else t.appendChild(d.createTextNode(n));r.appendChild(t)}else{t=d.getElementsByTagName('head')[0];var n=d.createElement('div');n.style.cssText='z-index: 2147483647 !important;position: fixed !important;left: 0 !important;top: 0 !important;width: 100% !important;height: 100% !important;background: white !important;';n.setAttribute('id','_vis_opt_path_hides');n.classList.add('_vis_hide_layer');t.parentNode.insertBefore(n,t.nextSibling)}var o='https://dev.visualwebsiteoptimizer.com/j.php?a='+account_id+'&u='+encodeURIComponent(d.URL)+'&vn='+version;if(w.location.search.indexOf('_vwo_xhr')!==-1){this.addScript({src:o})}else{this.load(o+'&x=true')}}};w._vwo_code=code;code.init();})();

package/themes/umberto/layout/_partial/google-optimize.pug

@@ -1,15 +0,0 @@
-if googleoptimize
-
-    // Google Optimize
-    script.
-        if (!{ JSON.stringify(googleoptimize.domains) }.indexOf(location.hostname) !== -1) {
-            (function (w, d, s, i) {
-                var f = d.getElementsByTagName(s)[0],
-                    j = d.createElement(s);
-                j.async = true;
-                j.src = 'https://www.googleoptimize.com/optimize.js?id=' + i;
-                f.parentNode.insertBefore(j, f);
-            })( window, document, 'script', '!{ googleoptimize.id }' );
-        }
-
-    // End Google Optimize