@speedkit/cli 2.4.1

package/dist/services/onboarding/templates/install-speed-kit-js-template.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InstallSpeedKitJsTemplate = void 0;
+const tslib_1 = require("tslib");
+const abstract_template_1 = tslib_1.__importDefault(require("../../document-handler-runtime/templates/abstract-template"));
+class InstallSpeedKitJsTemplate extends abstract_template_1.default {
+    getTemplate() {
+        return `
+// Config
+{{{config}}}
+
+// Reset potential split test parameters
+speedKit.split = 1.0;
+speedKit.splitTestId = 'debug';
+
+// Force installation on the Onboarding install resource
+speedKit.disabled = speedKit.disabled && !location.pathname.includes('/speed-kit-install.html');
+// speedKit.sw = '/speed-kit-install-sw.js';
+
+{{#if forceInstall}}
+// inject installation resource in all pages
+speedKit.forceInstall = {{forceInstall}}
+speedKit.installPath = '{{{installPath}}}';
+speedKit.installParams = '{{{installParams}}}';
+{{/if}}
+
+document.addEventListener('speed-kit-loaded', function(event) {
+  var blocks = SpeedKit.dynamicBlocks || {};
+  var errors = SpeedKit.dynamicBlocks.errors || [];
+
+  console.log(\`[SKOnboarding]: Merged \${blocks.mergedBlocks || 0} blocks from \${blocks.remoteBlocks || 0} remote into \${blocks.localBlocks || 0} local blocks\`);
+  errors.forEach(function(error) {
+    console.error(\`[SKOnboarding]: Merging block with id \${error.id} failed with error:\\n\${error.stackTrace}\`);
+  });
+});
+// Inject BypassDeactivation into install.js to persist after navigations
+navigator?.serviceWorker?.controller?.postMessage({ type: 'bypass-deactivation', data: true });
+    `;
+    }
+}
+exports.InstallSpeedKitJsTemplate = InstallSpeedKitJsTemplate;

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

@@ -0,0 +1,18 @@
+import { FileInterface } from "../integration-api/integration-api-model";
+export type task = {
+    todo: string;
+    context: string;
+    file: string;
+    line: number;
+};
+/**
+ * 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
+ */
+export declare class TodoCollector {
+    private files;
+    constructor(files: FileInterface[]);
+    getOpenTasks(): task[];
+    lineNumber(needle: string, haystack: string): number;
+    lineNumberByIndex(index: number, string: string): number;
+}

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

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TodoCollector = void 0;
+const virtual_file_1 = require("../integration-api/struct/virtual-file");
+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
+ */
+class TodoCollector {
+    files;
+    constructor(files) {
+        this.files = files;
+    }
+    getOpenTasks() {
+        const configFiles = this.files.filter(file => {
+            return !(file.type instanceof virtual_file_1.VirtualFile);
+        });
+        const tasks = [];
+        for (const configFile of configFiles) {
+            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)
+                });
+                return taskString;
+            });
+        }
+        return tasks;
+    }
+    lineNumber(needle, haystack) {
+        return this.lineNumberByIndex(haystack.indexOf(needle), haystack);
+    }
+    lineNumberByIndex(index, string) {
+        // RegExp
+        var line = 0, match, re = /(^)[\S\s]/gm;
+        while (match = re.exec(string)) {
+            if (match.index > index)
+                break;
+            line++;
+        }
+        return line;
+    }
+}
+exports.TodoCollector = TodoCollector;

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

@@ -0,0 +1,5 @@
+export default class PrewarmService {
+    static fetchURLByIp(ip: string, url: string, origin: string, variation: string, app: string, token: string): Promise<any>;
+    static fetchURL(url: string, origin: string, variation: string, app: string, token: string, sortParameters: boolean): Promise<any>;
+    static chunk(arr: any[], len: number): any[];
+}

package/dist/services/prewarm-service.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const normalize_1 = require("../helpers/normalize");
+const fetch = require('node-fetch');
+const https = require('https');
+const agent = new https.Agent({
+    rejectUnauthorized: false,
+    keepAlive: true,
+});
+class PrewarmService {
+    // eslint-disable-next-line max-params
+    static async fetchURLByIp(ip, url, origin, variation, app, token) {
+        if (variation && variation !== 'DEFAULT' && variation !== 'DESKTOP') {
+            url = url + (url.includes('?') ? '&' : '?') + `bqvariation=${variation.toLowerCase()}`;
+        }
+        url += (url.includes('?') ? '&' : '?') + `bqpass=1`;
+        return fetch(`https://${ip}/v1/asset/${url}`, {
+            agent,
+            method: 'HEAD',
+            headers: {
+                Host: `${app}.app.baqend.com`,
+                Origin: origin,
+                authorization: `BAT ${token}`,
+                'Accept-Encoding': 'gzip, deflate, br',
+            },
+            timeout: 10000,
+        });
+    }
+    // eslint-disable-next-line max-params
+    static async fetchURL(url, origin, variation, app, token, sortParameters) {
+        let normalizedUrl = (0, normalize_1.normalize)(url, sortParameters);
+        if (variation && variation !== 'DEFAULT' && variation !== 'DESKTOP') {
+            normalizedUrl += (normalizedUrl.includes('?') ? '&' : '?') + `bqvariation=${variation.toLowerCase()}`;
+        }
+        normalizedUrl += (normalizedUrl.includes('?') ? '&' : '?') + `bqpass=1`;
+        return fetch(`https://${app}.app.baqend.com/v1/asset/${normalizedUrl}`, {
+            agent,
+            method: 'HEAD',
+            headers: {
+                Origin: origin,
+                authorization: `BAT ${token}`,
+                'Accept-Encoding': 'gzip, deflate, br',
+            },
+            timeout: 10000,
+        });
+    }
+    static chunk(arr, len) {
+        const chunks = [];
+        const n = arr.length;
+        let i = 0;
+        while (i < n) {
+            chunks.push(arr.slice(i, i += len));
+        }
+        return chunks;
+    }
+}
+exports.default = PrewarmService;

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

@@ -0,0 +1,3 @@
+export * from './pull-service-model';
+export * from './pull-service-factory';
+export * from './pull-service';

package/dist/services/pull/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./pull-service-model"), exports);
+tslib_1.__exportStar(require("./pull-service-factory"), exports);
+tslib_1.__exportStar(require("./pull-service"), exports);

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

@@ -0,0 +1,12 @@
+import { PullContext, PullService } from "./";
+import { UserCliConfig } from "../../helpers/cli-config";
+export declare class PullServiceFactory {
+    private readonly context;
+    private userConfig;
+    private service?;
+    constructor(context: PullContext, userConfig: UserCliConfig);
+    buildService(): Promise<PullService>;
+    private build;
+    private getIntegrationFiles;
+    private getConfigApi;
+}

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

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PullServiceFactory = void 0;
+const tslib_1 = require("tslib");
+const integration_api_context_1 = tslib_1.__importDefault(require("../integration-api/context/integration-api-context"));
+const integration_api_service_factory_1 = tslib_1.__importDefault(require("../integration-api/factory/integration-api-service-factory"));
+const config_api_service_factory_1 = tslib_1.__importDefault(require("../config-api/factory/config-api-service-factory"));
+const config_api_context_1 = tslib_1.__importDefault(require("../config-api/context/config-api-context"));
+const cli_1 = require("../cli");
+const _1 = require("./");
+class PullServiceFactory {
+    context;
+    userConfig;
+    service = undefined;
+    constructor(context, userConfig) {
+        this.context = context;
+        this.userConfig = userConfig;
+        this.context = context;
+    }
+    async buildService() {
+        if (!(this.service instanceof _1.PullService)) {
+            await this.build();
+        }
+        return this.service;
+    }
+    async build() {
+        const files = await this.getIntegrationFiles();
+        const customer = files.getCustomerConfig().config;
+        const configName = customer.name || this.context.configName;
+        const configApi = this.getConfigApi(customer.app);
+        const cliService = new cli_1.CliServiceFactory().getService();
+        this.service = new _1.PullService(files, cliService, configApi, configName, this.context.customerPath);
+    }
+    async getIntegrationFiles() {
+        const integrationApiContext = new integration_api_context_1.default(this.context.customerPath, this.context.configName, []);
+        const integrationApi = new integration_api_service_factory_1.default(integrationApiContext, this.userConfig).buildService();
+        return await integrationApi.run();
+    }
+    getConfigApi(app) {
+        const configApiContext = new config_api_context_1.default(app);
+        return new config_api_service_factory_1.default(configApiContext).getService();
+    }
+}
+exports.PullServiceFactory = PullServiceFactory;

package/dist/services/pull/pull-service-model.d.ts

@@ -0,0 +1,43 @@
+export declare class PullContext {
+    readonly customerPath: string;
+    readonly configName: string;
+    constructor(customerPath: string, configName?: string);
+}
+export declare const InstallResourceToFileMapping: {
+    config: {
+        fileName: string;
+        extension: string;
+    };
+    documentHandlerConfig: {
+        fileName: string;
+        extension: string;
+    };
+    dynamicFetcherConfig: {
+        fileName: string;
+        extension: string;
+    };
+    custom: {
+        fileName: string;
+        extension: string;
+    };
+    loader: {
+        fileName: string;
+        extension: string;
+    };
+    sw: {
+        fileName: string;
+        extension: string;
+    };
+    documentHandler: {
+        fileName: string;
+        extension: string;
+    };
+    dynamicFetcher: {
+        fileName: string;
+        extension: string;
+    };
+    customStyle: {
+        fileName: string;
+        extension: string;
+    };
+};

package/dist/services/pull/pull-service-model.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InstallResourceToFileMapping = exports.PullContext = void 0;
+const tslib_1 = require("tslib");
+const dotenv = tslib_1.__importStar(require("dotenv"));
+dotenv.config();
+const DEFAULT_CONFIG_NAME = 'production';
+class PullContext {
+    customerPath;
+    configName;
+    constructor(customerPath, configName = DEFAULT_CONFIG_NAME) {
+        this.customerPath = customerPath;
+        this.configName = configName;
+    }
+}
+exports.PullContext = PullContext;
+exports.InstallResourceToFileMapping = {
+    'config': { fileName: "config_SpeedKit", extension: "js" },
+    'documentHandlerConfig': { fileName: "config_documentHandler", extension: "js" },
+    'dynamicFetcherConfig': { fileName: "config_dynamicBlocks", extension: "es6" },
+    'custom': { fileName: "config_loadHandler", extension: "js" },
+    'loader': { fileName: "custom_loader", extension: "js" },
+    'sw': { fileName: "custom_sw", extension: "js" },
+    'documentHandler': { fileName: "custom_documentHandler", extension: "js" },
+    'dynamicFetcher': { fileName: "custom_dynamicFetcher", extension: "js" },
+    'customStyle': { fileName: "config_dynamicStyles", extension: "css" },
+};

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

@@ -0,0 +1,18 @@
+import { CliServiceInterface } from "../cli";
+import { FileListInterface } from "../integration-api/integration-api-model";
+import ConfigApiService from "../config-api/config-api-service";
+export declare class PullService {
+    private fileList;
+    private cli;
+    private configApi;
+    private configName;
+    private basePath;
+    constructor(fileList: FileListInterface, cli: CliServiceInterface, configApi: ConfigApiService, configName: string, basePath: string);
+    run(): Promise<void>;
+    private updateLocalFileByInstallResource;
+    private isEqualContent;
+    private isEmpty;
+    private readLocalFile;
+    private createFile;
+    private hasGitChanges;
+}

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

@@ -0,0 +1,106 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PullService = void 0;
+const tslib_1 = require("tslib");
+const cli_1 = require("../cli");
+const install_resource_file_1 = tslib_1.__importDefault(require("../integration-api/struct/install-resource-file"));
+const _1 = require("./");
+const safe_1 = require("../../helpers/safe");
+const child_process_1 = require("child_process");
+class PullService {
+    fileList;
+    cli;
+    configApi;
+    configName;
+    basePath;
+    constructor(fileList, cli, configApi, configName, basePath) {
+        this.fileList = fileList;
+        this.cli = cli;
+        this.configApi = configApi;
+        this.configName = configName;
+        this.basePath = basePath;
+    }
+    async run() {
+        if (this.hasGitChanges()) {
+            this.cli.writeWarning(`You have unStashed changes in folder ${this.basePath}`);
+            const shouldContinue = await this.cli.confirm(`Do you want to override your changes`, true);
+            if (!shouldContinue) {
+                this.cli.exit(0);
+                return;
+            }
+        }
+        this.cli.startAction("fetch active installResource");
+        const installResourceResult = await (0, safe_1.safe)(this.configApi.getActiveInstall(this.configName));
+        if (installResourceResult.success === false) {
+            this.cli.endAction(cli_1.CliActionStatus.FAILED);
+            this.cli.writeError(`An error happened try fetching the installResource ${installResourceResult.error}`);
+            return;
+        }
+        this.cli.endAction(cli_1.CliActionStatus.COMPLETED);
+        const installResource = installResourceResult.data;
+        for (const key in _1.InstallResourceToFileMapping) {
+            await this.updateLocalFileByInstallResource(installResource, key);
+        }
+    }
+    async updateLocalFileByInstallResource(installResource, key) {
+        const installResourceContent = installResource[key];
+        const fileName = _1.InstallResourceToFileMapping[key]['fileName'];
+        const extension = _1.InstallResourceToFileMapping[key]['extension'];
+        // local and remote are empty. skip
+        if (this.isEmpty(installResourceContent) && !this.fileList.hasFile(fileName)) {
+            this.cli.writeSuccess(`empty, skip: ${fileName}`);
+            return;
+        }
+        // local file doesn't exist. create it
+        if (!this.isEmpty(installResourceContent) && !this.fileList.hasFile(fileName)) {
+            this.cli.writeSuccess(`create: ${fileName}`);
+            await this.createFile(fileName, extension, installResourceContent, key);
+            return;
+        }
+        const file = this.readLocalFile(fileName);
+        // local file exists but remote is empty. delete
+        if (this.isEmpty(installResourceContent) && this.fileList.hasFile(fileName)) {
+            this.cli.writeError(`delete: ${fileName}`);
+            await file.delete();
+            return;
+        }
+        // same content, skip
+        if (this.isEqualContent(installResourceContent, file.getContent())) {
+            this.cli.writeSuccess(`equal, skip: ${fileName}`);
+            return;
+        }
+        // local and remote exists. update
+        this.cli.writeWarning(`update: ${fileName}`);
+        file.setContent(installResourceContent);
+        await file.updateFile();
+    }
+    isEqualContent(installResourceContent, remoteContent) {
+        return installResourceContent === remoteContent;
+    }
+    isEmpty(installResourceContent) {
+        return !installResourceContent || installResourceContent.length === 0;
+    }
+    readLocalFile(fileName) {
+        return this.fileList.getByName(fileName);
+    }
+    async createFile(fileName, extension, content, key) {
+        const resourceFile = new install_resource_file_1.default(fileName, `${this.basePath}/${fileName}.${extension}`, content, key);
+        this.fileList.addFile(resourceFile);
+        await resourceFile.updateFile();
+    }
+    hasGitChanges() {
+        const customerName = this.basePath.split('/').filter((value) => value.length > 0).pop();
+        try {
+            const stdoutBuffer = (0, child_process_1.execSync)("git diff --name-status");
+            const stdout = stdoutBuffer.toString("utf8");
+            {
+                return stdout.includes(customerName);
+            }
+        }
+        catch (error) {
+            this.cli.writeError(error.message);
+            this.cli.exit(1);
+        }
+    }
+}
+exports.PullService = PullService;

package/dist/templates/pops.js

@@ -0,0 +1,97 @@
+const POP = {
+  "BRU": "151.101.10.8",
+  "BFI": "151.101.22.8",
+  "LGB": "151.101.26.8",
+  "SYD": "151.101.30.8",
+  "AMS": "151.101.38.8",
+  "SJC": "151.101.42.8",
+  "NYC": "151.101.46.8",
+  "WVI": "151.101.50.8",
+  "IAH": "151.101.58.8",
+  "LHR": "151.101.62.8",
+  "DEN": "151.101.70.8",
+  "HKG": "151.101.78.8",
+  "MEL": "151.101.82.8",
+  "BMA": "151.101.86.8",
+  "ITM": "151.101.90.8",
+  "BNE": "151.101.98.8",
+  "PER": "151.101.106.8",
+  "TYO": "151.101.110.8",
+  "BOS": "151.101.118.8",
+  "YYZ": "151.101.126.8",
+  "MAD": "151.101.134.8",
+  "YUL": "151.101.138.8",
+  "FJR": "151.101.142.8",
+  "CMH": "151.101.146.8",
+  "MSP": "151.101.150.8",
+  "BOM": "151.101.154.8",
+  "MAA": "151.101.158.8",
+  "AKL": "151.101.166.8",
+  "JNB": "151.101.174.8",
+  "GIG": "151.101.178.8",
+  "PAO": "151.101.202.8",
+  "PDK": "151.101.206.8",
+  "EWR": "151.101.210.8",
+  "YVR": "151.101.214.8",
+  "EZE": "151.101.218.8",
+  "SCL": "151.101.222.8",
+  "CPT": "151.101.226.8",
+  "HND": "151.101.230.8",
+  "WLG": "151.101.234.8",
+  "OSL": "151.101.238.8",
+  "MXP": "151.101.242.8",
+  "HEL": "151.101.246.8",
+  "GRU": "151.101.250.8",
+  "CWB": "151.101.254.8",
+  "DAL": "199.232.10.8",
+  "VIE": "199.232.18.8",
+  "DEL": "199.232.22.8",
+  "DUB": "199.232.26.8",
+  "STP": "199.232.30.8",
+  "FTY": "199.232.34.8",
+  "LGA": "199.232.38.8",
+  "CPH": "199.232.42.8",
+  "QPG": "199.232.46.8",
+  "BOG": "199.232.50.8",
+  "MAN": "199.232.54.8",
+  "LON": "199.232.58.8",
+  "STL": "199.232.70.8",
+  "MCI": "199.232.74.8",
+  "MRS": "199.232.82.8",
+  "LCK": "199.232.98.8",
+  "CCU": "199.232.102.8",
+  "HYD": "199.232.106.8",
+  "CGH": "199.232.114.8",
+  "LIM": "199.232.134.8",
+  "PDX": "199.232.146.8",
+  "PHX": "199.232.154.8",
+  "BKK": "199.232.166.8",
+  "PAR": "199.232.170.8",
+  "MUC": "199.232.190.8",
+  "SOF": "146.75.2.8",
+  "FOR": "146.75.6.8",
+  "DTW": "146.75.10.8",
+  "CHC": "146.75.14.8",
+  "ACC": "146.75.18.8",
+  "MNL": "146.75.22.8",
+  "KUL": "146.75.26.8",
+  "IAD": "146.75.30.8",
+  "ATL": "146.75.46.8",
+  "ICN": "146.75.50.8",
+  "LIN": "146.75.54.8",
+  "PMO": "146.75.58.8",
+  "FCO": "146.75.62.8",
+  "DXB": "146.75.66.8",
+  "LCY": "146.75.74.8",
+  "CHI": "146.75.78.8",
+  "GNV": "146.75.86.8",
+  "LIS": "146.75.90.8",
+  "BUR": "146.75.94.8",
+  "HNL": "146.75.98.8",
+  "ADL": "146.75.102.8",
+  "DFW": "146.75.106.8",
+  "YYC": "146.75.110.8",
+  "NRT": "146.75.114.8",
+  "FRA": "146.75.118.8",
+  "MIA": "146.75.126.8"
+}

package/dist/templates/speedKit.Revalidated.js

@@ -0,0 +1,86 @@
+const fetch = require('node-fetch')
+const https = require('node:https')
+
+/* global Abort, ORIGIN_POPS */
+
+const agent = new https.Agent({rejectUnauthorized: false})
+
+{{config}} // eslint-disable-line
+
+const ORIGIN_PATHS = Object.keys(ORIGIN_POPS).filter(origin => origin.endsWith('/'))
+
+const fetchURL = async (ip, url, origin, variation, db) => {
+  if (variation && variation !== 'DEFAULT') {
+    url = url + (url.includes('?') ? '&' : '?') + `bqvariation=${variation.toLowerCase()}`
+  }
+
+  const app = db.connection.host
+  try {
+    await fetch(`https://${ip}/v1/asset/${url}`, {
+      agent,
+      headers: {
+        'Accept-Encoding': 'gzip, deflate, br',
+        Host: `${app}.app.baqend.com`,
+        Origin: origin,
+        authorization: `BAT ${db.token}`,
+        'baqend-prewarm': '1',
+      },
+      method: 'HEAD',
+      timeout: 3000,
+    })
+  } catch (error) {
+    console.log(`error fetching https://${ip}/v1/asset/${url}`, error)
+  }
+}
+
+const fetchAssets = async (ip, assets, db) => {
+  const fetches = []
+  for (const asset of assets) {
+    let {extendedURL, origin, url, variation} = asset
+    url += (extendedURL || '')
+    fetches.push(fetchURL(ip, url, origin, variation, db))
+  }
+
+  await Promise.all(fetches)
+}
+
+/**
+ *
+ * @param {EntityManager} db - The baqend entity manager
+ * @param {Array<{ extendedURL: string, origin: string, url: string, variation: string }>} assets - list of assets to prewar
+ * @return {Promise<void>}
+ */
+exports.call = async (db, assets) => {
+  if (!db.User.me || db.User.me.key !== '1') {
+    throw new Abort('Not logged in.')
+  }
+
+  const originBuckets = {}
+  for (const asset of assets) {
+    let bucket = 'DEFAULT'
+
+    if (ORIGIN_POPS[asset.origin]) {
+      bucket = asset.origin
+    }
+
+    // if there is a path specific prewarm list, overwrite the default prewarm list.
+    const path = ORIGIN_PATHS.find(path => asset.url.startsWith(path))
+    if (path) {
+      bucket = path
+    }
+
+    originBuckets[bucket] = originBuckets[bucket] || []
+    originBuckets[bucket].push(asset)
+  }
+
+  // wait for fastly purge
+  setTimeout(async () => {
+    for (const bucket of Object.keys(originBuckets)) {
+      for (const pop of ORIGIN_POPS[bucket]) {
+        if (pop) { // prevent np when the pop is not defined
+          await fetchAssets(pop, originBuckets[bucket], db)
+        }
+      }
+    }
+  }, 5000)
+}