@speedkit/cli 3.20.0 → 3.22.0

package/CHANGELOG.md

@@ -1,3 +1,27 @@
+# [3.22.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v3.21.0...v3.22.0) (2026-01-30)
+
+
+### Features
+
+* add socksConnector to run localDocHandler in proxyMode ([eb3d3a2](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/eb3d3a2ce197aad600506df38032ba6e1fc25594))
+* set correct variations ([6021e22](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/6021e2258a9afe61ee9fced046d1f944b0134d57))
+* update crawler for docHandler to respect variations ([5880526](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/58805265156bde07b61bcb5599dd19cacffc7680))
+
+# [3.21.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v3.20.0...v3.21.0) (2026-01-30)
+
+
+### Bug Fixes
+
+* **wizard:** soft to hard nav conversion ([501c490](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/501c49092a50d91a2b7986ffa41ea6916282c005))
+* **wizard:** soft to hard nav conversion ([9801d0f](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/9801d0f90b6cbf4f2d895aed56483c505b84a8cc))
+
+
+### Features
+
+* **customer-config:** prevent soft2hard nav conversion for product variant switches ([66c0923](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/66c0923a22e15965c26c11a0ae4370170ec4ccf5))
+* **customer-config:** remove conditional for predictive preloading as it is not necessary ([eead957](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/eead957e2c8b3e094edd7204858c2cb87036c1e7))
+* **customer-config:** update general logic for soft2hard nav conversion ([05a5a61](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/05a5a611476b9dbda9d3afe22a15a7dc637d4d66))
+
 # [3.20.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v3.19.0...v3.20.0) (2026-01-06)
 
 

package/README.md

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

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

@@ -37,6 +37,7 @@ export interface CustomerConfigSettings {
     withGoogleOptimize?: boolean;
     activateCfRocketLoaderPlugin?: boolean;
     hasSoftNavigations?: boolean;
+    convertSoftToHardNavigations?: boolean;
     isPOV?: boolean;
     isShopify?: boolean;
     isShopware?: 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, addSSR, addSSRInnerShadowDomSupport, addDeviceDetection, useGATracking, useScrapingBee, withGoogleOptimize, activateCfRocketLoaderPlugin, hasSoftNavigations, isShopify, isShopware, isSalesforce, isOxid, isPlentymarkets, isPOV, } = {};
+        let { production, staging, activateScopedDeployments, subRouteScope, includeServiceWorker, activateImageOptimisation, removeLazyLoading, addSSR, addSSRInnerShadowDomSupport, addDeviceDetection, useGATracking, useScrapingBee, withGoogleOptimize, activateCfRocketLoaderPlugin, hasSoftNavigations, convertSoftToHardNavigations, 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,
@@ -198,6 +198,9 @@ class CustomerConfigService {
             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);
+        if (hasSoftNavigations) {
+            convertSoftToHardNavigations = await this.cli.confirm("[Soft2Hard Navigations] Should soft navigations be converted to hard 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);
         activateCfRocketLoaderPlugin = await this.cli.confirm("[Services] Is Cloudflare's Rocket Loader used, for which we need to activate our rocket loader plugin?", false);
@@ -218,6 +221,7 @@ class CustomerConfigService {
             withGoogleOptimize,
             activateCfRocketLoaderPlugin,
             hasSoftNavigations,
+            convertSoftToHardNavigations,
             isShopify,
             isShopware,
             isSalesforce,

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

@@ -269,6 +269,22 @@ import { PredictivePreloading } from 'predictive-preloading/predictivePreloading
     },
   {{/if}}
 {{/if}}
+{{#if convertSoftToHardNavigations}}
+  {
+    on: "domInteractive",
+    track: () => {
+      if (
+        // check that dashboard is not disabled and user is in group A
+        window?.SpeedKit.lastNavigate.disconnectCause.indexOf("DashboardDisabled") > -1 ||
+        !window?.SpeedKit?.skSupported ||
+        SpeedKit.group !== "A"
+      ) {
+        return;
+      }
+      convertSoftToHardNavigation();
+    },
+  },
+{{/if}}
 {{#if isPlentymarkets}}
   {
     on: "domInteractive",
@@ -367,12 +383,81 @@ import { PredictivePreloading } from 'predictive-preloading/predictivePreloading
   });
 {{/if}}
 
-{{#if hasSoftNavigations}}
-  new PredictivePreloading({
-    // TODO: configure according to the needs of the customer e.g. preload API-calls, soft-nav to hard-nav conversion...
-  });
-{{else}}
+{{#if convertSoftToHardNavigations}}
+  function softNavShouldBeConverted(url) {
+    // no link item found
+    if (!url || url === location.href) {
+      return false;
+    }
+
+    try {
+      // Always resolve the target relative to the current location
+      var resolvedTarget = new URL(url, location.href);
+
+      if (location.origin !== resolvedTarget?.origin) {
+        return false;
+      }
+
+      // must be a different path
+      if (location.pathname === resolvedTarget?.pathname) {
+        return false;
+      }
+
+      if (!SpeedKit?.isPageTypeEnabled(resolvedTarget.href)) {
+        return false;
+      }
+
+      if (
+        // speedKit sw is known
+        window?.speedKit?.sw &&
+        // can detect sw
+        navigator?.serviceWorker?.controller?.scriptURL &&
+        navigator.serviceWorker.controller.scriptURL.indexOf(new URL(window.speedKit.sw, location.origin).pathname) > -1
+      ) {
+        return true;
+      }
+    } catch (e) {}
+    return false;
+  }
+
+  function convertSoftToHardNavigation() {
+    function speedKitClickEventListener(event) {
+      var target = event.target.closest("a");
+
+      // Drop out if no link address is found or the target is the current page
+      if (!target || !target.href || target.href === location.href) {
+        return;
+      }
+
+      // Don't convert to hard navigation if it is just a product variant switch
+      // TODO: adjust conditions to customer-specific implementation as needed
+      var targetPathname = new URL(target.href).pathname;
+      var isPDP = targetPathname.indexOf("/p/") !== -1;
+      var isSamePathname = new URL(location.href).pathname === targetPathname;
+      var variantSwitchIdentifier = target.matches('.color-option, .size-option, .swatch-option');
+      if (
+        (isPDP && isSamePathname) || // url-based check
+        variantSwitchIdentifier // element-based check
+      ) {
+        return;
+      }
+
+      // Check if the target is enabled by SpeedKit and is a valid page for conversion
+      if (!softNavShouldBeConverted(target?.href)) {
+        return;
+      }
+
+      // Prevent soft navigation
+      event.preventDefault();
+
+      // Execute hard navigation instead
+      location.href = target.href;
+    }
+    window.addEventListener("click", speedKitClickEventListener, true);
+  }
+
+{{/if}}
+
   // TODO: check if prerendering needs to be scoped to certain pages
   new PredictivePreloading({ prerender: true });
-{{/if}}
 }();

package/dist/services/document-handler-runtime/document-handler-server.js

@@ -190,7 +190,7 @@ class DocumentHandlerServer {
             if (module === "baqend") {
                 return { baqend: { message: { RevalidateAssets: () => true } } };
             }
-            if (module.includes("fetch")) {
+            if (module.toLowerCase().includes("fetch")) {
                 return this.createFetchMock();
             }
             const fileExtension = node_path_1.default.extname(module);

package/dist/services/onboarding/onboarding-model.d.ts

@@ -74,6 +74,8 @@ export type SpeedKitServerConfigVariation = {
         encodePrefixedUrl?: boolean;
         headers?: {
             cookie?: string;
+            accept?: string;
+            "user-agent"?: string;
         };
         queryParams?: [];
         regex?: null | string;

package/dist/services/onboarding/onboarding-service-factory.d.ts

@@ -15,4 +15,6 @@ export declare class OnboardingServiceFactory {
     private getIntegrationFiles;
     private getUrlForTest;
     private ensureHttps;
+    private getCrawlerAgent;
+    private getCrawlerProxyConfig;
 }

package/dist/services/onboarding/onboarding-service-factory.js

@@ -43,6 +43,8 @@ const static_recipe_1 = require("../integration-api/virtual/static-recipe");
 const diff_against_current_page_1 = require("./dashboard/diff-against-current-page");
 const extension_downloader_1 = require("./browser/extension/extension-downloader");
 const executable_validator_1 = require("./browser/executable/executable-validator");
+const fetch_socks_1 = require("fetch-socks");
+const node_crypto_1 = tslib_1.__importDefault(require("node:crypto"));
 class OnboardingServiceFactory {
     context;
     cliConfig;
@@ -119,7 +121,8 @@ class OnboardingServiceFactory {
     async getFetchEventHandler(files, customerConfig, documentHandler, cache, cli, browserContext, athenaClient) {
         const configApi = this.getConfigApi(customerConfig.app);
         const serverConfig = await this.getSpeedKitServerConfig(configApi, cli);
-        const crawler = new crawler_1.Crawler(cli, serverConfig);
+        const agent = this.getCrawlerAgent(customerConfig, cli);
+        const crawler = new crawler_1.Crawler(cli, agent, serverConfig);
         const parameterQueryBuilder = new parameter_query_builder_1.ParameterQueryBuilder(customerConfig, files.getByName(files_1.INTEGRATION_FILES.CONFIG.SPEED_KIT));
         const DiffService = new diff_1.DiffServiceFactory(new diff_1.DiffContext(this.cliConfig.diffExec, this.cliConfig.diffExecTemplate)).getService();
         const requestDiffService = new request_diff_service_1.RequestDiffService(DiffService, documentHandler);
@@ -214,5 +217,43 @@ class OnboardingServiceFactory {
     ensureHttps(url = "") {
         return url.startsWith("https://") ? url : `https://${url}`;
     }
+    getCrawlerAgent(customerConfig, cli) {
+        const proxy = [];
+        const connect = {
+            keepAlive: true,
+        };
+        const agentOptions = {
+            rejectUnauthorized: false,
+            secureOptions: node_crypto_1.default.constants.SSL_OP_LEGACY_SERVER_CONNECT,
+        };
+        const crawlerProxyConfig = this.getCrawlerProxyConfig(customerConfig);
+        if (crawlerProxyConfig) {
+            cli.writeWarning(`use proxy from chromeFlags for local documenthandler`);
+            proxy.push(crawlerProxyConfig);
+        }
+        return (0, fetch_socks_1.socksDispatcher)(proxy, { ...agentOptions, connect });
+    }
+    getCrawlerProxyConfig(customerConfig) {
+        if (!customerConfig.chromeFlags ||
+            customerConfig.chromeFlags.length === 0) {
+            return;
+        }
+        //"--proxy-server=socks5://ap-northeast-1.proxy.baqend.com:1080"
+        const selector = /--proxy-server=socks(4|5):(\/\/[^:]*):(\d+)/is;
+        for (const flag of customerConfig.chromeFlags) {
+            if (!flag.includes("--proxy-server=socks")) {
+                continue;
+            }
+            const [, type, host, port] = flag.match(selector) || [];
+            if (!type || !host || !port) {
+                continue;
+            }
+            return {
+                type: Number(type),
+                host,
+                port: Number(port),
+            };
+        }
+    }
 }
 exports.OnboardingServiceFactory = OnboardingServiceFactory;

package/dist/services/onboarding/virtual-orestes-app/crawler.d.ts

@@ -1,9 +1,11 @@
 import { SpeedKitServerConfig } from "../onboarding-model";
 import { CliService } from "../../cli";
+import { Agent } from "undici";
 export declare class Crawler {
     private cli;
+    private agentConfig;
     private speedKitServerConfig?;
-    constructor(cli: CliService, speedKitServerConfig?: SpeedKitServerConfig);
+    constructor(cli: CliService, agentConfig: Agent, speedKitServerConfig?: SpeedKitServerConfig);
     fetchRemote(originUrl: string, variation: string): Promise<Response>;
     private setDefaultUserAgent;
     private prepareOriginRequest;

package/dist/services/onboarding/virtual-orestes-app/crawler.js

@@ -1,58 +1,62 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Crawler = void 0;
-const tslib_1 = require("tslib");
 const onboarding_model_1 = require("../onboarding-model");
 const safe_1 = require("../../../helpers/safe");
-const node_https_1 = require("node:https");
-const node_crypto_1 = tslib_1.__importDefault(require("node:crypto"));
-const agent = new node_https_1.Agent({
-    rejectUnauthorized: false,
-    keepAlive: true,
-    secureOptions: node_crypto_1.default.constants.SSL_OP_LEGACY_SERVER_CONNECT,
-});
+const cli_1 = require("../../cli");
 class Crawler {
     cli;
+    agentConfig;
     speedKitServerConfig;
-    constructor(cli, speedKitServerConfig) {
+    constructor(cli, agentConfig, speedKitServerConfig) {
         this.cli = cli;
+        this.agentConfig = agentConfig;
         this.speedKitServerConfig = speedKitServerConfig;
     }
     async fetchRemote(originUrl, variation) {
         const userAgent = this.setDefaultUserAgent(variation);
-        const headers = { "User-Agent": userAgent };
+        const headers = {
+            "User-Agent": userAgent,
+        };
         const requestInit = {
             ...this.prepareOriginRequest(originUrl, variation, {
                 headers,
             }),
-            agent,
+            agent: this.agentConfig,
         };
+        this.cli.startAction(`[documentHandler:fetch]: ${originUrl}`);
         const fetchResponse = await (0, safe_1.safe)(fetch(originUrl, requestInit));
         if (fetchResponse.success === true) {
+            this.cli.endAction(cli_1.CliActionStatus.COMPLETED);
             return fetchResponse.data;
         }
+        this.cli.endAction(cli_1.CliActionStatus.FAILED);
         this.cli.writeError(`error while fetching Asset: ${originUrl}`);
         this.cli.writeError(fetchResponse.error);
         this.cli.writeError(JSON.stringify(fetchResponse.errorObj));
     }
     setDefaultUserAgent(variation) {
-        if (variation.includes("mobile")) {
+        if (/^mobile$/is.test(variation)) {
             return onboarding_model_1.USER_AGENT.MOBILE;
         }
-        if (variation.includes("tablet")) {
+        if (/^tablet$/is.test(variation)) {
             return onboarding_model_1.USER_AGENT.TABLET;
         }
-        if (variation.includes("tv")) {
-            return onboarding_model_1.USER_AGENT.TV;
-        }
         return onboarding_model_1.USER_AGENT.DESKTOP;
     }
     prepareOriginRequest(originUrl, variationParameter, init) {
-        if (!this.speedKitServerConfig || !variationParameter) {
+        if (!this.speedKitServerConfig) {
+            return init;
+        }
+        if (this.speedKitServerConfig.speedKit.variations?.["*"]) {
+            const config = this.speedKitServerConfig.speedKit.variations["*"];
+            init.headers = { ...init.headers, ...config.headers };
+        }
+        if (!variationParameter) {
             return init;
         }
         for (const variationKey in this.speedKitServerConfig.speedKit.variations) {
-            if (variationParameter === variationKey.toUpperCase()) {
+            if (variationParameter === variationKey) {
                 const variationConfig = this.speedKitServerConfig.speedKit.variations[variationKey];
                 init.headers = { ...init.headers, ...variationConfig.headers };
                 return init;

package/dist/services/onboarding/virtual-orestes-app/index.js

@@ -27,7 +27,7 @@ class VirtualOrestesApp {
         const UrlObject = new URL(event.request.url);
         const variation = UrlObject.searchParams.has("bqvariation")
             ? UrlObject.searchParams.get("bqvariation").trim()
-            : "DEFAULT";
+            : "default";
         const cachedResponse = this.getCachedResponse(event.request.url);
         if (cachedResponse instanceof baqend_response_1.BaqendResponse) {
             return cachedResponse;
@@ -35,11 +35,11 @@ class VirtualOrestesApp {
         const response = await this.crawler.fetchRemote(originUrl, variation);
         // todo check if we can handle more then htmlResponses
         // only handle html responses
-        if (!response.headers.get("Content-Type").includes("html")) {
+        if (!response?.headers?.get("Content-Type")?.includes("html")) {
             return;
         }
-        const hasNoStoreFlag = response.headers
-            .get("Cache-Control")
+        const hasNoStoreFlag = response?.headers
+            ?.get("Cache-Control")
             ?.includes("no-store");
         const customHeaders = this.prepareCustomHeaders(originUrl, hasNoStoreFlag);
         // CDN Redirect
@@ -50,7 +50,7 @@ class VirtualOrestesApp {
             return this.returnRedirect(customHeaders, response, event);
         }
         const { responseContent, responseEncoding } = await this.getResponseText(response);
-        if (!this.isHtmlContentHeader(response.headers) ||
+        if (!this.isHtmlContentHeader(response?.headers) ||
             !this.isValidHtmlContent(responseContent)) {
             const customResponse = new baqend_response_1.BaqendResponse(responseContent, `text/html; charset=${responseEncoding}`, customHeaders);
             this.cache.addEntry(event.request.url, customResponse);
@@ -68,28 +68,28 @@ class VirtualOrestesApp {
         if (!Buffer.isBuffer(skResponse.body) && this.customerConfig.forceInstall) {
             skResponse.body = this.rewriteInstallResource(skResponse.body);
         }
-        for (const key in skResponse.headers) {
+        for (const key in skResponse?.headers) {
             customHeaders.push({
                 name: key,
-                value: skResponse.headers[key],
+                value: skResponse?.headers[key],
             });
         }
         const originHeaders = [];
         // eslint-disable-next-line unicorn/no-array-for-each
-        response.headers.forEach((value, key) => {
+        response?.headers.forEach((value, key) => {
             originHeaders.push({ name: `x-origin-${key}`, value: value });
         });
         customHeaders.push({
             name: "x-sk-detected-encoding",
             value: responseEncoding,
         });
-        const baqendResponse = new baqend_response_1.BaqendResponse(skResponse.body, response.headers.get("Content-Type"), [...customHeaders, ...originHeaders]);
+        const baqendResponse = new baqend_response_1.BaqendResponse(skResponse.body, response?.headers.get("Content-Type"), [...customHeaders, ...originHeaders]);
         this.cache.addEntry(event.request.url, baqendResponse);
         return baqendResponse;
     }
     async getResponseText(response) {
         const buffer = Buffer.from(await response.arrayBuffer());
-        const contentType = response.headers.get("content-type") || "";
+        const contentType = response?.headers.get("content-type") || "";
         const charsetRegex = /charset=([^\s"(),./:;<=>?@[\]]*)/i;
         const encodingFromHeader = contentType && charsetRegex.test(contentType)
             ? charsetRegex.exec(contentType)[1]
@@ -125,7 +125,7 @@ class VirtualOrestesApp {
     convertResponseHeadersToOrestesFormat(response) {
         const convertedResponseHeaders = {};
         // eslint-disable-next-line unicorn/no-array-for-each
-        response.headers.forEach((value, key) => {
+        response?.headers?.forEach((value, key) => {
             convertedResponseHeaders[key] = value;
         });
         return convertedResponseHeaders;
@@ -133,7 +133,7 @@ class VirtualOrestesApp {
     returnRedirect(customHeaders, response, event) {
         customHeaders.push({
             name: "location",
-            value: response.headers.get("location") || "",
+            value: response?.headers.get("location") || "",
         });
         const redirectResponse = new baqend_response_1.BaqendResponse("", null, customHeaders, response.status);
         this.cache.addEntry(event.request.url, redirectResponse);

package/oclif.manifest.json

@@ -738,5 +738,5 @@
       ]
     }
   },
-  "version": "3.20.0"
+  "version": "3.22.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@speedkit/cli",
   "description": "Speed Kit CLI",
-  "version": "3.20.0",
+  "version": "3.22.0",
   "author": {
     "name": "Baqend.com",
     "email": "info@baqend.com"
@@ -85,6 +85,7 @@
     "encoding-japanese": "^2.2.0",
     "esbuild": "^0.20.2",
     "extract-zip": "^2.0.1",
+    "fetch-socks": "^1.3.2",
     "fluent-ffmpeg": "^2.1.3",
     "fs-extra": "^11.2.0",
     "handlebars": "^4.7.8",