@speedkit/cli 3.9.1 → 3.11.0

package/CHANGELOG.md

@@ -1,3 +1,37 @@
+# [3.11.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v3.10.0...v3.11.0) (2025-10-16)
+
+
+### Bug Fixes
+
+* broken version reference in updated puppeteer package ([91c474f](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/91c474fcb774e61e772a55734df7fc7a2c0c4811))
+
+
+### Features
+
+* improve default Shopify tracking code ([84496f3](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/84496f3a015587b986fa9394bacd9ddd80c7ff04))
+* integrate new SPA bundle ([8330322](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/8330322a187c8659e84f1946d9f57d507a852842))
+
+# [3.10.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v3.9.1...v3.10.0) (2025-10-15)
+
+
+### Bug Fixes
+
+* **wizard:** ssr ([7f48214](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/7f48214e04aae0183b4027e1d0b103f22bbb8499))
+* **wizard:** ssr ([a848bb2](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/a848bb26f3fcafd79d12d7acbf4b9b4a32105ff4))
+
+
+### Features
+
+* **customer-config:** improve root-referencing style handling by parallelizing css fetching ([907d487](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/907d4875ed738ac6ba773562907a947a529ac198))
+* **customer-config:** move css processing from dh to lambda ([409da9b](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/409da9ba8c542ddcdc45feb5f25c06b3d98d37a3))
+* **customer-config:** optimise ssr handling + provide dom-parsing dh as default ([ac0c2fa](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/ac0c2fab72f926d8a818d21dd8c0a67c736d033d))
+* **customer-config:** prevent ssr shadow root container from being accessible by screen readers ([0743a91](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/0743a91a111ed1207fa3e8079c1a0f22166bc67c))
+* **customer-config:** remove ssr tv blacklisting due to deprecation ([5a7e6c2](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/5a7e6c2bfb12678153d1f7dd2b16790a47c27484))
+* **customer-config:** remove unnecessary ssr tablet disabling ([a48582f](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/a48582f65bb0f55019cc77476998c206f415d0ae))
+* **customer-config:** scope shadow app root container positioning to pre-rendered pages ([46e970b](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/46e970b35295794b9e05c588bf34fc80470a2f84))
+* **customer-config:** update ssr variation detection ([56a79b5](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/56a79b55f49b12628682bfbe9a23c403a39ebdba))
+* **customer-config:** update ssr variation detection ([8744274](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/87442749b5a3dc730195d5f009316501d80ed95c))
+
 ## [3.9.1](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v3.9.0...v3.9.1) (2025-10-15)
 
 

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @speedkit/cli
 $ sk COMMAND
 running command...
 $ sk (--version)
-@speedkit/cli/3.9.1 linux-x64 node-v20.19.5
+@speedkit/cli/3.11.0 linux-x64 node-v20.19.5
 $ sk --help [COMMAND]
 USAGE
   $ sk COMMAND

package/dist/commands/generate-pop-config.js

@@ -3,13 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const core_1 = require("@oclif/core");
 const cli_1 = require("baqend/cli");
-const promises_1 = require("node:fs/promises");
 const file_helper_1 = require("../helpers/file-helper");
 const cli_parameters_1 = require("../models/cli-parameters");
 const cli_2 = require("../services/cli");
 const config_api_service_1 = tslib_1.__importDefault(require("../services/config-api-service"));
-const diff_service_1 = require("../services/diff-service");
 const pop_config_1 = require("../services/pop-config");
+const diff_1 = require("../services/diff");
+const cli_config_1 = require("../helpers/cli-config");
 const POP_REMAPPING = {
     HHN: "FRA",
 };
@@ -131,16 +131,19 @@ class GeneratePopConfig extends core_1.Command {
         const database = await cli_1.account.login({ app });
         const configService = new config_api_service_1.default(database, app);
         const cliService = new cli_2.CliServiceFactory().getService();
-        const diffService = new diff_service_1.DiffService(cliService);
+        const userConfig = new cli_config_1.CliConfig(this.config).load();
+        const diffService = new diff_1.DiffServiceFactory(new diff_1.DiffContext(userConfig.diffExec, userConfig.diffExecTemplate)).getService();
+        // new DiffService(cliService);
         const popPrewarmingCode = await this.createPopPrewarmingCode(config);
-        const popPrewarmingCodePath = await diffService.writeContentToTemporalFile(`generated_${moduleName}`, popPrewarmingCode);
         const remoteConfig = await configService.getRemoteModule(moduleName);
-        const doDeploy = deploy ??
-            (await diffService.shouldDeployModule(moduleName, remoteConfig, popPrewarmingCodePath));
+        const result = await diffService.diffContent(moduleName, popPrewarmingCode, remoteConfig);
+        const content = result.changedOrigins;
+        const isEqual = result.diff;
+        if (isEqual) {
+            cliService.write(`created config is the same as the deployed one`);
+        }
+        const doDeploy = !isEqual && (deploy ?? (await cliService.confirm("deploy changes?")));
         if (doDeploy) {
-            const content = await (0, promises_1.readFile)(popPrewarmingCodePath, {
-                encoding: "utf8",
-            });
             await configService.saveRemoteModule(content, moduleName);
             this.log(`Changes for module ${moduleName} were updated successfully`);
         }

package/dist/services/customer-config/customer-config-service-model.d.ts

@@ -29,11 +29,9 @@ export interface CustomerConfigSettings {
     includeServiceWorker?: string;
     activateImageOptimisation?: boolean;
     removeLazyLoading?: boolean;
-    addPreRendering?: boolean;
-    addUADetection?: boolean;
-    supportShadowDomInPreRendering?: boolean;
-    shadowDomCustomElementPrefix?: string;
-    activateRumTracking?: boolean;
+    addSSR?: boolean;
+    addSSRInnerShadowDomSupport?: boolean;
+    addDeviceDetection?: boolean;
     useGATracking?: boolean;
     useScrapingBee?: boolean;
     withGoogleOptimize?: boolean;

package/dist/services/customer-config/customer-config-service.js

@@ -136,7 +136,7 @@ class CustomerConfigService {
         return true;
     }
     async getConfigSettings() {
-        let { production, staging, activateScopedDeployments, subRouteScope, includeServiceWorker, activateImageOptimisation, removeLazyLoading, addPreRendering, addUADetection, supportShadowDomInPreRendering, shadowDomCustomElementPrefix, activateRumTracking, useGATracking, useScrapingBee, withGoogleOptimize, activateCfRocketLoaderWorkaround, hasSoftNavigations, isShopify, isShopware, isSalesforce, isOxid, isPlentymarkets, isPOV, } = {};
+        let { production, staging, activateScopedDeployments, subRouteScope, includeServiceWorker, activateImageOptimisation, removeLazyLoading, addSSR, addSSRInnerShadowDomSupport, addDeviceDetection, useGATracking, useScrapingBee, withGoogleOptimize, activateCfRocketLoaderWorkaround, hasSoftNavigations, isShopify, isShopware, isSalesforce, isOxid, isPlentymarkets, isPOV, } = {};
         this.appName = await this.cli.prompt(`[App Name] Enter desired SK app name:`, {
             validator: (input) => /^[\da-z]+(?:-[\da-z]+)*$/.test(input) ? "" : "No valid kebab-case",
             defaultAnswer: this.appName,
@@ -173,7 +173,7 @@ class CustomerConfigService {
                 staging = await this.getEnvironmentConfig(customer_config_service_model_1.EnvironmentType.STAGING, production.host.replace("www", "staging"));
             }
         }
-        activateScopedDeployments = await this.cli.confirm("[Scoping] Is the shop using (locale-based) sub-routes, like e.g. /de-de, on the basis of which scoped deployments should to be activated to prevent local-based changes from triggering a global deployment job?", false);
+        activateScopedDeployments = await this.cli.confirm("[Scoping] Is the shop using (locale-based) sub-resources, like e.g. /de-de/main.js, on the basis of which scoped deployments should to be activated to prevent local-based changes from triggering a global deployment job?", false);
         if (activateScopedDeployments &&
             (await this.cli.confirm("[Scoping] Should SK only be active on specific sub-routes? (e.g. /de-de)", false))) {
             subRouteScope = await this.cli.prompt("[Scoping] Enter one exemplary sub-route to scope SK to (without leading/trailing slashes):", { defaultAnswer: "de-de" });
@@ -181,29 +181,23 @@ class CustomerConfigService {
         if (await this.cli.confirm("[Service Worker] Is there a Service Worker which needs to be included?", false)) {
             includeServiceWorker = await this.cli.prompt("[Service Worker] Enter path of Service Worker to be included:", { defaultAnswer: "/sw.js" });
         }
-        addUADetection = await this.cli.confirm("[Variation handling] Do mobile and desktop versions of the website differ in their HTML structure, which would require us to add variations?", false);
         activateImageOptimisation = await this.cli.confirm("[IO] Should image optimisation be activated?", false);
-        removeLazyLoading = await this.cli.confirm("[Lazy-Loading] Does the shop require us to resolve lazy-loaded content?");
-        if (await this.cli.confirm("[Lambda-SSR] Add server-side-rendering? This requires a set-up Lambda function to work. Also requires usage of the DOM-based DocumentHandler.", false)) {
-            addPreRendering = true;
-            if (await this.cli.confirm("[Lambda-SSR] Does the customer utilize Shadow DOMs? If so additional handling for this will be added.", false)) {
-                supportShadowDomInPreRendering = true;
-                shadowDomCustomElementPrefix = await this.cli.prompt("[Lambda-SSR] Please specify the prefix of the custom elements used (e.g. o2 uses tef-): ", { defaultAnswer: "custom-" });
+        removeLazyLoading = await this.cli.confirm("[Lazy Loading] Does the shop require us to resolve lazy-loaded content?");
+        if (await this.cli.confirm("[Lambda SSR] Add server-side-rendering? This requires a set-up Lambda function to work.", false)) {
+            addSSR = true;
+            if (await this.cli.confirm("[Lambda SSR] Does the customer utilize Shadow DOMs? If so additional handling for this will be added.", false)) {
+                addSSRInnerShadowDomSupport = true;
             }
-            await this.cli.confirm("Confirm that you increased the Node memory limit to at least 1024 as the SSR setup is memory intensive." +
-                ' BBQ App -> Data -> App -> Search for App -> Addons -> "nodeMemLimit": 1024', false);
         }
+        // ask for variation handling only if adding Lambda SSR is not needed, as it will come with device detection anyway
+        addDeviceDetection = addSSR
+            ? true
+            : await this.cli.confirm("[Device Detection] Do mobile and desktop versions of the website differ in their HTML structure, which would require us to add variations?", false);
         useScrapingBee = await this.cli.confirm("[ScrapingBee] Do customer responses differ geo-location-based which would require ScrapingBee API to fetch documents?", false);
-        activateRumTracking = true;
-        // activateRumTracking = await this.cli.confirm(
-        //   "[Tracking] Activate RUM Tracking?",
-        // );
-        // if (activateRumTracking) {
         if (!isShopify) {
             useGATracking = await this.cli.confirm("[Tracking] Add tracking based on Google Analytics' DataLayer?");
         }
         hasSoftNavigations = await this.cli.confirm("[Tracking] Add tracking for Soft Navigations?", false);
-        // }
         isPOV = await this.cli.confirm("[Tracking] Is a POV (proof of value) anticipated, so that additional tracking is needed?", false);
         withGoogleOptimize = await this.cli.confirm("[Services] Is Google Optimize used?", false);
         activateCfRocketLoaderWorkaround = isShopify
@@ -218,11 +212,9 @@ class CustomerConfigService {
             includeServiceWorker,
             activateImageOptimisation,
             removeLazyLoading,
-            addPreRendering,
-            addUADetection,
-            supportShadowDomInPreRendering,
-            shadowDomCustomElementPrefix,
-            activateRumTracking,
+            addSSR,
+            addSSRInnerShadowDomSupport,
+            addDeviceDetection,
             useGATracking,
             useScrapingBee,
             withGoogleOptimize,

package/dist/services/customer-config/templates/config_SpeedKit.js.hbs

@@ -25,30 +25,6 @@
   var ENABLED_HOSTS = getEnabledHosts(ENABLED_HOSTS_CONFIGS);
   var CURRENT_HOST_CONFIG = getCurrentHostConfig(ENABLED_HOSTS_CONFIGS);
 
-{{#if addPreRendering}}
-    // Lambda SSR specific: disable SK for tablets as they are not covered in lambda
-    function isTablet() {
-      var userAgent = window.navigator.userAgent.toLowerCase();
-      var tabletUAs = [
-        /tablet/,
-        /ipad/,
-        /nexus 7/,
-        /nexus 10/,
-        /silk\//,
-        /\bgt-[pn]\d{4}\b/,
-        /\bsm-t\d{3}\b/,
-        /^.*android(?!.*mobile|.*smart-tv|.*smarttv|.*aft[tm]|.*crkey).*$/,
-      ];
-
-      if ("ontouchend" in document && userAgent.indexOf("Macintosh") > -1) {
-        return true;
-      }
-      return tabletUAs.some(function (ua) {
-        return ua.test(userAgent);
-      });
-    }
-{{/if}}
-
   /**
    * @type {SpeedKitConfig}
    */
@@ -66,22 +42,36 @@
     includeServiceWorker: "{{includeServiceWorker}}",
 {{/if}}
     preloadDynamicBlocks: true,
-    rumTracking: {{activateRumTracking}},
-{{#if addPreRendering}}
-  // Lambda SSR specific: detect device to cover different resolutions when rendered in lambda
-  userAgentDetection: true,
-{{else if addUADetection}}
-  userAgentDetection: true,
+    rumTracking: true,
+{{#if addDeviceDetection}}
+  {{#unless addSSR}}
+    userAgentDetection: true,
+  {{/unless}}
+    detectDevice: function(doc) {
+  {{#if addSSR}}
+      // SSR specific – identify device based on screen width:
+      // TODO: adjust devices + breakpoints to your needs
+      var width = window?.screen?.width || 1024;
+      if (width < 768) return "mobile";
+      return "desktop";
+  {{else}}
+      // TODO: adjust condition to your needs
+      return doc.querySelector('<mobile-specific-element>') ? "mobile" : "desktop";
+  {{/if}}
+    },
 {{/if}}
-{{#if addUADetection}}
-  detectDevice: function(doc) {
-    // TODO adjust condition to your needs
-    return doc.querySelector('<mobile-specific-element>') ? "mobile" : "desktop";
-  },
+{{#if addSSR}}
+    customVariation: [
+      {
+        variationFunction: function (request, device, cookies) {
+          // SSR specific – don't report a variation for specific page types NOT covered by SSR:
+          // TODO: adjust and activate if needed
+          // if (request.url.indexOf("<url-page-type-idenfier>") > -1) return "desktop";
+          return device;
+        },
+      },
+    ],
 {{/if}}
-    split: CURRENT_HOST_CONFIG.split,
-    splitTestId: CURRENT_HOST_CONFIG.splitTestId,
-    disabled: !CURRENT_HOST_CONFIG.enabled{{#if addPreRendering}} || isTablet(){{/if}},
 {{#if useScrapingBee}}
     customVariation: [
       {
@@ -94,6 +84,9 @@
       },
     ],
 {{/if}}
+    split: CURRENT_HOST_CONFIG.split,
+    splitTestId: CURRENT_HOST_CONFIG.splitTestId,
+    disabled: !CURRENT_HOST_CONFIG.enabled,
     enabledSites: [
       {
         pathname: [
@@ -150,12 +143,6 @@
 {{/if}}
     ],
     blacklist: [
-{{#if addPreRendering}}
-      // blacklist tv variations
-      {
-        tv: true,
-      },
-{{/if}}
       {
         pathname: [
           // TODO: adjust/replace this exemplary list

package/dist/services/customer-config/templates/config_customer.json.hbs

@@ -1,56 +1,46 @@
 {
-"production": {
-"_meta": {
-"shopSystem":
-{{#if isShopify}}
-  "Shopify"
-{{else if isShopware}}
-  "Shopware"
-{{else if isSalesforce}}
-  "Salesforce Commerce Cloud"
-{{else if isOxid}}
-  "OXID eShop"
-{{else if isPlentymarkets}}
-  "Plentymarkets"
-{{else}}
-  "TODO: enter name of system in use"
-{{/if}}
-},
-"app": "{{appName}}",
-"domain": "{{production.host}}",
-"origins": [
-"https://{{production.host}}"
-],
-{{#if isShopify}}
-  "swPath": "/apps/speed-kit/sw.js",
-{{else}}
-  "swPath": "/wrapper-sw.js",
-{{/if}}
-{{#if subRouteScope}}
-  "scope": "/{{subRouteScope}}/",
-{{else}}
-  "scope": "/",
-{{/if}}
-"forceInstall": {{production.forceInstall}}
-}
-{{#if staging.host}},
-"staging": {
-"name": "staging",
-"domain": "{{staging.host}}",
-"origins": [
-"https://{{staging.host}}"
-],
-"forceInstall": {{staging.forceInstall}},
-{{#if isShopify}}
-  "swPath": "/apps/speed-kit/sw.js",
-{{else}}
-  "swPath": "/wrapper-sw.js",
-{{/if}}
-{{#if subRouteScope}}
-  "scope": "/{{subRouteScope}}/"
-{{else}}
-  "scope": "/"
-{{/if}}
-}
-{{/if}}
+  "production": {
+    "_meta": {
+      "shopSystem":
+      {{#if isShopify}}
+        "Shopify"
+      {{else if isShopware}}
+        "Shopware"
+      {{else if isSalesforce}}
+        "Salesforce Commerce Cloud"
+      {{else if isOxid}}
+        "OXID eShop"
+      {{else if isPlentymarkets}}
+        "Plentymarkets"
+      {{else}}
+        "TODO: enter name of system in use"
+      {{/if}}
+    },
+    "app": "{{appName}}",
+    "domain": "{{production.host}}",
+    "origins": [
+      "https://{{production.host}}"
+    ],
+  {{#if isShopify}}
+    "swPath": "/apps/speed-kit/sw.js",
+  {{else}}
+    "swPath": "/wrapper-sw.js",
+  {{/if}}
+  {{#if subRouteScope}}
+    "scope": "/{{subRouteScope}}/",
+  {{else}}
+    "scope": "/",
+  {{/if}}
+    "forceInstall": {{production.forceInstall}}
+  }
+  {{#if staging.host}},
+  "staging": {
+    "name": "staging",
+    "domain": "{{staging.host}}",
+    "origins": [
+      "https://{{staging.host}}"
+    ],
+    "forceInstall": {{staging.forceInstall}},
+  }
+  {{/if}}
 }