@speedkit/cli 2.13.0 → 2.14.1

package/dist/services/onboarding/fetch-events/speed-kit-install-html.js

@@ -9,39 +9,39 @@ class SpeedKitInstallHtml {
     customerConfig;
     browserContext;
     speedKitInstallHtmlTemplate;
-    constructor(customerConfig, browserContext, speedKitInstallHtmlTemplate) {
-        this.customerConfig = customerConfig;
-        this.browserContext = browserContext;
-        this.speedKitInstallHtmlTemplate = speedKitInstallHtmlTemplate;
-    }
     get patterns() {
         const result = [];
         for (const origin of this.customerConfig.origins) {
             const pattern = [
                 {
-                    requestStage: "Request",
-                    resourceType: "Document",
                     urlPattern: `${origin}${this.customerConfig.scope}speed-kit-install.html*`,
+                    resourceType: "Document",
+                    requestStage: "Request",
                 },
                 {
-                    requestStage: "Request",
-                    resourceType: "XHR",
                     urlPattern: `${origin}${this.customerConfig.scope}speed-kit-install.html*`,
+                    resourceType: "XHR",
+                    requestStage: "Request",
                 },
                 {
-                    requestStage: "Request",
-                    resourceType: "Fetch",
                     urlPattern: `${origin}${this.customerConfig.scope}speed-kit-install.html*`,
+                    resourceType: "Fetch",
+                    requestStage: "Request",
                 },
             ];
             result.push(...pattern);
         }
         return result;
     }
+    constructor(customerConfig, browserContext, speedKitInstallHtmlTemplate) {
+        this.customerConfig = customerConfig;
+        this.browserContext = browserContext;
+        this.speedKitInstallHtmlTemplate = speedKitInstallHtmlTemplate;
+    }
     async handle() {
         return new baqend_response_1.BaqendResponse(this.speedKitInstallHtmlTemplate.render({
-            domain: this.browserContext.domain,
             installPath: this.customerConfig.installPath,
+            domain: this.browserContext.domain,
             swPath: this.customerConfig.swPath,
         }));
     }

package/dist/services/onboarding/file-events/file-watcher.d.ts

@@ -1,10 +1,10 @@
-import { Page } from "puppeteer";
 import { CliService } from "../../cli";
+import { Page } from "puppeteer";
+import CustomerConfig from "../../integration-api/struct/customer-config";
 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,13 +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 clearPageFunction;
-    private clearServiceWorker;
-    private handleDynamicStyles;
-    private handleGenericConfigFiles;
     private handleServiceWorkerDependencies;
-    private onChangeConfigFileCallback;
-    private onChangeDynamicStyleCallback;
+    private handleGenericConfigFiles;
+    private handleDynamicStyles;
     private onChangeServiceWorkerCallback;
     private updateStyles;
+    private onChangeConfigFileCallback;
+    private onChangeDynamicStyleCallback;
+    private clearPageFunction;
+    private clearServiceWorker;
 }

package/dist/services/onboarding/file-events/file-watcher.js

@@ -2,8 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FileWatcher = void 0;
 const safe_1 = require("../../../helpers/safe");
-const files_1 = require("../../../models/files");
 const virtual_file_1 = require("../../integration-api/struct/virtual-file");
+const files_1 = require("../../../models/files");
 /**
  * Add different callbacks that will be executed if a local file is changed.
  */
@@ -28,39 +28,29 @@ class FileWatcher {
         this.handleGenericConfigFiles(page, installResource);
         this.handleDynamicStyles(page);
     }
-    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,
-                });
+    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;
             }
-        }
-    }
-    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}`);
+            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.onChangeServiceWorkerCallback(file, page, installResource, serviceWorkerReinstallCallback));
+                if (result.success === false) {
+                    this.cli.writeError(`error after fileChange: ${file.name}: ${result.error}`);
+                }
+            });
+        }
     }
     handleGenericConfigFiles(page, installResource) {
         // add watcher to configFiles
@@ -86,28 +76,34 @@ class FileWatcher {
             });
         }
     }
-    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(dependency);
-            if (file.type === virtual_file_1.VirtualFile) {
-                continue;
+    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}`);
             }
-            file.onChange(async (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}`);
-                }
-            });
+        });
+    }
+    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);
+    }
+    updateStyles(styles) {
+        const styleElement = document.querySelector("#speed-kit-df-styles");
+        if (styleElement) {
+            styleElement.textContent = decodeURI(styles);
         }
     }
     async onChangeConfigFileCallback(page, installResource, file) {
@@ -131,21 +127,25 @@ class FileWatcher {
         await this.documentHandler.buildDocumentHandler();
         this.cache.clear();
     }
-    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);
-    }
-    updateStyles(styles) {
-        const styleElement = document.querySelector("#speed-kit-df-styles");
-        if (styleElement) {
-            styleElement.textContent = decodeURI(styles);
+    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}`,
+        });
+    }
 }
 exports.FileWatcher = FileWatcher;

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

@@ -1,8 +1,8 @@
-import { CliService } from "../cli";
 import CustomerConfig from "../integration-api/struct/customer-config";
+import { BrowserContext } from "./onboarding-model";
 import { FetchEventHandler } from "./fetch-event-handler";
 import { FileWatcher } from "./file-events/file-watcher";
-import { BrowserContext } from "./onboarding-model";
+import { CliService } from "../cli";
 import { TodoCollector } from "./todo-collector";
 /**
  * Represents the OnboardingService which is responsible for setting up the browser to test a config using Puppeteer.
@@ -20,12 +20,12 @@ export declare class OnboardingService {
      * prepare puppeteerBrowser, add eventListeners and start
      */
     run(): Promise<void>;
-    private findPage;
-    private navigate;
     private prepareBrowser;
-    private prepareCleanState;
     private preparePage;
+    private findPage;
+    private prepareCleanState;
+    private reinstallSpeedKit;
     private registerFileWatcher;
     private registerReinstallSpeedKitOnNavigate;
-    private reinstallSpeedKit;
+    private navigate;
 }

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

@@ -2,10 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OnboardingService = void 0;
 const tslib_1 = require("tslib");
-const chalk_1 = tslib_1.__importDefault(require("chalk"));
 const puppeteer_extra_1 = tslib_1.__importDefault(require("puppeteer-extra"));
-const safe_1 = require("../../helpers/safe");
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
 const cli_1 = require("../cli");
+const safe_1 = require("../../helpers/safe");
 /**
  * Represents the OnboardingService which is responsible for setting up the browser to test a config using Puppeteer.
  */
@@ -34,32 +34,17 @@ class OnboardingService {
         const page = await this.preparePage(browser);
         this.cli.endAction(cli_1.CliActionStatus.COMPLETED);
         if (this.browserContext.startParameterDashboard) {
-            // eslint-disable-next-line unicorn/no-await-expression-member
             await (await browser.newPage()).goto("http://skonboarding.local/");
         }
         await this.navigate(page, `${this.customerConfig.scope}speed-kit-install.html?url=${this.customerConfig.scope}`);
     }
-    async findPage(browser) {
-        if (!browser)
-            throw new Error("Please start a browser first.");
-        const [page] = await browser.pages();
-        if (page) {
-            return page;
-        }
-        return browser.newPage();
-    }
-    async navigate(page, pathname) {
-        const goto = new URL(pathname, `${this.browserContext.domain}`);
-        await page.goto(goto.toString());
-        await page.bringToFront();
-    }
     async prepareBrowser() {
         const browser = await puppeteer_extra_1.default.launch({
-            args: this.browserContext.browserArgs,
-            defaultViewport: null,
             devtools: true,
-            executablePath: this.browserContext.chromePath,
+            defaultViewport: null,
             headless: false /* ignoreDefaultArgs: true, */,
+            executablePath: this.browserContext.chromePath,
+            args: this.browserContext.browserArgs,
         });
         for (const target of browser.targets()) {
             if (target.type() === "browser") {
@@ -72,6 +57,27 @@ class OnboardingService {
         });
         return browser;
     }
+    async preparePage(browser) {
+        const page = await this.findPage(browser);
+        await this.prepareCleanState(page);
+        this.registerFileWatcher(page);
+        this.registerReinstallSpeedKitOnNavigate(page);
+        // inject open Todos from configFiles
+        page.on("framenavigated", async (_frame) => {
+            const tasks = this.taskCollector.getOpenTasks();
+            await (0, safe_1.safe)(page.evaluate(`window.skOnboarding = ${JSON.stringify(tasks)}`));
+        });
+        return page;
+    }
+    async findPage(browser) {
+        if (!browser)
+            throw new Error("Please start a browser first.");
+        const [page] = await browser.pages();
+        if (page) {
+            return page;
+        }
+        return browser.newPage();
+    }
     async prepareCleanState(page) {
         const pageClient = await page.target().createCDPSession();
         pageClient.on("ServiceWorker.workerRegistrationUpdated", ({ registrations, }) => {
@@ -95,17 +101,14 @@ class OnboardingService {
         await pageClient.send("Emulation.clearDeviceMetricsOverride");
         await pageClient.send("Emulation.clearGeolocationOverride");
     }
-    async preparePage(browser) {
-        const page = await this.findPage(browser);
-        await this.prepareCleanState(page);
-        this.registerFileWatcher(page);
-        this.registerReinstallSpeedKitOnNavigate(page);
-        // inject open Todos from configFiles
-        page.on("framenavigated", async (_frame) => {
-            const tasks = this.taskCollector.getOpenTasks();
-            await (0, safe_1.safe)(page.evaluate(`window.skOnboarding = ${JSON.stringify(tasks)}`));
-        });
-        return page;
+    async reinstallSpeedKit(page, pathname) {
+        const url = new URL(page.url());
+        let target = url.href;
+        if (!pathname.includes("/speed-kit-install.html")) {
+            target = `${this.customerConfig.scope}speed-kit-install.html?url=${encodeURIComponent(target)}`;
+        }
+        this.reinstallOnNextNavigate = false;
+        await this.navigate(page, target);
     }
     registerFileWatcher(page) {
         this.fileWatcher.addCallbackOnFileChange(page, async () => {
@@ -123,14 +126,10 @@ class OnboardingService {
             }
         });
     }
-    async reinstallSpeedKit(page, pathname) {
-        const url = new URL(page.url());
-        let target = url.href;
-        if (!pathname.includes("/speed-kit-install.html")) {
-            target = `${this.customerConfig.scope}speed-kit-install.html?url=${encodeURIComponent(target)}`;
-        }
-        this.reinstallOnNextNavigate = false;
-        await this.navigate(page, target);
+    async navigate(page, pathname) {
+        const goto = new URL(pathname, `${this.browserContext.domain}`);
+        await page.goto(goto.toString());
+        await page.bringToFront();
     }
 }
 exports.OnboardingService = OnboardingService;

package/dist/services/onboarding/request-cache/cache.d.ts

@@ -1,5 +1,5 @@
-import { CliService } from "../../cli";
 import { BaqendResponse } from "../browser/baqend-response";
+import { CliService } from "../../cli";
 /**
  * This class represents a cache for storing responses from the localDocumentHandler.
  */
@@ -7,9 +7,9 @@ export declare class Cache {
     private cli;
     private inMemoryCache;
     constructor(cli: CliService);
-    addEntry(requestUri: string, response: BaqendResponse): void;
-    clear(): void;
     getAll(): IterableIterator<[string, BaqendResponse]>;
     getEntry(requestUri: string): BaqendResponse | void;
+    addEntry(requestUri: string, response: BaqendResponse): void;
     removeEntry(requestUri: string): void;
+    clear(): void;
 }

package/dist/services/onboarding/request-cache/cache.js

@@ -10,13 +10,6 @@ class Cache {
     constructor(cli) {
         this.cli = cli;
     }
-    addEntry(requestUri, response) {
-        this.inMemoryCache.set(requestUri, response);
-    }
-    clear() {
-        this.cli.writeWarning("clear request-caches");
-        this.inMemoryCache.clear();
-    }
     getAll() {
         return this.inMemoryCache.entries();
     }
@@ -25,8 +18,15 @@ class Cache {
             return this.inMemoryCache.get(requestUri);
         }
     }
+    addEntry(requestUri, response) {
+        this.inMemoryCache.set(requestUri, response);
+    }
     removeEntry(requestUri) {
         this.inMemoryCache.delete(requestUri);
     }
+    clear() {
+        this.cli.writeWarning("clear request-caches");
+        this.inMemoryCache.clear();
+    }
 }
 exports.Cache = Cache;

package/dist/services/onboarding/server-config/index.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ServerConfig = void 0;
-const safe_1 = require("../../../helpers/safe");
 const cli_1 = require("../../cli");
+const safe_1 = require("../../../helpers/safe");
 class ServerConfig {
     cli;
     client;

package/dist/services/onboarding/todo-collector.d.ts

@@ -1,9 +1,9 @@
 import { FileInterface } from "../integration-api/integration-api-model";
 export type task = {
+    todo: string;
     context: string;
     file: string;
     line: number;
-    todo: string;
 };
 /**
  * Represents a TodoCollector class that collects open tasks from files.

package/dist/services/onboarding/todo-collector.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TodoCollector = void 0;
 const virtual_file_1 = require("../integration-api/struct/virtual-file");
-const TODO_MATCH = /(todo[^\n\r()|]*)((?:(?:\r\n|\r|\n)[^\n\r()|]*){3})/i;
+const TODO_MATCH = /(todo[^(\r\n|\r|\n)]*)((?:\r\n|\r|\n)[^(\r\n|\r|\n)]*(?:\r\n|\r|\n)[^(\r\n|\r|\n)]*(?:\r\n|\r|\n)[^(\r\n|\r|\n)]*)/i;
 /**
  * Represents a TodoCollector class that collects open tasks from files.
  * This files will then be injected to the current open page, so you or the browser-extension can access and display them
@@ -21,10 +21,10 @@ class TodoCollector {
             const content = configFile.getContent();
             content.replace(TODO_MATCH, (taskString, task, taskContext) => {
                 tasks.push({
+                    todo: task,
                     context: encodeURI(taskContext),
                     file: configFile.name,
                     line: this.lineNumber(task, content),
-                    todo: task,
                 });
                 return taskString;
             });
@@ -36,8 +36,7 @@ class TodoCollector {
     }
     lineNumberByIndex(index, string) {
         // RegExp
-        let line = 0;
-        let match;
+        let line = 0, match;
         const re = /(^)[\S\s]/gm;
         while ((match = re.exec(string))) {
             if (match.index > index)

package/oclif.manifest.json

@@ -696,5 +696,5 @@
       ]
     }
   },
-  "version": "2.13.0"
+  "version": "2.14.1"
 }

package/package.json

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