@grafana/faro-core 2.3.0 → 2.4.0

package/dist/types/core/src/api/events/types.d.ts

@@ -1,29 +0,0 @@
-import type { SpanContext } from '@opentelemetry/api';
-import type { TraceContext } from '../traces';
-import type { UserAction } from '../types';
-export type EventAttributes = Record<string, string>;
-export interface EventEvent {
-    name: string;
-    timestamp: string;
-    domain?: string;
-    attributes?: EventAttributes;
-    trace?: TraceContext;
-    action?: UserAction;
-}
-export interface PushEventOptions {
-    skipDedupe?: boolean;
-    spanContext?: Pick<SpanContext, 'traceId' | 'spanId'>;
-    timestampOverwriteMs?: number;
-    /**
-     * Allows manual transformation of the payload before adding it to the internal buffer.
-     *
-     * @param payload - The event payload to be transformed.
-     * @returns The transformed event payload.
-     *
-     * @remarks This should be used sparingly and only in special cases where custom payload processing cannot be deferred to the before-send hook.
-     */
-    customPayloadTransformer?: (payload: EventEvent) => EventEvent;
-}
-export interface EventsAPI {
-    pushEvent: (name: string, attributes?: EventAttributes, domain?: string, options?: PushEventOptions) => void;
-}

package/dist/types/core/src/api/exceptions/const.d.ts

@@ -1,2 +0,0 @@
-export declare const defaultExceptionType = "Error";
-export declare const defaultErrorArgsSerializer: (args: [any?, ...any[]]) => string;

package/dist/types/core/src/api/exceptions/index.d.ts

@@ -1,3 +0,0 @@
-export { defaultExceptionType, defaultErrorArgsSerializer } from './const';
-export { initializeExceptionsAPI } from './initialize';
-export type { ExceptionEvent, ExceptionStackFrame, ExceptionsAPI, ExtendedError, PushErrorOptions, Stacktrace, StacktraceParser, ErrorWithIndexProperties, ExceptionEventExtended, } from './types';

package/dist/types/core/src/api/exceptions/initialize.d.ts

@@ -1,17 +0,0 @@
-import type { Config } from '../../config';
-import type { InternalLogger } from '../../internalLogger';
-import type { Metas } from '../../metas';
-import type { Transports } from '../../transports';
-import type { UnpatchedConsole } from '../../unpatchedConsole';
-import type { TracesAPI } from '../traces';
-import type { UserActionsAPI } from '../userActions';
-import type { ExceptionsAPI } from './types';
-export declare function initializeExceptionsAPI({ internalLogger, config, metas, transports, tracesApi, userActionsApi, }: {
-    unpatchedConsole: UnpatchedConsole;
-    internalLogger: InternalLogger;
-    config: Config;
-    metas: Metas;
-    transports: Transports;
-    tracesApi: TracesAPI;
-    userActionsApi: UserActionsAPI;
-}): ExceptionsAPI;

package/dist/types/core/src/api/exceptions/initialize.test.d.ts

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

package/dist/types/core/src/api/exceptions/types.d.ts

@@ -1,61 +0,0 @@
-import type { SpanContext } from '@opentelemetry/api';
-import type { TraceContext } from '../traces';
-import type { UserAction } from '../types';
-export type StacktraceParser = (err: ExtendedError) => Stacktrace;
-export interface ExceptionStackFrame {
-    filename: string;
-    function: string;
-    colno?: number;
-    lineno?: number;
-    bundleid?: string;
-}
-export interface ExtendedError extends Error {
-    columnNumber?: number;
-    stacktrace?: Error['stack'];
-}
-export interface Stacktrace {
-    frames: ExceptionStackFrame[];
-}
-export type ExceptionContext = Record<string, string>;
-export interface ExceptionEventDefault {
-    timestamp: string;
-    type: string;
-    value: string;
-    fingerprint?: string;
-    stacktrace?: Stacktrace;
-    trace?: TraceContext;
-    context?: ExceptionContext;
-    action?: UserAction;
-}
-/**
- * The ExceptionEventExtended type is used to represent an exception event with an additional error
- * property and is only meant for client side use. The additional property is removed by Faro before
- * sending the event to the transport.
- */
-export type ExceptionEventExtended = ExceptionEventDefault & {
-    originalError?: Error;
-};
-export type ExceptionEvent<EXTENDED = ExceptionEventDefault> = EXTENDED extends boolean ? ExceptionEventExtended : ExceptionEventDefault;
-export interface PushErrorOptions {
-    fingerprint?: string;
-    skipDedupe?: boolean;
-    stackFrames?: ExceptionStackFrame[];
-    type?: string;
-    context?: ExceptionContext;
-    spanContext?: Pick<SpanContext, 'traceId' | 'spanId'>;
-    timestampOverwriteMs?: number;
-    /**
-     * Retains the original error object in the payload after parsing.
-     * This is primarily for internal, advanced use cases.
-     * Faro users should not need to use this option.
-     */
-    originalError?: Error;
-}
-export type ErrorWithIndexProperties = Error & {
-    cause?: any;
-};
-export interface ExceptionsAPI {
-    changeStacktraceParser: (stacktraceParser: StacktraceParser) => void;
-    getStacktraceParser: () => StacktraceParser | undefined;
-    pushError: (value: ErrorWithIndexProperties, options?: PushErrorOptions) => void;
-}

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

@@ -1,11 +0,0 @@
-export { initializeAPI } from './initialize';
-export type { API, APIEvent, UserAction } from './types';
-export type { EventAttributes, EventEvent, EventsAPI, PushEventOptions } from './events';
-export { defaultExceptionType, defaultErrorArgsSerializer } from './exceptions';
-export type { ExceptionEvent, ExceptionStackFrame, ExceptionsAPI, ExtendedError, PushErrorOptions, Stacktrace, StacktraceParser, ExceptionEventExtended, } from './exceptions';
-export { defaultLogArgsSerializer } from './logs';
-export type { LogContext, LogEvent, LogArgsSerializer, LogsAPI, PushLogOptions } from './logs';
-export type { MeasurementEvent, MeasurementsAPI, PushMeasurementOptions } from './measurements';
-export type { MetaAPI } from './meta';
-export { UserActionImportance, type UserActionImportanceType, UserActionState, type UserActionInterface, type UserActionInternalInterface, type UserActionsAPI, userActionsMessageBus, } from './userActions';
-export type { OTELApi, TraceContext, TraceEvent, TracesAPI } from './traces';

package/dist/types/core/src/api/initialize.d.ts

@@ -1,7 +0,0 @@
-import type { Config } from '../config';
-import type { InternalLogger } from '../internalLogger';
-import type { Metas } from '../metas';
-import type { Transports } from '../transports';
-import type { UnpatchedConsole } from '../unpatchedConsole';
-import type { API } from './types';
-export declare function initializeAPI(unpatchedConsole: UnpatchedConsole, internalLogger: InternalLogger, config: Config, metas: Metas, transports: Transports): API;

package/dist/types/core/src/api/initialize.test.d.ts

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

package/dist/types/core/src/api/itemBuffer.test.d.ts

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

package/dist/types/core/src/api/logs/const.d.ts

@@ -1,2 +0,0 @@
-import type { LogArgsSerializer } from './types';
-export declare const defaultLogArgsSerializer: LogArgsSerializer;

package/dist/types/core/src/api/logs/index.d.ts

@@ -1,3 +0,0 @@
-export { defaultLogArgsSerializer } from './const';
-export { initializeLogsAPI } from './initialize';
-export type { LogContext, LogEvent, LogArgsSerializer, LogsAPI, PushLogOptions } from './types';

package/dist/types/core/src/api/logs/initialize.d.ts

@@ -1,17 +0,0 @@
-import type { Config } from '../../config';
-import type { InternalLogger } from '../../internalLogger';
-import type { Metas } from '../../metas';
-import type { Transports } from '../../transports';
-import type { UnpatchedConsole } from '../../unpatchedConsole';
-import type { TracesAPI } from '../traces';
-import type { UserActionsAPI } from '../userActions';
-import type { LogsAPI } from './types';
-export declare function initializeLogsAPI({ internalLogger, config, metas, transports, tracesApi, userActionsApi, }: {
-    unpatchedConsole: UnpatchedConsole;
-    internalLogger: InternalLogger;
-    config: Config;
-    metas: Metas;
-    transports: Transports;
-    tracesApi: TracesAPI;
-    userActionsApi: UserActionsAPI;
-}): LogsAPI;

package/dist/types/core/src/api/logs/initialize.test.d.ts

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

package/dist/types/core/src/api/logs/types.d.ts

@@ -1,24 +0,0 @@
-import type { SpanContext } from '@opentelemetry/api';
-import type { LogLevel } from '../../utils';
-import type { TraceContext } from '../traces';
-import type { UserAction } from '../types';
-export type LogContext = Record<string, string>;
-export interface LogEvent {
-    context: LogContext | undefined;
-    level: LogLevel;
-    message: string;
-    timestamp: string;
-    trace?: TraceContext;
-    action?: UserAction;
-}
-export interface PushLogOptions {
-    context?: LogContext;
-    level?: LogLevel;
-    skipDedupe?: boolean;
-    spanContext?: Pick<SpanContext, 'traceId' | 'spanId'>;
-    timestampOverwriteMs?: number;
-}
-export interface LogsAPI {
-    pushLog: (args: unknown[], options?: PushLogOptions) => void;
-}
-export type LogArgsSerializer = (args: unknown[]) => string;

package/dist/types/core/src/api/measurements/index.d.ts

@@ -1,2 +0,0 @@
-export { initializeMeasurementsAPI } from './initialize';
-export type { MeasurementEvent, MeasurementsAPI, PushMeasurementOptions } from './types';

package/dist/types/core/src/api/measurements/initialize.d.ts

@@ -1,17 +0,0 @@
-import type { Config } from '../../config';
-import type { InternalLogger } from '../../internalLogger';
-import type { Metas } from '../../metas';
-import type { Transports } from '../../transports';
-import type { UnpatchedConsole } from '../../unpatchedConsole';
-import type { TracesAPI } from '../traces';
-import type { UserActionsAPI } from '../userActions';
-import type { MeasurementsAPI } from './types';
-export declare function initializeMeasurementsAPI({ internalLogger, config, metas, transports, tracesApi, userActionsApi, }: {
-    unpatchedConsole: UnpatchedConsole;
-    internalLogger: InternalLogger;
-    config: Config;
-    metas: Metas;
-    transports: Transports;
-    tracesApi: TracesAPI;
-    userActionsApi: UserActionsAPI;
-}): MeasurementsAPI;

package/dist/types/core/src/api/measurements/initialize.test.d.ts

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

package/dist/types/core/src/api/measurements/types.d.ts

@@ -1,25 +0,0 @@
-import type { SpanContext } from '@opentelemetry/api';
-import type { TraceContext } from '../traces';
-import type { UserAction } from '../types';
-export type MeasurementContext = Record<string, string>;
-export interface MeasurementEvent<V extends {
-    [label: string]: number;
-} = {
-    [label: string]: number;
-}> {
-    type: string;
-    values: V;
-    timestamp: string;
-    trace?: TraceContext;
-    context?: MeasurementContext;
-    action?: UserAction;
-}
-export interface PushMeasurementOptions {
-    skipDedupe?: boolean;
-    context?: MeasurementContext;
-    spanContext?: Pick<SpanContext, 'traceId' | 'spanId'>;
-    timestampOverwriteMs?: number;
-}
-export interface MeasurementsAPI {
-    pushMeasurement: (payload: Omit<MeasurementEvent, 'timestamp'> & Partial<Pick<MeasurementEvent, 'timestamp'>>, options?: PushMeasurementOptions) => void;
-}

package/dist/types/core/src/api/meta/index.d.ts

@@ -1,2 +0,0 @@
-export { initializeMetaAPI } from './initialize';
-export type { MetaAPI } from './types';

package/dist/types/core/src/api/meta/initialize.d.ts

@@ -1,15 +0,0 @@
-import type { Config } from '../../config';
-import type { InternalLogger } from '../../internalLogger';
-import type { Metas } from '../../metas';
-import type { Transports } from '../../transports';
-import type { UnpatchedConsole } from '../../unpatchedConsole';
-import type { TracesAPI } from '../traces';
-import type { MetaAPI } from './types';
-export declare function initializeMetaAPI({ internalLogger, metas, }: {
-    unpatchedConsole: UnpatchedConsole;
-    internalLogger: InternalLogger;
-    config: Config;
-    metas: Metas;
-    transports: Transports;
-    tracesApi: TracesAPI;
-}): MetaAPI;

package/dist/types/core/src/api/meta/initilialize.test.d.ts

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

package/dist/types/core/src/api/meta/types.d.ts

@@ -1,21 +0,0 @@
-import type { MetaOverrides, MetaPage, MetaSession, MetaUser, MetaView } from '../../metas';
-type OverridesAvailableThroughApi = Pick<MetaOverrides, 'serviceName'>;
-export interface MetaAPI {
-    setUser: (user?: MetaUser | undefined) => void;
-    resetUser: () => void;
-    setSession: (session?: MetaSession | undefined, options?: {
-        overrides: OverridesAvailableThroughApi;
-    }) => void;
-    resetSession: () => void;
-    getSession: () => MetaSession | undefined;
-    setView: (view?: MetaView | undefined, options?: {
-        overrides: OverridesAvailableThroughApi;
-    }) => void;
-    getView: () => MetaView | undefined;
-    /**
-     * If a string is provided, it will be used as the page id.
-     */
-    setPage: (page?: MetaPage | string | undefined) => void;
-    getPage: () => MetaPage | undefined;
-}
-export {};

package/dist/types/core/src/api/traces/index.d.ts

@@ -1,2 +0,0 @@
-export { initializeTracesAPI } from './initialize';
-export type { OTELApi, TraceContext, TraceEvent, TracesAPI } from './types';

package/dist/types/core/src/api/traces/initialize.d.ts

@@ -1,7 +0,0 @@
-import type { Config } from '../../config';
-import type { InternalLogger } from '../../internalLogger';
-import type { Metas } from '../../metas';
-import type { Transports } from '../../transports/types';
-import type { UnpatchedConsole } from '../../unpatchedConsole';
-import type { TracesAPI } from './types';
-export declare function initializeTracesAPI(_unpatchedConsole: UnpatchedConsole, internalLogger: InternalLogger, _config: Config, metas: Metas, transports: Transports): TracesAPI;

package/dist/types/core/src/api/traces/types.d.ts

@@ -1,20 +0,0 @@
-import type { ContextAPI as OTELContextAPI, TraceAPI as OTELTraceAPI } from '@opentelemetry/api';
-import type { IResourceSpans } from '@opentelemetry/otlp-transformer/build/src/trace/internal-types';
-export interface TraceEvent {
-    resourceSpans?: IResourceSpans[];
-}
-export interface OTELApi {
-    trace: OTELTraceAPI;
-    context: OTELContextAPI;
-}
-export interface TracesAPI {
-    getOTEL: () => OTELApi | undefined;
-    getTraceContext: () => TraceContext | undefined;
-    initOTEL: (trace: OTELTraceAPI, context: OTELContextAPI) => void;
-    isOTELInitialized: () => boolean;
-    pushTraces: (traces: TraceEvent) => void;
-}
-export interface TraceContext {
-    trace_id: string;
-    span_id: string;
-}

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

@@ -1,14 +0,0 @@
-import type { EventEvent, EventsAPI } from './events';
-import type { ExceptionEvent, ExceptionsAPI } from './exceptions';
-import type { LogEvent, LogsAPI } from './logs';
-import type { MeasurementEvent, MeasurementsAPI } from './measurements';
-import type { MetaAPI } from './meta';
-import type { TraceEvent, TracesAPI } from './traces';
-import type { UserActionsAPI } from './userActions';
-export type UserAction = {
-    name: string;
-    id?: string;
-    parentId?: string;
-};
-export type APIEvent = LogEvent | ExceptionEvent | MeasurementEvent | TraceEvent | EventEvent;
-export type API = LogsAPI & ExceptionsAPI & MeasurementsAPI & TracesAPI & MetaAPI & EventsAPI & UserActionsAPI;

package/dist/types/core/src/api/userActions/const.d.ts

@@ -1,8 +0,0 @@
-export declare const userActionStartByApiCallEventName = "faroApiCall";
-export declare const userActionStart = "user_action_start";
-export declare const UserActionImportance: {
-    readonly Normal: "normal";
-    readonly Critical: "critical";
-};
-export type UserActionImportanceType = (typeof UserActionImportance)[keyof typeof UserActionImportance];
-export declare const userActionEventName = "faro.user.action";

package/dist/types/core/src/api/userActions/index.d.ts

@@ -1,4 +0,0 @@
-export { UserActionImportance } from './const';
-export { type UserActionImportance as UserActionImportanceType } from './const';
-export { type UserActionsAPI, UserActionState, type UserActionInterface, type UserActionInternalInterface, } from './types';
-export { initializeUserActionsAPI, userActionsMessageBus } from './initialize';

package/dist/types/core/src/api/userActions/initialize.d.ts

@@ -1,21 +0,0 @@
-import type { Config } from '../../config';
-import type { InternalLogger } from '../../internalLogger';
-import type { TransportItem, Transports } from '../../transports';
-import { Observable } from '../../utils/reactive';
-import type { EventsAPI } from '../events/types';
-import { type UserActionInterface, type UserActionsAPI } from './types';
-export declare const userActionsMessageBus: Observable<import("./types").UserActionStart>;
-export declare function initializeUserActionsAPI({ transports, internalLogger, config, pushEvent, }: {
-    transports: Transports;
-    config: Config;
-    internalLogger: InternalLogger;
-    pushEvent: EventsAPI['pushEvent'];
-}): UserActionsAPI;
-/**
- * Adds an item to the buffer associated with the given UserAction.
- * The item will only be added if the UserAction is in the Started state.
- * @param userAction The UserAction instance
- * @param item The item to add to the buffer
- * @returns {boolean} True if the item was added, false otherwise
- */
-export declare function addItemToUserActionBuffer(userAction: UserActionInterface | undefined, item: TransportItem): boolean;

package/dist/types/core/src/api/userActions/initialize.test.d.ts

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

package/dist/types/core/src/api/userActions/types.d.ts

@@ -1,55 +0,0 @@
-import { type TransportItem } from '../../transports';
-import { type UserActionImportanceType, userActionStartByApiCallEventName } from './const';
-export declare enum UserActionState {
-    Started = 0,
-    Halted = 1,
-    Cancelled = 2,
-    Ended = 3
-}
-/**
- * Public interface for the UserAction.
- * This is the interface that is part of the public API.
- */
-export interface UserActionInterface {
-    name: string;
-    parentId: string;
-}
-/**
- * Internal interface for the UserAction.
- * This interface is intended for internal use only and not guaranteed to be stable.
- */
-export interface UserActionInternalInterface extends UserActionInterface {
-    halt(): void;
-    end(attributes?: Record<string, string>): void;
-    cancel(): void;
-    getState(): UserActionState;
-}
-export interface UserActionTransportItemBuffer {
-    addItem(item: TransportItem): boolean;
-}
-export type ApiUserActionEvent = {
-    name: string;
-    attributes?: Record<string, string>;
-    type: typeof userActionStartByApiCallEventName | string;
-};
-export type EndUserActionProps = {
-    userActionName: string;
-    startTime: number;
-    endTime: number;
-    actionId: string;
-    event: ApiUserActionEvent;
-    attributes?: Record<string, string>;
-};
-export type StartUserActionOptions = {
-    triggerName?: string;
-    importance?: UserActionImportanceType;
-};
-export interface UserActionsAPI {
-    startUserAction: (name: string, attributes?: Record<string, string>, options?: StartUserActionOptions) => UserActionInterface | undefined;
-    getActiveUserAction: () => UserActionInterface | undefined;
-}
-export type UserActionStart = {
-    type: 'user_action_start';
-    userAction: UserActionInterface;
-};
-export type UserActionMessage = UserActionStart;

package/dist/types/core/src/api/userActions/userAction.d.ts

@@ -1,36 +0,0 @@
-import { type TransportItem, type Transports } from '../../transports';
-import { Observable } from '../../utils';
-import type { EventsAPI } from '../events/types';
-import { type APIEvent } from '../types';
-import { type UserActionImportanceType } from './const';
-import { type UserActionInternalInterface, UserActionState, type UserActionTransportItemBuffer } from './types';
-export default class UserAction extends Observable implements UserActionInternalInterface, UserActionTransportItemBuffer {
-    name: string;
-    id: string;
-    attributes?: Record<string, string>;
-    parentId: string;
-    trigger: string;
-    importance: UserActionImportanceType;
-    startTime?: number;
-    trackUserActionsExcludeItem?: (item: TransportItem<APIEvent>) => boolean;
-    private _state;
-    private _itemBuffer;
-    private _transports;
-    private _pushEvent;
-    constructor({ name, parentId, trigger, transports, attributes, trackUserActionsExcludeItem, importance, pushEvent, }: {
-        name: string;
-        transports: Transports;
-        parentId?: string;
-        trigger: string;
-        attributes?: Record<string, string>;
-        trackUserActionsExcludeItem?: (item: TransportItem<APIEvent>) => boolean;
-        importance?: UserActionImportanceType;
-        pushEvent: EventsAPI['pushEvent'];
-    });
-    addItem(item: TransportItem): boolean;
-    private _start;
-    halt(): void;
-    cancel(): void;
-    end(): void;
-    getState(): UserActionState;
-}

package/dist/types/core/src/api/userActions/userAction.test.d.ts

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

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

@@ -1,2 +0,0 @@
-import type { Patterns } from '../config/types';
-export declare function shouldIgnoreEvent(patterns: Patterns, msg: string): boolean;

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

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

package/dist/types/core/src/config/const.d.ts

@@ -1,6 +0,0 @@
-export declare const defaultGlobalObjectKey = "faro";
-export declare const defaultBatchingConfig: {
-    enabled: boolean;
-    sendTimeout: number;
-    itemLimit: number;
-};

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

@@ -1,2 +0,0 @@
-export { defaultBatchingConfig, defaultGlobalObjectKey } from './const';
-export type { Config, Patterns } from './types';