@speedkit/cli 2.31.1 → 2.32.0

package/CHANGELOG.md

@@ -1,3 +1,14 @@
+# [2.32.0](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.31.1...v2.32.0) (2024-06-14)
+
+
+### Features
+
+* **config-wizard:** update prerendering template ([1f3e26b](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/1f3e26b849d12d8f3337e70fde8d49b11cfba9b9))
+* **config-wizard:** update prerendering template ([92cbc1b](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/92cbc1bbd8d750b7fcf1677ed602256d6d5d2e65))
+* **config-wizard:** update prerendering template ([1419422](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/1419422a4e8f40307a173ca28688840dd3055661))
+* **config-wizard:** update prerendering template ([3ac8632](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/3ac8632b1f6521af6da7672c0ff8d11d2f6842d5))
+* **config-wizard:** update prerendering template ([4e8e710](https://gitlab.orestes.info/baqend/speed-kit-cli/commit/4e8e71011b3ec969d97d185869638abe8e15fb9d))
+
 ## [2.31.1](https://gitlab.orestes.info/baqend/speed-kit-cli/compare/v2.31.0...v2.31.1) (2024-06-13)
 
 

package/README.md

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

package/dist/helpers/file-helper.d.ts

@@ -1,2 +1,8 @@
+/**
+ * @deprecated
+ */
 export declare function createTemporalDirectory(): Promise<null | string>;
+/**
+ * @deprecated
+ */
 export declare function readLocalFile(basePath: string, fileName: string): Promise<null | string>;

package/dist/helpers/file-helper.js

@@ -6,6 +6,9 @@ const node_fs_1 = require("node:fs");
 const os = tslib_1.__importStar(require("node:os"));
 const path = tslib_1.__importStar(require("node:path"));
 const customer_config_1 = require("./customer-config");
+/**
+ * @deprecated
+ */
 async function createTemporalDirectory() {
     try {
         return (0, node_fs_1.mkdtempSync)(path.join(os.tmpdir(), "speed-kit-cli-"));
@@ -16,6 +19,9 @@ async function createTemporalDirectory() {
     }
 }
 exports.createTemporalDirectory = createTemporalDirectory;
+/**
+ * @deprecated
+ */
 async function readLocalFile(basePath, fileName) {
     try {
         const file = await customer_config_1.ConfigFile.loadFile(basePath, fileName);

package/dist/helpers/race.d.ts

@@ -1 +1 @@
-export declare function race<T>(promise: Promise<T>): Promise<T>;
+export declare function race<T>(promise: Promise<T>, timeout?: number): Promise<T>;

package/dist/helpers/race.js

@@ -1,18 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.race = void 0;
-const safe_1 = require("./safe");
+const tslib_1 = require("tslib");
+const application_error_1 = tslib_1.__importDefault(require("../services/error-handling/error/application-error"));
 const DEFAULT_TIMEOUT = 5000;
-async function race(promise) {
+class RaceTimeOutError extends application_error_1.default {
+}
+async function race(promise, timeout = DEFAULT_TIMEOUT) {
     const timeOut = new Promise((resolve, reject) => {
         setTimeout(() => {
-            reject("timeout");
-        }, DEFAULT_TIMEOUT);
+            reject(new RaceTimeOutError(`timeout of ${timeout}ms reached`));
+        }, timeout);
     });
-    const result = await (0, safe_1.safe)(Promise.race([promise, timeOut]));
-    if (result.success === true) {
-        return result.data;
-    }
-    throw new Error(result.error);
+    return Promise.race([promise, timeOut]);
 }
 exports.race = race;

package/dist/helpers/safe.js

@@ -17,7 +17,7 @@ async function safeAsync(promise) {
         if (error instanceof Error) {
             return { success: false, error: error.message, errorObj: error };
         }
-        return { success: false, error: "Something went wrong" };
+        return { success: false, error: "Something went wrong", errorObj: error };
     }
 }
 function safeSync(function_) {
@@ -29,6 +29,6 @@ function safeSync(function_) {
         if (error instanceof Error) {
             return { success: false, error: error.message, errorObj: error };
         }
-        return { success: false, error: "Something went wrong" };
+        return { success: false, error: "Something went wrong", errorObj: error };
     }
 }

package/dist/models/cli-parameters.js

@@ -83,12 +83,13 @@ exports.CLI_CONFIG_NAME = {
         char: CLIParametersChar.ConfigName,
         default: "production",
         description: "The costumer config name",
+        required: false,
     }),
 };
 exports.CLI_CUSTOMER_CONFIG = {
     [CLIParameters.CustomerPath]: core_1.Args.directory({
-        name: CLIParameters.CustomerPath, // name of arg to show in help and reference with args[name]
-        required: true, // make the arg required with `required: true`
-        description: "The customer config path", // help description
+        name: CLIParameters.CustomerPath,
+        required: true,
+        description: "The customer config path",
     }),
 };

package/dist/services/athena/athena-service.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AthenaService = void 0;
 const client_athena_1 = require("@aws-sdk/client-athena");
 const athena_service_model_1 = require("./athena-service-model");
+const athena_query_error_1 = require("./error/athena-query-error");
 class AthenaService {
     client;
     constructor(client) {
@@ -99,11 +100,11 @@ class AthenaService {
             const status = result.QueryExecution.Status;
             switch (status.State) {
                 case client_athena_1.QueryExecutionState.FAILED: {
-                    throw new Error("The Amazon Athena query failed to run with error message: " +
+                    throw new athena_query_error_1.AthenaQueryError("The Amazon Athena query failed to run with error message: " +
                         status.StateChangeReason);
                 }
                 case client_athena_1.QueryExecutionState.CANCELLED: {
-                    throw new Error("The Amazon Athena query was cancelled.");
+                    throw new athena_query_error_1.AthenaQueryError("The Amazon Athena query was cancelled.");
                 }
                 case client_athena_1.QueryExecutionState.SUCCEEDED: {
                     return;

package/dist/services/athena/error/athena-query-error.d.ts

@@ -0,0 +1,4 @@
+import ApplicationError from "../../error-handling/error/application-error";
+export declare class AthenaQueryError extends ApplicationError {
+    readonly code = "ATHENA_QUERY_FAILED";
+}

package/dist/services/athena/error/athena-query-error.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AthenaQueryError = void 0;
+const tslib_1 = require("tslib");
+const application_error_1 = tslib_1.__importDefault(require("../../error-handling/error/application-error"));
+class AthenaQueryError extends application_error_1.default {
+    code = "ATHENA_QUERY_FAILED";
+}
+exports.AthenaQueryError = AthenaQueryError;

package/dist/services/athena/error/fetch-credentials-error.d.ts

@@ -1,2 +1,6 @@
-export declare class FetchCredentialsError extends Error {
+import ApplicationError from "../../error-handling/error/application-error";
+export declare class FetchCredentialsError extends ApplicationError {
+    readonly suggestions: string[];
+    readonly code = "AWS_ATHENA_NO_CREDENTIALS";
+    readonly reference = "https://www.notion.so/baqend/AWS-Cli-SSO-login-f19af359eb514114aa6a36cd9b65e0c1";
 }

package/dist/services/athena/error/fetch-credentials-error.js

@@ -1,6 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FetchCredentialsError = void 0;
-class FetchCredentialsError extends Error {
+const tslib_1 = require("tslib");
+const application_error_1 = tslib_1.__importDefault(require("../../error-handling/error/application-error"));
+class FetchCredentialsError extends application_error_1.default {
+    suggestions = [
+        "login to https://bbq.awsapps.com/start/#/ to gather credentials",
+        "or run: aws sso login",
+    ];
+    code = "AWS_ATHENA_NO_CREDENTIALS";
+    reference = "https://www.notion.so/baqend/AWS-Cli-SSO-login-f19af359eb514114aa6a36cd9b65e0c1";
 }
 exports.FetchCredentialsError = FetchCredentialsError;

package/dist/services/bundler/bundle-service.js

@@ -5,6 +5,8 @@ const tslib_1 = require("tslib");
 const esbuild_1 = require("esbuild");
 const node_fetch_1 = tslib_1.__importDefault(require("node-fetch"));
 const node_url_1 = require("node:url");
+const bundle_resolve_error_1 = require("./error/bundle-resolve-error");
+const bundle_fetch_error_1 = require("./error/bundle-fetch-error");
 const importCache = {};
 class BundleService {
     async bundle({ entryPoints, basePaths, define, target = "es5", minify = true, logLevel = "silent", }) {
@@ -33,7 +35,7 @@ class BundleService {
             setup(build) {
                 build.onResolve({ filter: /.*/ }, (arguments_) => {
                     if (!entryPoints[arguments_.path]) {
-                        throw new Error("Could not resolve " + arguments_.path);
+                        throw new bundle_resolve_error_1.BundleResolveError(`Could not resolve "${arguments_.path}"`);
                     }
                     return {
                         path: arguments_.path,
@@ -58,7 +60,7 @@ class BundleService {
                     const [base, path] = arguments_.path.split("/", 2);
                     const url = new node_url_1.URL(path, basePaths[base]).toString();
                     if (!url.startsWith(basePaths[base])) {
-                        throw new Error(`Importing ${path} failed. Can't resolve the path`);
+                        throw new bundle_resolve_error_1.BundleResolveError(`Importing ${path} failed. Can't resolve the path`);
                     }
                     return {
                         path: url,
@@ -76,7 +78,7 @@ class BundleService {
                     }
                     const fetched = await (0, node_fetch_1.default)(url);
                     if (!fetched.ok) {
-                        throw new Error(`Importing ${url} failed with error ${fetched.status}`);
+                        throw new bundle_fetch_error_1.BundleFetchError(`Importing ${url} failed with error ${fetched.status}`);
                     }
                     let text = await fetched.text();
                     text = text.replace("window.SpeedKit=window.SpeedKit||{},window.SpeedKit.plugins=window.SpeedKit.plugins||{},window.SpeedKit.plugins.", "export var ");

package/dist/services/bundler/error/bundle-fetch-error.d.ts

@@ -0,0 +1,3 @@
+import ApplicationError from "../../error-handling/error/application-error";
+export declare class BundleFetchError extends ApplicationError {
+}

package/dist/services/bundler/error/bundle-fetch-error.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BundleFetchError = void 0;
+const tslib_1 = require("tslib");
+const application_error_1 = tslib_1.__importDefault(require("../../error-handling/error/application-error"));
+class BundleFetchError extends application_error_1.default {
+}
+exports.BundleFetchError = BundleFetchError;

package/dist/services/bundler/error/bundle-resolve-error.d.ts

@@ -0,0 +1,3 @@
+import ApplicationError from "../../error-handling/error/application-error";
+export declare class BundleResolveError extends ApplicationError {
+}

package/dist/services/bundler/error/bundle-resolve-error.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BundleResolveError = void 0;
+const tslib_1 = require("tslib");
+const application_error_1 = tslib_1.__importDefault(require("../../error-handling/error/application-error"));
+class BundleResolveError extends application_error_1.default {
+}
+exports.BundleResolveError = BundleResolveError;

package/dist/services/config-api/client.d.ts

@@ -9,6 +9,6 @@ export default class Client {
     createRequest(requestExtension: RequestExtensionInterface): Promise<RequestInit>;
     getEntityManager(): Promise<EntityManager>;
     getModule(moduleName: string): Promise<string>;
-    send(url: string, requestExtension?: RequestExtensionInterface): Promise<any>;
+    send<T>(url: string, requestExtension?: RequestExtensionInterface): Promise<T>;
     setModule(moduleName: string, moduleCode: string): Promise<string>;
 }

package/dist/services/config-api/client.js

@@ -4,6 +4,9 @@ const tslib_1 = require("tslib");
 const deepmerge_1 = tslib_1.__importDefault(require("deepmerge"));
 const node_https_1 = require("node:https");
 const race_1 = require("../../helpers/race");
+const safe_1 = require("../../helpers/safe");
+const json_response_error_1 = tslib_1.__importDefault(require("./error/json-response-error"));
+const connection_error_1 = require("../error-handling/error/connection-error");
 const REQUEST_TIMEOUT = 10_000;
 const CONTENT_TYPE = "application/json;charset=UTF-8";
 class Client {
@@ -30,24 +33,43 @@ class Client {
         return { ...(0, deepmerge_1.default)(baseRequest, requestExtension), agent: this.agent };
     }
     async getEntityManager() {
-        return (0, race_1.race)(this.entityManagerFactory.getEntityManager(this.app));
+        const result = await (0, safe_1.safe)((0, race_1.race)(this.entityManagerFactory.getEntityManager(this.app), REQUEST_TIMEOUT));
+        if (result.success === true) {
+            return result.data;
+        }
+        throw new connection_error_1.ConnectionError(`Could not connect to app: ${this.app} - ${result.error}`);
     }
     async getModule(moduleName) {
         const entityManager = await this.getEntityManager();
-        return entityManager.code.loadCode(moduleName, "module");
+        const moduleResponse = await (0, safe_1.safe)(entityManager.code.loadCode(moduleName, "module"));
+        if (moduleResponse.success !== true) {
+            throw new connection_error_1.ConnectionError(`Could not load module "${moduleName}" from app "${this.app}" - ${moduleResponse.error}`);
+        }
+        return moduleResponse.data;
     }
     async send(url, requestExtension = {}) {
         const requestInit = await this.createRequest(requestExtension);
-        const response = await fetch(url, requestInit);
+        const responseResult = await (0, safe_1.safe)(fetch(url, requestInit));
+        if (responseResult.success !== true) {
+            throw new connection_error_1.ConnectionError(responseResult.error);
+        }
+        const response = responseResult.data;
         if (response.status !== 200) {
-            const message = await response.json();
-            throw new Error(message);
+            throw new connection_error_1.ConnectionError(`${response.statusText}`);
         }
-        return response.json();
+        const jsonResponse = await (0, safe_1.safe)(response.json());
+        if (jsonResponse.success !== true) {
+            throw new json_response_error_1.default(jsonResponse.error);
+        }
+        return jsonResponse.data;
     }
     async setModule(moduleName, moduleCode) {
         const entityManager = await this.getEntityManager();
-        return entityManager.code.saveCode(moduleName, "module", moduleCode);
+        const moduleResponse = await (0, safe_1.safe)(entityManager.code.saveCode(moduleName, "module", moduleCode));
+        if (moduleResponse.success !== true) {
+            throw new connection_error_1.ConnectionError(`Could not save module "${moduleName}" to app "${this.app}" - ${moduleResponse.error}`);
+        }
+        return moduleResponse.data;
     }
 }
 exports.default = Client;

package/dist/services/config-api/error/json-response-error.d.ts

@@ -1,2 +1,4 @@
-export default class JsonResponseError extends Error {
+import ApplicationError from "../../error-handling/error/application-error";
+export default class JsonResponseError extends ApplicationError {
+    readonly code = "JSON_RESPONSE_ERROR";
 }

package/dist/services/config-api/error/json-response-error.js

@@ -1,5 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-class JsonResponseError extends Error {
+const tslib_1 = require("tslib");
+const application_error_1 = tslib_1.__importDefault(require("../../error-handling/error/application-error"));
+class JsonResponseError extends application_error_1.default {
+    code = "JSON_RESPONSE_ERROR";
 }
 exports.default = JsonResponseError;

package/dist/services/config-api/error/login-error.d.ts

@@ -1,5 +1,5 @@
-import DeployAppError from "../../deploy/error/deploy-app-error";
-export default class LoginError extends DeployAppError {
-    app: string;
+import ApplicationError from "../../error-handling/error/application-error";
+export default class LoginError extends ApplicationError {
+    readonly code = "LOGIN_ERROR";
     constructor(app: string);
 }

package/dist/services/config-api/error/login-error.js

@@ -1,12 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const deploy_app_error_1 = tslib_1.__importDefault(require("../../deploy/error/deploy-app-error"));
-class LoginError extends deploy_app_error_1.default {
-    app;
+const application_error_1 = tslib_1.__importDefault(require("../../error-handling/error/application-error"));
+class LoginError extends application_error_1.default {
+    code = "LOGIN_ERROR";
     constructor(app) {
         super(`Could not login to app ${app}`);
-        this.app = app;
     }
 }
 exports.default = LoginError;

package/dist/services/config-api/factory/config-api-service-factory.js

@@ -7,6 +7,7 @@ const entity_manager_factory_1 = tslib_1.__importDefault(require("./entity-manag
 const node_fs_1 = require("node:fs");
 const node_os_1 = tslib_1.__importDefault(require("node:os"));
 const node_path_1 = tslib_1.__importDefault(require("node:path"));
+const application_error_1 = tslib_1.__importDefault(require("../../error-handling/error/application-error"));
 class ConfigApiServiceFactory {
     context;
     service = undefined;
@@ -21,7 +22,7 @@ class ConfigApiServiceFactory {
     }
     buildService() {
         if (!this.context.app) {
-            throw new Error("app is undefined");
+            throw new application_error_1.default("app is undefined");
         }
         this.createLoginTokenFileIfNotExists();
         const entityManagerFactory = new entity_manager_factory_1.default();

package/dist/services/config-api-service.d.ts

@@ -1,5 +1,8 @@
 import { EntityManager } from "baqend";
 import Install from "../models/install";
+/**
+ * @deprecated
+ */
 export default class ConfigApiService {
     private db;
     private readonly app;

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

@@ -8,6 +8,9 @@ const agent = new node_https_1.default.Agent({
     rejectUnauthorized: false,
     keepAlive: true,
 });
+/**
+ * @deprecated
+ */
 /* eslint-disable no-console */
 class ConfigApiService {
     db;

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

@@ -28,6 +28,8 @@ export interface CustomerConfigSettings {
     activateImageOptimisation?: boolean;
     removeLazyLoading?: boolean;
     addPreRendering?: boolean;
+    supportShadowDomInPreRendering?: boolean;
+    shadowDomCustomElementPrefix?: string;
     activateRumTracking?: boolean;
     useGATracking?: boolean;
     withGoogleOptimize?: boolean;

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

@@ -161,7 +161,7 @@ class CustomerConfigService {
         }
     }
     async getConfigSettings() {
-        let { production, staging, subRouteScope, includeServiceWorker, activateImageOptimisation, removeLazyLoading, addPreRendering, activateRumTracking, useGATracking, withGoogleOptimize, activateCfRocketLoaderWorkaround, isShopify, isShopware, isSalesforce, isPlentymarkets, shopifyId, } = {};
+        let { production, staging, subRouteScope, includeServiceWorker, activateImageOptimisation, removeLazyLoading, addPreRendering, supportShadowDomInPreRendering, shadowDomCustomElementPrefix, 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,
@@ -207,7 +207,13 @@ class CustomerConfigService {
         }
         activateImageOptimisation = await this.cli.confirm("Activate Image Optimisation?", false);
         removeLazyLoading = await this.cli.confirm("Remove Lazy-Loading?");
-        addPreRendering = await this.cli.confirm("Add Pre-Rendering? This requires a set-up Lambda function to work. Also requires a DOM-based DocumentHandler.", false);
+        if (await this.cli.confirm("Add Pre-Rendering? This requires a set-up Lambda function to work. Also requires a DOM-based DocumentHandler.", false)) {
+            addPreRendering = true;
+            if (await this.cli.confirm("Does the customer utilize Shadow DOMs? If so additional handling for this will be added.", false)) {
+                supportShadowDomInPreRendering = true;
+                shadowDomCustomElementPrefix = await this.cli.prompt("Please specify the prefix of the custom elements used (e.g. o2 uses tef-): ", { defaultAnswer: "custom-" });
+            }
+        }
         activateRumTracking = await this.cli.confirm("Activate RUM Tracking?");
         if (activateRumTracking && !isShopify) {
             useGATracking = await this.cli.confirm("Add Tracking based on Google Analytics' DataLayer?");
@@ -225,6 +231,8 @@ class CustomerConfigService {
             activateImageOptimisation,
             removeLazyLoading,
             addPreRendering,
+            supportShadowDomInPreRendering,
+            shadowDomCustomElementPrefix,
             activateRumTracking,
             useGATracking,
             withGoogleOptimize,

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

@@ -25,6 +25,30 @@
   var ENABLED_HOSTS = getEnabledHosts(ENABLED_HOSTS_CONFIGS);
   var CURRENT_HOST_CONFIG = getCurrentHostConfig(ENABLED_HOSTS_CONFIGS);
 
+{{#if addPreRendering}}
+    // Pre-rendering specific: disable SK for tablets as they are not covered in lambda
+    function isTablet() {
+      var userAgent = window.navigator.userAgent.toLowerCase();
+      var tabletUAs = [
+        /tablet/,
+        /ipad/,
+        /nexus 7/,
+        /nexus 10/,
+        /silk\//,
+        /\bgt-[pn]\d{4}\b/,
+        /\bsm-t\d{3}\b/,
+        /^.*android(?!.*mobile|.*smart-tv|.*smarttv|.*aft[tm]|.*crkey).*$/,
+      ];
+
+      if ("ontouchend" in document && userAgent.indexOf("Macintosh") > -1) {
+        return true;
+      }
+      return tabletUAs.some(function (ua) {
+        return ua.test(userAgent);
+      });
+    }
+{{/if}}
+
   /**
    * @type {SpeedKitConfig}
    */
@@ -43,9 +67,13 @@
 {{/if}}
     preloadDynamicBlocks: true,
     rumTracking: {{activateRumTracking}},
+{{#if addPreRendering}}
+  // Pre-rendering specific: detect device to cover different resolutions when rendered in lambda
+  userAgentDetection: true,
+{{/if}}
     split: CURRENT_HOST_CONFIG.split,
     splitTestId: CURRENT_HOST_CONFIG.splitTestId,
-    disabled: !CURRENT_HOST_CONFIG.enabled,
+    disabled: !CURRENT_HOST_CONFIG.enabled{{#if addPreRendering}} || isTablet(){{/if}},
     enabledSites: [
       {
         pathname: [
@@ -122,6 +150,12 @@
 {{/if}}
     ],
     blacklist: [
+{{#if addPreRendering}}
+      // blacklist tv variations
+      {
+        tv: true,
+      },
+{{/if}}
       {
         pathname: [
           // TODO: adjust/replace this exemplary list