@speedkit/cli 4.21.0 → 4.22.0

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

@@ -1,548 +0,0 @@
-{{#*inline "disabledSites"}}
-  // TODO: adjust/replace this exemplary list
-  {{#if isPlentymarkets}}
-
-  // Plentymarkets specific:
-  /kundenkonto/i,
-  /warenkorb/i,
-  {{/if}}
-
-  // Login & Account:
-  /account/i,
-  /profile/i,
-  /password/i,
-  /registration/i,
-  /register/i,
-  /login/i,
-  /authenticate/i,
-  /wish(-)?list/i,
-
-  // Checkout & Payment:
-  /cart/i,
-  /basket/i,
-  /checkout/i,
-  /order/i,
-  /success/i,
-  /confirmation/i,
-  /payment/i,
-  /success/i,
-
-  // Admin:
-  /\/admin/i,
-  /\/backend/i,
-{{/inline}}
-
-{{#if isShopify}}
-import { ShopifyPlugin } from "speed-kit-config/ShopifyPlugin";
-{{/if}}
-{{#if addSSR}}
-import { SSRPlugin } from "speed-kit-config/SSRPlugin";
-{{/if}}
-
-(function() {
-{{#if isShopify}}
-  SpeedKit.configPlugins = SpeedKit.configPlugins || [];
-  SpeedKit.configPlugins.push(new ShopifyPlugin());
-{{/if}}
-{{#if addSSR}}
-{{#unless isShopify}}
-  SpeedKit.configPlugins = SpeedKit.configPlugins || [];
-{{/unless}}
-  SpeedKit.configPlugins.push(new SSRPlugin());
-{{/if}}
-
-  var ENABLED_HOSTS_CONFIGS = [
-    // Production:
-    {
-      hosts: ["{{production.host}}"],
-{{#if subRouteScope}}
-      scopes: ["{{subRouteScope}}"],
-{{/if}}
-      split: 0,
-      splitTestId: "0vs100_20xx-xx-xx",
-    },
-
-{{#if staging.host}}
-    // Staging:
-    {
-      hosts: ["{{staging.host}}"],
-{{#if subRouteScope}}
-      scopes: ["{{subRouteScope}}"],
-{{/if}}
-    },
-{{else}}
-    // No Staging configured
-{{/if}}
-  ];
-  var ENABLED_HOSTS = getEnabledHosts(ENABLED_HOSTS_CONFIGS);
-  var CURRENT_HOST_CONFIG = getCurrentHostConfig(ENABLED_HOSTS_CONFIGS);
-{{#if useDisabledSitesApproach}}
-
-  var DISABLED_SITES = [
-    // Used as pathnames in...
-    // - disabled sites
-    // - blacklist
-
-    {{> disabledSites}}
-  ];
-{{/if}}
-
-  /**
-   * @type {SpeedKitConfig}
-   */
-  window.speedKit = {
-    ruleSetConfig: {
-      version: 2,
-    },
-    appName: APP,
-{{#if isShopify}}
-    sw: "/apps/speed-kit/sw.js", // Shopify specific
-{{else}}
-    sw: "/wrapper-sw.js",
-{{/if}}
-{{#if includeServiceWorker}}
-    includeServiceWorker: "{{includeServiceWorker}}",
-{{/if}}
-    preloadDynamicBlocks: true,
-    rumTracking: true,
-{{#if addDeviceDetection}}
-  {{#unless addSSR}}
-    // Server-side responsive: origin returns different HTML per device (UA-keyed).
-    userAgentDetection: true,
-    detectDevice: function(doc) {
-      // TODO: set a marker present only in the mobile variation. Read it from `doc`.
-      return doc.querySelector('<mobile-specific-element>') ? "mobile" : "desktop";
-    },
-  {{/unless}}
-  {{#if addSSR}}
-    // SSR: pick the device by viewport width; SSRPlugin (above) handles resize/zoom/bfcache.
-    detectDevice: function(doc) {
-      // TODO: set the real breakpoint — discover it, don't guess (tools/sk-breakpoints.mjs).
-      var width = document.documentElement.clientWidth;
-      if (!width) return null;
-      return width <= 820 ? "mobile" : "desktop";
-    },
-  {{/if}}
-{{/if}}
-{{#if addSSR}}
-    customVariation: [
-      {
-        variationFunction: function (request, device, cookies) {
-          // SSR specific – don't report a variation for specific page types NOT covered by SSR:
-          // TODO: adjust and activate if needed
-          // if (request.url.indexOf("<url-page-type-idenfier>") > -1) return "desktop";
-          return device;
-        },
-      },
-    ],
-{{/if}}
-{{#if useScrapingBee}}
-    customVariation: [
-      {
-        variationFunction: function (request, device, cookies) {
-          if (device === "desktop") {
-            return "proxycrawl";
-          }
-          return "proxycrawlmobile";
-        },
-      },
-    ],
-{{/if}}
-    split: CURRENT_HOST_CONFIG.split,
-    splitTestId: CURRENT_HOST_CONFIG.splitTestId,
-    disabled: !CURRENT_HOST_CONFIG.enabled,
-    // TODO: walk the live checkout + login flows and pin exact prefixes (SSO/PSP returns, separate reg pages). See /disabled-scopes.
-    disabledScopes: [
-      "/cart",
-      "/checkout",
-{{#if isShopify}}
-      "/account", // login/register/recover/orders
-      "/services/login_with_shop", // Shop Pay auto-login transfer (platform route, all locales)
-{{else}}
-      "/login",
-{{/if}}
-    ],
-    enabledSites: [
-      {
-        pathname: [
-          // TODO: adjust/replace this exemplary list
-
-          /^\/$/, // Home
-
-{{#if isShopify}}
-          /\/collections\//i, // Category & PLP
-          /\/products\//i, // PDP
-{{else}}
-          /\/c\//, // Category & PLP
-          /\/p\//, // PDP
-{{/if}}
-        ],
-      },
-    ],
-    // Pages that aren't enabled themselves, but are allowed to trigger soft-to-hard
-    // navigations and preloading/prerendering for enabled pages.
-    activeSites: [
-      {
-        pathname: [
-          // TODO: adjust/replace or remove if not needed
-          /\/search/i, // e.g. search results
-        ],
-      },
-    ],
-    whitelist: [
-      {
-{{#if isPlentymarkets}}
-        host: ENABLED_HOSTS.concat([
-          // Plentymarkets specific:
-          /cdn\d\d\.plentymarkets\.com/,
-          "www.gstatic.com",
-          "static.doubleclick.net",
-          "static.newsletter2go.com",
-          "cdn-static.optimonk.com",
-        ]),
-{{else}}
-        host: ENABLED_HOSTS,
-{{/if}}
-        contentType: [
-          'navigate',
-{{#if activateImageOptimisation}}
-          'image',
-{{/if}}
-        ],
-      },
-      {
-        host: [
-          "fonts.googleapis.com",
-          "fonts.gstatic.com",
-        ],
-        contentType: ["script", "style", "font"],
-      },
-{{#if isShopify}}
-      // Shopify specific:
-      {
-        url: [
-          "bat.bing.com/bat.js",
-          "connect.facebook.net/en_US/fbevents.js",
-        ],
-      },
-{{/if}}
-    ],
-    blacklist: [
-      {{#if useDisabledSitesApproach}}
-      {
-        pathname: DISABLED_SITES,
-      },
-      {{/if}}
-      {
-        pathname: [
-      {{#if isPlentymarkets}}
-
-          // Plentymarkets specific:
-          /\/rest/i, // REST API
-      {{/if}}
-      {{#if isSalesforce}}
-
-          // SFCC specific:
-          /\/demandware\.store/i, // high-level api blacklist
-      {{/if}}
-      {{#unless useDisabledSitesApproach}}
-          {{> disabledSites}}
-      {{/unless}}
-
-          // Payment Services:
-          /paypal/i,
-          /klarna/i,
-          /amazon/i,
-          /ratepay/i,
-          /payone/i,
-
-          // Misc:
-          /\/akam\//i, // Akamai telemetry data
-          /\.pdf/,
-          /\/adyen/i,
-          /\/cdn-cgi\//i, // dynamic scripts
-        ],
-      },
-      {
-        url: [
-          /[?&](_=1\d{12})/, // jQuery code execution callbacks
-          /[?&]nocache/i,
-          /[?&]kameleoon=true/i, // = Kameleoon's graphical editor mode is active
-
-          // GTM:
-          "www.googletagmanager.com/gtm.js",
-          "www.googletagmanager.com/gtag/js",
-        ],
-      },
-      {
-        host: ["www.paypal.com", "www.paypalobjects.com"],
-      },
-{{#if isShopify}}
-
-      // Shopify specific:
-      {
-        pathname: [
-          "/api/",
-          "/apps/",
-          "/a/",
-          "/community/",
-          "/tools/",
-          "/recommendations/",
-          /discount/,
-          /orders/,
-          /digital_wallets/, // HTML Fragment in Checkout that does not match XHR Rule
-          "/app/services/", // many checkout resources
-        ],
-      },
-{{/if}}
-{{#if isShopware}}
-
-      // Shopware specific:
-      {
-        pathname: [
-          /\/refreshStatistic/i, // stats request
-        ],
-      },
-{{/if}}
-{{#if isOxid}}
-
-      // OXID eShop specific:
-      {
-        url: [
-          /[?&]cl=/i,
-          // "cl" parameter specifying the OXID controller class, which can affect the entire page layout and content
-          // – common values: start, alist, details, basket, order, register, login
-          // TODO: check in the fine-tuning phase at the latest whether the resulting blacklisted rate is not too high
-          /[?&]searchparam/i,
-        ],
-      },
-{{/if}}
-{{#if isPlentymarkets}}
-
-      // Plentymarkets specific:
-      {
-        url: [
-          /\/plentymarkets/i, // API, updates of certain pages can be triggered under this path
-
-          // params:
-          /[?&]time=/i,
-          /[?&]subscription=/i,
-          /[?&]hash=/i,
-          /[?&]AccountShow=/i,
-          /[?&]OrderID=/i,
-          /[?&]PaymentMethod=/i,
-          /[?&]paymentId=/i,
-          /[?&]token=/i,
-          /[?&]PayerID=/i,
-        ],
-      },
-{{/if}}
-{{#if isShopify}}
-
-      // Shopify specific:
-      // exclude preview function from caching
-      {
-        url: [
-          /[?&]view=/i,
-          /[?&]_ab=/i,
-          /[?&]_fd=/i,
-          /[?&]preview_theme/i,
-        ],
-      },
-      { cookie: ["preview_theme"] },
-{{/if}}
-{{#if isPlentymarkets}}
-
-      // Plentymarkets specific:
-      // blacklist on experimental features cookie
-      {
-        cookie: ['PluginSetPreview'],
-        contentType: ['document'],
-      },
-
-      // Plentymarkets specific:
-      // blacklist based on custom cookie (e.g. on user logging in => see loadHandler)
-      { cookie: ['baqend-speedkit-blacklist'] },
-{{/if}}
-    ],
-    stripQueryParams: [{
-      params: [
-        // Default:
-        /.*clid$/, // generic Click ID
-        "AdSet", // Meta Ads (Facebook)
-        "_ga", // Google Analytics User ID (Universal Analytics)
-        "_gl", // Google Analytics User ID (GA 4+)
-        "_klaviyopid", // Klaviyo
-        "_kx", // Klaviyo
-        "a8", // A8.net (affiliate marketing)
-        "ad_id",
-        "adid",
-        "adobe_mc", // Adobe Marketing Cloud
-        "adword",
-        "at_gd", // Urchin Tracking Module
-        "awc", // AWIN (former Zanox Affiliate Network)
-        "brid",
-        "cjid",
-        "clickid",
-        "clickref",
-        "cstrackid", // ChannelSight
-        "cto_pld",
-        "dicbo",
-        "ds_rl",
-        "ef_id", // Adobe Advertising Cloud
-        "epik",
-        "fb_audience", // Facebook Ads
-        "gQT",
-        "gb_clk", // Click tracking
-        "gtm_debug", // Google Tag Manager
-        "irclickid",
-        "kk", // Kelkoo Shopping Search Engine Key
-        "ldtag_cl", // LINE Ads
-        "lt_r", // LINE Ads
-        "msclkid", // Microsoft Click ID
-        "msockid", // Microsoft Bing
-        "nsctrid",
-        "ps_kw", // Paid Search Keyword Tracking
-        "rdt_cid", // Reddit Ad Click ID
-        "rtbhc", // RTB House
-        "s_kwcid", // AMO ID, Adobe Advertising Cloud
-        "srclt", // LINE Ads
-        "srsltid", // google search engine
-        "tblci", // Taboola Click ID
-        "tduid", // Tradedoubler UID
-        "trackingtoken",
-        "ved",
-        "yj_r", // Yahoo! JAPAN Ads
-        "zanpid", // AWIN (former Zanox Affiliate Network)
-        /^(mb|nb|nx|ny)$/,
-        /^ScCid$/i, // Snapchat Click ID
-        /^WT\./, // WebTrends
-        /^[gw]braid$/, // Google's iOS web-to-app campaign measurement
-        /^_ly_/, // LY Ads
-        /^affid$/i, // Affiliate ID
-        /^bv(state|messageType|notificationId|recipientDomain)$/, // Bazaarvoice
-        /^campaign(_id)?$/,
-        /^cq_/,
-        /^dy(IsPreview|SmartId|IsDraft|ExperienceId|VariationId|pPreviewKey|PersistSession|Temp)$/, // Dynamic Yield
-        /^ecm(Uid|Id)$/i, // Econda ARP / Mailings
-        /^em_/, // Econda ARP / Mailings
-        /^et_/,
-        /^ext(ProvId|Pu|Li|Pm|Cr|Tg|Si|MT|NT|DV|AP)$/,
-        /^gad(w|_source|_campaignid)?$/, // Google Ads
-        /^gcl(id|src)$/, // Google Click ID + Source
-        /^judgeme_/, // Judge.me (review system)
-        /^klar_/, // getklar.com
-        /^neocom_/, // Neocom.ai
-        /^sa_/,
-        /^saf_/, // Spider AF
-        /^sc_/, // e.g. Adobe
-        /^sfmc_/, // Salesforce Marketing Cloud
-        /^sv(1|_campaign_id)$/,
-        /^trc_/, // Tracify
-        /^uslk_/, // Userlike Chatbot
-        /^utm[_-]/, // Urchin Tracking Module
-        /^vm(st|track)_id$/,
-        /^wg(u|expiry)$/, // Webgains Affiliate Network
-        /^wt_(mc|az|ref|t)$/, // Webtrekk/Mapp Intelligence
-{{#if isShopify}}
-
-        // Shopify specific:
-        "_fid",
-        "_pos",
-        "_psq",
-        "_sid",
-        "_ss",
-        "_v",
-        /^pr_/i, // Product Recommendation
-{{/if}}
-{{#if isOxid}}
-
-        // OXID specific:
-        "cnid",
-        "force_sid",
-{{/if}}
-
-        // Site-specific:
-        // TODO: extend or remove during query param analysis
-      ],
-    }],
-  };
-
-  //================================================================================
-  // Utility Functions
-  //================================================================================
-
-  function getEnabledHosts(enabledHostsConfigs) {
-    var allHosts = [];
-    enabledHostsConfigs.forEach(function (enabledHostsConfig) {
-      allHosts = allHosts.concat(enabledHostsConfig.hosts);
-    });
-
-    // Return unique array ("set") of all enabled hosts
-    return allHosts.filter(function (value, index, self) {
-      return self.indexOf(value) === index;
-    });
-  }
-
-  function getCurrentHostConfig(enabledHostsConfigs) {
-    var currentHost = location.hostname;
-    var defaultSplit = 0;
-    var defaultSplitTestId = "0vs100";
-    var foundHostConfig;
-
-    // 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
-      }
-    }
-
-    if (foundHostConfig) {
-      // Provide fallback split values if incomplete or incorrect
-      if (
-        !(foundHostConfig.split >= 0 && foundHostConfig.split <= 1) ||
-        !foundHostConfig.splitTestId
-      ) {
-        foundHostConfig.split = defaultSplit;
-        foundHostConfig.splitTestId = defaultSplitTestId;
-      }
-      foundHostConfig.enabled = true;
-      return foundHostConfig;
-    } else {
-      return {
-        enabled: false,
-        split: defaultSplit,
-        splitTestId: defaultSplitTestId,
-      };
-    }
-  }
-{{#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.json.hbs

@@ -1,38 +0,0 @@
-{
-  "production": {
-    "_meta": {
-      "shopSystem":
-      {{#if shopSystemName}}
-        "{{shopSystemName}}"
-      {{else}}
-        "TODO: enter name of system in use"
-      {{/if}}
-    },
-    "app": "{{appName}}",
-    "domain": "{{production.host}}",
-    "origins": [
-      "https://{{production.host}}"
-    ],
-  {{#if isShopify}}
-    "swPath": "/apps/speed-kit/sw.js",
-  {{else}}
-    "swPath": "/wrapper-sw.js",
-  {{/if}}
-  {{#if subRouteScope}}
-    "scope": "/{{subRouteScope}}/",
-  {{else}}
-    "scope": "/",
-  {{/if}}
-    "forceInstall": {{production.forceInstall}}
-  }
-  {{#if staging.host}},
-  "staging": {
-    "name": "staging",
-    "domain": "{{staging.host}}",
-    "origins": [
-      "https://{{staging.host}}"
-    ],
-    "forceInstall": {{staging.forceInstall}}
-  }
-  {{/if}}
-}