@speedkit/cli 2.70.1 → 2.72.0

package/CHANGELOG.md

@@ -1,3 +1,23 @@
+# [2.72.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.71.0...v2.72.0) (2024-12-18)
+
+
+### Bug Fixes
+
+* **integration-devtools:** only update if installed ([d9f9710](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/d9f971019d0baaa05dbba4e2ca684419577e5a78))
+
+
+### Features
+
+* **onboarding:** embed integration-devtools ([530d863](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/530d8633c06a84110f24116885c4f02ee1d9df65))
+
+# [2.71.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.70.1...v2.71.0) (2024-12-12)
+
+
+### Features
+
+* **wizard:** lambda add initial hiding of shadow-dom and un-hide when rendered ([dddfd62](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/dddfd62791754558ae7481914c1be3eef65ffc8f))
+* **wizard:** remove legacy dynamic blocks lambda server-side rendering related code ([3ee1e4a](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/3ee1e4a755b21b28f56aa4f2e74f910e093be6ba))
+
 ## [2.70.1](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.70.0...v2.70.1) (2024-12-12)
 
 

package/README.md

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

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

@@ -98,6 +98,8 @@ const config = {
       assignStylesToShadowDom(document);
       addDeclarativeShadowDOMPolyfill(document);
       addPolyFillAfterMainPreRenderTemplate(document);
+      hideCustomShadowDom(document);
+      showCustomShadowDom(document);
     {{/unless}}
     {{#if supportShadowDomInPreRendering}}
       overrideCustomElementDefine(document);
@@ -350,6 +352,26 @@ export const post = async (db, req, res) => {
       topTemplate.after(polyfillScript);
     });
   }
+
+  function hideCustomShadowDom(document) {
+    const customShadowRoots = getCustomShadowElements(document);
+
+    customShadowRoots.forEach((element) => {
+      const style = document.createElement("style");
+      style.textContent = `.speed-kit-pre-rendered-block-added{visibility:hidden;}`;
+      element.prepend(style);
+    });
+  }
+
+  function showCustomShadowDom(document) {
+    const customShadowRoots = getCustomShadowElements(document);
+
+    customShadowRoots.forEach((element) => {
+      const style = document.createElement("style");
+      style.textContent = `.speed-kit-pre-rendered-block-added{visibility:visible;}`;
+      element.appendChild(style);
+    });
+  }
   {{#if supportShadowDomInPreRendering}}
     //================================================================================
     // PuppeteerCallback

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

@@ -13,20 +13,6 @@
 {{/if}}
 
     blocks: [
-{{#if addPreRendering}}
-  {{#unless supportShadowDomInPreRendering}}
-      ...preRenderedRootConfig.map((config) => {
-        return {
-          selector: config.selector,
-          merge: (localBlock, remoteBlock) => {
-            handlePreRenderBlock(localBlock, remoteBlock);
-          },
-          detectChanges: false,
-        };
-      }),
-
-  {{/unless}}
-{{/if}}
       // TODO: adjust/replace this exemplary list
       {
 {{#if addPreRendering}}

package/dist/services/onboarding/browser/extension/extension-downloader.d.ts

@@ -0,0 +1,12 @@
+import { UserCliConfig } from "../../../../helpers/cli-config";
+import { CliServiceInterface } from "../../../cli";
+export declare class ExtensionDownloader {
+    private userConfig;
+    private cli;
+    constructor(userConfig: UserCliConfig, cli: CliServiceInterface);
+    downloadExtension(): Promise<string | false>;
+    private updateLocalDevtools;
+    isInstalled(): boolean;
+    private checkInstalledVersion;
+    private getRemoteVersion;
+}

package/dist/services/onboarding/browser/extension/extension-downloader.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExtensionDownloader = void 0;
+const tslib_1 = require("tslib");
+const node_fs_1 = tslib_1.__importDefault(require("node:fs"));
+const node_path_1 = tslib_1.__importDefault(require("node:path"));
+const semver_1 = tslib_1.__importDefault(require("semver"));
+const extract_zip_1 = tslib_1.__importDefault(require("extract-zip"));
+const cli_1 = require("../../../cli");
+const safe_1 = require("../../../../helpers/safe");
+const devtools = "integration-devtools";
+class ExtensionDownloader {
+    userConfig;
+    cli;
+    constructor(userConfig, cli) {
+        this.userConfig = userConfig;
+        this.cli = cli;
+    }
+    async downloadExtension() {
+        // check for already installed devExtension
+        const isInstalled = this.isInstalled();
+        if (isInstalled) {
+            // check for updates
+            const remoteVersion = await this.getRemoteVersion();
+            const localVersion = await this.checkInstalledVersion();
+            if (semver_1.default.compare(remoteVersion, localVersion) > 0) {
+                const response = await this.cli.confirm(`integration-devtools update available from ${localVersion} to ${remoteVersion}  Install?`, true);
+                if (!response) {
+                    return false;
+                }
+            }
+        }
+        else {
+            const response = await this.cli.confirm("Do you want to install devtools-extension?", true);
+            if (!response) {
+                return false;
+            }
+        }
+        this.cli.startAction("update integration-devtools");
+        const response = await (0, safe_1.safe)(this.updateLocalDevtools());
+        if (response.success === false) {
+            this.cli.endAction(cli_1.CliActionStatus.FAILED);
+            this.cli.writeError(response.error);
+            return false;
+        }
+        this.cli.endAction(cli_1.CliActionStatus.COMPLETED);
+        return response.data;
+    }
+    async updateLocalDevtools() {
+        // downloadExtension
+        const extensionResponse = await fetch("https://threepointonefour.app.baqend.com/v1/code/webhook_gitlab_release?download");
+        // get fileName from header
+        const fileName = extensionResponse.headers.get("filename");
+        // resolve path for unpacked extension
+        const extensionUnpacked = node_path_1.default.resolve(this.userConfig.tempFolder, devtools);
+        // resolve path for zipFile
+        const archivePath = node_path_1.default.resolve(this.userConfig.tempFolder, fileName);
+        // getFileBlob
+        const extensionBlob = await extensionResponse.arrayBuffer();
+        // write zipFile
+        node_fs_1.default.writeFileSync(archivePath, Buffer.from(extensionBlob));
+        // cleanUp older versions
+        node_fs_1.default.rmSync(extensionUnpacked, { recursive: true, force: true });
+        // extract zipArchive
+        await (0, extract_zip_1.default)(archivePath, { dir: extensionUnpacked });
+        // remove zipArchive
+        node_fs_1.default.rmSync(archivePath);
+        return extensionUnpacked;
+    }
+    isInstalled() {
+        const extensionPath = node_path_1.default.resolve(this.userConfig.tempFolder, devtools, "manifest.json");
+        return node_fs_1.default.existsSync(extensionPath);
+    }
+    checkInstalledVersion() {
+        const extensionPath = node_path_1.default.resolve(this.userConfig.tempFolder, devtools, "manifest.json");
+        const manifestFile = node_fs_1.default.readFileSync(extensionPath, "utf-8");
+        const manifestConfig = JSON.parse(manifestFile);
+        return manifestConfig.version;
+    }
+    async getRemoteVersion() {
+        const versionResponse = await fetch("https://threepointonefour.app.baqend.com/v1/code/webhook_gitlab_release");
+        if (!versionResponse.ok) {
+            throw new Error("Could not find version for" + devtools);
+        }
+        const response = await versionResponse.json();
+        return response.version;
+    }
+}
+exports.ExtensionDownloader = ExtensionDownloader;

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

@@ -1,10 +1,12 @@
 import { UserCliConfig } from "../../../../helpers/cli-config";
 import { CliServiceInterface } from "../../../cli";
+import { ExtensionDownloader } from "./extension-downloader";
 export declare class ExtensionValidator {
+    private extensionDownloader;
     private cliConfig;
-    private cliBasePath;
     private cli;
-    constructor(cliConfig: UserCliConfig, cliBasePath: string, cli: CliServiceInterface);
+    constructor(extensionDownloader: ExtensionDownloader, cliConfig: UserCliConfig, cli: CliServiceInterface);
     getValidBrowserExtensionPaths(): Promise<string[]>;
     private getManifestConfig;
+    private handleDevtoolsExtension;
 }

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

@@ -9,17 +9,16 @@ const safe_1 = require("../../../../helpers/safe");
 const node_fs_1 = require("node:fs");
 const browser_extension_error_1 = require("../../error/browser-extension-error");
 class ExtensionValidator {
+    extensionDownloader;
     cliConfig;
-    cliBasePath;
     cli;
-    constructor(cliConfig, cliBasePath, cli) {
+    constructor(extensionDownloader, cliConfig, cli) {
+        this.extensionDownloader = extensionDownloader;
         this.cliConfig = cliConfig;
-        this.cliBasePath = cliBasePath;
         this.cli = cli;
     }
     async getValidBrowserExtensionPaths() {
         const validExtensions = [];
-        const validPaths = [];
         this.cli.startAction("resolve browserExtensions");
         const browserExtensions = this.cliConfig.chromeExtensionPaths
             .split(",")
@@ -37,13 +36,14 @@ class ExtensionValidator {
                 name: manifestConfig.name,
                 version: manifestConfig.version,
             });
-            validPaths.push(cleanedExtensionPath);
         }
         this.cli.endAction(cli_1.CliActionStatus.COMPLETED);
+        this.cli.spacer();
+        await this.handleDevtoolsExtension(validExtensions);
         if (validExtensions.length > 0) {
             this.cli.table(validExtensions, { name: {}, version: {}, path: {} });
         }
-        return validPaths;
+        return validExtensions.map((config) => config.path);
     }
     async getManifestConfig(cleanedExtensionPath) {
         const manifestPath = node_path_1.default.resolve(cleanedExtensionPath, "manifest.json");
@@ -59,5 +59,20 @@ class ExtensionValidator {
         }
         return result.data;
     }
+    async handleDevtoolsExtension(validExtensions) {
+        if (validExtensions.some((config) => config.name.toLowerCase().includes("devtools extension"))) {
+            return;
+        }
+        const path = await this.extensionDownloader.downloadExtension();
+        if (path === false) {
+            return;
+        }
+        const extensionConfig = await this.getManifestConfig(path);
+        validExtensions.push({
+            path: path,
+            name: extensionConfig.name,
+            version: extensionConfig.version,
+        });
+    }
 }
 exports.ExtensionValidator = ExtensionValidator;

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

@@ -41,6 +41,7 @@ const fs = tslib_1.__importStar(require("node:fs"));
 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");
 class OnboardingServiceFactory {
     context;
     cliConfig;
@@ -66,7 +67,8 @@ class OnboardingServiceFactory {
         const skTemplate = new install_speed_kit_js_template_1.InstallSpeedKitJsTemplate();
         const speedKitInstallContext = new speed_kit_install_context_1.SpeedKitInstallContext(customerConfig, this.context.configName, files, bundler, skTemplate, this.context.local);
         await this.buildInstallResource(speedKitInstallContext, files, cli);
-        const extensionPaths = await new extension_validator_1.ExtensionValidator(this.cliConfig, this.context.cliPath, cli).getValidBrowserExtensionPaths();
+        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 browserContext = new onboarding_model_1.BrowserContext(domainToStart, customerConfig.chromeFlags || [], this.cliConfig);
         const fileWatcher = new file_watcher_1.FileWatcher(cli, customerConfig, files, documentHandler, browserContext, cache);

package/oclif.manifest.json

@@ -712,5 +712,5 @@
       ]
     }
   },
-  "version": "2.70.1"
+  "version": "2.72.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@speedkit/cli",
   "description": "Speed Kit CLI",
-  "version": "2.70.1",
+  "version": "2.72.0",
   "author": {
     "name": "Baqend.com",
     "email": "info@baqend.com"
@@ -92,6 +92,7 @@
     "parse5-htmlparser2-tree-adapter": "7.0.0",
     "puppeteer": "^22.6.5",
     "puppeteer-extra": "^3.3.6",
+    "semver": "^7.6.3",
     "strip-comments": "^2.0.1",
     "uuid": "^9.0.1",
     "esbuild": "^0.20.2",