@grafana/faro-core 1.0.5 → 1.1.0

package/dist/types/core/src/transports/index.d.ts

@@ -2,5 +2,5 @@ export { initializeTransports } from './initialize';
 export { BaseTransport } from './base';
 export { TransportItemType, transportItemTypeToBodyKey } from './const';
 export { registerInitialTransports } from './registerInitial';
-export type { BeforeSendHook, Transport, TransportBody, TransportItem, TransportItemPayload, Transports, } from './types';
+export type { BatchExecutorOptions, BeforeSendHook, SendFn, Transport, TransportBody, TransportItem, TransportItemPayload, Transports, } from './types';
 export { getTransportBody } from './utils';

package/dist/types/core/src/transports/types.d.ts

@@ -4,6 +4,7 @@ import type { Extension } from '../extensions';
 import type { Meta } from '../metas';
 import type { TransportItemType } from './const';
 export type TransportItemPayload<P = APIEvent> = P;
+export type SendFn<P = APIEvent> = (items: Array<TransportItem<P>>) => void;
 export type BeforeSendHook<P = APIEvent> = (item: TransportItem<P>) => TransportItem<P> | null;
 export interface TransportItem<P = APIEvent> {
     type: TransportItemType;
@@ -13,7 +14,9 @@ export interface TransportItem<P = APIEvent> {
 export interface Transport extends Extension {
     send(items: TransportItem | TransportItem[]): void | Promise<void>;
     getIgnoreUrls(): Patterns;
+    isBatched(): boolean;
 }
+export type BodyKey = 'exceptions' | 'logs' | 'measurements' | 'traces' | 'events';
 export interface TransportBody {
     meta: Meta;
     exceptions?: ExceptionEvent[];
@@ -35,3 +38,9 @@ export interface Transports {
     pause: () => void;
     unpause: () => void;
 }
+export interface BatchExecutorOptions {
+    readonly enabled?: boolean;
+    readonly sendTimeout?: number;
+    readonly itemLimit?: number;
+    readonly paused?: boolean;
+}

package/dist/types/core/src/transports/utils.d.ts

@@ -1,2 +1,5 @@
+import type { IResourceSpans } from '@opentelemetry/otlp-transformer';
+import type { TraceEvent } from '..';
 import type { TransportBody, TransportItem } from './types';
-export declare function getTransportBody(item: TransportItem): TransportBody;
+export declare function mergeResourceSpans(traces?: TraceEvent, resourceSpans?: IResourceSpans[]): TraceEvent | undefined;
+export declare function getTransportBody(item: TransportItem[]): TransportBody;

package/dist/types/core/src/transports/utils.test.d.ts

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

package/dist/types/core/src/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "1.0.5";
+export declare const VERSION = "1.1.0";

package/dist/types/globalObject/globalObject.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import type { Faro, internalGlobalObjectKey } from '../sdk';
-export type GlobalObject<T = typeof window | typeof global> = T & {
+export type GlobalObject<T = typeof globalThis | typeof global | typeof self> = T & {
     [label: string]: Faro;
     [internalGlobalObjectKey]: Faro;
 };

package/dist/types/index.d.ts

@@ -5,7 +5,7 @@ export type { Extension } from './extensions';
 export { globalObject } from './globalObject';
 export type { GlobalObject } from './globalObject';
 export { initializeFaro } from './initialize';
-export { defaultGlobalObjectKey } from './config';
+export { defaultBatchingConfig, defaultGlobalObjectKey } from './config';
 export type { Config, Patterns } from './config';
 export { BaseInstrumentation } from './instrumentations';
 export type { Instrumentation, Instrumentations } from './instrumentations';
@@ -16,7 +16,7 @@ export { faro, getInternalFaroFromGlobalObject, internalGlobalObjectKey, isInter
 export type { Faro } from './sdk';
 export { Conventions } from './semantic';
 export { BaseTransport, getTransportBody, TransportItemType, transportItemTypeToBodyKey } from './transports';
-export type { BeforeSendHook, Transport, TransportBody, TransportItem, TransportItemPayload, Transports, } from './transports';
+export type { BeforeSendHook, SendFn, Transport, TransportBody, TransportItem, TransportItemPayload, Transports, } from './transports';
 export { defaultUnpatchedConsole } from './unpatchedConsole';
 export type { UnpatchedConsole } from './unpatchedConsole';
 export { allLogLevels, createPromiseBuffer, deepEqual, defaultLogLevel, genShortID, getCurrentTimestamp, 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, LogLevel, noop, } from './utils';

package/dist/types/testUtils/mockTransport.d.ts

@@ -4,9 +4,10 @@ import type { Transport, TransportItem } from '../transports';
 export declare class MockTransport extends BaseTransport implements Transport {
     private ignoreURLs;
     readonly name = "@grafana/transport-mock";
-    readonly version = "1.0.5";
+    readonly version = "1.1.0";
     items: TransportItem[];
     constructor(ignoreURLs?: Patterns);
-    send(item: TransportItem | TransportItem[]): void | Promise<void>;
+    send(items: TransportItem[]): void | Promise<void>;
+    isBatched(): boolean;
     getIgnoreUrls(): Patterns;
 }

package/dist/types/transports/base.d.ts

@@ -1,6 +1,7 @@
 import { BaseExtension } from '../extensions';
 import type { Transport, TransportItem } from './types';
 export declare abstract class BaseTransport extends BaseExtension implements Transport {
-    abstract send(item: TransportItem | TransportItem[]): void | Promise<void>;
+    abstract send(items: TransportItem | TransportItem[]): void | Promise<void>;
+    isBatched(): boolean;
     getIgnoreUrls(): Array<string | RegExp>;
 }

package/dist/types/transports/batchExecutor.d.ts

@@ -0,0 +1,16 @@
+import type { TransportItem } from '../';
+import type { BatchExecutorOptions, SendFn } from './types';
+export declare class BatchExecutor {
+    private readonly itemLimit;
+    private readonly sendTimeout;
+    private signalBuffer;
+    private sendFn;
+    private paused;
+    private flushInterval;
+    constructor(sendFn: SendFn, options?: BatchExecutorOptions);
+    addItem(item: TransportItem): void;
+    start(): void;
+    pause(): void;
+    groupItems(items: TransportItem[]): TransportItem[][];
+    private flush;
+}

package/dist/types/transports/const.d.ts

@@ -1,3 +1,4 @@
+import type { BodyKey } from './types';
 export declare enum TransportItemType {
     EXCEPTION = "exception",
     LOG = "log",
@@ -5,4 +6,4 @@ export declare enum TransportItemType {
     TRACE = "trace",
     EVENT = "event"
 }
-export declare const transportItemTypeToBodyKey: Record<TransportItemType, string>;
+export declare const transportItemTypeToBodyKey: Record<TransportItemType, BodyKey>;

package/dist/types/transports/index.d.ts

@@ -2,5 +2,5 @@ export { initializeTransports } from './initialize';
 export { BaseTransport } from './base';
 export { TransportItemType, transportItemTypeToBodyKey } from './const';
 export { registerInitialTransports } from './registerInitial';
-export type { BeforeSendHook, Transport, TransportBody, TransportItem, TransportItemPayload, Transports, } from './types';
+export type { BatchExecutorOptions, BeforeSendHook, SendFn, Transport, TransportBody, TransportItem, TransportItemPayload, Transports, } from './types';
 export { getTransportBody } from './utils';

package/dist/types/transports/types.d.ts

@@ -4,6 +4,7 @@ import type { Extension } from '../extensions';
 import type { Meta } from '../metas';
 import type { TransportItemType } from './const';
 export type TransportItemPayload<P = APIEvent> = P;
+export type SendFn<P = APIEvent> = (items: Array<TransportItem<P>>) => void;
 export type BeforeSendHook<P = APIEvent> = (item: TransportItem<P>) => TransportItem<P> | null;
 export interface TransportItem<P = APIEvent> {
     type: TransportItemType;
@@ -13,7 +14,9 @@ export interface TransportItem<P = APIEvent> {
 export interface Transport extends Extension {
     send(items: TransportItem | TransportItem[]): void | Promise<void>;
     getIgnoreUrls(): Patterns;
+    isBatched(): boolean;
 }
+export type BodyKey = 'exceptions' | 'logs' | 'measurements' | 'traces' | 'events';
 export interface TransportBody {
     meta: Meta;
     exceptions?: ExceptionEvent[];
@@ -35,3 +38,9 @@ export interface Transports {
     pause: () => void;
     unpause: () => void;
 }
+export interface BatchExecutorOptions {
+    readonly enabled?: boolean;
+    readonly sendTimeout?: number;
+    readonly itemLimit?: number;
+    readonly paused?: boolean;
+}

package/dist/types/transports/utils.d.ts

@@ -1,2 +1,5 @@
+import type { IResourceSpans } from '@opentelemetry/otlp-transformer';
+import type { TraceEvent } from '..';
 import type { TransportBody, TransportItem } from './types';
-export declare function getTransportBody(item: TransportItem): TransportBody;
+export declare function mergeResourceSpans(traces?: TraceEvent, resourceSpans?: IResourceSpans[]): TraceEvent | undefined;
+export declare function getTransportBody(item: TransportItem[]): TransportBody;

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "1.0.5";
+export declare const VERSION = "1.1.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/faro-core",
-  "version": "1.0.5",
+  "version": "1.1.0",
   "description": "Core package of Faro.",
   "keywords": [
     "observability",
@@ -52,10 +52,14 @@
   "dependencies": {
     "@opentelemetry/api": "^1.4.1",
     "@opentelemetry/api-metrics": "^0.33.0",
-    "@opentelemetry/otlp-transformer": "^0.37.0"
+    "@opentelemetry/otlp-transformer": "^0.37.0",
+    "murmurhash-js": "^1.0.0"
+  },
+  "devDependencies": {
+    "@types/murmurhash-js": "^1.0.4"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "bfcaf6fef4e1e50ae20466e4de180d7fd3f35b80"
+  "gitHead": "343a23899fb2ba377d0c6e939262c51dfdd64a7a"
 }