@speedkit/cli 2.10.0 → 2.11.0

package/dist/services/onboarding/fetch-events/speed-kit-rum-pi-request.js

@@ -19,7 +19,7 @@ class SpeedKitRumPiRequest {
         this.cli = cli;
         this.patterns = [
             {
-                requestStage: 'Request',
+                requestStage: "Request",
                 urlPattern: `https://${this.customerConfig.appDomain}/v1/rum/pi*`,
             },
         ];
@@ -32,10 +32,10 @@ class SpeedKitRumPiRequest {
         if (result.success === false) {
             return;
         }
-        if (!('changeDetection' in result.data)) {
+        if (!("changeDetection" in result.data)) {
             return;
         }
-        const changeDetection = result.data.changeDetection;
+        const changeDetection = (result.data.changeDetection);
         this.cache.removeEntry(changeDetection.url);
         this.cli.write(`changeDetection triggered for url: ${changeDetection.url} - cleared from dh-cache`);
     }

package/dist/services/onboarding/fetch-events/speed-kit-service-worker-js.d.ts

@@ -1,7 +1,7 @@
-import Protocol from 'devtools-protocol';
-import { FileInterface } from '../../integration-api/integration-api-model';
-import CustomerConfig from '../../integration-api/struct/customer-config';
-import { FetchRequestPausedEventHandler } from '../onboarding-model';
+import Protocol from "devtools-protocol";
+import { FileInterface } from "../../integration-api/integration-api-model";
+import CustomerConfig from "../../integration-api/struct/customer-config";
+import { FetchRequestPausedEventHandler } from "../onboarding-model";
 /**
  * SpeedKitServiceWorkerJs class is responsible for handling fetch requests for the SpeedKit service worker.
  * Injects serviceWorker from local file, if custom_sw is present.

package/dist/services/onboarding/fetch-events/speed-kit-service-worker-js.js

@@ -15,13 +15,15 @@ class SpeedKitServiceWorkerJs {
     constructor(customerConfig, serviceWorker) {
         this.customerConfig = customerConfig;
         this.serviceWorker = serviceWorker;
-        this.patterns = [{
-                requestStage: 'Request',
+        this.patterns = [
+            {
+                requestStage: "Request",
                 urlPattern: `https://${this.customerConfig.appDomain}/v1/speedkit/sw.js*`,
-            }];
+            },
+        ];
     }
     async handle() {
-        return new baqend_response_1.BaqendResponse(this.serviceWorker.getContent(), 'text/javascript; charset=utf-8');
+        return new baqend_response_1.BaqendResponse(this.serviceWorker.getContent(), "text/javascript; charset=utf-8");
     }
 }
 exports.SpeedKitServiceWorkerJs = SpeedKitServiceWorkerJs;

package/dist/services/onboarding/file-events/{fileWatcher.d.ts → file-watcher.d.ts}

@@ -1,10 +1,10 @@
-import { CliService } from "../../cli";
 import { Page } from "puppeteer";
-import CustomerConfig from "../../integration-api/struct/customer-config";
+import { CliService } from "../../cli";
 import { DocumentHandlerServer } from "../../document-handler-runtime/document-handler-server";
-import { Cache } from "../request-cache/cache";
 import { ConfigFileInterface, FileListInterface } from "../../integration-api/integration-api-model";
+import CustomerConfig from "../../integration-api/struct/customer-config";
 import { BrowserContext } from "../onboarding-model";
+import { Cache } from "../request-cache/cache";
 /**
  * Add different callbacks that will be executed if a local file is changed.
  */
@@ -17,12 +17,13 @@ export declare class FileWatcher {
     private cache;
     constructor(cli: CliService, customerConfig: CustomerConfig, files: FileListInterface, documentHandler: DocumentHandlerServer, browserContext: BrowserContext, cache: Cache);
     addCallbackOnFileChange(page: Page, serviceWorkerReinstallCallback: (file: ConfigFileInterface) => Promise<void>): void;
-    private handleServiceWorkerDependencies;
-    private handleGenericConfigFiles;
+    private clearPageFunction;
+    private clearServiceWorker;
     private handleDynamicStyles;
-    private onChangeServiceWorkerCallback;
+    private handleGenericConfigFiles;
+    private handleServiceWorkerDependencies;
     private onChangeConfigFileCallback;
     private onChangeDynamicStyleCallback;
-    private clearPageFunction;
-    private clearServiceWorker;
+    private onChangeServiceWorkerCallback;
+    private updateStyles;
 }

package/dist/services/onboarding/file-events/{fileWatcher.js → file-watcher.js}

@@ -2,8 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FileWatcher = void 0;
 const safe_1 = require("../../../helpers/safe");
-const virtual_file_1 = require("../../integration-api/struct/virtual-file");
 const files_1 = require("../../../models/files");
+const virtual_file_1 = require("../../integration-api/struct/virtual-file");
 /**
  * Add different callbacks that will be executed if a local file is changed.
  */
@@ -28,66 +28,88 @@ class FileWatcher {
         this.handleGenericConfigFiles(page, installResource);
         this.handleDynamicStyles(page);
     }
-    handleServiceWorkerDependencies(page, installResource, serviceWorkerReinstallCallback) {
-        // add watcher to serviceWorker related files
-        const serviceWorkerDependencies = [files_1.INTEGRATION_FILES.CONFIG.SPEED_KIT, files_1.INTEGRATION_FILES.CONFIG.LOAD_HANDLER, files_1.INTEGRATION_FILES.CUSTOM.LOADER, files_1.INTEGRATION_FILES.CUSTOM.SW];
-        for (const dependency of serviceWorkerDependencies) {
-            if (!this.files.hasFile(dependency)) {
+    async clearPageFunction(page) {
+        const client = await page.target().createCDPSession();
+        const cacheResponse = await client.send("CacheStorage.requestCacheNames", {
+            securityOrigin: this.browserContext.domain,
+        });
+        for (const cache of cacheResponse.caches) {
+            if (cache.cacheName.includes("baqend")) {
+                await client.send("CacheStorage.deleteCache", {
+                    cacheId: cache.cacheId,
+                });
+            }
+        }
+    }
+    async clearServiceWorker(page) {
+        const client = await page.target().createCDPSession();
+        await client.send("ServiceWorker.enable");
+        await client.send("ServiceWorker.unregister", {
+            scopeURL: `https://${this.customerConfig.domain}`,
+        });
+    }
+    handleDynamicStyles(page) {
+        if (!this.files.hasFile(files_1.INTEGRATION_FILES.CONFIG.DYNAMIC_STYLES)) {
+            return;
+        }
+        // add watcher that will instantly add changes to current page
+        this.files
+            .getByName(files_1.INTEGRATION_FILES.CONFIG.DYNAMIC_STYLES)
+            .onChange(async (file) => {
+            const result = await (0, safe_1.safe)(this.onChangeDynamicStyleCallback(file, page));
+            if (result.success === false) {
+                this.cli.writeError(`error after fileChange: ${file.name}: ${result.error}`);
+            }
+        });
+    }
+    handleGenericConfigFiles(page, installResource) {
+        // add watcher to configFiles
+        const generalConfigFiles = [
+            files_1.INTEGRATION_FILES.CONFIG.DYNAMIC_BLOCKS,
+            files_1.INTEGRATION_FILES.CONFIG.DOCUMENT_HANDLER,
+            files_1.INTEGRATION_FILES.CUSTOM.DYNAMIC_FETCHER,
+            files_1.INTEGRATION_FILES.CUSTOM.DOCUMENT_HANDLER,
+        ];
+        for (const configFile of generalConfigFiles) {
+            if (!this.files.hasFile(configFile)) {
                 continue;
             }
-            const file = this.files.getByName(dependency);
+            const file = this.files.getByName(configFile);
             if (file.type === virtual_file_1.VirtualFile) {
                 continue;
             }
             file.onChange(async (file) => {
-                const result = await (0, safe_1.safe)(this.onChangeServiceWorkerCallback(file, page, installResource, serviceWorkerReinstallCallback));
+                const result = await (0, safe_1.safe)(this.onChangeConfigFileCallback(page, installResource, file));
                 if (result.success === false) {
                     this.cli.writeError(`error after fileChange: ${file.name}: ${result.error}`);
                 }
             });
         }
     }
-    handleGenericConfigFiles(page, installResource) {
-        // add watcher to configFiles
-        const generalConfigFiles = [files_1.INTEGRATION_FILES.CONFIG.DYNAMIC_BLOCKS, files_1.INTEGRATION_FILES.CONFIG.DOCUMENT_HANDLER, files_1.INTEGRATION_FILES.CUSTOM.DYNAMIC_FETCHER, files_1.INTEGRATION_FILES.CUSTOM.DOCUMENT_HANDLER];
-        for (const configFile of generalConfigFiles) {
-            if (!this.files.hasFile(configFile)) {
+    handleServiceWorkerDependencies(page, installResource, serviceWorkerReinstallCallback) {
+        // add watcher to serviceWorker related files
+        const serviceWorkerDependencies = [
+            files_1.INTEGRATION_FILES.CONFIG.SPEED_KIT,
+            files_1.INTEGRATION_FILES.CONFIG.LOAD_HANDLER,
+            files_1.INTEGRATION_FILES.CUSTOM.LOADER,
+            files_1.INTEGRATION_FILES.CUSTOM.SW,
+        ];
+        for (const dependency of serviceWorkerDependencies) {
+            if (!this.files.hasFile(dependency)) {
                 continue;
             }
-            const file = this.files.getByName(configFile);
+            const file = this.files.getByName(dependency);
             if (file.type === virtual_file_1.VirtualFile) {
                 continue;
             }
             file.onChange(async (file) => {
-                const result = await (0, safe_1.safe)(this.onChangeConfigFileCallback(page, installResource, file));
+                const result = await (0, safe_1.safe)(this.onChangeServiceWorkerCallback(file, page, installResource, serviceWorkerReinstallCallback));
                 if (result.success === false) {
                     this.cli.writeError(`error after fileChange: ${file.name}: ${result.error}`);
                 }
             });
         }
     }
-    handleDynamicStyles(page) {
-        if (!this.files.hasFile(files_1.INTEGRATION_FILES.CONFIG.DYNAMIC_STYLES)) {
-            return;
-        }
-        // add watcher that will instantly add changes to current page
-        this.files.getByName(files_1.INTEGRATION_FILES.CONFIG.DYNAMIC_STYLES).onChange(async (file) => {
-            const result = await (0, safe_1.safe)(this.onChangeDynamicStyleCallback(file, page));
-            if (result.success === false) {
-                this.cli.writeError(`error after fileChange: ${file.name}: ${result.error}`);
-            }
-        });
-    }
-    async onChangeServiceWorkerCallback(file, page, installResource, serviceWorkerReinstallCallback) {
-        this.cli.writeWarning(`changed file: ${file.name} (reinstall serviceWorker)`);
-        // clear speed-kit-service-worker-caches and uninstall serviceWorker
-        await this.clearPageFunction(page);
-        await this.clearServiceWorker(page);
-        // rebuild installResource
-        await installResource.buildContent();
-        // tell puppeteer to reinstall serviceworker on next navigate
-        await serviceWorkerReinstallCallback(file);
-    }
     async onChangeConfigFileCallback(page, installResource, file) {
         await this.clearPageFunction(page);
         await this.documentHandler.buildDocumentHandler();
@@ -98,13 +120,7 @@ class FileWatcher {
     async onChangeDynamicStyleCallback(file, page) {
         this.cli.writeWarning(`changed file: ${file.name} (update styles on page)`);
         const escapedStyles = encodeURI(file.getContent());
-        function updateStyles(styles) {
-            const styleElement = document.querySelector('#speed-kit-df-styles');
-            if (styleElement) {
-                styleElement.textContent = decodeURI(styles);
-            }
-        }
-        const evaluateResult = await (0, safe_1.safe)(page.evaluate(`(${updateStyles.toString()})("${escapedStyles}");`));
+        const evaluateResult = await (0, safe_1.safe)(page.evaluate(`(${this.updateStyles.toString()})("${escapedStyles}");`));
         if (evaluateResult.success === false) {
             this.cli.writeError(evaluateResult.error);
         }
@@ -115,19 +131,21 @@ class FileWatcher {
         await this.documentHandler.buildDocumentHandler();
         this.cache.clear();
     }
-    async clearPageFunction(page) {
-        const client = await page.target().createCDPSession();
-        const cacheResponse = await client.send('CacheStorage.requestCacheNames', { securityOrigin: this.browserContext.domain });
-        for (const cache of cacheResponse.caches) {
-            if (cache.cacheName.includes('baqend')) {
-                await client.send('CacheStorage.deleteCache', { cacheId: cache.cacheId });
-            }
-        }
+    async onChangeServiceWorkerCallback(file, page, installResource, serviceWorkerReinstallCallback) {
+        this.cli.writeWarning(`changed file: ${file.name} (reinstall serviceWorker)`);
+        // clear speed-kit-service-worker-caches and uninstall serviceWorker
+        await this.clearPageFunction(page);
+        await this.clearServiceWorker(page);
+        // rebuild installResource
+        await installResource.buildContent();
+        // tell puppeteer to reinstall serviceworker on next navigate
+        await serviceWorkerReinstallCallback(file);
     }
-    async clearServiceWorker(page) {
-        const client = await page.target().createCDPSession();
-        await client.send('ServiceWorker.enable');
-        await client.send('ServiceWorker.unregister', { scopeURL: `https://${this.customerConfig.domain}` });
+    updateStyles(styles) {
+        const styleElement = document.querySelector("#speed-kit-df-styles");
+        if (styleElement) {
+            styleElement.textContent = decodeURI(styles);
+        }
     }
 }
 exports.FileWatcher = FileWatcher;

package/dist/services/onboarding/index.d.ts

@@ -1,3 +1,3 @@
-export { OnboardingContext } from './onboarding-model';
-export * from './onboarding-service';
-export * from './onboarding-service-factory';
+export { OnboardingContext } from "./onboarding-model";
+export * from "./onboarding-service";
+export * from "./onboarding-service-factory";

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

@@ -1,69 +1,71 @@
-import { Protocol } from "puppeteer-core";
 import { CDPSession } from "puppeteer";
+import { Protocol } from "puppeteer-core";
+import { UserCliConfig } from "../../helpers/cli-config";
 import { AbortResponse } from "./browser/abort-response";
 export declare class BrowserContext {
     readonly domain: string;
     readonly chromeFlags?: string[];
+    readonly userConfig?: UserCliConfig;
     readonly browserArgs: string[];
     readonly chromePath: string;
     startParameterDashboard: boolean;
-    constructor(domain: string, chromeFlags?: string[]);
+    constructor(domain: string, chromeFlags?: string[], userConfig?: UserCliConfig);
 }
 export interface FetchRequestPausedEventHandler {
+    handle(event: Protocol.Fetch.RequestPausedEvent, client: CDPSession): Promise<AbortResponse | Partial<Protocol.Fetch.FulfillRequestRequest> | void>;
     readonly patterns: Protocol.Fetch.RequestPattern[];
-    handle(event: Protocol.Fetch.RequestPausedEvent, client: CDPSession): Promise<Partial<Protocol.Fetch.FulfillRequestRequest> | AbortResponse | void>;
 }
 export declare class OnboardingContext {
     readonly customerPath: string;
     readonly configName: string;
     readonly local: boolean;
     readonly verboseLevel?: boolean;
-    readonly DEFAULT_SW_PATH = "https://www.baqend.com/speed-kit/latest/sw.js";
-    readonly DEFAULT_SNIPPET_PATH = "https://www.baqend.com/speed-kit/latest/snippet.js";
     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);
 }
 export type awsCredentials = {
-    region: string;
     accessKeyId: string;
+    region: string;
     secretAccessKey: string;
 };
 export type SpeedKitServerConfigAuthentication = {
-    "user": string;
-    "password": string;
-    "uri": string;
-    "type": "basic";
+    password: string;
+    type: "basic";
+    uri: string;
+    user: string;
 };
 export type SpeedKitServerConfigVariation = {
     [key: string]: {
-        "headers"?: {
-            "cookie"?: string;
+        encodePrefixedUrl?: boolean;
+        headers?: {
+            cookie?: string;
         };
-        "urlPrefix"?: string;
-        "encodePrefixedUrl"?: boolean;
-        "queryParams"?: [];
-        "regex"?: null | string;
+        queryParams?: [];
+        regex?: null | string;
+        urlPrefix?: string;
     };
 };
 export type SpeedKitServerConfig = {
-    "speedKit": {
-        "httpAuthUser": null | string;
-        "httpAuthPass": null | string;
-        "httpAuthURI": null | string;
-        "httpAuthType": "basic";
-        "defaultAssetRequestsPerSecond": number;
-        "globalMinAssetRequestsPerSecond": number;
-        "globalMaxAssetRequestsPerSecond": number;
-        "assetRequestRateScaleUpStep": number;
-        "assetRequestRateScaleDownFactor": number;
-        "assetRequestRateLimitUpperTTFBLimit": number;
-        "assetRequestRateLimitLowerTTFBLimit": number;
-        "maxRevalidationWindowSize": number;
-        "minMaxAge": number;
-        "assetStreamingRateLimitTimeoutMs": 2000;
-        "streamRateLimit": number;
-        "authentications": SpeedKitServerConfigAuthentication[];
-        "variations": SpeedKitServerConfigVariation;
+    speedKit: {
+        assetRequestRateLimitLowerTTFBLimit: number;
+        assetRequestRateLimitUpperTTFBLimit: number;
+        assetRequestRateScaleDownFactor: number;
+        assetRequestRateScaleUpStep: number;
+        assetStreamingRateLimitTimeoutMs: 2000;
+        authentications: SpeedKitServerConfigAuthentication[];
+        defaultAssetRequestsPerSecond: number;
+        globalMaxAssetRequestsPerSecond: number;
+        globalMinAssetRequestsPerSecond: number;
+        httpAuthPass: null | string;
+        httpAuthType: "basic";
+        httpAuthURI: null | string;
+        httpAuthUser: null | string;
+        maxRevalidationWindowSize: number;
+        minMaxAge: number;
+        streamRateLimit: number;
+        variations: SpeedKitServerConfigVariation;
     };
 };

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

@@ -1,34 +1,34 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OnboardingContext = exports.BrowserContext = void 0;
-const tslib_1 = require("tslib");
-const dotenv = tslib_1.__importStar(require("dotenv"));
-dotenv.config();
 const DEFAULT_BROWSER_ARGS = [
-    '--enable-features=NetworkService',
-    '--no-first-run',
-    '--disable-infobars',
+    "--enable-features=NetworkService",
+    "--no-first-run",
+    "--disable-infobars",
 ];
-if (process.env.SPEED_KIT_EXTENSION_PATH) {
-    DEFAULT_BROWSER_ARGS.push(`--load-extension=${process.env.SPEED_KIT_EXTENSION_PATH}`, `--disable-extensions-except=${process.env.SPEED_KIT_EXTENSION_PATH}`);
-}
-if (process.env.CHROME_USER_PROFILE_PATH) {
-    DEFAULT_BROWSER_ARGS.push(`--user-data-dir=${process.env.CHROME_USER_PROFILE_PATH}`);
-}
 class BrowserContext {
     domain;
     chromeFlags;
+    userConfig;
     browserArgs;
     chromePath;
     startParameterDashboard = false;
-    constructor(domain, chromeFlags) {
+    constructor(domain, chromeFlags, userConfig) {
         this.domain = domain;
         this.chromeFlags = chromeFlags;
+        this.userConfig = userConfig;
         this.domain = domain;
         this.chromeFlags = chromeFlags || [];
-        this.chromePath = process.env.CHROME_PATH;
+        this.chromePath = userConfig.chromePath;
+        const browserArgs = DEFAULT_BROWSER_ARGS;
+        if (userConfig?.chromeExtensionPaths) {
+            browserArgs.push(`--load-extension=${userConfig?.chromeExtensionPaths}`, `--disable-extensions-except=${userConfig?.chromeExtensionPaths}`);
+        }
+        if (userConfig?.chromeUserProfilePath) {
+            browserArgs.push(`--user-data-dir=${userConfig?.chromeUserProfilePath}`);
+        }
         this.browserArgs = [
-            ...DEFAULT_BROWSER_ARGS,
+            ...browserArgs,
             `--unsafely-treat-insecure-origin-as-secure=${domain}`,
             ...this.chromeFlags,
         ];
@@ -40,10 +40,10 @@ class OnboardingContext {
     configName;
     local;
     verboseLevel;
-    DEFAULT_SW_PATH = 'https://www.baqend.com/speed-kit/latest/sw.js';
-    DEFAULT_SNIPPET_PATH = 'https://www.baqend.com/speed-kit/latest/snippet.js';
-    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_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) {
         this.customerPath = customerPath;
         this.configName = configName;

package/dist/services/onboarding/onboarding-service-factory.d.ts

@@ -1,16 +1,16 @@
-import { OnboardingService } from "./onboarding-service";
-import { OnboardingContext } from "./onboarding-model";
 import { UserCliConfig } from "../../helpers/cli-config";
+import { OnboardingContext } from "./onboarding-model";
+import { OnboardingService } from "./onboarding-service";
 export declare class OnboardingServiceFactory {
     private readonly context;
     private cliConfig;
     constructor(context: OnboardingContext, cliConfig: UserCliConfig);
     getService(): Promise<OnboardingService>;
-    private getUrlForTest;
     private buildInstallResource;
-    private getFetchEventHandler;
-    private getIntegrationFiles;
-    private getConfigApi;
     private getAthenaClient;
+    private getConfigApi;
     private getCredentials;
+    private getFetchEventHandler;
+    private getIntegrationFiles;
+    private getUrlForTest;
 }