@speedkit/cli 2.70.0 → 2.71.0

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+# [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)
+
+
+### Bug Fixes
+
+* **prewarm:** set variationString in correct case ([627959d](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/627959d1d997601840c13a679a304b573c985e6f))
+
 # [2.70.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.69.1...v2.70.0) (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.0 linux-x64 node-v20.18.1
+@speedkit/cli/2.71.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/prewarm/assets/asset-api-client.d.ts

@@ -14,4 +14,20 @@ export declare class AssetApiClient {
     increaseMaxRequestsPerSecond(): void;
     private isValidUrl;
     private setRateLimit;
+    /**
+     * handle parameter "bqvariation"
+     * reflect behaviour of SpeedKit.
+     * - do not send default variation
+     * - send mobile/tablet/tv as lowercase
+     * - send customVariations as they are
+     *
+     * As orestes will always make variations uppercase and does not care for caseSensitivity,
+     * a caseMissMatch on fastly will also resolve in a cacheMiss.
+     * That is why we need to preWarm in the correct case always.
+     *
+     * @param variation
+     * @param assetUrl
+     * @private
+     */
+    private setVariationParameter;
 }

package/dist/services/prewarm/assets/asset-api-client.js

@@ -27,9 +27,7 @@ class AssetApiClient {
     async fetchURL(url, variation) {
         this.isValidUrl(url);
         const assetUrl = new node_url_1.URL((0, normalize_1.normalize)(url, this.sortParameters));
-        if (variation !== "DEFAULT" && variation !== "DESKTOP") {
-            assetUrl.searchParams.set("bqvariation", variation);
-        }
+        this.setVariationParameter(variation, assetUrl);
         assetUrl.searchParams.set("bqpass", "1");
         return (0, node_fetch_1.default)(`https://${this.app}.app.baqend.com/v1/asset/${assetUrl.toString()}`, {
             agent: this.agent,
@@ -68,5 +66,33 @@ class AssetApiClient {
     setRateLimit(limit) {
         this.rateLimit = limit > 1 ? Math.floor(limit) : 1;
     }
+    /**
+     * handle parameter "bqvariation"
+     * reflect behaviour of SpeedKit.
+     * - do not send default variation
+     * - send mobile/tablet/tv as lowercase
+     * - send customVariations as they are
+     *
+     * As orestes will always make variations uppercase and does not care for caseSensitivity,
+     * a caseMissMatch on fastly will also resolve in a cacheMiss.
+     * That is why we need to preWarm in the correct case always.
+     *
+     * @param variation
+     * @param assetUrl
+     * @private
+     */
+    setVariationParameter(variation, assetUrl) {
+        // on default or desktop do net set variationParam
+        if (variation === "default" || variation === "desktop") {
+            return;
+        }
+        // on tv|tablet|mobile set variation as lowerCase
+        if (__1.DEFAULT_VARIATIONS.includes(variation.toLowerCase())) {
+            assetUrl.searchParams.set("bqvariation", variation.toLowerCase());
+            return;
+        }
+        // on any other customVariation set variation as it is
+        assetUrl.searchParams.set("bqvariation", variation);
+    }
 }
 exports.AssetApiClient = AssetApiClient;

package/dist/services/prewarm/pre-warm-model.d.ts

@@ -37,3 +37,4 @@ export declare const TIMING_HEADER_KEY = "server-timing";
 export declare const PROGRESS_BAR_FORMAT = "[{bar}] {percentage}% | ETA: {eta}s | {value}/{total} | error:{errors} | rate: {rate} | retry: {retry}";
 export declare const VARIATION_SEPARATOR = ",";
 export declare const DEFAULT_VARIATION: string[];
+export declare const DEFAULT_VARIATIONS: string[];

package/dist/services/prewarm/pre-warm-model.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_VARIATION = exports.VARIATION_SEPARATOR = exports.PROGRESS_BAR_FORMAT = exports.TIMING_HEADER_KEY = exports.TIMING_HEADER_ERROR_CODE_SELECTOR = exports.RATE_LIMIT_CODES = exports.RATE_LIMIT_MULTIPLICATOR = exports.MAX_REQUESTS_PER_SECOND = exports.DEFAULT_REQUESTS_PER_SECOND = exports.TIMOUT_AFTER_DETECTED_RATE_LIMIT = exports.FETCH_TIMEOUT = exports.MIN_TIME_TO_FETCH_BATCH = exports.ItemStatus = exports.PreWarmContext = void 0;
+exports.DEFAULT_VARIATIONS = exports.DEFAULT_VARIATION = exports.VARIATION_SEPARATOR = exports.PROGRESS_BAR_FORMAT = exports.TIMING_HEADER_KEY = exports.TIMING_HEADER_ERROR_CODE_SELECTOR = exports.RATE_LIMIT_CODES = exports.RATE_LIMIT_MULTIPLICATOR = exports.MAX_REQUESTS_PER_SECOND = exports.DEFAULT_REQUESTS_PER_SECOND = exports.TIMOUT_AFTER_DETECTED_RATE_LIMIT = exports.FETCH_TIMEOUT = exports.MIN_TIME_TO_FETCH_BATCH = exports.ItemStatus = exports.PreWarmContext = void 0;
 class PreWarmContext {
     app;
     path;
@@ -36,4 +36,5 @@ exports.TIMING_HEADER_ERROR_CODE_SELECTOR = /errorcode;desc=([^,]*),/;
 exports.TIMING_HEADER_KEY = "server-timing";
 exports.PROGRESS_BAR_FORMAT = "[{bar}] {percentage}% | ETA: {eta}s | {value}/{total} | error:{errors} | rate: {rate} | retry: {retry}";
 exports.VARIATION_SEPARATOR = ",";
-exports.DEFAULT_VARIATION = ["DEFAULT"];
+exports.DEFAULT_VARIATION = ["default"];
+exports.DEFAULT_VARIATIONS = ["mobile", "tablet", "tv"];

package/oclif.manifest.json

@@ -712,5 +712,5 @@
       ]
     }
   },
-  "version": "2.70.0"
+  "version": "2.71.0"
 }

package/package.json

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