@speedkit/cli 2.21.0 → 2.22.0

package/CHANGELOG.md

@@ -1,3 +1,12 @@
+# [2.22.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.21.0...v2.22.0) (2024-04-12)
+
+
+### Features
+
+* **customer-config:** add blacklist html returning false by default to document handler config ([954014c](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/954014ca9211e8da4129e781a5762362da6b8f9f))
+* **customer-config:** implement scopes handling ([8f8f0c4](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/8f8f0c413a3e9166d26105f567bb6af884adbba7))
+* **customer-config:** update scopes handling ([257090b](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/257090ba71cc04ecb298345948367545e0564589))
+
 # [2.21.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.20.0...v2.21.0) (2024-04-10)
 
 

package/README.md

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

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

@@ -23,6 +23,7 @@ export interface CustomerConfigSettings {
     appName?: string;
     production?: EnvironmentConfig;
     staging?: EnvironmentConfig;
+    subRouteScope?: string;
     includeServiceWorker?: string;
     activateImageOptimisation?: boolean;
     removeLazyLoading?: boolean;

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

@@ -161,7 +161,7 @@ class CustomerConfigService {
         }
     }
     async getConfigSettings() {
-        let { production, staging, includeServiceWorker, activateImageOptimisation, removeLazyLoading, addPreRendering, activateRumTracking, useGATracking, withGoogleOptimize, activateCfRocketLoaderWorkaround, isShopify, isShopware, isSalesforce, isPlentymarkets, shopifyId, } = {};
+        let { production, staging, subRouteScope, includeServiceWorker, activateImageOptimisation, removeLazyLoading, addPreRendering, activateRumTracking, useGATracking, withGoogleOptimize, activateCfRocketLoaderWorkaround, isShopify, isShopware, isSalesforce, isPlentymarkets, shopifyId, } = {};
         this.appName = await this.cli.prompt(`Enter SK App Name:`, {
             validator: (input) => /^[\da-z]+(?:-[\da-z]+)*$/.test(input) ? "" : "No valid kebab-case",
             defaultAnswer: this.appName,
@@ -199,6 +199,9 @@ class CustomerConfigService {
                 staging = await this.getEnvironmentConfig(customer_config_service_model_1.EnvironmentType.STAGING, production.host.replace("www", "stg"));
             }
         }
+        if (await this.cli.confirm("Should SK only be active on specific sub-routes? (e.g. /de-de)", false)) {
+            subRouteScope = await this.cli.prompt("Enter one exemplary sub-route to scope to (without leading/trailing slashes):", { defaultAnswer: "de-de" });
+        }
         if (await this.cli.confirm("Is there a Service Worker which needs to be included?", false)) {
             includeServiceWorker = await this.cli.prompt("Enter path of Service Worker to be included:", { defaultAnswer: "/sw.js" });
         }
@@ -217,6 +220,7 @@ class CustomerConfigService {
             appName: this.appName,
             production,
             staging,
+            subRouteScope,
             includeServiceWorker,
             activateImageOptimisation,
             removeLazyLoading,

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

@@ -3,6 +3,9 @@
     // Production:
     {
       hosts: ["{{production.host}}"],
+{{#if subRouteScope}}
+      scopes: ["{{subRouteScope}}"],
+{{/if}}
       split: 0,
       splitTestId: "0vs100_20xx-xx-xx",
     },
@@ -11,6 +14,9 @@
     // Staging:
     {
       hosts: ["{{staging.host}}"],
+{{#if subRouteScope}}
+      scopes: ["{{subRouteScope}}"],
+{{/if}}
     },
 {{else}}
     // No Staging configured
@@ -100,7 +106,7 @@
         // – unless this has been explicitly requested!
         contentType: ["script", "style", "font"],
       },
-      
+
       // Shopify specific:
       {
         url: [
@@ -323,7 +329,14 @@
 
     // Lookup for matching enabled hosts config
     for (var i = 0; i < enabledHostsConfigs.length; i++) {
+{{#if subRouteScope}}
+      if (
+        enabledHostsConfigs[i].hosts.indexOf(currentHost) !== -1 &&
+        isCurrentScopeEnabled(enabledHostsConfigs[i].scopes)
+      ) {
+{{else}}
       if (enabledHostsConfigs[i].hosts.indexOf(currentHost) !== -1) {
+{{/if}}
         foundHostConfig = enabledHostsConfigs[i];
         break; // Break out of the loop once the config related to the host is found
       }
@@ -348,4 +361,25 @@
       };
     }
   }
+{{#if subRouteScope}}
+
+  function isCurrentScopeEnabled(enabledScopes) {
+    // Check if enabled scopes are provided
+    if (!enabledScopes) {
+      // If not: consider current scope as enabled due to no scoping
+      return true;
+    }
+
+    // Check if enabled scopes are provided as array
+    if (!Array.isArray(enabledScopes)) {
+      // If not: consider current scope as disabled due to faulty scoping
+      return false;
+    }
+
+    // Test if current scope matches enabled scopes
+    var pattern = "^/(" + enabledScopes.join("|") + ")/";
+    var regex = new RegExp(pattern);
+    return regex.test(location.pathname);
+  }
+{{/if}}
 })();

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

@@ -1,5 +1,5 @@
 /**
- * Shop System in use:
+ * Shop/Frontend system in use:
 {{#if isShopify}}
  * - Shopify
 {{else if isShopware}}
@@ -9,7 +9,7 @@
 {{else if isPlentymarkets}}
  * - Plentymarkets
 {{else}}
- * - TODO: enter name of shop system here... please
+ * - TODO: enter name of system in use
 {{/if}}
  */
 
@@ -25,7 +25,11 @@ const shared = {
 {{else}}
   swPath: "/wrapper-sw.js",
 {{/if}}
+{{#if subRouteScope}}
+  scope: "/{{subRouteScope}}/",
+{{else}}
   scope: "/",
+{{/if}}
 };
 
 const configs = {

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

@@ -45,6 +45,11 @@ const lazyLoadList = [
 {{/unless}}
 const config = {
   rejectHTML({ db, {{#if addPreRendering}}document{{else}}html{{/if}}, variation, url, headers }) {
+    /* Use to configure guards to prevent e.g. error and captcha pages from being cached */
+    return false;
+  },
+  blacklistHTML({ db, {{#if addPreRendering}}document{{else}}html{{/if}}, variation, url, headers }) {
+    /* Use to configure guards to black-list e.g. specific page types */
     return false;
   },
   shouldTransform({ db, {{#if addPreRendering}}document{{else}}html{{/if}}, variation, url, headers }) {

package/oclif.manifest.json

@@ -699,5 +699,5 @@
       ]
     }
   },
-  "version": "2.21.0"
+  "version": "2.22.0"
 }

package/package.json

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