@speedkit/cli 2.65.0 → 2.65.2

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [2.65.2](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.65.1...v2.65.2) (2024-11-12)
+
+
+### Bug Fixes
+
+* **speed-kit-cli:** missing opening tag in force install ([dbee840](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/dbee840057c2ebbd00d032bf482297592025a818))
+
+## [2.65.1](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.65.0...v2.65.1) (2024-11-08)
+
+
+### Bug Fixes
+
+* **onboarding:** remove reference to defaultLocalDevtools ([c2c3128](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/c2c3128069169488a2cc5e1da85ea77676f55e8e))
+
 # [2.65.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.64.0...v2.65.0) (2024-11-01)
 
 

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @speedkit/cli
 $ sk COMMAND
 running command...
 $ sk (--version)
-@speedkit/cli/2.65.0 linux-x64 node-v20.18.0
+@speedkit/cli/2.65.2 linux-x64 node-v20.18.0
 $ sk --help [COMMAND]
 USAGE
   $ sk COMMAND
@@ -353,7 +353,7 @@ DESCRIPTION
   Display help for sk.
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.3/src/commands/help.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.16/src/commands/help.ts)_
 
 ## `sk login [APP]`
 

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

@@ -1,43 +1,9 @@
 (function() {
-{{#if addPreRendering}}
-  {{#unless supportShadowDomInPreRendering}}
-  const PRERENDER_TIMEOUT = 30_000; // 30s
-  const PRERENDER_CHECK_INTERVAL = 300; // 300ms
-  const preRenderedRootConfig = [
-    // TODO: adjust/replace this exemplary list
-    {
-      selector: "body > #app, #speed-kit-pre-rendered-app",
-      detectChanges: [
-        {
-          // header area
-          find: "#page-root > div > .aem-container > div:nth-of-type(1)",
-          detectChanges: [
-            // main categories
-            {
-              find: 'button[id^="menu-button"] p',
-              compare: ["text"],
-            },
-            // logo
-            {
-              find: "img[src]",
-              compare: ["src"],
-            },
-          ],
-        },
-      ],
-    },
-  ];
-
-  {{/unless}}
-{{/if}}
   /**
    * @type {DynamicBlockConfig}
    */
   window.dynamicBlockConfig = {
-{{#if isShopify}}
-    dynamicScriptExecution: true, // Shopify specific
-    // => as some async external scripts are injected more or less randomly into the html, destroying the order of local & remote scripts
-{{/if}}
+    dynamicScriptExecution: true,
 {{#if addPreRendering}}
     assetChangeDetection: {
       ignore: [
@@ -62,31 +28,30 @@
   {{/unless}}
 {{/if}}
       // TODO: adjust/replace this exemplary list
-
       {
 {{#if addPreRendering}}
-        selector: '#main',
+        selector: ".prerendered-top-level-element",
 {{else}}
-        selector: 'body',
+        selector: "body",
 {{/if}}
         detectChanges: [
           // Main Headline:
           {
-            find: 'h1',
-            compare: ['text'],
+            find: "h1",
+            compare: ["text"],
           },
 
           // Home:
           {
-            find: '.stage-teaser source',
-            compare: ['srcset'],
+            find: ".stage-teaser source",
+            compare: ["srcset"],
           },
 
           // PLP:
           {
-            find: '.product-grid .product img',
+            find: ".product-grid .product img",
             limit: 9, // only compare the first 9 products
-            compare: ['src'],
+            compare: ["src"],
           },
           // ...
 
@@ -95,7 +60,6 @@
         ],
       },
 {{#if isShopify}}
-
       // Shopify specific:
       {
         selector: "#shopify-section-announcement-bar",
@@ -135,11 +99,11 @@
 
       // Workaround for Cloudflare's Rocket Loader (e.g. needed for Shopify)
       {
-        selector: 'script[data-cf-settings]',
+        selector: "script[data-cf-settings]",
         mergeFunction: function (localBlock, remoteBlock) {
-          let cFHash = remoteBlock.getAttribute('data-cf-settings');
-          localBlock.setAttribute('data-cf-settings', cFHash);
-          let deferScripts = document.querySelectorAll('script[src][defer]');
+          let cFHash = remoteBlock.getAttribute("data-cf-settings");
+          localBlock.setAttribute("data-cf-settings", cFHash);
+          let deferScripts = document.querySelectorAll("script[src][defer]");
                 deferScripts.forEach((deferScript) => {
             let type = deferScript.type;
             type = type.replace(/[a-f0-9]{24}/, cFHash.split('-')[0]);
@@ -150,327 +114,36 @@
 {{/if}}
 
       // default entries
-      {selector: 'link[rel="canonical"]'},
-      {selector: 'meta[name]', idAttribute: 'name'},
-      {selector: 'meta[property]', idAttribute: 'property'},
-      {selector: 'script[type="application/ld+json"]'},
+      { selector: 'link[rel="canonical"]'},
+      { selector: "meta[name]", idAttribute: "name"},
+      { selector: 'meta[property]', idAttribute: "property"},
+      { selector: 'script[type="application/ld+json"]'},
     ],
-  };
-
-  //================================================================================
-  // Utility Functions
-  //================================================================================
-
-{{#if addPreRendering}}
-{{#if supportShadowDomInPreRendering}}
-  const preRenderedRootConfig = [
-    // TODO: adjust/replace this exemplary list
-    // TODO: accessing elements within a shadow-dom, nested detectChanges is needed on that level
-    {
-      selector: ".sk-container",
-      remote: "body > #app",
+    {{#if addPreRendering}}
+    preRenderedRootConfig: [
+      // TODO: adjust/replace this exemplary list
+      {
+      selector: ".prerendered-top-level-element",
       detectChanges: [
         {
-          find: "tef-carousel",
+          // header area
+          find: "#page-root > div > .aem-container > div:nth-of-type(1)",
           detectChanges: [
+            // main categories
+            {
+              find: 'button[id^="menu-button"] p',
+              compare: ["text"],
+            },
+            // logo
             {
-              find: ".slide tef-stage-teaser",
-              detectChanges: [
-                {
-                  find: '[slot="visual"] source',
-                  compare: ["srcset"],
-                },
-                {
-                  find: '[slot="overline"]',
-                  compare: ["text"],
-                },
-              ],
+              find: "img[src]",
+              compare: ["src"],
             },
           ],
         },
-      ],
-    },
-  ];
-
-  document.addEventListener("dynamic-fetcher-data-ready", function () {
-    setTimeout(() => {
-      registerRemoteRenderObserver();
-    }, 500);
-  });
-
-  function registerRemoteRenderObserver() {
-    window?.performance?.mark("sk-prerender-observe-start");
-
-    let promises = [];
-    for (const preRenderedRoot of preRenderedRootConfig) {
-      const remoteSelector = preRenderedRoot.remote;
-      const remoteRootElement = document.querySelector(remoteSelector);
-      if (!remoteRootElement) {
-        continue;
-      }
-      promises = [...promises, ...collectWaitForEvents(remoteRootElement)];
-    }
-    removePlaceholderWhenResolved(promises);
-  }
-
-  function collectWaitForEvents(remoteRootElement) {
-    const undefinedElements =
-      remoteRootElement.querySelectorAll(":not(:defined)");
-    return [...undefinedElements]
-      .filter((element) => element.localName.startsWith("{{shadowDomCustomElementPrefix}}"))
-      .map((element) => {
-        return customElements.whenDefined(element.localName);
-      });
-  }
-
-  /**
-   * checks for all webComponents to be ready before switching to origin
-   *
-   * @param remoteRootElement
-   */
-  function removePlaceholderWhenResolved(promises) {
-    const preRenderedPlaceHolders = document.querySelectorAll(
-      ".speed-kit-shadow-app-root",
-    );
-    Promise.race([
-      Promise.all(promises),
-      new Promise((resolve) => {
-        setTimeout(resolve, 5000);
-      }),
-    ])
-      .catch((error) => {})
-      .then(() => {
-        try {
-          detectChanges();
-        } catch (error) {}
-        preRenderedPlaceHolders.forEach((localRootElement) =>
-          localRootElement.remove(),
-        );
-        dispatchReadyEvent(window.dynamicBlockConfig.preRenderWaitFor);
-      });
-  }
-{{else}}
-  function handlePreRenderBlock(localBlock, remoteBlock) {
-    // handle preRendering by inserting pre-rendered #app before initial #app
-    if (
-      window.dynamicBlockConfig.preRenderWaitFor &&
-      window.dynamicBlockConfig.preRenderWaitFor.length > 0
-    ) {
-      localBlock.classList.add("speed-kit-shadow-app-root");
-      localBlock.before(remoteBlock);
-      return;
-    }
-    SpeedKit.replaceBlock(localBlock, remoteBlock);
-  }
-
-  document.addEventListener("dynamic-fetcher-data-ready", () => {
-    function registerRemoteRenderObserver() {
-      window?.performance?.mark("sk-prerender-observe-start");
-
-      for (const preRenderedRoot of preRenderedRootConfig) {
-        const selector = preRenderedRoot.selector
-          .split(",")
-          .map((selector) => {
-            return selector + ".speed-kit-pre-rendered-block-added";
-          })
-          .join(",");
-
-        const localRootElement = document.querySelector(selector);
-
-        if (!localRootElement) {
-          continue;
-        }
-        removePlaceholder(localRootElement);
-      }
-    }
-    registerRemoteRenderObserver();
-  });
-
-  /**
-   * checks for all webComponents to be ready before switching to origin
-   *
-   * @param localRootElement
-   */
-  function removePlaceholder(localRootElement) {
-    let waitFor = [];
-    for (let selector of window.dynamicBlockConfig.preRenderWaitFor) {
-      waitFor.push(
-        querySelectorWithRetry(
-          document,
-          selector,
-          PRERENDER_CHECK_INTERVAL,
-          Math.floor(PRERENDER_TIMEOUT / PRERENDER_CHECK_INTERVAL),
-        ),
-      );
-    }
-
-    const promises = [...waitFor];
-
-    Promise.race([
-      Promise.all(promises),
-      new Promise((resolve) => {
-        setTimeout(resolve, PRERENDER_TIMEOUT);
-      }),
-    ])
-      .catch((error) => {})
-      .then(() => {
-        try {
-          detectChanges(
-            localRootElement,
-            window.dynamicBlockConfig.preRenderWaitFor,
-          );
-        } catch (error) {}
-        localRootElement.remove();
-        dispatchReadyEvent(window.dynamicBlockConfig.preRenderWaitFor);
-      });
-  }
-
-  async function sleep(interval = 100) {
-    return new Promise((resolve) => setTimeout(resolve, interval));
-  }
-
-  /**
-   * retry searching for a given selector in the actual app root
-   * @param root
-   * @param selector
-   * @param retryInterval
-   * @param maxAttempts
-   * @returns {Promise<*>}
-   */
-  async function querySelectorWithRetry(
-    root,
-    selector,
-    retryInterval = 100,
-    maxAttempts = 50,
-  ) {
-    for (let i = 0; i < maxAttempts; i++) {
-      const element = root.querySelector(selector);
-      if (element) {
-        return element;
-      }
-      await sleep(retryInterval);
-    }
-  }
-{{/if}}
-  /**
-   * dispatch prerender ready event after shadow app root was removed
-   */
-  function dispatchReadyEvent(preRenderWaitForElement) {
-    window?.performance?.mark("sk-prerender-observe-end");
-    document.dispatchEvent(
-      new CustomEvent("speed-kit-prerender-ready", {
-        detail: { element: preRenderWaitForElement },
-      }),
-    );
-    document.querySelector("html").classList.add("sk-prerender-ready");
-  }
-
-  function detectChanges() {
-    window?.performance?.mark("sk-prerender-change-detection-start");
-
-    for (const config of preRenderedRootConfig) {
-      const localRootElement = document.querySelector(
-        `${config.selector}.speed-kit-pre-rendered-block-added`,
-      );
-      const remoteRootElement = document.querySelector(
-        `${config.selector}:not(.speed-kit-pre-rendered-block-added)`,
-      );
-
-      if (!localRootElement || !remoteRootElement) {
-        continue;
-      }
-      if (config.detectChanges && config.detectChanges.length > 0) {
-        for (const detect of config.detectChanges) {
-          detectChangesInBlock(localRootElement, remoteRootElement, detect);
-        }
-      }
-    }
-    window?.performance?.mark("sk-prerender-change-detection-end");
-  }
-
-  function detectChangesInBlock(
-    parentLocalElement,
-    parentRemoteElement,
-    config,
-  ) {
-    const localRootElement = parentLocalElement.querySelector(config.find);
-    const remoteRootElement = parentRemoteElement.querySelector(config.find);
-
-    if (!localRootElement) {
-      return;
-    }
-
-    if (!remoteRootElement) {
-      sendRevalidation(config.find, "remote block not found");
-    }
-
-    // on next subElement search for changes
-    if (config.detectChanges && config.detectChanges.length > 0) {
-      for (const detect of config.detectChanges) {
-        detectChangesInBlock(localRootElement, remoteRootElement, detect);
-      }
-      return;
-    }
-
-    if (!config.compare || config.compare.length === 0) {
-      return;
-    }
-
-    for (const compare of config.compare) {
-      if (
-        compare === "text" &&
-        localRootElement.innerHTML !== remoteRootElement.innerHTML
-      ) {
-        sendRevalidation(config.find, "content diffs");
-        continue;
-      }
-
-      if (
-        localRootElement.hasAttribute(compare) &&
-        remoteRootElement.hasAttribute(compare) &&
-        localRootElement.getAttribute(compare) !==
-        remoteRootElement.getAttribute(compare)
-      ) {
-        sendRevalidation(config.find, `${compare} diffs`);
-      }
-    }
-  }
-
-  /**
-   * @param selector {string}
-   * @param reason {string}
-   */
-  function sendRevalidation(selector, reason) {
-    let baqendAssetUrl = location.href;
-    let userId = window.SpeedKit.userId || "";
-    let sessionId = window.SpeedKit.sessionId || "";
-    let navigateId = window.SpeedKit.navigateId;
-
-    let detectedChanges = {
-      url: baqendAssetUrl,
-      triggeredBy: { [selector]: [reason] },
-    };
-
-    let beaconUrl =
-      "https://" +
-      window.dynamicBlockConfig.appName +
-      ".app.baqend.com/v1/rum/pi";
-    let data = {
-      piId: navigateId,
-      userId: userId,
-      sessionId: sessionId,
-      changeDetection: detectedChanges,
-      debug: true,
-    };
-
-    if (navigator.sendBeacon) {
-      navigator.sendBeacon(beaconUrl, JSON.stringify(data));
-      return;
-    }
-
-    let xhr = new XMLHttpRequest();
-    xhr.open("POST", beaconUrl, true);
-    xhr.send(JSON.stringify(data));
-  }
-{{/if}}
+        ],
+      },
+        ],
+    {{/if}}
+  };
 })();

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

@@ -8,7 +8,6 @@ const cli_1 = require("../../../cli");
 const safe_1 = require("../../../../helpers/safe");
 const node_fs_1 = require("node:fs");
 const browser_extension_error_1 = require("../../error/browser-extension-error");
-const SPEED_KIT_EXTENSION_NAME = "Speed Kit DevTools Extension";
 class ExtensionValidator {
     cliConfig;
     cliBasePath;
@@ -21,7 +20,6 @@ class ExtensionValidator {
     async getValidBrowserExtensionPaths() {
         const validExtensions = [];
         const validPaths = [];
-        let addIncludedExtension = true;
         this.cli.startAction("resolve browserExtensions");
         const browserExtensions = this.cliConfig.chromeExtensionPaths
             .split(",")
@@ -34,9 +32,6 @@ class ExtensionValidator {
             if (!manifestConfig) {
                 continue;
             }
-            if (manifestConfig.name.includes(SPEED_KIT_EXTENSION_NAME)) {
-                addIncludedExtension = false;
-            }
             validExtensions.push({
                 path: cleanedExtensionPath,
                 name: manifestConfig.name,
@@ -48,9 +43,6 @@ class ExtensionValidator {
         if (validExtensions.length > 0) {
             this.cli.table(validExtensions, { name: {}, version: {}, path: {} });
         }
-        if (addIncludedExtension) {
-            validPaths.push(node_path_1.default.resolve(this.cliBasePath, "chrome-dist", "devtools"));
-        }
         return validPaths;
     }
     async getManifestConfig(cleanedExtensionPath) {

package/dist/services/onboarding/fetch-events/customer-domain-document-response.js

@@ -113,9 +113,19 @@ class CustomerDomainDocumentResponse {
     }
     rewriteInstallResource(text) {
         text = text.replace(onboarding_model_1.SpeedKitInstallRegex, "");
-        return text.replace(/<\s*head\b[^>]*>/, (head) => {
-            return `${head}\n<script src="${this.customerConfig.installPath}" ${this.customerConfig.installParams}></script>`;
-        });
+        const matchOpeningHead = /<\s*head\b[^>]*>/;
+        const matchClosingHead = /<\/\s*head\s*>/;
+        if (matchOpeningHead.test(text)) {
+            return text.replace(matchOpeningHead, (head) => {
+                return `${head}\n<script src="${this.customerConfig.installPath}" ${this.customerConfig.installParams}></script>`;
+            });
+        }
+        if (matchClosingHead.test(text)) {
+            return text.replace(matchClosingHead, (head) => {
+                return `<script src="${this.customerConfig.installPath}" ${this.customerConfig.installParams}></script>${head}\n`;
+            });
+        }
+        return text;
     }
     rewriteHtmlToLocalConfig(html) {
         const DF_CONFIG_PATTERN = /(<script[^>]* id="speed-kit-df-config"[^>]*>)([\S\s]*?)(<\/script>)/g;

package/oclif.manifest.json

@@ -712,5 +712,5 @@
       ]
     }
   },
-  "version": "2.65.0"
+  "version": "2.65.2"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@speedkit/cli",
   "description": "Speed Kit CLI",
-  "version": "2.65.0",
+  "version": "2.65.2",
   "author": {
     "name": "Baqend.com",
     "email": "info@baqend.com"
@@ -66,27 +66,27 @@
   "type": "commonjs",
   "dependencies": {
     "@aws-sdk/client-athena": "^3.529",
-    "@inquirer/prompts": "^3.0",
+    "@inquirer/prompts": "^3.3.2",
     "@oclif/core": "^3.23",
     "@oclif/plugin-autocomplete": "^3.0",
-    "@oclif/plugin-help": "^6.0",
-    "@oclif/plugin-not-found": "^3.0",
-    "@oclif/plugin-warn-if-update-available": "^3.0",
+    "@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",
-    "chalk": "^4",
+    "chalk": "^4.1.2",
     "clipboardy-cjs": "^3.0.0",
     "css-select": "5.1.0",
-    "deepmerge": "^4.2.2",
+    "deepmerge": "^4.3.1",
     "diff": "^5.1.0",
     "dom-serializer": "2.0.0",
     "domhandler": "5.0.3",
     "domutils": "^3.1",
-    "dotenv": "^16.4",
+    "dotenv": "^16.4.5",
     "extract-zip": "^2.0.1",
     "fs-extra": "^11.2.0",
     "handlebars": "^4.7.8",
-    "htmlparser2": "8.0",
+    "htmlparser2": "8.0.2",
     "json2csv": "^6.0.0-alpha.2",
     "node-fetch": "^2.7.0",
     "parse5": "7.1",
@@ -101,8 +101,8 @@
     "ts-node": "^10.9.2"
   },
   "devDependencies": {
-    "@commitlint/cli": "^17.7.1",
-    "@commitlint/config-conventional": "^17.7.0",
+    "@commitlint/cli": "^17.8.1",
+    "@commitlint/config-conventional": "^17.8.1",
     "@istanbuljs/nyc-config-typescript": "^1.0.2",
     "@oclif/prettier-config": "^0.2.1",
     "@oclif/test": "^3",
@@ -115,18 +115,18 @@
     "@typescript-eslint/eslint-plugin": "^7.2.0",
     "chai": "^4.4.1",
     "copyfiles": "^2.4.1",
-    "eslint": "^8.57",
+    "eslint": "^8.57.1",
     "eslint-config-prettier": "^9.1",
     "eslint-plugin-prettier": "^5.1",
     "eslint-plugin-unicorn": "^51.0.1",
-    "globby": "^11",
+    "globby": "^11.1.0",
     "husky": "^8.0.3",
     "lint-staged": "^14.0.1",
     "memfs": "^4.8.0",
     "mocha": "^10.1.0",
     "mocha-junit-reporter": "^2.2.1",
     "mock-fs": "^5.2.0",
-    "nock": "^13.5",
+    "nock": "^13.5.5",
     "nyc": "^15.1.0",
     "oclif": "^4.8.8",
     "shx": "^0.3.4",