@grafana/faro-core 1.0.0-beta3 → 1.0.0

package/dist/esm/unpatchedConsole/types.d.ts

@@ -1 +0,0 @@
-export type UnpatchedConsole = Console;

package/dist/esm/utils/baseObject.d.ts

@@ -1,6 +0,0 @@
-export type BaseObjectKey = string | number;
-export type BaseObjectPrimitiveValue = string | number | boolean | null | undefined;
-export type BaseObjectValue = BaseObjectPrimitiveValue | BaseObject | BaseObjectPrimitiveValue[];
-export interface BaseObject {
-    [key: BaseObjectKey]: BaseObjectValue;
-}

package/dist/esm/utils/deepEqual.d.ts

@@ -1,2 +0,0 @@
-import deepEqual from 'fast-deep-equal';
-export { deepEqual };

package/dist/esm/utils/extensions.d.ts

@@ -1,19 +0,0 @@
-import type { Faro } from '../sdk';
-export interface Extension {
-    readonly name: string;
-    readonly version: string;
-    get faro(): Faro;
-    logDebug(...args: unknown[]): void;
-    logInfo(...args: unknown[]): void;
-    logWarn(...args: unknown[]): void;
-    logError(...args: unknown[]): void;
-}
-export declare abstract class BaseExtension implements Extension {
-    abstract readonly name: string;
-    abstract readonly version: string;
-    get faro(): Faro;
-    logDebug(...args: unknown[]): void;
-    logInfo(...args: unknown[]): void;
-    logWarn(...args: unknown[]): void;
-    logError(...args: unknown[]): void;
-}

package/dist/esm/utils/extensions.js

@@ -1,23 +0,0 @@
-import { faro } from '../sdk';
-export class BaseExtension {
-    get faro() {
-        return faro;
-    }
-    logDebug(...args) {
-        var _a, _b;
-        (_b = (_a = this.faro) === null || _a === void 0 ? void 0 : _a.internalLogger) === null || _b === void 0 ? void 0 : _b.debug(`${this.name}\n`, ...args);
-    }
-    logInfo(...args) {
-        var _a, _b;
-        (_b = (_a = this.faro) === null || _a === void 0 ? void 0 : _a.internalLogger) === null || _b === void 0 ? void 0 : _b.info(`${this.name}\n`, ...args);
-    }
-    logWarn(...args) {
-        var _a, _b;
-        (_b = (_a = this.faro) === null || _a === void 0 ? void 0 : _a.internalLogger) === null || _b === void 0 ? void 0 : _b.warn(`${this.name}\n`, ...args);
-    }
-    logError(...args) {
-        var _a, _b;
-        (_b = (_a = this.faro) === null || _a === void 0 ? void 0 : _a.internalLogger) === null || _b === void 0 ? void 0 : _b.error(`${this.name}\n`, ...args);
-    }
-}
-//# sourceMappingURL=extensions.js.map

package/dist/esm/utils/extensions.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"extensions.js","sourceRoot":"","sources":["../../../src/utils/extensions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAe9B,MAAM,OAAgB,aAAa;IAIjC,IAAI,IAAI;QACN,OAAO,IAAI,CAAC;IACd,CAAC;IAED,QAAQ,CAAC,GAAG,IAAe;;QACzB,MAAA,MAAA,IAAI,CAAC,IAAI,0CAAE,cAAc,0CAAE,KAAK,CAAC,GAAG,IAAI,CAAC,IAAI,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC;IAC9D,CAAC;IAED,OAAO,CAAC,GAAG,IAAe;;QACxB,MAAA,MAAA,IAAI,CAAC,IAAI,0CAAE,cAAc,0CAAE,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC;IAC7D,CAAC;IAED,OAAO,CAAC,GAAG,IAAe;;QACxB,MAAA,MAAA,IAAI,CAAC,IAAI,0CAAE,cAAc,0CAAE,IAAI,CAAC,GAAG,IAAI,CAAC,IAAI,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC;IAC7D,CAAC;IAED,QAAQ,CAAC,GAAG,IAAe;;QACzB,MAAA,MAAA,IAAI,CAAC,IAAI,0CAAE,cAAc,0CAAE,KAAK,CAAC,GAAG,IAAI,CAAC,IAAI,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC;IAC9D,CAAC;CACF","sourcesContent":["import { faro } from '../sdk';\nimport type { Faro } from '../sdk';\n\nexport interface Extension {\n  readonly name: string;\n  readonly version: string;\n\n  get faro(): Faro;\n\n  logDebug(...args: unknown[]): void;\n  logInfo(...args: unknown[]): void;\n  logWarn(...args: unknown[]): void;\n  logError(...args: unknown[]): void;\n}\n\nexport abstract class BaseExtension implements Extension {\n  abstract readonly name: string;\n  abstract readonly version: string;\n\n  get faro(): Faro {\n    return faro;\n  }\n\n  logDebug(...args: unknown[]): void {\n    this.faro?.internalLogger?.debug(`${this.name}\\n`, ...args);\n  }\n\n  logInfo(...args: unknown[]): void {\n    this.faro?.internalLogger?.info(`${this.name}\\n`, ...args);\n  }\n\n  logWarn(...args: unknown[]): void {\n    this.faro?.internalLogger?.warn(`${this.name}\\n`, ...args);\n  }\n\n  logError(...args: unknown[]): void {\n    this.faro?.internalLogger?.error(`${this.name}\\n`, ...args);\n  }\n}\n"]}

package/dist/esm/utils/getCurrentTimestamp.d.ts

@@ -1 +0,0 @@
-export declare function getCurrentTimestamp(): string;

package/dist/esm/utils/index.d.ts

@@ -1,12 +0,0 @@
-export { BaseExtension } from './extensions';
-export type { Extension } from './extensions';
-export type { BaseObject, BaseObjectKey, BaseObjectPrimitiveValue, BaseObjectValue } from './baseObject';
-export { deepEqual } from './deepEqual';
-export { getCurrentTimestamp } from './getCurrentTimestamp';
-export { isArray, isBoolean, isDomError, isDomException, isElement, isElementDefined, isError, isErrorDefined, isErrorEvent, isEvent, isEventDefined, isFunction, isInstanceOf, isInt, isMap, isMapDefined, isNull, isNumber, isObject, isPrimitive, isRegExp, isString, isSymbol, isSyntheticEvent, isThenable, isToString, isTypeof, isUndefined, } from './is';
-export type { IsFnHelper } from './is';
-export { allLogLevels, defaultLogLevel, LogLevel } from './logLevels';
-export { noop } from './noop';
-export { createPromiseBuffer } from './promiseBuffer';
-export type { BufferItem, PromiseBuffer, PromiseBufferOptions, PromiseProducer } from './promiseBuffer';
-export { genShortID } from './shortId';

package/dist/esm/utils/is.d.ts

@@ -1,31 +0,0 @@
-export type IsFnHelper<T = unknown> = (value: unknown) => value is T;
-export declare function isTypeof<T = unknown>(value: unknown, type: string): value is T;
-export declare function isToString<T = unknown>(value: unknown, type: string): value is T;
-export declare function isInstanceOf<T extends Function = any>(value: unknown, reference: T): value is T;
-export declare const isUndefined: IsFnHelper<undefined>;
-export declare const isNull: IsFnHelper<null>;
-export declare const isString: IsFnHelper<string>;
-export declare const isNumber: IsFnHelper<number | bigint>;
-export declare const isInt: IsFnHelper<number>;
-export declare const isBoolean: IsFnHelper<boolean>;
-export declare const isSymbol: IsFnHelper<Symbol>;
-export declare const isObject: IsFnHelper<object>;
-export declare const isFunction: IsFnHelper<Function>;
-export declare const isArray: IsFnHelper<unknown[]>;
-export declare const isRegExp: IsFnHelper<string>;
-export declare const isThenable: IsFnHelper<{
-    then: Function;
-}>;
-export declare const isPrimitive: IsFnHelper<string | number | bigint | boolean | symbol>;
-export declare const isEventDefined: boolean;
-export declare const isEvent: IsFnHelper<Event>;
-export declare const isErrorDefined: boolean;
-export declare const isError: IsFnHelper<Error>;
-export declare const isErrorEvent: IsFnHelper<ErrorEvent>;
-export declare const isDomError: IsFnHelper<DOMException>;
-export declare const isDomException: IsFnHelper<DOMException>;
-export declare const isElementDefined: boolean;
-export declare const isElement: IsFnHelper<Element>;
-export declare const isMapDefined: boolean;
-export declare const isMap: IsFnHelper<Map<any, any>>;
-export declare const isSyntheticEvent: IsFnHelper<Event>;

package/dist/esm/utils/logLevels.d.ts

@@ -1,10 +0,0 @@
-export declare enum LogLevel {
-    TRACE = "trace",
-    DEBUG = "debug",
-    INFO = "info",
-    LOG = "log",
-    WARN = "warn",
-    ERROR = "error"
-}
-export declare const defaultLogLevel = LogLevel.LOG;
-export declare const allLogLevels: Readonly<Array<Readonly<LogLevel>>>;

package/dist/esm/utils/noop.d.ts

@@ -1 +0,0 @@
-export declare function noop(): void;

package/dist/esm/utils/promiseBuffer.d.ts

@@ -1,14 +0,0 @@
-export interface PromiseBufferOptions {
-    concurrency: number;
-    size: number;
-}
-export type PromiseProducer<T> = () => PromiseLike<T>;
-export interface PromiseBuffer<T> {
-    add(promiseProducer: PromiseProducer<T>): PromiseLike<T>;
-}
-export interface BufferItem<T> {
-    producer: PromiseProducer<T>;
-    resolve: (value: T) => void;
-    reject: (reason?: any) => void;
-}
-export declare function createPromiseBuffer<T>(options: PromiseBufferOptions): PromiseBuffer<T>;

package/dist/esm/utils/promiseBuffer.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/esm/utils/promiseBuffer.test.js

@@ -1,87 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import { createTestPromise } from '../testUtils';
-import { createPromiseBuffer } from './promiseBuffer';
-function defer(fn) {
-    return __awaiter(this, void 0, void 0, function* () {
-        return new Promise((resolve) => {
-            setImmediate(() => {
-                fn();
-                resolve();
-            });
-        });
-    });
-}
-describe('PromiseBuffer', () => {
-    it('add() new promise that resolves when task is completed', () => __awaiter(void 0, void 0, void 0, function* () {
-        const buf = createPromiseBuffer({ size: 2, concurrency: 2 });
-        expect(yield buf.add(() => Promise.resolve('hi'))).toEqual('hi');
-    }));
-    it('executes tasks concurrently, limited to concurrency setting', () => __awaiter(void 0, void 0, void 0, function* () {
-        var _a, _b, _c, _d;
-        const promises = [];
-        const buf = createPromiseBuffer({
-            size: 10,
-            concurrency: 2,
-        });
-        const addTask = (id) => {
-            return buf.add(() => {
-                const prom = createTestPromise(id);
-                promises.push(prom);
-                return prom.promise;
-            });
-        };
-        addTask(1);
-        addTask(2);
-        addTask(3);
-        // 1 & 2 have started to execute. 3d is not started
-        expect(promises).toHaveLength(2);
-        expect((_a = promises[0]) === null || _a === void 0 ? void 0 : _a.id).toEqual(1);
-        expect((_b = promises[1]) === null || _b === void 0 ? void 0 : _b.id).toEqual(2);
-        // resolve first two
-        (_c = promises[0]) === null || _c === void 0 ? void 0 : _c.resolve();
-        (_d = promises[1]) === null || _d === void 0 ? void 0 : _d.resolve();
-        yield defer(() => {
-            var _a, _b;
-            // 3 has started to be executed
-            expect(promises).toHaveLength(3);
-            expect((_a = promises[2]) === null || _a === void 0 ? void 0 : _a.id).toEqual(3);
-            (_b = promises[2]) === null || _b === void 0 ? void 0 : _b.resolve();
-        });
-    }));
-    it('rejects tasks that exceed buffer size', () => __awaiter(void 0, void 0, void 0, function* () {
-        var _e;
-        const promises = [];
-        const buf = createPromiseBuffer({
-            size: 3,
-            concurrency: 2,
-        });
-        const addTask = (id) => {
-            return buf.add(() => {
-                const prom = createTestPromise(id);
-                promises.push(prom);
-                return prom.promise;
-            });
-        };
-        // adding 3 tasks works, 2 of them begin executing
-        addTask(1);
-        addTask(2);
-        addTask(3);
-        expect(promises).toHaveLength(2);
-        // adding 4th task fails
-        expect(() => addTask(4)).toThrow('Task buffer full');
-        // finishing a task allows new tasks to be added again
-        (_e = promises[0]) === null || _e === void 0 ? void 0 : _e.resolve();
-        yield defer(() => {
-            addTask(4);
-        });
-    }));
-});
-//# sourceMappingURL=promiseBuffer.test.js.map

package/dist/esm/utils/promiseBuffer.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"promiseBuffer.test.js","sourceRoot":"","sources":["../../../src/utils/promiseBuffer.test.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,iBAAiB,EAAe,MAAM,cAAc,CAAC;AAC9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAEtD,SAAe,KAAK,CAAC,EAAc;;QACjC,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;YACnC,YAAY,CAAC,GAAG,EAAE;gBAChB,EAAE,EAAE,CAAC;gBACL,OAAO,EAAE,CAAC;YACZ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CAAA;AAED,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC7B,EAAE,CAAC,wDAAwD,EAAE,GAAS,EAAE;QACtE,MAAM,GAAG,GAAG,mBAAmB,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC,CAAC;QAC7D,MAAM,CAAC,MAAM,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACnE,CAAC,CAAA,CAAC,CAAC;IAEH,EAAE,CAAC,6DAA6D,EAAE,GAAS,EAAE;;QAC3E,MAAM,QAAQ,GAA6B,EAAE,CAAC;QAC9C,MAAM,GAAG,GAAG,mBAAmB,CAAC;YAC9B,IAAI,EAAE,EAAE;YACR,WAAW,EAAE,CAAC;SACf,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,CAAC,EAAU,EAAE,EAAE;YAC7B,OAAO,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE;gBAClB,MAAM,IAAI,GAAG,iBAAiB,CAAO,EAAE,CAAC,CAAC;gBACzC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACpB,OAAO,IAAI,CAAC,OAAO,CAAC;YACtB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC;QAEF,OAAO,CAAC,CAAC,CAAC,CAAC;QACX,OAAO,CAAC,CAAC,CAAC,CAAC;QACX,OAAO,CAAC,CAAC,CAAC,CAAC;QAEX,mDAAmD;QACnD,MAAM,CAAC,QAAQ,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QACjC,MAAM,CAAC,MAAA,QAAQ,CAAC,CAAC,CAAC,0CAAE,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QACnC,MAAM,CAAC,MAAA,QAAQ,CAAC,CAAC,CAAC,0CAAE,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAEnC,oBAAoB;QACpB,MAAA,QAAQ,CAAC,CAAC,CAAC,0CAAE,OAAO,EAAE,CAAC;QACvB,MAAA,QAAQ,CAAC,CAAC,CAAC,0CAAE,OAAO,EAAE,CAAC;QAEvB,MAAM,KAAK,CAAC,GAAG,EAAE;;YACf,+BAA+B;YAC/B,MAAM,CAAC,QAAQ,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;YACjC,MAAM,CAAC,MAAA,QAAQ,CAAC,CAAC,CAAC,0CAAE,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YACnC,MAAA,QAAQ,CAAC,CAAC,CAAC,0CAAE,OAAO,EAAE,CAAC;QACzB,CAAC,CAAC,CAAC;IACL,CAAC,CAAA,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,GAAS,EAAE;;QACrD,MAAM,QAAQ,GAA6B,EAAE,CAAC;QAC9C,MAAM,GAAG,GAAG,mBAAmB,CAAC;YAC9B,IAAI,EAAE,CAAC;YACP,WAAW,EAAE,CAAC;SACf,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,CAAC,EAAU,EAAE,EAAE;YAC7B,OAAO,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE;gBAClB,MAAM,IAAI,GAAG,iBAAiB,CAAO,EAAE,CAAC,CAAC;gBACzC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACpB,OAAO,IAAI,CAAC,OAAO,CAAC;YACtB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC;QAEF,kDAAkD;QAClD,OAAO,CAAC,CAAC,CAAC,CAAC;QACX,OAAO,CAAC,CAAC,CAAC,CAAC;QACX,OAAO,CAAC,CAAC,CAAC,CAAC;QACX,MAAM,CAAC,QAAQ,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QACjC,wBAAwB;QACxB,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QAErD,sDAAsD;QACtD,MAAA,QAAQ,CAAC,CAAC,CAAC,0CAAE,OAAO,EAAE,CAAC;QAEvB,MAAM,KAAK,CAAC,GAAG,EAAE;YACf,OAAO,CAAC,CAAC,CAAC,CAAC;QACb,CAAC,CAAC,CAAC;IACL,CAAC,CAAA,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { createTestPromise, TestPromise } from '../testUtils';\nimport { createPromiseBuffer } from './promiseBuffer';\n\nasync function defer(fn: () => void) {\n  return new Promise<void>((resolve) => {\n    setImmediate(() => {\n      fn();\n      resolve();\n    });\n  });\n}\n\ndescribe('PromiseBuffer', () => {\n  it('add() new promise that resolves when task is completed', async () => {\n    const buf = createPromiseBuffer({ size: 2, concurrency: 2 });\n    expect(await buf.add(() => Promise.resolve('hi'))).toEqual('hi');\n  });\n\n  it('executes tasks concurrently, limited to concurrency setting', async () => {\n    const promises: Array<TestPromise<void>> = [];\n    const buf = createPromiseBuffer({\n      size: 10,\n      concurrency: 2,\n    });\n\n    const addTask = (id: number) => {\n      return buf.add(() => {\n        const prom = createTestPromise<void>(id);\n        promises.push(prom);\n        return prom.promise;\n      });\n    };\n\n    addTask(1);\n    addTask(2);\n    addTask(3);\n\n    // 1 & 2 have started to execute. 3d is not started\n    expect(promises).toHaveLength(2);\n    expect(promises[0]?.id).toEqual(1);\n    expect(promises[1]?.id).toEqual(2);\n\n    // resolve first two\n    promises[0]?.resolve();\n    promises[1]?.resolve();\n\n    await defer(() => {\n      // 3 has started to be executed\n      expect(promises).toHaveLength(3);\n      expect(promises[2]?.id).toEqual(3);\n      promises[2]?.resolve();\n    });\n  });\n\n  it('rejects tasks that exceed buffer size', async () => {\n    const promises: Array<TestPromise<void>> = [];\n    const buf = createPromiseBuffer({\n      size: 3,\n      concurrency: 2,\n    });\n\n    const addTask = (id: number) => {\n      return buf.add(() => {\n        const prom = createTestPromise<void>(id);\n        promises.push(prom);\n        return prom.promise;\n      });\n    };\n\n    // adding 3 tasks works, 2 of them begin executing\n    addTask(1);\n    addTask(2);\n    addTask(3);\n    expect(promises).toHaveLength(2);\n    // adding 4th task fails\n    expect(() => addTask(4)).toThrow('Task buffer full');\n\n    // finishing a task allows new tasks to be added again\n    promises[0]?.resolve();\n\n    await defer(() => {\n      addTask(4);\n    });\n  });\n});\n\nexport {};\n"]}

package/dist/esm/utils/shortId.d.ts

@@ -1 +0,0 @@
-export declare function genShortID(length?: number): string;

package/dist/esm/version.d.ts

@@ -1 +0,0 @@
-export declare const VERSION = "1.0.0-beta3";