@speedkit/cli 2.68.0 → 2.69.1

package/CHANGELOG.md

@@ -1,3 +1,25 @@
+## [2.69.1](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.69.0...v2.69.1) (2024-12-11)
+
+
+### Bug Fixes
+
+* **axios:** remove unused axios dependency ([40f0238](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/40f023845a800667c284c63a1fafe816c3d42d12))
+
+# [2.69.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.68.0...v2.69.0) (2024-12-11)
+
+
+### Bug Fixes
+
+* createProfileFolder if not exists ([e820a45](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/e820a45f6c4398b646f609c6d072d8d7775e4ac9))
+
+
+### Features
+
+* create dynamic browserProfile from last session ([cce0f99](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/cce0f995fb6ee8d9c84818d93ef1db50a6bd7820))
+* **diff:** add .html-extension so idea can have syntaxHighlighting ([748bc25](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/748bc2541a7d6b6a521b2eecf8e22666aefe68b4))
+* load last browserConfig and create a fresh profile with it ([878a420](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/878a42027b15a43d59f438bc34a88f8b10a652e6))
+* **onboarding:** filter unwanted configKeys from previous configs ([b3f08a0](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/b3f08a09d05fe6689fd826a03e5702559c5c6a68))
+
 # [2.68.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.67.0...v2.68.0) (2024-12-11)
 
 

package/README.md

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

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

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

package/dist/helpers/cli-config.js

@@ -28,6 +28,7 @@ class CliConfig {
         ideaDirectory: "",
         slackToken: "",
         testApp: "",
+        tempFolder: "/tmp",
     };
     constructor(config) {
         this.config = config;
@@ -38,6 +39,7 @@ class CliConfig {
         // override config from environment
         this.loadConfigFromEnvironment();
         this.resolveExtensionConfigPaths();
+        this.userCliConfig.tempFolder = this.config.cacheDir;
         return this.userCliConfig;
     }
     createEmptyConfigFile() {

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

@@ -21,7 +21,6 @@ export declare class CustomerConfigService {
     private compileHandlebarsFiles;
     private getEnvironmentConfig;
     private shouldFileBeOverwritten;
-    private downloadAndSaveFile;
     private getConfigSettings;
     logWarnings(configSettings: CustomerConfigSettings): Promise<void>;
     generateConfig(): Promise<void>;

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

@@ -5,7 +5,6 @@ const tslib_1 = require("tslib");
 const fs = tslib_1.__importStar(require("node:fs"));
 const path = tslib_1.__importStar(require("node:path"));
 const Handlebars = tslib_1.__importStar(require("handlebars"));
-const axios_1 = tslib_1.__importDefault(require("axios"));
 const cli_1 = require("../cli");
 const customer_config_service_model_1 = require("./customer-config-service-model");
 class CustomerConfigService {
@@ -136,30 +135,6 @@ class CustomerConfigService {
         }
         return true;
     }
-    async downloadAndSaveFile(url, outputFilePath) {
-        this.cli.startAction(`Adding ${path.basename(outputFilePath)}`);
-        try {
-            if (!(await this.shouldFileBeOverwritten(outputFilePath))) {
-                this.cli.endAction(cli_1.CliActionStatus.SKIPPED);
-                return;
-            }
-            const response = await axios_1.default.get(url, { responseType: "text" });
-            const date = new Date();
-            const day = String(date.getDate()).padStart(2, "0");
-            const month = String(date.getMonth() + 1).padStart(2, "0"); // Months are 0-indexed
-            const year = date.getFullYear();
-            const time = date.toLocaleTimeString("de-DE");
-            const formattedDate = `${day}.${month}.${year}, ${time}`;
-            // Add timestamp banner to the file
-            const banner = `/**\n * Downloaded from:\n * ${url}\n * \n * Date: ${formattedDate}\n */\n\n`;
-            const contentWithBanner = banner + response.data;
-            fs.writeFileSync(outputFilePath, contentWithBanner);
-            this.cli.endAction(cli_1.CliActionStatus.COMPLETED);
-        }
-        catch {
-            this.cli.endAction(cli_1.CliActionStatus.FAILED);
-        }
-    }
     async getConfigSettings() {
         let { production, staging, subRouteScope, includeServiceWorker, activateImageOptimisation, removeLazyLoading, addPreRendering, supportShadowDomInPreRendering, shadowDomCustomElementPrefix, activateRumTracking, useGATracking, useScrapingBee, withGoogleOptimize, activateCfRocketLoaderWorkaround, hasSoftNavigations, isShopify, isShopware, isSalesforce, isPlentymarkets, shopifyId, } = {};
         this.appName = await this.cli.prompt(`Enter SK App Name:`, {

package/dist/services/onboarding/browser/config/browser-config.d.ts

@@ -0,0 +1,27 @@
+import { UserCliConfig } from "../../../../helpers/cli-config";
+/**
+ * this class makes sure you always start skOnboarding with a fresh browser,
+ * but still keep your window/devtools-configuration
+ */
+export declare class BrowserConfig {
+    private userConfig;
+    constructor(userConfig: UserCliConfig);
+    /**
+     * create a new temporary profileFolder
+     * load browserConfigJsonFile from last profileFolder
+     * delete older profiles
+     */
+    loadProfileTempDir(): string;
+    /**
+     * load latest browserConfig and put it into newly created profilePath
+     */
+    private createProfileDirWithLatestConfig;
+    private sortFoldersByDate;
+    /**
+     * remove keys we don't need
+     *
+     * @param configString
+     * @private
+     */
+    private cleanUpLastConfig;
+}

package/dist/services/onboarding/browser/config/browser-config.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BrowserConfig = void 0;
+const tslib_1 = require("tslib");
+const node_path_1 = tslib_1.__importDefault(require("node:path"));
+const node_fs_1 = tslib_1.__importDefault(require("node:fs"));
+const chromeProfilesParentFolder = "chrome_profile";
+const keysToRemove = new Set([
+    "sessions",
+    "extensions",
+    "in_product_help",
+    "history_clusters",
+    "media",
+    "profile",
+    "protection",
+]);
+/**
+ * this class makes sure you always start skOnboarding with a fresh browser,
+ * but still keep your window/devtools-configuration
+ */
+class BrowserConfig {
+    userConfig;
+    constructor(userConfig) {
+        this.userConfig = userConfig;
+    }
+    /**
+     * create a new temporary profileFolder
+     * load browserConfigJsonFile from last profileFolder
+     * delete older profiles
+     */
+    loadProfileTempDir() {
+        const chromeProfilePath = node_path_1.default.resolve(this.userConfig.tempFolder, chromeProfilesParentFolder, String(Date.now()));
+        const chromeProfilesParentFolderPath = node_path_1.default.resolve(this.userConfig.tempFolder, chromeProfilesParentFolder);
+        // create parentFolder if not exists
+        if (!node_fs_1.default.existsSync(chromeProfilesParentFolderPath)) {
+            node_fs_1.default.mkdirSync(chromeProfilesParentFolderPath, { recursive: true });
+        }
+        // load older profiles
+        const chromeProfileFolders = node_fs_1.default.readdirSync(chromeProfilesParentFolderPath);
+        if (!chromeProfileFolders || chromeProfileFolders.length === 0) {
+            return chromeProfilePath;
+        }
+        const sortedFolders = this.sortFoldersByDate(chromeProfileFolders);
+        this.createProfileDirWithLatestConfig(sortedFolders, chromeProfilesParentFolderPath, chromeProfilePath);
+        return chromeProfilePath;
+    }
+    /**
+     * load latest browserConfig and put it into newly created profilePath
+     */
+    createProfileDirWithLatestConfig(sortedFolders, chromeTemporaryFolderPath, chromeProfilePath) {
+        let foundLatestFolder = false;
+        for (const folderName of sortedFolders) {
+            const preferencesPath = node_path_1.default.resolve(chromeTemporaryFolderPath, folderName, "Default", "Preferences");
+            // look for chrome preferences in latest profileFolder
+            // delete folders not containing any profiles
+            // delete all older folders after we found latest profile
+            if (!node_fs_1.default.existsSync(preferencesPath) || foundLatestFolder) {
+                node_fs_1.default.rmSync(node_path_1.default.resolve(chromeTemporaryFolderPath, folderName), {
+                    recursive: true,
+                    force: true,
+                });
+                continue;
+            }
+            // return latest found config
+            const lastConfigString = this.cleanUpLastConfig(node_fs_1.default.readFileSync(preferencesPath, "utf8"));
+            node_fs_1.default.mkdirSync(node_path_1.default.resolve(chromeProfilePath, "Default"), {
+                recursive: true,
+            });
+            node_fs_1.default.writeFileSync(node_path_1.default.resolve(chromeProfilePath, "Default", "Preferences"), lastConfigString, { encoding: "utf-8" });
+            // after adding latest profile to new profile
+            // delete folder where we got the latest config from
+            node_fs_1.default.rmSync(node_path_1.default.resolve(chromeTemporaryFolderPath, folderName), {
+                recursive: true,
+                force: true,
+            });
+            foundLatestFolder = true;
+        }
+    }
+    sortFoldersByDate(chromeProfileFolders) {
+        return chromeProfileFolders.sort((a, b) => {
+            return Number.parseInt(b) - Number.parseInt(a);
+        });
+    }
+    /**
+     * remove keys we don't need
+     *
+     * @param configString
+     * @private
+     */
+    cleanUpLastConfig(configString) {
+        const config = JSON.parse(configString);
+        const newConfig = {};
+        for (const key in config) {
+            if (keysToRemove.has(key)) {
+                continue;
+            }
+            newConfig[key] = config[key];
+        }
+        return JSON.stringify(newConfig);
+    }
+}
+exports.BrowserConfig = BrowserConfig;

package/dist/services/onboarding/dashboard/diff-against-current-page.js

@@ -32,8 +32,8 @@ class DiffAgainstCurrentPage {
             originHtml = originDocumentHandlerResponse.body;
         }
         this.cli.endAction(cli_1.CliActionStatus.COMPLETED);
-        const remoteFilePath = await this.diffService.writeContentToTemporalFile(`remote-${variant}`, originHtml);
-        const localFilePath = await this.diffService.writeContentToTemporalFile("current", currentHtml);
+        const remoteFilePath = await this.diffService.writeContentToTemporalFile(`remote-${variant}.html`, originHtml);
+        const localFilePath = await this.diffService.writeContentToTemporalFile("current.html", currentHtml);
         return await this.diffService.executeDiff(localFilePath, remoteFilePath);
     }
 }

package/dist/services/onboarding/onboarding-model.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SpeedKitInstallRegex = exports.USER_AGENT = exports.OnboardingContext = exports.BrowserContext = exports.CDP_SESSION = exports.BROWSER_EVENTS = void 0;
 const core_1 = require("@oclif/core");
 const cli_parameters_1 = require("../../models/cli-parameters");
+const browser_config_1 = require("./browser/config/browser-config");
 const DEFAULT_BROWSER_ARGS = [
     "--enable-features=Translate,NetworkService",
     "--no-first-run",
@@ -57,6 +58,11 @@ class BrowserContext {
         if (userConfig?.chromeUserProfilePath) {
             browserArguments.push(`--user-data-dir=${userConfig?.chromeUserProfilePath}`);
         }
+        else {
+            const browserConfig = new browser_config_1.BrowserConfig(this.userConfig);
+            const temporaryProfileDirectory = browserConfig.loadProfileTempDir();
+            browserArguments.push(`--user-data-dir=${temporaryProfileDirectory}`);
+        }
         this.browserArgs = [
             ...browserArguments,
             `--unsafely-treat-insecure-origin-as-secure=${domain}`,

package/oclif.manifest.json

@@ -712,5 +712,5 @@
       ]
     }
   },
-  "version": "2.68.0"
+  "version": "2.69.1"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@speedkit/cli",
   "description": "Speed Kit CLI",
-  "version": "2.68.0",
+  "version": "2.69.1",
   "author": {
     "name": "Baqend.com",
     "email": "info@baqend.com"
@@ -72,8 +72,7 @@
     "@oclif/plugin-help": "^6.2.16",
     "@oclif/plugin-not-found": "^3.2.25",
     "@oclif/plugin-warn-if-update-available": "^3.1.21",
-    "axios": "^1.6",
-    "baqend": "^3.4",
+    "baqend": "^4.1.0",
     "chalk": "^4.1.2",
     "clipboardy-cjs": "^3.0.0",
     "css-select": "5.1.0",
@@ -92,9 +91,7 @@
     "parse5": "7.1",
     "parse5-htmlparser2-tree-adapter": "7.0.0",
     "puppeteer": "^22.6.5",
-    "puppeteer-core": "^22.6.5",
     "puppeteer-extra": "^3.3.6",
-    "puppeteer-extra-plugin-user-preferences": "^2.4.1",
     "strip-comments": "^2.0.1",
     "uuid": "^9.0.1",
     "esbuild": "^0.20.2",