@speedkit/cli 3.2.0 → 3.4.0

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+# [3.4.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v3.3.0...v3.4.0) (2025-08-18)
+
+
+### Bug Fixes
+
+* escape path to browserExecutable for validator ([aafcecf](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/aafcecf3433a053aa87229492b4c8aca6b28867f))
+
+
+### Features
+
+* **onboarding:** ask to download chrome ([c2e8f01](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/c2e8f0140bae117be04cb9da580318306aa0c285))
+* **onboarding:** set correctPath to validate executable exists ([3d6a4dd](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/3d6a4dd68089937866c49ed60bdaece49e63083b))
+
+# [3.3.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v3.2.0...v3.3.0) (2025-08-14)
+
+
+### Features
+
+* **wizard:** extend questionnaire ([b36eb9f](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/b36eb9f595f904bd342907408bf40d1ba80c923b))
+* **wizard:** extend questionnaire ([c1770cd](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/c1770cd8642e71c69310659cae9835e4e4db838f))
+
 # [3.2.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v3.1.2...v3.2.0) (2025-08-13)
 
 

package/README.md

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

package/dist/helpers/cli-config.d.ts

@@ -9,6 +9,7 @@ export type UserCliConfig = {
     slackToken: string;
     testApp: string;
     tempFolder: string;
+    runtimeConfig: Config;
 };
 export declare class CliConfig {
     private config;

package/dist/helpers/cli-config.js

@@ -29,6 +29,7 @@ class CliConfig {
         slackToken: "",
         testApp: "",
         tempFolder: "/tmp",
+        runtimeConfig: {},
     };
     constructor(config) {
         this.config = config;
@@ -40,6 +41,7 @@ class CliConfig {
         this.loadConfigFromEnvironment();
         this.resolveExtensionConfigPaths();
         this.userCliConfig.tempFolder = this.config.cacheDir;
+        this.userCliConfig.runtimeConfig = this.config;
         return this.userCliConfig;
     }
     createEmptyConfigFile() {

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

@@ -30,6 +30,7 @@ export interface CustomerConfigSettings {
     activateImageOptimisation?: boolean;
     removeLazyLoading?: boolean;
     addPreRendering?: boolean;
+    addUADetection?: boolean;
     supportShadowDomInPreRendering?: boolean;
     shadowDomCustomElementPrefix?: string;
     activateRumTracking?: 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, supportShadowDomInPreRendering, shadowDomCustomElementPrefix, activateRumTracking, useGATracking, useScrapingBee, withGoogleOptimize, activateCfRocketLoaderWorkaround, hasSoftNavigations, isShopify, isShopware, isSalesforce, isOxid, isPlentymarkets, } = {};
+        let { production, staging, activateScopedDeployments, subRouteScope, includeServiceWorker, activateImageOptimisation, removeLazyLoading, addPreRendering, addUADetection, supportShadowDomInPreRendering, shadowDomCustomElementPrefix, activateRumTracking, useGATracking, useScrapingBee, withGoogleOptimize, activateCfRocketLoaderWorkaround, hasSoftNavigations, isShopify, isShopware, isSalesforce, isOxid, isPlentymarkets, } = {};
         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,
@@ -181,6 +181,7 @@ 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)) {
@@ -217,6 +218,7 @@ class CustomerConfigService {
             activateImageOptimisation,
             removeLazyLoading,
             addPreRendering,
+            addUADetection,
             supportShadowDomInPreRendering,
             shadowDomCustomElementPrefix,
             activateRumTracking,

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

@@ -70,6 +70,14 @@
 {{#if addPreRendering}}
   // Lambda SSR specific: detect device to cover different resolutions when rendered in lambda
   userAgentDetection: true,
+{{else if addUADetection}}
+  userAgentDetection: true,
+{{/if}}
+{{#if addUADetection}}
+  detectDevice: function(doc) {
+    // TODO adjust condition to your needs
+    return doc.querySelector('<mobile-specific-element>') ? "mobile" : "desktop";
+  },
 {{/if}}
     split: CURRENT_HOST_CONFIG.split,
     splitTestId: CURRENT_HOST_CONFIG.splitTestId,

package/dist/services/customer-config/templates/config_dynamicBlocks.es6.hbs

@@ -8,7 +8,12 @@
     // ssr container
     prerendered: [{ selector: "body > .speed-kit-shadow-app-root" }],
 {{/if}}
-
+{{#if addUADetection}}
+  detectDevice: (doc) => {
+    // TODO adjust condition to your needs
+    return doc.querySelector('<mobile-specific-element>') ? "mobile" : "desktop";
+  },
+{{/if}}
     blocks: [
       // TODO: adjust/replace this exemplary list
       {

package/dist/services/onboarding/browser/executable/executable-validator.d.ts

@@ -0,0 +1,12 @@
+import { UserCliConfig } from "../../../../helpers/cli-config";
+import { CliServiceInterface } from "../../../cli";
+export declare class ExecutableValidator {
+    readonly userConfig: UserCliConfig;
+    private cli;
+    constructor(userConfig: UserCliConfig, cli: CliServiceInterface);
+    validateOrInstall(): Promise<void>;
+    private getExecutablePathFromPuppeteer;
+    private isValidBrowserExecutable;
+    private cleanPath;
+    installBrowser(): Promise<void>;
+}

package/dist/services/onboarding/browser/executable/executable-validator.js

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExecutableValidator = void 0;
+const tslib_1 = require("tslib");
+// import CLI from puppeteer to use function as sames as `npx puppeteer browsers install`
+const browsers_1 = require("@puppeteer/browsers");
+const version_js_1 = require("puppeteer-core/internal/generated/version.js");
+const node_fs_1 = require("node:fs");
+const application_error_1 = tslib_1.__importDefault(require("../../../error-handling/error/application-error"));
+const browsers_2 = require("@puppeteer/browsers");
+const node_path_1 = require("node:path");
+class ExecutableValidator {
+    userConfig;
+    cli;
+    constructor(userConfig, cli) {
+        this.userConfig = userConfig;
+        this.cli = cli;
+    }
+    async validateOrInstall() {
+        // check if a valid browserExecutablePath is configured
+        const userChromePath = this.userConfig?.chromePath;
+        if (userChromePath.length > 0 &&
+            this.isValidBrowserExecutable(userChromePath)) {
+            return;
+        }
+        // write error if configured path is not executable
+        if (userChromePath.length > 0) {
+            this.cli.writeError(`Invalid "chromePath" configured: ${userChromePath}`);
+        }
+        // check if a browser is installed via puppeteer
+        const puppeteerCache = new browsers_2.Cache(this.userConfig.tempFolder);
+        const installedBrowsers = puppeteerCache.getInstalledBrowsers();
+        if (installedBrowsers.length > 0) {
+            // found an installed browser, set path to this
+            this.userConfig.chromePath = installedBrowsers[0].executablePath;
+            return;
+        }
+        // write warning that no browser is configured
+        if (userChromePath.length === 0) {
+            this.cli.writeWarning(`No Browser configured`);
+        }
+        // ask if you want to download stable chrome
+        const result = await this.cli.confirm("Do you want to download Chrome@latest via puppeteer?", true);
+        // @todo set more detailed error message here.
+        if (!result) {
+            throw new application_error_1.default("No Browser found to use", [
+                `set path to browser executable (chromePath) in ${this.userConfig.runtimeConfig.configDir}/config.json`,
+                `set path to browser executable (CHROME_PATH) in ./.env or as systemwide env`,
+                `let the ci download the latest chrome for you`,
+            ]);
+        }
+        // use puppeteerCli to download chrome
+        await this.installBrowser();
+        // set path to freshly installed chrome
+        this.userConfig.chromePath = this.getExecutablePathFromPuppeteer();
+    }
+    getExecutablePathFromPuppeteer() {
+        const puppeteerCache = new browsers_2.Cache(this.userConfig.tempFolder);
+        const installedBrowsers = puppeteerCache.getInstalledBrowsers();
+        return installedBrowsers[0].executablePath;
+    }
+    isValidBrowserExecutable(chromePath) {
+        return (0, node_fs_1.existsSync)(this.cleanPath((0, node_path_1.resolve)(chromePath)));
+    }
+    cleanPath(path) {
+        return path.trim().replaceAll(" ", "\\ ");
+    }
+    async installBrowser() {
+        const puppeteerCli = new browsers_1.CLI({
+            cachePath: this.userConfig.tempFolder,
+            scriptName: "@puppeteer/browsers",
+            version: version_js_1.packageVersion,
+            prefixCommand: {
+                cmd: "browsers",
+                description: "Manage browsers of this Puppeteer installation",
+            },
+            allowCachePathOverride: false,
+            pinnedBrowsers: {
+                [browsers_1.Browser.CHROME]: {
+                    buildId: "stable",
+                    skipDownload: false,
+                },
+            },
+        });
+        // first two parameters would be npx puppeteer, when used outside sk-cli
+        await puppeteerCli.run(["", "", "browsers", "install"]);
+    }
+}
+exports.ExecutableValidator = ExecutableValidator;
+//

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

@@ -42,6 +42,7 @@ const path = tslib_1.__importStar(require("node:path"));
 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");
 class OnboardingServiceFactory {
     context;
     cliConfig;
@@ -70,6 +71,8 @@ class OnboardingServiceFactory {
         const extensionDownloader = new extension_downloader_1.ExtensionDownloader(this.cliConfig, cli);
         const extensionPaths = await new extension_validator_1.ExtensionValidator(extensionDownloader, this.cliConfig, cli).getValidBrowserExtensionPaths();
         this.cliConfig.chromeExtensionPaths = extensionPaths.join(",");
+        const browserValidator = new executable_validator_1.ExecutableValidator(this.cliConfig, cli);
+        await browserValidator.validateOrInstall();
         const browserContext = new onboarding_model_1.BrowserContext(domainToStart, customerConfig.chromeFlags || [], this.cliConfig);
         const fileWatcher = new file_watcher_1.FileWatcher(cli, customerConfig, files, documentHandler, browserContext, cache);
         const athenaClient = (await this.getAthenaClient()) || null;

package/oclif.manifest.json

@@ -732,5 +732,5 @@
       ]
     }
   },
-  "version": "3.2.0"
+  "version": "3.4.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@speedkit/cli",
   "description": "Speed Kit CLI",
-  "version": "3.2.0",
+  "version": "3.4.0",
   "author": {
     "name": "Baqend.com",
     "email": "info@baqend.com"