@speedkit/cli 3.43.1 → 4.0.0

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

@@ -1,14 +1,11 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FileWatcher = void 0;
-const safe_1 = require("../../../helpers/safe");
-const integration_api_1 = require("../../integration-api");
-const files_1 = require("../../../models/files");
-const race_1 = require("../../../helpers/race");
+import { safe } from "../../../helpers/safe.js";
+import { FILE_TYPE, } from "../../integration-api/index.js";
+import { INTEGRATION_FILES } from "../../../models/files.js";
+import { race } from "../../../helpers/race.js";
 /**
  * Add different callbacks that will be executed if a local file is changed.
  */
-class FileWatcher {
+export class FileWatcher {
     cli;
     customerConfig;
     files;
@@ -30,7 +27,7 @@ class FileWatcher {
      * @param serviceWorkerReinstallCallback
      */
     addCallbackOnFileChange(page, serviceWorkerReinstallCallback) {
-        const installResource = this.files.getByName(files_1.INTEGRATION_FILES.BUILD.INSTALL);
+        const installResource = this.files.getByName(INTEGRATION_FILES.BUILD.INSTALL);
         this.handleServiceWorkerDependencies(page, installResource, serviceWorkerReinstallCallback);
         this.handleGenericConfigFiles(page, installResource);
         this.handleDynamicStyles(page);
@@ -50,21 +47,21 @@ 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,
+            INTEGRATION_FILES.CONFIG.SPEED_KIT,
+            INTEGRATION_FILES.CONFIG.LOAD_HANDLER,
+            INTEGRATION_FILES.CUSTOM.LOADER,
+            INTEGRATION_FILES.CUSTOM.SW,
         ];
         for (const dependency of serviceWorkerDependencies) {
             if (!this.files.hasFile(dependency)) {
                 continue;
             }
             const file = this.files.getByName(dependency);
-            if (file.type === integration_api_1.FILE_TYPE.VIRTUAL_FILE) {
+            if (file.type === FILE_TYPE.VIRTUAL_FILE) {
                 continue;
             }
             file.onChange(async (file) => {
-                const result = await (0, safe_1.safe)(this.onChangeServiceWorkerCallback(file, page, installResource, serviceWorkerReinstallCallback));
+                const result = await safe(this.onChangeServiceWorkerCallback(file, page, installResource, serviceWorkerReinstallCallback));
                 if (result.success === false) {
                     this.cli.writeError(`error after fileChange: ${file.name}: ${result.error}`);
                 }
@@ -84,21 +81,21 @@ class FileWatcher {
     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,
+            INTEGRATION_FILES.CONFIG.DYNAMIC_BLOCKS,
+            INTEGRATION_FILES.CONFIG.DOCUMENT_HANDLER,
+            INTEGRATION_FILES.CUSTOM.DYNAMIC_FETCHER,
+            INTEGRATION_FILES.CUSTOM.DOCUMENT_HANDLER,
         ];
         for (const configFile of generalConfigFiles) {
             if (!this.files.hasFile(configFile)) {
                 continue;
             }
             const file = this.files.getByName(configFile);
-            if (file.type === integration_api_1.FILE_TYPE.VIRTUAL_FILE) {
+            if (file.type === FILE_TYPE.VIRTUAL_FILE) {
                 continue;
             }
             file.onChange(async (file) => {
-                const result = await (0, safe_1.safe)(this.onChangeConfigFileCallback(page, installResource, file));
+                const result = await safe(this.onChangeConfigFileCallback(page, installResource, file));
                 if (result.success === false) {
                     this.cli.writeError(`error after fileChange: ${file.name}: ${result.error}`);
                 }
@@ -116,14 +113,14 @@ class FileWatcher {
      * @private
      */
     handleDynamicStyles(page) {
-        if (!this.files.hasFile(files_1.INTEGRATION_FILES.CONFIG.DYNAMIC_STYLES)) {
+        if (!this.files.hasFile(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)
+            .getByName(INTEGRATION_FILES.CONFIG.DYNAMIC_STYLES)
             .onChange(async (file) => {
-            const result = await (0, safe_1.safe)(this.onChangeDynamicStyleCallback(file, page));
+            const result = await safe(this.onChangeDynamicStyleCallback(file, page));
             if (result.success === false) {
                 this.cli.writeError(`error after fileChange: ${file.name}: ${result.error}`);
             }
@@ -175,7 +172,7 @@ class FileWatcher {
         await this.documentHandler.buildDocumentHandler();
         this.cache.clear();
         const escapedStyles = encodeURI(file.getContent());
-        const evaluateResult = await (0, safe_1.safe)((0, race_1.race)(Promise.all([
+        const evaluateResult = await safe(race(Promise.all([
             page.evaluate(this.updateStylesInlineFunction, escapedStyles),
             this.safeClearPageBrowsersCacheStorage(page),
         ]), 200));
@@ -192,7 +189,7 @@ class FileWatcher {
      * @private
      */
     async safeClearPageBrowsersCacheStorage(page) {
-        const result = await (0, safe_1.safe)(this.clearPageBrowsersCacheStorage(page));
+        const result = await safe(this.clearPageBrowsersCacheStorage(page));
         if (result.success === false) {
             this.cli.writeError(result.error);
         }
@@ -210,7 +207,7 @@ class FileWatcher {
         });
         for (const cache of cacheResponse.caches) {
             if (cache.cacheName.includes("baqend")) {
-                await (0, safe_1.safe)((0, race_1.race)(client.send("CacheStorage.deleteCache", {
+                await safe(race(client.send("CacheStorage.deleteCache", {
                     cacheId: cache.cacheId,
                 }), 20));
             }
@@ -246,4 +243,3 @@ class FileWatcher {
         return true;
     }
 }
-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.js";
+export * from "./onboarding-service.js";
+export * from "./onboarding-service-factory.js";

package/dist/services/onboarding/index.js

@@ -1,8 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OnboardingContext = void 0;
-const tslib_1 = require("tslib");
-var onboarding_model_1 = require("./onboarding-model");
-Object.defineProperty(exports, "OnboardingContext", { enumerable: true, get: function () { return onboarding_model_1.OnboardingContext; } });
-tslib_1.__exportStar(require("./onboarding-service"), exports);
-tslib_1.__exportStar(require("./onboarding-service-factory"), exports);
+export { OnboardingContext } from "./onboarding-model.js";
+export * from "./onboarding-service.js";
+export * from "./onboarding-service-factory.js";

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

@@ -1,9 +1,9 @@
 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";
+import { UserCliConfig } from "../../helpers/cli-config.js";
+import { AbortResponse } from "./browser/abort-response.js";
 import { VanillaPuppeteer } from "puppeteer-extra";
+import { Command } from "@oclif/core/command";
 export declare const BROWSER_EVENTS: {
     DISCONNECTED: string;
     FETCH_AUTH_REQUIRED: string;
@@ -46,7 +46,7 @@ export declare class BrowserContext {
     getPuppeteerLaunchOptions(): Parameters<VanillaPuppeteer["launch"]>[0];
 }
 export interface FetchRequestPausedEventHandler {
-    handle(event: Protocol.Fetch.RequestPausedEvent, client: CDPSession): Promise<AbortResponse | Partial<Protocol.Fetch.FulfillRequestRequest> | void>;
+    handle(event: Protocol.Fetch.RequestPausedEvent, client: CDPSession): Promise<AbortResponse | Partial<Protocol.Fetch.FulfillRequestRequest> | null>;
     readonly patterns: Protocol.Fetch.RequestPattern[];
 }
 export declare class OnboardingContext {
@@ -60,33 +60,31 @@ export declare class OnboardingContext {
     readonly useTestConfig: boolean;
     readonly debuggingPort: boolean;
     readonly headless: boolean;
-    static flags: FlagInput;
+    static flags: Record<string, Command.Flag>;
     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, domain: string, local: boolean, ignoreContentSecurityPolicy: boolean, cliPath: string, verboseLevel?: boolean, useTestConfig?: boolean, debuggingPort?: boolean, headless?: boolean);
 }
-export type SpeedKitServerConfigAuthentication = {
+export interface SpeedKitServerConfigAuthentication {
     password: string;
     type: "basic";
     uri: string;
     user: string;
-};
-export type SpeedKitServerConfigVariation = {
-    [key: string]: {
-        encodePrefixedUrl?: boolean;
-        headers?: {
-            cookie?: string;
-            accept?: string;
-            "user-agent"?: string;
-        };
-        queryParams?: [];
-        regex?: null | string;
-        urlPrefix?: string;
+}
+export type SpeedKitServerConfigVariation = Record<string, {
+    encodePrefixedUrl?: boolean;
+    headers?: {
+        cookie?: string;
+        accept?: string;
+        "user-agent"?: string;
     };
-};
-export type SpeedKitServerConfig = {
+    queryParams?: [];
+    regex?: null | string;
+    urlPrefix?: string;
+}>;
+export interface SpeedKitServerConfig {
     speedKit: {
         assetRequestRateLimitLowerTTFBLimit: number;
         assetRequestRateLimitUpperTTFBLimit: number;
@@ -106,11 +104,11 @@ export type SpeedKitServerConfig = {
         streamRateLimit: number;
         variations: SpeedKitServerConfigVariation;
     };
-};
-export type DevelopmentToolsMessage = {
+}
+export interface DevelopmentToolsMessage {
     id: string;
     data: any;
-};
+}
 export declare const USER_AGENT: {
     DESKTOP: string;
     MOBILE: string;

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

@@ -1,10 +1,7 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.META_CONTENT_TYPE_REGEX = exports.SpeedKitInstallRegex = exports.USER_AGENT = exports.OnboardingContext = exports.BrowserContext = exports.CDP_SESSION = exports.BROWSER_EVENTS = void 0;
-const core_1 = require("@oclif/core");
-const cli_parameters_1 = require("../../models/cli-parameters");
-const browser_config_1 = require("./browser/config/browser-config");
-const node_path_1 = require("node:path");
+import { Flags } from "@oclif/core";
+import { CLI_CONFIG_IS_TEST, CLI_CONFIG_NAME, CLIParameters, CLIParametersChar, } from "../../models/cli-parameters.js";
+import { BrowserConfig } from "./browser/config/browser-config.js";
+import { resolve } from "node:path";
 const DEFAULT_BROWSER_ARGS = [
     "--enable-features=Translate,NetworkService",
     "--no-first-run",
@@ -15,12 +12,12 @@ const DEFAULT_BROWSER_ARGS = [
     // triggered by the flag above. Value is arbitrary and only used as an identifier.
     "--test-type=speed-kit-cli",
 ];
-exports.BROWSER_EVENTS = {
+export const BROWSER_EVENTS = {
     DISCONNECTED: "disconnected",
     FETCH_AUTH_REQUIRED: "Fetch.authRequired",
     FETCH_REQUEST_PAUSED: "Fetch.requestPaused",
 };
-exports.CDP_SESSION = {
+export const CDP_SESSION = {
     EVENTS: {
         SERVICE_WORKER: {
             REGISTRATION_UPDATED: "ServiceWorker.workerRegistrationUpdated",
@@ -41,7 +38,7 @@ exports.CDP_SESSION = {
         },
     },
 };
-class BrowserContext {
+export class BrowserContext {
     domain;
     browserVersionString;
     chromeFlags;
@@ -61,13 +58,13 @@ class BrowserContext {
         this.headless = headless;
         this.domain = domain;
         this.chromeFlags = chromeFlags || [];
-        this.chromePath = (0, node_path_1.resolve)(userConfig.chromePath);
+        this.chromePath = resolve(userConfig.chromePath);
         const browserArguments = DEFAULT_BROWSER_ARGS;
         if (userConfig?.chromeUserProfilePath) {
             browserArguments.push(`--user-data-dir=${userConfig?.chromeUserProfilePath}`);
         }
         else {
-            const browserConfig = new browser_config_1.BrowserConfig(this.userConfig);
+            const browserConfig = new BrowserConfig(this.userConfig);
             const temporaryProfileDirectory = browserConfig.loadProfileTempDir();
             browserArguments.push(`--user-data-dir=${temporaryProfileDirectory}`);
         }
@@ -114,8 +111,7 @@ class BrowserContext {
         return options;
     }
 }
-exports.BrowserContext = BrowserContext;
-class OnboardingContext {
+export class OnboardingContext {
     customerPath;
     configName;
     domain;
@@ -127,33 +123,33 @@ class OnboardingContext {
     debuggingPort;
     headless;
     static flags = {
-        ...cli_parameters_1.CLI_CONFIG_NAME,
-        ...cli_parameters_1.CLI_CONFIG_IS_TEST,
-        [cli_parameters_1.CLIParameters.Domain]: core_1.Flags.string({
-            char: cli_parameters_1.CLIParametersChar.Domain,
+        ...CLI_CONFIG_NAME,
+        ...CLI_CONFIG_IS_TEST,
+        [CLIParameters.Domain]: Flags.string({
+            char: CLIParametersChar.Domain,
             description: "Startup domain (optional)",
         }),
-        local: core_1.Flags.boolean({
+        local: Flags.boolean({
             char: "l",
             default: false,
             description: "Run with local documentHandler",
         }),
-        debuggingPort: core_1.Flags.boolean({
+        debuggingPort: Flags.boolean({
             char: "p",
             default: false,
             description: "Enable remote debugging port (disables speculation rules/prerendering)",
         }),
-        verboseLevel: core_1.Flags.boolean({
+        verboseLevel: Flags.boolean({
             char: "v",
             default: false,
             description: "Show all messages",
         }),
-        ignoreContentSecurityPolicy: core_1.Flags.boolean({
+        ignoreContentSecurityPolicy: Flags.boolean({
             char: "s",
             default: false,
             description: `Removes header/meta "content-security-policy" for origin-responses`,
         }),
-        headless: core_1.Flags.boolean({
+        headless: Flags.boolean({
             default: false,
             description: "Run Chrome in headless mode (for CI environments). Implicitly enables remote debugging port.",
         }),
@@ -175,12 +171,11 @@ class OnboardingContext {
         this.headless = headless;
     }
 }
-exports.OnboardingContext = OnboardingContext;
-exports.USER_AGENT = {
+export const USER_AGENT = {
     DESKTOP: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.2 Safari/605.1.15 (compatible; SpeedKit/1.0)",
     MOBILE: "Mozilla/5.0 (iPhone; CPU iPhone OS 14_7_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.2 Mobile/15E148 Safari/604.1 (compatible; SpeedKit/1.0)",
     TABLET: "Mozilla/5.0 (iPad; CPU OS 14_7_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.2 Mobile/15E148 Safari/604.1 (compatible; SpeedKit/1.0)",
     TV: "Mozilla/5.0 (Linux; NetCast; U) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.79 Safari/537.36 SmartTV/10.0 Colt/2.0 (compatible; SpeedKit/1.0)",
 };
-exports.SpeedKitInstallRegex = /<script[^>]*src[^>]*app\.baqend\.com\/v1\/speedkit\/install.js[^>]*>(?:(?!<\/script>).)*<\/script>/s;
-exports.META_CONTENT_TYPE_REGEX = /<meta[^"]*http-equiv="content-type"[^"]*content="text\/html;[^"]*charset=([^\s"(),./:;<=>?@[\]]*)"/is;
+export const SpeedKitInstallRegex = /<script[^>]*src[^>]*app\.baqend\.com\/v1\/speedkit\/install.js[^>]*>(?:(?!<\/script>).)*<\/script>/s;
+export const META_CONTENT_TYPE_REGEX = /<meta[^"]*http-equiv="content-type"[^"]*content="text\/html;[^"]*charset=([^\s"(),./:;<=>?@[\]]*)"/is;

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

@@ -1,6 +1,6 @@
-import { UserCliConfig } from "../../helpers/cli-config";
-import { OnboardingContext } from "./onboarding-model";
-import { OnboardingService } from "./onboarding-service";
+import { UserCliConfig } from "../../helpers/cli-config.js";
+import { OnboardingContext } from "./onboarding-model.js";
+import { OnboardingService } from "./onboarding-service.js";
 export declare class OnboardingServiceFactory {
     private readonly context;
     private cliConfig;