@pratham.raval/browser-core 6.22.3

package/esm/tools/experimentalFeatures.d.ts

@@ -0,0 +1,20 @@
+/**
+ * LIMITATION:
+ * For NPM setup, this feature flag singleton is shared between RUM and Logs product.
+ * This means that an experimental flag set on the RUM product will be set on the Logs product.
+ * So keep in mind that in certain configurations, your experimental feature flag may affect other products.
+ *
+ * FORMAT:
+ * All feature flags should be snake_cased
+ */
+export declare enum ExperimentalFeature {
+    TRACK_INTAKE_REQUESTS = "track_intake_requests",
+    USE_TREE_WALKER_FOR_ACTION_NAME = "use_tree_walker_for_action_name",
+    FEATURE_OPERATION_VITAL = "feature_operation_vital",
+    SHORT_SESSION_INVESTIGATION = "short_session_investigation"
+}
+export declare function initFeatureFlags(enableExperimentalFeatures: string[] | undefined): void;
+export declare function addExperimentalFeatures(enabledFeatures: ExperimentalFeature[]): void;
+export declare function isExperimentalFeatureEnabled(featureName: ExperimentalFeature): boolean;
+export declare function resetExperimentalFeatures(): void;
+export declare function getExperimentalFeatures(): Set<ExperimentalFeature>;

package/esm/tools/experimentalFeatures.js

@@ -0,0 +1,41 @@
+/**
+ * LIMITATION:
+ * For NPM setup, this feature flag singleton is shared between RUM and Logs product.
+ * This means that an experimental flag set on the RUM product will be set on the Logs product.
+ * So keep in mind that in certain configurations, your experimental feature flag may affect other products.
+ *
+ * FORMAT:
+ * All feature flags should be snake_cased
+ */
+// We want to use a real enum (i.e. not a const enum) here, to be able to check whether an arbitrary
+// string is an expected feature flag
+import { objectHasValue } from './utils/objectUtils';
+// eslint-disable-next-line no-restricted-syntax
+export var ExperimentalFeature;
+(function (ExperimentalFeature) {
+    ExperimentalFeature["TRACK_INTAKE_REQUESTS"] = "track_intake_requests";
+    ExperimentalFeature["USE_TREE_WALKER_FOR_ACTION_NAME"] = "use_tree_walker_for_action_name";
+    ExperimentalFeature["FEATURE_OPERATION_VITAL"] = "feature_operation_vital";
+    ExperimentalFeature["SHORT_SESSION_INVESTIGATION"] = "short_session_investigation";
+})(ExperimentalFeature || (ExperimentalFeature = {}));
+const enabledExperimentalFeatures = new Set();
+export function initFeatureFlags(enableExperimentalFeatures) {
+    if (Array.isArray(enableExperimentalFeatures)) {
+        addExperimentalFeatures(enableExperimentalFeatures.filter((flag) => objectHasValue(ExperimentalFeature, flag)));
+    }
+}
+export function addExperimentalFeatures(enabledFeatures) {
+    enabledFeatures.forEach((flag) => {
+        enabledExperimentalFeatures.add(flag);
+    });
+}
+export function isExperimentalFeatureEnabled(featureName) {
+    return enabledExperimentalFeatures.has(featureName);
+}
+export function resetExperimentalFeatures() {
+    enabledExperimentalFeatures.clear();
+}
+export function getExperimentalFeatures() {
+    return enabledExperimentalFeatures;
+}
+//# sourceMappingURL=experimentalFeatures.js.map

package/esm/tools/experimentalFeatures.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"experimentalFeatures.js","sourceRoot":"","sources":["../../src/tools/experimentalFeatures.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,oGAAoG;AACpG,qCAAqC;AAErC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAEpD,gDAAgD;AAChD,MAAM,CAAN,IAAY,mBAKX;AALD,WAAY,mBAAmB;IAC7B,sEAA+C,CAAA;IAC/C,0FAAmE,CAAA;IACnE,0EAAmD,CAAA;IACnD,kFAA2D,CAAA;AAC7D,CAAC,EALW,mBAAmB,KAAnB,mBAAmB,QAK9B;AAED,MAAM,2BAA2B,GAA6B,IAAI,GAAG,EAAE,CAAA;AAEvE,MAAM,UAAU,gBAAgB,CAAC,0BAAgD;IAC/E,IAAI,KAAK,CAAC,OAAO,CAAC,0BAA0B,CAAC,EAAE,CAAC;QAC9C,uBAAuB,CACrB,0BAA0B,CAAC,MAAM,CAAC,CAAC,IAAI,EAA+B,EAAE,CACtE,cAAc,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAC1C,CACF,CAAA;IACH,CAAC;AACH,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,eAAsC;IAC5E,eAAe,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QAC/B,2BAA2B,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IACvC,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,UAAU,4BAA4B,CAAC,WAAgC;IAC3E,OAAO,2BAA2B,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;AACrD,CAAC;AAED,MAAM,UAAU,yBAAyB;IACvC,2BAA2B,CAAC,KAAK,EAAE,CAAA;AACrC,CAAC;AAED,MAAM,UAAU,uBAAuB;IACrC,OAAO,2BAA2B,CAAA;AACpC,CAAC"}

package/esm/tools/getZoneJsOriginalValue.d.ts

@@ -0,0 +1,19 @@
+export interface BrowserWindowWithZoneJs extends Window {
+    Zone?: {
+        __symbol__?: (name: string) => string;
+    };
+}
+/**
+ * Gets the original value for a DOM API that was potentially patched by Zone.js.
+ *
+ * Zone.js[1] is a library that patches a bunch of JS and DOM APIs. It usually stores the original
+ * value of the patched functions/constructors/methods in a hidden property prefixed by
+ * __zone_symbol__.
+ *
+ * In multiple occasions, we observed that Zone.js is the culprit of important issues leading to
+ * browser resource exhaustion (memory leak, high CPU usage). This method is used as a workaround to
+ * use the original DOM API instead of the one patched by Zone.js.
+ *
+ * [1]: https://github.com/angular/angular/tree/main/packages/zone.js
+ */
+export declare function getZoneJsOriginalValue<Target, Name extends keyof Target & string>(target: Target, name: Name): Target[Name];

package/esm/tools/getZoneJsOriginalValue.js

@@ -0,0 +1,26 @@
+import { getGlobalObject } from './globalObject';
+/**
+ * Gets the original value for a DOM API that was potentially patched by Zone.js.
+ *
+ * Zone.js[1] is a library that patches a bunch of JS and DOM APIs. It usually stores the original
+ * value of the patched functions/constructors/methods in a hidden property prefixed by
+ * __zone_symbol__.
+ *
+ * In multiple occasions, we observed that Zone.js is the culprit of important issues leading to
+ * browser resource exhaustion (memory leak, high CPU usage). This method is used as a workaround to
+ * use the original DOM API instead of the one patched by Zone.js.
+ *
+ * [1]: https://github.com/angular/angular/tree/main/packages/zone.js
+ */
+export function getZoneJsOriginalValue(target, name) {
+    const browserWindow = getGlobalObject();
+    let original;
+    if (browserWindow.Zone && typeof browserWindow.Zone.__symbol__ === 'function') {
+        original = target[browserWindow.Zone.__symbol__(name)];
+    }
+    if (!original) {
+        original = target[name];
+    }
+    return original;
+}
+//# sourceMappingURL=getZoneJsOriginalValue.js.map

package/esm/tools/getZoneJsOriginalValue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getZoneJsOriginalValue.js","sourceRoot":"","sources":["../../src/tools/getZoneJsOriginalValue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAWhD;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,sBAAsB,CACpC,MAAc,EACd,IAAU;IAEV,MAAM,aAAa,GAAG,eAAe,EAA2B,CAAA;IAChE,IAAI,QAAkC,CAAA;IACtC,IAAI,aAAa,CAAC,IAAI,IAAI,OAAO,aAAa,CAAC,IAAI,CAAC,UAAU,KAAK,UAAU,EAAE,CAAC;QAC9E,QAAQ,GAAI,MAAc,CAAC,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAA;IACjE,CAAC;IACD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,CAAA;IACzB,CAAC;IACD,OAAO,QAAQ,CAAA;AACjB,CAAC"}

package/esm/tools/globalObject.d.ts

@@ -0,0 +1,19 @@
+/**
+ * inspired by https://mathiasbynens.be/notes/globalthis
+ */
+interface WorkerGlobalScope {
+    empty: never;
+}
+type Without<T, U> = {
+    [P in Exclude<keyof T, keyof U>]?: never;
+};
+type XOR<T, U> = T | U extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U;
+export type GlobalObject = XOR<Window, WorkerGlobalScope>;
+export declare function getGlobalObject<T = typeof globalThis>(): T;
+/**
+ * Cached reference to the global object so it can be imported and re-used without
+ * re-evaluating the heavyweight fallback logic in `getGlobalObject()`.
+ */
+export declare const globalObject: (Without<Window, WorkerGlobalScope> & WorkerGlobalScope) | (Without<WorkerGlobalScope, Window> & Window);
+export declare const isWorkerEnvironment: boolean;
+export {};

package/esm/tools/globalObject.js

@@ -0,0 +1,40 @@
+/**
+ * inspired by https://mathiasbynens.be/notes/globalthis
+ */
+export function getGlobalObject() {
+    if (typeof globalThis === 'object') {
+        return globalThis;
+    }
+    Object.defineProperty(Object.prototype, '_dd_temp_', {
+        get() {
+            return this;
+        },
+        configurable: true,
+    });
+    // @ts-ignore _dd_temp is defined using defineProperty
+    let globalObject = _dd_temp_;
+    // @ts-ignore _dd_temp is defined using defineProperty
+    delete Object.prototype._dd_temp_;
+    if (typeof globalObject !== 'object') {
+        // on safari _dd_temp_ is available on window but not globally
+        // fallback on other browser globals check
+        if (typeof self === 'object') {
+            globalObject = self;
+        }
+        else if (typeof window === 'object') {
+            globalObject = window;
+        }
+        else {
+            globalObject = {};
+        }
+    }
+    return globalObject;
+}
+/**
+ * Cached reference to the global object so it can be imported and re-used without
+ * re-evaluating the heavyweight fallback logic in `getGlobalObject()`.
+ */
+// eslint-disable-next-line local-rules/disallow-side-effects
+export const globalObject = getGlobalObject();
+export const isWorkerEnvironment = 'WorkerGlobalScope' in globalObject;
+//# sourceMappingURL=globalObject.js.map

package/esm/tools/globalObject.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"globalObject.js","sourceRoot":"","sources":["../../src/tools/globalObject.ts"],"names":[],"mappings":"AAAA;;GAEG;AAaH,MAAM,UAAU,eAAe;IAC7B,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;QACnC,OAAO,UAA0B,CAAA;IACnC,CAAC;IACD,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,SAAS,EAAE,WAAW,EAAE;QACnD,GAAG;YACD,OAAO,IAAc,CAAA;QACvB,CAAC;QACD,YAAY,EAAE,IAAI;KACnB,CAAC,CAAA;IACF,sDAAsD;IACtD,IAAI,YAAY,GAAY,SAAS,CAAA;IACrC,sDAAsD;IACtD,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,CAAA;IACjC,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE,CAAC;QACrC,8DAA8D;QAC9D,0CAA0C;QAC1C,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,YAAY,GAAG,IAAI,CAAA;QACrB,CAAC;aAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YACtC,YAAY,GAAG,MAAM,CAAA;QACvB,CAAC;aAAM,CAAC;YACN,YAAY,GAAG,EAAE,CAAA;QACnB,CAAC;IACH,CAAC;IACD,OAAO,YAAiB,CAAA;AAC1B,CAAC;AAED;;;GAGG;AACH,6DAA6D;AAC7D,MAAM,CAAC,MAAM,YAAY,GAAG,eAAe,EAAgB,CAAA;AAE3D,MAAM,CAAC,MAAM,mBAAmB,GAAG,mBAAmB,IAAI,YAAY,CAAA"}

package/esm/tools/instrumentMethod.d.ts

@@ -0,0 +1,75 @@
+import { noop } from './utils/functionUtils';
+/**
+ * Object passed to the callback of an instrumented method call. See `instrumentMethod` for more
+ * info.
+ */
+export interface InstrumentedMethodCall<TARGET extends {
+    [key: string]: any;
+}, METHOD extends keyof TARGET> {
+    /**
+     * The target object on which the method was called.
+     */
+    target: TARGET;
+    /**
+     * The parameters with which the method was called.
+     *
+     * Note: if needed, parameters can be mutated by the instrumentation
+     */
+    parameters: Parameters<TARGET[METHOD]>;
+    /**
+     * Registers a callback that will be called after the original method is called, with the method
+     * result passed as argument.
+     */
+    onPostCall: (callback: PostCallCallback<TARGET, METHOD>) => void;
+    /**
+     * The stack trace of the method call.
+     */
+    handlingStack?: string;
+}
+type PostCallCallback<TARGET extends {
+    [key: string]: any;
+}, METHOD extends keyof TARGET> = (result: ReturnType<TARGET[METHOD]>) => void;
+/**
+ * Instruments a method on a object, calling the given callback before the original method is
+ * invoked. The callback receives an object with information about the method call.
+ *
+ * This function makes sure that we are "good citizens" regarding third party instrumentations: when
+ * removing the instrumentation, the original method is usually restored, but if a third party
+ * instrumentation was set after ours, we keep it in place and just replace our instrumentation with
+ * a noop.
+ *
+ * Note: it is generally better to instrument methods that are "owned" by the object instead of ones
+ * that are inherited from the prototype chain. Example:
+ * * do:    `instrumentMethod(Array.prototype, 'push', ...)`
+ * * don't: `instrumentMethod([], 'push', ...)`
+ *
+ * This method is also used to set event handler properties (ex: window.onerror = ...), as it has
+ * the same requirements as instrumenting a method:
+ * * if the event handler is already set by a third party, we need to call it and not just blindly
+ * override it.
+ * * if the event handler is set by a third party after us, we need to keep it in place when
+ * removing ours.
+ *
+ * @example
+ *
+ *  instrumentMethod(window, 'fetch', ({ target, parameters, onPostCall }) => {
+ *    console.log('Before calling fetch on', target, 'with parameters', parameters)
+ *
+ *    onPostCall((result) => {
+ *      console.log('After fetch calling on', target, 'with parameters', parameters, 'and result', result)
+ *    })
+ *  })
+ */
+export declare function instrumentMethod<TARGET extends {
+    [key: string]: any;
+}, METHOD extends keyof TARGET & string>(targetPrototype: TARGET, method: METHOD, onPreCall: (this: null, callInfos: InstrumentedMethodCall<TARGET, METHOD>) => void, { computeHandlingStack }?: {
+    computeHandlingStack?: boolean;
+}): {
+    stop: typeof noop;
+};
+export declare function instrumentSetter<TARGET extends {
+    [key: string]: any;
+}, PROPERTY extends keyof TARGET>(targetPrototype: TARGET, property: PROPERTY, after: (target: TARGET, value: TARGET[PROPERTY]) => void): {
+    stop: typeof noop;
+};
+export {};

package/esm/tools/instrumentMethod.js

@@ -0,0 +1,114 @@
+import { setTimeout } from './timer';
+import { callMonitored } from './monitor';
+import { noop } from './utils/functionUtils';
+import { createHandlingStack } from './stackTrace/handlingStack';
+/**
+ * Instruments a method on a object, calling the given callback before the original method is
+ * invoked. The callback receives an object with information about the method call.
+ *
+ * This function makes sure that we are "good citizens" regarding third party instrumentations: when
+ * removing the instrumentation, the original method is usually restored, but if a third party
+ * instrumentation was set after ours, we keep it in place and just replace our instrumentation with
+ * a noop.
+ *
+ * Note: it is generally better to instrument methods that are "owned" by the object instead of ones
+ * that are inherited from the prototype chain. Example:
+ * * do:    `instrumentMethod(Array.prototype, 'push', ...)`
+ * * don't: `instrumentMethod([], 'push', ...)`
+ *
+ * This method is also used to set event handler properties (ex: window.onerror = ...), as it has
+ * the same requirements as instrumenting a method:
+ * * if the event handler is already set by a third party, we need to call it and not just blindly
+ * override it.
+ * * if the event handler is set by a third party after us, we need to keep it in place when
+ * removing ours.
+ *
+ * @example
+ *
+ *  instrumentMethod(window, 'fetch', ({ target, parameters, onPostCall }) => {
+ *    console.log('Before calling fetch on', target, 'with parameters', parameters)
+ *
+ *    onPostCall((result) => {
+ *      console.log('After fetch calling on', target, 'with parameters', parameters, 'and result', result)
+ *    })
+ *  })
+ */
+export function instrumentMethod(targetPrototype, method, onPreCall, { computeHandlingStack } = {}) {
+    let original = targetPrototype[method];
+    if (typeof original !== 'function') {
+        if (method in targetPrototype && method.startsWith('on')) {
+            original = noop;
+        }
+        else {
+            return { stop: noop };
+        }
+    }
+    let stopped = false;
+    const instrumentation = function () {
+        if (stopped) {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-return, @typescript-eslint/no-unsafe-call
+            return original.apply(this, arguments);
+        }
+        const parameters = Array.from(arguments);
+        let postCallCallback;
+        callMonitored(onPreCall, null, [
+            {
+                target: this,
+                parameters,
+                onPostCall: (callback) => {
+                    postCallCallback = callback;
+                },
+                handlingStack: computeHandlingStack ? createHandlingStack('instrumented method') : undefined,
+            },
+        ]);
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-call
+        const result = original.apply(this, parameters);
+        if (postCallCallback) {
+            callMonitored(postCallCallback, null, [result]);
+        }
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+        return result;
+    };
+    targetPrototype[method] = instrumentation;
+    return {
+        stop: () => {
+            stopped = true;
+            // If the instrumentation has been removed by a third party, keep the last one
+            if (targetPrototype[method] === instrumentation) {
+                targetPrototype[method] = original;
+            }
+        },
+    };
+}
+export function instrumentSetter(targetPrototype, property, after) {
+    const originalDescriptor = Object.getOwnPropertyDescriptor(targetPrototype, property);
+    if (!originalDescriptor || !originalDescriptor.set || !originalDescriptor.configurable) {
+        return { stop: noop };
+    }
+    const stoppedInstrumentation = noop;
+    let instrumentation = (target, value) => {
+        // put hooked setter into event loop to avoid of set latency
+        setTimeout(() => {
+            if (instrumentation !== stoppedInstrumentation) {
+                after(target, value);
+            }
+        }, 0);
+    };
+    const instrumentationWrapper = function (value) {
+        originalDescriptor.set.call(this, value);
+        instrumentation(this, value);
+    };
+    Object.defineProperty(targetPrototype, property, {
+        set: instrumentationWrapper,
+    });
+    return {
+        stop: () => {
+            var _a;
+            if (((_a = Object.getOwnPropertyDescriptor(targetPrototype, property)) === null || _a === void 0 ? void 0 : _a.set) === instrumentationWrapper) {
+                Object.defineProperty(targetPrototype, property, originalDescriptor);
+            }
+            instrumentation = stoppedInstrumentation;
+        },
+    };
+}
+//# sourceMappingURL=instrumentMethod.js.map

package/esm/tools/instrumentMethod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"instrumentMethod.js","sourceRoot":"","sources":["../../src/tools/instrumentMethod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AACzC,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAA;AAC5C,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAA;AAmChE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,UAAU,gBAAgB,CAC9B,eAAuB,EACvB,MAAc,EACd,SAAkF,EAClF,EAAE,oBAAoB,KAAyC,EAAE;IAEjE,IAAI,QAAQ,GAAG,eAAe,CAAC,MAAM,CAAC,CAAA;IAEtC,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE,CAAC;QACnC,IAAI,MAAM,IAAI,eAAe,IAAI,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YACzD,QAAQ,GAAG,IAAsB,CAAA;QACnC,CAAC;aAAM,CAAC;YACN,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAA;QACvB,CAAC;IACH,CAAC;IAED,IAAI,OAAO,GAAG,KAAK,CAAA;IAEnB,MAAM,eAAe,GAAG;QACtB,IAAI,OAAO,EAAE,CAAC;YACZ,kGAAkG;YAClG,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,SAAkD,CAAC,CAAA;QACjF,CAAC;QAED,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,SAAS,CAA+B,CAAA;QAEtE,IAAI,gBAA8D,CAAA;QAElE,aAAa,CAAC,SAAS,EAAE,IAAI,EAAE;YAC7B;gBACE,MAAM,EAAE,IAAI;gBACZ,UAAU;gBACV,UAAU,EAAE,CAAC,QAAQ,EAAE,EAAE;oBACvB,gBAAgB,GAAG,QAAQ,CAAA;gBAC7B,CAAC;gBACD,aAAa,EAAE,oBAAoB,CAAC,CAAC,CAAC,mBAAmB,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,SAAS;aAC7F;SACF,CAAC,CAAA;QAEF,6DAA6D;QAC7D,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,UAAU,CAAC,CAAA;QAE/C,IAAI,gBAAgB,EAAE,CAAC;YACrB,aAAa,CAAC,gBAAgB,EAAE,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,CAAA;QACjD,CAAC;QAED,+DAA+D;QAC/D,OAAO,MAAM,CAAA;IACf,CAAC,CAAA;IAED,eAAe,CAAC,MAAM,CAAC,GAAG,eAAiC,CAAA;IAE3D,OAAO;QACL,IAAI,EAAE,GAAG,EAAE;YACT,OAAO,GAAG,IAAI,CAAA;YACd,8EAA8E;YAC9E,IAAI,eAAe,CAAC,MAAM,CAAC,KAAK,eAAe,EAAE,CAAC;gBAChD,eAAe,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAA;YACpC,CAAC;QACH,CAAC;KACF,CAAA;AACH,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC9B,eAAuB,EACvB,QAAkB,EAClB,KAAwD;IAExD,MAAM,kBAAkB,GAAG,MAAM,CAAC,wBAAwB,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAA;IACrF,IAAI,CAAC,kBAAkB,IAAI,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC,kBAAkB,CAAC,YAAY,EAAE,CAAC;QACvF,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAA;IACvB,CAAC;IAED,MAAM,sBAAsB,GAAG,IAAI,CAAA;IACnC,IAAI,eAAe,GAAG,CAAC,MAAc,EAAE,KAAuB,EAAE,EAAE;QAChE,4DAA4D;QAC5D,UAAU,CAAC,GAAG,EAAE;YACd,IAAI,eAAe,KAAK,sBAAsB,EAAE,CAAC;gBAC/C,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;YACtB,CAAC;QACH,CAAC,EAAE,CAAC,CAAC,CAAA;IACP,CAAC,CAAA;IAED,MAAM,sBAAsB,GAAG,UAAwB,KAAuB;QAC5E,kBAAkB,CAAC,GAAI,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;QACzC,eAAe,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;IAC9B,CAAC,CAAA;IAED,MAAM,CAAC,cAAc,CAAC,eAAe,EAAE,QAAQ,EAAE;QAC/C,GAAG,EAAE,sBAAsB;KAC5B,CAAC,CAAA;IAEF,OAAO;QACL,IAAI,EAAE,GAAG,EAAE;;YACT,IAAI,CAAA,MAAA,MAAM,CAAC,wBAAwB,CAAC,eAAe,EAAE,QAAQ,CAAC,0CAAE,GAAG,MAAK,sBAAsB,EAAE,CAAC;gBAC/F,MAAM,CAAC,cAAc,CAAC,eAAe,EAAE,QAAQ,EAAE,kBAAkB,CAAC,CAAA;YACtE,CAAC;YACD,eAAe,GAAG,sBAAsB,CAAA;QAC1C,CAAC;KACF,CAAA;AACH,CAAC"}

package/esm/tools/matchOption.d.ts

@@ -0,0 +1,8 @@
+export type MatchOption = string | RegExp | ((value: string) => boolean);
+export declare function isMatchOption(item: unknown): item is MatchOption;
+/**
+ * Returns true if value can be matched by at least one of the provided MatchOptions.
+ * When comparing strings, setting useStartsWith to true will compare the value with the start of
+ * the option, instead of requiring an exact match.
+ */
+export declare function matchList(list: MatchOption[], value: string, useStartsWith?: boolean): boolean;

package/esm/tools/matchOption.js

@@ -0,0 +1,31 @@
+import { display } from './display';
+import { getType } from './utils/typeUtils';
+export function isMatchOption(item) {
+    const itemType = getType(item);
+    return itemType === 'string' || itemType === 'function' || item instanceof RegExp;
+}
+/**
+ * Returns true if value can be matched by at least one of the provided MatchOptions.
+ * When comparing strings, setting useStartsWith to true will compare the value with the start of
+ * the option, instead of requiring an exact match.
+ */
+export function matchList(list, value, useStartsWith = false) {
+    return list.some((item) => {
+        try {
+            if (typeof item === 'function') {
+                return item(value);
+            }
+            else if (item instanceof RegExp) {
+                return item.test(value);
+            }
+            else if (typeof item === 'string') {
+                return useStartsWith ? value.startsWith(item) : item === value;
+            }
+        }
+        catch (e) {
+            display.error(e);
+        }
+        return false;
+    });
+}
+//# sourceMappingURL=matchOption.js.map

package/esm/tools/matchOption.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"matchOption.js","sourceRoot":"","sources":["../../src/tools/matchOption.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACnC,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAI3C,MAAM,UAAU,aAAa,CAAC,IAAa;IACzC,MAAM,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC9B,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,UAAU,IAAI,IAAI,YAAY,MAAM,CAAA;AACnF,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,SAAS,CAAC,IAAmB,EAAE,KAAa,EAAE,aAAa,GAAG,KAAK;IACjF,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;QACxB,IAAI,CAAC;YACH,IAAI,OAAO,IAAI,KAAK,UAAU,EAAE,CAAC;gBAC/B,OAAO,IAAI,CAAC,KAAK,CAAC,CAAA;YACpB,CAAC;iBAAM,IAAI,IAAI,YAAY,MAAM,EAAE,CAAC;gBAClC,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YACzB,CAAC;iBAAM,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACpC,OAAO,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK,CAAA;YAChE,CAAC;QACH,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;QAClB,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC,CAAC,CAAA;AACJ,CAAC"}

package/esm/tools/mergeInto.d.ts

@@ -0,0 +1,25 @@
+type Merged<TDestination, TSource> = TSource extends undefined ? TDestination : TDestination extends undefined ? TSource : TSource extends any[] ? TDestination extends any[] ? TDestination & TSource : TSource : TSource extends object ? TDestination extends object ? TDestination extends any[] ? TSource : TDestination & TSource : TSource : TSource;
+/**
+ * Iterate over source and affect its sub values into destination, recursively.
+ * If the source and destination can't be merged, return source.
+ */
+export declare function mergeInto<D, S>(destination: D, source: S, circularReferenceChecker?: CircularReferenceChecker): Merged<D, S>;
+/**
+ * A simplistic implementation of a deep clone algorithm.
+ * Caveats:
+ * - It doesn't maintain prototype chains - don't use with instances of custom classes.
+ * - It doesn't handle Map and Set
+ */
+export declare function deepClone<T>(value: T): T;
+type Combined<A, B> = A extends null ? B : B extends null ? A : Merged<A, B>;
+export declare function combine<A, B>(a: A, b: B): Combined<A, B>;
+export declare function combine<A, B, C>(a: A, b: B, c: C): Combined<Combined<A, B>, C>;
+export declare function combine<A, B, C, D>(a: A, b: B, c: C, d: D): Combined<Combined<Combined<A, B>, C>, D>;
+export declare function combine<A, B, C, D, E>(a: A, b: B, c: C, d: D, e: E): Combined<Combined<Combined<Combined<A, B>, C>, D>, E>;
+export declare function combine<A, B, C, D, E, F>(a: A, b: B, c: C, d: D, e: E, f: F): Combined<Combined<Combined<Combined<Combined<A, B>, C>, D>, E>, F>;
+export declare function combine<A, B, C, D, E, F, G>(a: A, b: B, c: C, d: D, e: E, f: F, g: G): Combined<Combined<Combined<Combined<Combined<Combined<A, B>, C>, D>, E>, F>, G>;
+export declare function combine<A, B, C, D, E, F, G, H>(a: A, b: B, c: C, d: D, e: E, f: F, g: G, h: H): Combined<Combined<Combined<Combined<Combined<Combined<Combined<A, B>, C>, D>, E>, F>, G>, H>;
+interface CircularReferenceChecker {
+    hasAlreadyBeenSeen(value: any): boolean;
+}
+export {};

package/esm/tools/mergeInto.js

@@ -0,0 +1,93 @@
+import { getType } from './utils/typeUtils';
+/**
+ * Iterate over source and affect its sub values into destination, recursively.
+ * If the source and destination can't be merged, return source.
+ */
+export function mergeInto(destination, source, circularReferenceChecker = createCircularReferenceChecker()) {
+    // ignore the source if it is undefined
+    if (source === undefined) {
+        return destination;
+    }
+    if (typeof source !== 'object' || source === null) {
+        // primitive values - just return source
+        return source;
+    }
+    else if (source instanceof Date) {
+        return new Date(source.getTime());
+    }
+    else if (source instanceof RegExp) {
+        const flags = source.flags ||
+            // old browsers compatibility
+            [
+                source.global ? 'g' : '',
+                source.ignoreCase ? 'i' : '',
+                source.multiline ? 'm' : '',
+                source.sticky ? 'y' : '',
+                source.unicode ? 'u' : '',
+            ].join('');
+        return new RegExp(source.source, flags);
+    }
+    if (circularReferenceChecker.hasAlreadyBeenSeen(source)) {
+        // remove circular references
+        return undefined;
+    }
+    else if (Array.isArray(source)) {
+        const merged = Array.isArray(destination) ? destination : [];
+        for (let i = 0; i < source.length; ++i) {
+            merged[i] = mergeInto(merged[i], source[i], circularReferenceChecker);
+        }
+        return merged;
+    }
+    const merged = getType(destination) === 'object' ? destination : {};
+    for (const key in source) {
+        if (Object.prototype.hasOwnProperty.call(source, key)) {
+            merged[key] = mergeInto(merged[key], source[key], circularReferenceChecker);
+        }
+    }
+    return merged;
+}
+/**
+ * A simplistic implementation of a deep clone algorithm.
+ * Caveats:
+ * - It doesn't maintain prototype chains - don't use with instances of custom classes.
+ * - It doesn't handle Map and Set
+ */
+export function deepClone(value) {
+    return mergeInto(undefined, value);
+}
+export function combine(...sources) {
+    let destination;
+    for (const source of sources) {
+        // Ignore any undefined or null sources.
+        if (source === undefined || source === null) {
+            continue;
+        }
+        destination = mergeInto(destination, source);
+    }
+    return destination;
+}
+function createCircularReferenceChecker() {
+    if (typeof WeakSet !== 'undefined') {
+        const set = new WeakSet();
+        return {
+            hasAlreadyBeenSeen(value) {
+                const has = set.has(value);
+                if (!has) {
+                    set.add(value);
+                }
+                return has;
+            },
+        };
+    }
+    const array = [];
+    return {
+        hasAlreadyBeenSeen(value) {
+            const has = array.indexOf(value) >= 0;
+            if (!has) {
+                array.push(value);
+            }
+            return has;
+        },
+    };
+}
+//# sourceMappingURL=mergeInto.js.map

package/esm/tools/mergeInto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mergeInto.js","sourceRoot":"","sources":["../../src/tools/mergeInto.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAwB3C;;;GAGG;AACH,MAAM,UAAU,SAAS,CACvB,WAAc,EACd,MAAS,EACT,wBAAwB,GAAG,8BAA8B,EAAE;IAE3D,uCAAuC;IACvC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO,WAA2B,CAAA;IACpC,CAAC;IAED,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QAClD,wCAAwC;QACxC,OAAO,MAAsB,CAAA;IAC/B,CAAC;SAAM,IAAI,MAAM,YAAY,IAAI,EAAE,CAAC;QAClC,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAA4B,CAAA;IAC9D,CAAC;SAAM,IAAI,MAAM,YAAY,MAAM,EAAE,CAAC;QACpC,MAAM,KAAK,GACT,MAAM,CAAC,KAAK;YACZ,6BAA6B;YAC7B;gBACE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;gBACxB,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;gBAC5B,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;gBAC3B,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;gBACxB,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;aAC1B,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACZ,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAA4B,CAAA;IACpE,CAAC;IAED,IAAI,wBAAwB,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAC;QACxD,6BAA6B;QAC7B,OAAO,SAAoC,CAAA;IAC7C,CAAC;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACjC,MAAM,MAAM,GAAU,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAA;QACnE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;YACvC,MAAM,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,wBAAwB,CAAC,CAAA;QACvE,CAAC;QACD,OAAO,MAAiC,CAAA;IAC1C,CAAC;IAED,MAAM,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAE,WAAgC,CAAC,CAAC,CAAC,EAAE,CAAA;IACzF,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;QACzB,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC;YACtD,MAAM,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,wBAAwB,CAAC,CAAA;QAC7E,CAAC;IACH,CAAC;IACD,OAAO,MAAiC,CAAA;AAC1C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,SAAS,CAAI,KAAQ;IACnC,OAAO,SAAS,CAAC,SAAS,EAAE,KAAK,CAAM,CAAA;AACzC,CAAC;AAiDD,MAAM,UAAU,OAAO,CAAC,GAAG,OAAc;IACvC,IAAI,WAAgB,CAAA;IAEpB,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,wCAAwC;QACxC,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YAC5C,SAAQ;QACV,CAAC;QAED,WAAW,GAAG,SAAS,CAAC,WAAW,EAAE,MAAM,CAAC,CAAA;IAC9C,CAAC;IAED,OAAO,WAAsB,CAAA;AAC/B,CAAC;AAMD,SAAS,8BAA8B;IACrC,IAAI,OAAO,OAAO,KAAK,WAAW,EAAE,CAAC;QACnC,MAAM,GAAG,GAAiB,IAAI,OAAO,EAAE,CAAA;QACvC,OAAO;YACL,kBAAkB,CAAC,KAAK;gBACtB,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;gBAC1B,IAAI,CAAC,GAAG,EAAE,CAAC;oBACT,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;gBAChB,CAAC;gBACD,OAAO,GAAG,CAAA;YACZ,CAAC;SACF,CAAA;IACH,CAAC;IACD,MAAM,KAAK,GAAU,EAAE,CAAA;IACvB,OAAO;QACL,kBAAkB,CAAC,KAAK;YACtB,MAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;YACrC,IAAI,CAAC,GAAG,EAAE,CAAC;gBACT,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YACnB,CAAC;YACD,OAAO,GAAG,CAAA;QACZ,CAAC;KACF,CAAA;AACH,CAAC"}

package/esm/tools/monitor.d.ts

@@ -0,0 +1,9 @@
+export declare function startMonitorErrorCollection(newOnMonitorErrorCollected: (error: unknown) => void): void;
+export declare function setDebugMode(newDebugMode: boolean): void;
+export declare function resetMonitor(): void;
+export declare function monitored<T extends (...params: any[]) => unknown>(_: any, __: string, descriptor: TypedPropertyDescriptor<T>): void;
+export declare function monitor<T extends (...args: any[]) => any>(fn: T): T;
+export declare function callMonitored<T extends (...args: any[]) => any>(fn: T, context: ThisParameterType<T>, args: Parameters<T>): ReturnType<T> | undefined;
+export declare function callMonitored<T extends (this: void) => any>(fn: T): ReturnType<T> | undefined;
+export declare function monitorError(e: unknown): void;
+export declare function displayIfDebugEnabled(...args: any[]): void;

package/esm/tools/monitor.js

@@ -0,0 +1,52 @@
+import { display } from './display';
+let onMonitorErrorCollected;
+let debugMode = false;
+export function startMonitorErrorCollection(newOnMonitorErrorCollected) {
+    onMonitorErrorCollected = newOnMonitorErrorCollected;
+}
+export function setDebugMode(newDebugMode) {
+    debugMode = newDebugMode;
+}
+export function resetMonitor() {
+    onMonitorErrorCollected = undefined;
+    debugMode = false;
+}
+export function monitored(_, __, descriptor) {
+    const originalMethod = descriptor.value;
+    descriptor.value = function (...args) {
+        const decorated = onMonitorErrorCollected ? monitor(originalMethod) : originalMethod;
+        return decorated.apply(this, args);
+    };
+}
+export function monitor(fn) {
+    return function () {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+        return callMonitored(fn, this, arguments);
+    }; // consider output type has input type
+}
+export function callMonitored(fn, context, args) {
+    try {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+        return fn.apply(context, args);
+    }
+    catch (e) {
+        monitorError(e);
+    }
+}
+export function monitorError(e) {
+    displayIfDebugEnabled(e);
+    if (onMonitorErrorCollected) {
+        try {
+            onMonitorErrorCollected(e);
+        }
+        catch (e) {
+            displayIfDebugEnabled(e);
+        }
+    }
+}
+export function displayIfDebugEnabled(...args) {
+    if (debugMode) {
+        display.error('[MONITOR]', ...args);
+    }
+}
+//# sourceMappingURL=monitor.js.map

package/esm/tools/monitor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"monitor.js","sourceRoot":"","sources":["../../src/tools/monitor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAEnC,IAAI,uBAA+D,CAAA;AACnE,IAAI,SAAS,GAAG,KAAK,CAAA;AAErB,MAAM,UAAU,2BAA2B,CAAC,0BAAoD;IAC9F,uBAAuB,GAAG,0BAA0B,CAAA;AACtD,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,YAAqB;IAChD,SAAS,GAAG,YAAY,CAAA;AAC1B,CAAC;AAED,MAAM,UAAU,YAAY;IAC1B,uBAAuB,GAAG,SAAS,CAAA;IACnC,SAAS,GAAG,KAAK,CAAA;AACnB,CAAC;AAED,MAAM,UAAU,SAAS,CACvB,CAAM,EACN,EAAU,EACV,UAAsC;IAEtC,MAAM,cAAc,GAAG,UAAU,CAAC,KAAM,CAAA;IACxC,UAAU,CAAC,KAAK,GAAG,UAAqB,GAAG,IAAmB;QAC5D,MAAM,SAAS,GAAG,uBAAuB,CAAC,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,cAAc,CAAA;QACpF,OAAO,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAkB,CAAA;IACrD,CAAM,CAAA;AACR,CAAC;AAED,MAAM,UAAU,OAAO,CAAoC,EAAK;IAC9D,OAAO;QACL,+DAA+D;QAC/D,OAAO,aAAa,CAAC,EAAE,EAAE,IAAI,EAAE,SAAqC,CAAC,CAAA;IACvE,CAAiB,CAAA,CAAC,sCAAsC;AAC1D,CAAC;AAQD,MAAM,UAAU,aAAa,CAC3B,EAAK,EACL,OAAa,EACb,IAAU;IAEV,IAAI,CAAC;QACH,+DAA+D;QAC/D,OAAO,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;IAChC,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,YAAY,CAAC,CAAC,CAAC,CAAA;IACjB,CAAC;AACH,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,CAAU;IACrC,qBAAqB,CAAC,CAAC,CAAC,CAAA;IACxB,IAAI,uBAAuB,EAAE,CAAC;QAC5B,IAAI,CAAC;YACH,uBAAuB,CAAC,CAAC,CAAC,CAAA;QAC5B,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,qBAAqB,CAAC,CAAC,CAAC,CAAA;QAC1B,CAAC;IACH,CAAC;AACH,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,GAAG,IAAW;IAClD,IAAI,SAAS,EAAE,CAAC;QACd,OAAO,CAAC,KAAK,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,CAAA;IACrC,CAAC;AACH,CAAC"}