@speedkit/cli 2.24.0 → 2.26.0

package/CHANGELOG.md

@@ -1,3 +1,20 @@
+# [2.26.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.25.0...v2.26.0) (2024-04-19)
+
+
+### Features
+
+* **customer-config:** improve deployment detection ([86bc831](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/86bc831683d1fb6dcdae5937f212668f6b4b981e))
+* **customer-config:** improve deployment detection ([b7b8c38](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/b7b8c38ca7b84af7da527faabe1e801453ef73f2))
+
+# [2.25.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.24.0...v2.25.0) (2024-04-17)
+
+
+### Features
+
+* **onboarding:** add a flagInput to optin for ignoring the contentPolicy ([760764d](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/760764d6c1826b46f8e8d0164f2ada0d0ae71fd4))
+* **onboarding:** remove content-policy-header ([c0ee577](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/c0ee577416ebbac6314463a93528cb5ccb68f3b2))
+* **onboarding:** remove unnecessary unpacking ([5f16138](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/5f161387536201b46c1270eb2cab4d10e3f3cffa))
+
 # [2.24.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.23.2...v2.24.0) (2024-04-17)
 
 

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @speedkit/cli
 $ sk COMMAND
 running command...
 $ sk (--version)
-@speedkit/cli/2.24.0 linux-x64 node-v20.12.2
+@speedkit/cli/2.26.0 linux-x64 node-v20.12.2
 $ sk --help [COMMAND]
 USAGE
   $ sk COMMAND
@@ -364,15 +364,16 @@ Start a local dev environment for building and testing the Speed Kit configurati
 
 ```
 USAGE
-  $ sk onboarding CUSTOMERPATH [-c <value>] [-l] [-v]
+  $ sk onboarding CUSTOMERPATH [-c <value>] [-l] [-v] [-s]
 
 ARGUMENTS
   CUSTOMERPATH  The customer config path
 
 FLAGS
-  -c, --configName=<value>  [default: production] The costumer config name
-  -l, --local               Run with local documentHandler
-  -v, --verboseLevel        Show all messages
+  -c, --configName=<value>           [default: production] The costumer config name
+  -l, --local                        Run with local documentHandler
+  -s, --ignoreContentSecurityPolicy  Removes header/meta "content-security-policy" for origin-responses
+  -v, --verboseLevel                 Show all messages
 
 DESCRIPTION
   Start a local dev environment for building and testing the Speed Kit configuration

package/dist/commands/onboarding.d.ts

@@ -1,11 +1,9 @@
 import { Command } from "@oclif/core";
 export default class Onboarding extends Command {
     static description: string;
-    static flags: {
-        local: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        verboseLevel: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        configName: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-    };
+    static flags: import("@oclif/core/lib/interfaces/parser").FlagInput<{
+        [flag: string]: any;
+    }>;
     static args: {
         customerPath: import("@oclif/core/lib/interfaces").Arg<string, {
             exists?: boolean;

package/dist/commands/onboarding.js

@@ -6,27 +6,15 @@ const onboarding_1 = require("../services/onboarding");
 const cli_config_1 = require("../helpers/cli-config");
 class Onboarding extends core_1.Command {
     static description = "Start a local dev environment for building and testing the Speed Kit configuration";
-    static flags = {
-        ...cli_parameters_1.CLI_CONFIG_NAME,
-        local: core_1.Flags.boolean({
-            char: "l",
-            default: false,
-            description: "Run with local documentHandler",
-        }),
-        verboseLevel: core_1.Flags.boolean({
-            char: "v",
-            default: false,
-            description: "Show all messages",
-        }),
-    };
+    static flags = onboarding_1.OnboardingContext.flags;
     static args = cli_parameters_1.CLI_CUSTOMER_CONFIG;
     static examples = [
         `$ sk onboarding <${cli_parameters_1.CLIParameters.CustomerPath}> -${cli_parameters_1.CLIParametersChar.ConfigName} <${cli_parameters_1.CLIParameters.ConfigName}>`,
         `$ sk onboarding ${cli_parameters_1.CLIParametersExample.CustomerPath} -${cli_parameters_1.CLIParametersChar.ConfigName} ${cli_parameters_1.CLIParametersExample.ConfigName}`,
     ];
     async run() {
-        const { args: { customerPath }, flags: { configName, local, verboseLevel }, } = await this.parse(Onboarding);
-        const service = await new onboarding_1.OnboardingServiceFactory(new onboarding_1.OnboardingContext(customerPath, configName, local, verboseLevel), new cli_config_1.CliConfig(this.config).load()).getService();
+        const { args: { customerPath }, flags: { configName, local, verboseLevel, ignoreContentSecurityPolicy }, } = await this.parse(Onboarding);
+        const service = await new onboarding_1.OnboardingServiceFactory(new onboarding_1.OnboardingContext(customerPath, configName, local, verboseLevel, ignoreContentSecurityPolicy), new cli_config_1.CliConfig(this.config).load()).getService();
         await service.run();
     }
 }

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

@@ -7,10 +7,51 @@ const minutesToMilliseconds = (minutes) => {
   return minutes * 60000;
 }
 
+const LOCALES_BY_LAYOUT = [
+  // TODO: adjust/replace this exemplary list
+  ExampleLayoutA: ["de_DE", "en_DE"],
+  ExampleLayoutB: ["en_US"],
+];
+const ASSET_SUB_PATHS = [
+  // These assets are expected to be found via the following base URL:
+  //  https://<ORIGIN>/on/demandware.static/Sites-<LAYOUT>-Site/-/<LOCALE>/v<VERSION>/...
+
+  // TODO: adjust/replace this exemplary list
+
+  // JS:
+  "js/main.js",
+  "internal/jscript/dwanalytics-(.*).js",
+
+  // CSS:
+  "css/style.css",
+];
+
+function getAssetList() {
+  return Object.entries(LOCALES_BY_LAYOUT).flatMap(([layout, locales]) =>
+    locales.flatMap((locale) =>
+      ASSET_SUB_PATHS.map(
+        (subPath) =>
+{{#if staging.host}}
+          `^https://(?:{{production.host}}|{{staging.host}})/on/demandware.static/Sites-${layout}-Site/-/${locale}/v(\\d{13})/${subPath}`,
+{{else}}
+          `^https://{{production.host}}/on/demandware.static/Sites-${layout}-Site/-/${locale}/v(\\d{13})/${subPath}`,
+{{/if}}
+      ),
+  );
+}
+
 const deploymentConfig = {
   slack: "<1Password deployment token>",
   origins: [
+    // Production:
     "https://{{production.host}}",
+{{#if staging.host}}
+
+    // Staging:
+    "https://{{staging.host}}",
+{{/if}}
+
+    // TODO: also check for other origins like e.g. https://*.my.salesforce.com
   ],
   jobType: "deployment", // "instant" | "deployment"
 
@@ -24,9 +65,9 @@ const deploymentConfig = {
   compareContentHashes: true,
 
   assetList: [
-    // TODO: adjust/replace this exemplary list
-    "^https://{{production.host}}/on/demandware.static/Sites-(?:.*)-Site/-/[a-z]{2}_[A-Z]{2}/v(\\d{13})/js/main.js",
-    "^https://{{production.host}}/on/demandware.static/Sites-(?:.*)-Site/-/[a-z]{2}_[A-Z]{2}/v(\\d{13})/css/style.css",
+    ...getAssetList(),
+
+    // TODO: add additional non-demandware asset urls as needed
   ],
 }
 

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

@@ -11,8 +11,9 @@ export declare class CustomerDomainDocumentResponse implements FetchRequestPause
     private customerConfig;
     private configDynamicBlock;
     private configDynamicStyles;
+    private removeContentSecurityPolicy;
     get patterns(): Protocol.Fetch.RequestPattern[];
-    constructor(customerConfig: CustomerConfig, configDynamicBlock: ConfigFileInterface, configDynamicStyles: ConfigFileInterface);
+    constructor(customerConfig: CustomerConfig, configDynamicBlock: ConfigFileInterface, configDynamicStyles: ConfigFileInterface, removeContentSecurityPolicy: boolean);
     handle(event: Protocol.Fetch.RequestPausedEvent, client: CDPSession): Promise<Partial<Protocol.Fetch.FulfillRequestRequest> | void>;
     private isValidHtmlContent;
     private isValidResponse;
@@ -21,4 +22,18 @@ export declare class CustomerDomainDocumentResponse implements FetchRequestPause
     private isSpeedKitResponse;
     private rewriteInstallResource;
     private rewriteHtmlToLocalConfig;
+    /**
+     * Removes content policy headers from the given array of headers.
+     *
+     * @param {Protocol.Fetch.HeaderEntry[]} headers - The array of header entries.
+     * @returns {Protocol.Fetch.HeaderEntry[]} - The modified array of header entries with content policy headers removed.
+     */
+    private removeContentSecurityHeaderFromResponse;
+    /**
+     * Removes the content security meta tag from the provided HTML content.
+     *
+     * @param {string} htmlContent - The HTML content from which to remove the meta tag.
+     * @returns {string} - The HTML content without the content security meta tag.
+     */
+    private removeContentSecurityMetaTag;
 }

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

@@ -10,6 +10,7 @@ class CustomerDomainDocumentResponse {
     customerConfig;
     configDynamicBlock;
     configDynamicStyles;
+    removeContentSecurityPolicy;
     get patterns() {
         const result = [];
         for (const origin of this.customerConfig.origins) {
@@ -44,10 +45,11 @@ class CustomerDomainDocumentResponse {
         }
         return result;
     }
-    constructor(customerConfig, configDynamicBlock, configDynamicStyles) {
+    constructor(customerConfig, configDynamicBlock, configDynamicStyles, removeContentSecurityPolicy) {
         this.customerConfig = customerConfig;
         this.configDynamicBlock = configDynamicBlock;
         this.configDynamicStyles = configDynamicStyles;
+        this.removeContentSecurityPolicy = removeContentSecurityPolicy;
     }
     async handle(event, client) {
         if (!this.isValidResponse(event)) {
@@ -66,7 +68,13 @@ class CustomerDomainDocumentResponse {
         if (this.isSpeedKitResponse(text)) {
             text = this.rewriteHtmlToLocalConfig(text);
         }
-        return new origin_response_1.OriginResponse(text, event.responseHeaders, event.responseStatusCode);
+        const headers = this.removeContentSecurityPolicy
+            ? this.removeContentSecurityHeaderFromResponse(event.responseHeaders)
+            : event.responseHeaders;
+        const content = this.removeContentSecurityPolicy
+            ? this.removeContentSecurityMetaTag(text)
+            : text;
+        return new origin_response_1.OriginResponse(content, headers, event.responseStatusCode);
     }
     isValidHtmlContent(text) {
         return text.includes("<html");
@@ -116,5 +124,25 @@ class CustomerDomainDocumentResponse {
         html = html.replaceAll(DF_STYLES_PATTERN, (_, tag, end) => `${tag}${this.configDynamicStyles.getContent()}${end}`);
         return html;
     }
+    /**
+     * Removes content policy headers from the given array of headers.
+     *
+     * @param {Protocol.Fetch.HeaderEntry[]} headers - The array of header entries.
+     * @returns {Protocol.Fetch.HeaderEntry[]} - The modified array of header entries with content policy headers removed.
+     */
+    removeContentSecurityHeaderFromResponse(headers) {
+        return headers.filter((header) => {
+            return !header.name.toLowerCase().includes("content-security-policy");
+        });
+    }
+    /**
+     * Removes the content security meta tag from the provided HTML content.
+     *
+     * @param {string} htmlContent - The HTML content from which to remove the meta tag.
+     * @returns {string} - The HTML content without the content security meta tag.
+     */
+    removeContentSecurityMetaTag(htmlContent) {
+        return htmlContent.replace(/<meta[^>]*http-equiv=["']content-security-policy[^>]*>/is, "");
+    }
 }
 exports.CustomerDomainDocumentResponse = CustomerDomainDocumentResponse;

package/dist/services/onboarding/onboarding-model.d.ts

@@ -2,6 +2,7 @@ import { CDPSession } from "puppeteer";
 import { Protocol } from "puppeteer-core";
 import { UserCliConfig } from "../../helpers/cli-config";
 import { AbortResponse } from "./browser/abort-response";
+import { FlagInput } from "@oclif/core/lib/interfaces/parser";
 export declare class BrowserContext {
     readonly domain: string;
     readonly chromeFlags?: string[];
@@ -20,17 +21,14 @@ export declare class OnboardingContext {
     readonly configName: string;
     readonly local: boolean;
     readonly verboseLevel?: boolean;
+    readonly ignoreContentSecurityPolicy: boolean;
+    static flags: FlagInput;
     readonly DEFAULT_DF_PATH = "https://www.baqend.com/speed-kit/latest/dynamic-fetcher.js";
     readonly DEFAULT_DOCUMENT_HANDLER_PATH = "https://www.baqend.com/speed-kit-handler/latest/DocumentHandler.js";
     readonly DEFAULT_SNIPPET_PATH = "https://www.baqend.com/speed-kit/latest/snippet.js";
     readonly DEFAULT_SW_PATH = "https://www.baqend.com/speed-kit/latest/sw.js";
-    constructor(customerPath: string, configName: string, local: boolean, verboseLevel?: boolean);
+    constructor(customerPath: string, configName: string, local: boolean, verboseLevel?: boolean, ignoreContentSecurityPolicy?: boolean);
 }
-export type awsCredentials = {
-    accessKeyId: string;
-    region: string;
-    secretAccessKey: string;
-};
 export type SpeedKitServerConfigAuthentication = {
     password: string;
     type: "basic";

package/dist/services/onboarding/onboarding-model.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OnboardingContext = exports.BrowserContext = void 0;
+const core_1 = require("@oclif/core");
+const cli_parameters_1 = require("../../models/cli-parameters");
 const DEFAULT_BROWSER_ARGS = [
     "--enable-features=NetworkService",
     "--no-first-run",
@@ -40,15 +42,35 @@ class OnboardingContext {
     configName;
     local;
     verboseLevel;
+    ignoreContentSecurityPolicy;
+    static flags = {
+        ...cli_parameters_1.CLI_CONFIG_NAME,
+        local: core_1.Flags.boolean({
+            char: "l",
+            default: false,
+            description: "Run with local documentHandler",
+        }),
+        verboseLevel: core_1.Flags.boolean({
+            char: "v",
+            default: false,
+            description: "Show all messages",
+        }),
+        ignoreContentSecurityPolicy: core_1.Flags.boolean({
+            char: "s",
+            default: false,
+            description: `Removes header/meta "content-security-policy" for origin-responses`,
+        }),
+    };
     DEFAULT_DF_PATH = "https://www.baqend.com/speed-kit/latest/dynamic-fetcher.js";
     DEFAULT_DOCUMENT_HANDLER_PATH = "https://www.baqend.com/speed-kit-handler/latest/DocumentHandler.js";
     DEFAULT_SNIPPET_PATH = "https://www.baqend.com/speed-kit/latest/snippet.js";
     DEFAULT_SW_PATH = "https://www.baqend.com/speed-kit/latest/sw.js";
-    constructor(customerPath, configName, local, verboseLevel) {
+    constructor(customerPath, configName, local, verboseLevel, ignoreContentSecurityPolicy = false) {
         this.customerPath = customerPath;
         this.configName = configName;
         this.local = local;
         this.verboseLevel = verboseLevel;
+        this.ignoreContentSecurityPolicy = ignoreContentSecurityPolicy;
     }
 }
 exports.OnboardingContext = OnboardingContext;

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

@@ -97,7 +97,7 @@ class OnboardingServiceFactory {
         const DiffService = new diff_1.DiffServiceFactory(new diff_1.DiffContext(this.cliConfig.diffExec, this.cliConfig.diffExecTemplate)).getService();
         const requestDiffService = new request_diff_service_1.RequestDiffService(DiffService, documentHandler);
         const handlers = [
-            new customer_domain_document_response_1.CustomerDomainDocumentResponse(customerConfig, files.getByName(files_1.INTEGRATION_FILES.CONFIG.DYNAMIC_BLOCKS), files.getByName(files_1.INTEGRATION_FILES.CONFIG.DYNAMIC_STYLES)),
+            new customer_domain_document_response_1.CustomerDomainDocumentResponse(customerConfig, files.getByName(files_1.INTEGRATION_FILES.CONFIG.DYNAMIC_BLOCKS), files.getByName(files_1.INTEGRATION_FILES.CONFIG.DYNAMIC_STYLES), this.context.ignoreContentSecurityPolicy),
             new speed_kit_install_html_1.SpeedKitInstallHtml(customerConfig, browserContext, new install_speed_kit_html_template_1.InstallSpeedKitHtmlTemplate()),
             new speed_kit_install_js_1.SpeedKitInstallJs(customerConfig, files.getByName(files_1.INTEGRATION_FILES.BUILD.INSTALL)),
             new customer_service_worker_js_1.CustomerServiceWorkerJs(customerConfig),

package/oclif.manifest.json

@@ -459,6 +459,13 @@
           "name": "verboseLevel",
           "allowNo": false,
           "type": "boolean"
+        },
+        "ignoreContentSecurityPolicy": {
+          "char": "s",
+          "description": "Removes header/meta \"content-security-policy\" for origin-responses",
+          "name": "ignoreContentSecurityPolicy",
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
@@ -660,5 +667,5 @@
       ]
     }
   },
-  "version": "2.24.0"
+  "version": "2.26.0"
 }

package/package.json

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