@coralogix/react-native-plugin 0.1.0

package/src/model/CoralogixOtelWebType.d.ts

@@ -0,0 +1,49 @@
+import type { SendLog } from './SendLog';
+import type { CoralogixRumLabels } from './CoralogixRumLabels';
+import { CoralogixBrowserSdkConfig } from './Types';
+import { UserContextConfig } from './UserContextConfig';
+import { ViewContextConfig } from './ViewContextConfig';
+import { ApplicationContextConfig } from './ApplicationContextConfig';
+import { CustomMeasurement } from './CustomMeasurement';
+import { NetworkRequestDetails } from './NetworkRequestDetails';
+export interface CoralogixOtelWebType extends SendLog {
+    /**
+     * Init CoralogixRum.
+     */
+    init: (options: CoralogixBrowserSdkConfig) => void;
+    /**
+     * Turn CoralogixRum off.
+     */
+    shutdown: () => void;
+    /** Sets labels to be added to every log after CoralogixRum initialization. */
+    setLabels: (labels: CoralogixRumLabels) => void;
+    /**
+     * Provides access to computed, final value of global attributes, which are applied to all created logs.
+     */
+    getLabels: () => Promise<CoralogixRumLabels>;
+    /** Sets user context to be added to every log after CoralogixRum initialization. */
+    setUserContext: (userContext: UserContextConfig) => void;
+    /** Sets user context to be added to every log after CoralogixRum initialization. */
+    setViewContext: (viewContext: ViewContextConfig) => void;
+    /** Sets application context to be added to every log after CoralogixRum initialization. */
+    setApplicationContext: (applicationContext: ApplicationContextConfig) => void;
+    /**
+     * Provides access to computed, final value of user context, which applied to all created logs.
+     */
+    getUserContext: () => Promise<UserContextConfig | undefined>;
+    /**
+     * Provides the session id.
+     */
+    getSessionId: () => Promise<string> | undefined;
+    /**
+     * Send custom key value pair
+     */
+    sendCustomMeasurement: (measurement: CustomMeasurement) => void;
+    reportError: (error: Error, isCrash: boolean) => void;
+    /**
+     * Report a network request to the underlying Coralogix SDK
+     * @param details
+     */
+    reportNetworkRequest: (details: NetworkRequestDetails) => void;
+    readonly isInited: boolean;
+}

package/src/model/CoralogixRumLabels.d.ts

@@ -0,0 +1 @@
+export type CoralogixRumLabels = Record<string, string>;

package/src/model/CustomMeasurement.d.ts

@@ -0,0 +1,4 @@
+export type CustomMeasurement = {
+    name: string;
+    value: number;
+};

package/src/model/NetworkRequestDetails.d.ts

@@ -0,0 +1,14 @@
+export type NetworkRequestDetails = {
+    method: string;
+    statusCode: number;
+    url: string;
+    fragments: string;
+    host: string;
+    schema: string;
+    statusText: string;
+    duration: number;
+    responseContentLength: number;
+    errorMessage?: string | null;
+    customTraceId: string;
+    customSpanId: string;
+};

package/src/model/SendLog.d.ts

@@ -0,0 +1,10 @@
+import { CoralogixLogSeverity } from './Types';
+export interface SendLog {
+    log: (severity: CoralogixLogSeverity, message: string, data?: Record<string, any>) => void;
+    debug: (message: string, data?: any) => void;
+    verbose: (message: string, data?: any) => void;
+    info: (message: string, data?: any) => void;
+    warn: (message: string, data?: any) => void;
+    error: (message: string, data?: any) => void;
+    critical: (message: string, data?: any) => void;
+}

package/src/model/Types.d.ts

@@ -0,0 +1,209 @@
+import type { CoralogixRumLabels } from './CoralogixRumLabels';
+import type { CoralogixOtelWebOptionsInstrumentations } from './CoralogixOtelWebOptionsInstrumentations';
+import { CoralogixDomain } from './CoralogixDomain';
+import { UserContextConfig } from './UserContextConfig';
+import { ViewContextConfig } from './ViewContextConfig';
+export interface CxSpan {
+    version_metadata: VersionMetaData;
+    applicationName: string;
+    subsystemName: string;
+    timestamp: number;
+    severity: CoralogixLogSeverity;
+    isErrorWithStacktrace: boolean;
+    instrumentation_data?: any;
+    text: {
+        cx_rum: CxRumEvent;
+    };
+}
+export interface UserMetadata {
+    user_id: string;
+    user_name?: string;
+    user_email?: string;
+    user_metadata?: {
+        [key: string]: any;
+    };
+}
+export interface SessionContext extends UserMetadata {
+    device: string | undefined;
+    os: string | undefined;
+    osVersion: string | number | undefined;
+}
+export interface DeviceState {
+    battery: string | undefined;
+    network_type: string | undefined;
+}
+export interface DeviceContext {
+    device: string | undefined;
+    deviceName: string | undefined;
+    emulator: boolean | undefined;
+    os: string | undefined;
+    osVersion: string | number | undefined;
+}
+interface VersionMetaData {
+    app_name: string;
+    app_version: string;
+}
+export declare enum CoralogixEventType {
+    ERROR = "error",
+    NETWORK_REQUEST = "network-request",
+    LOG = "log",
+    USER_INTERACTION = "user-interaction",
+    WEB_VITALS = "web-vitals",
+    LONG_TASK = "longtask",
+    RESOURCES = "resources",
+    INTERNAL = "internal",
+    NAVIGATION = "navigation"
+}
+export declare enum EventSource {
+    CONSOLE = "console",
+    FETCH = "fetch",
+    CODE = "code",
+    UNHANDLED_REJECTION = "unhandledrejection"
+}
+export declare enum CoralogixLogSeverity {
+    Debug = 1,
+    Verbose = 2,
+    Info = 3,
+    Warn = 4,
+    Error = 5,
+    Critical = 6
+}
+export interface EventContext {
+    type: CoralogixEventType;
+    source: EventSource;
+    severity: CoralogixLogSeverity;
+}
+export interface ErrorContext {
+    domain?: string;
+    code?: string;
+    error_message?: string;
+    user_info?: string;
+    original_stacktrace?: Array<Record<string, any>>;
+    error_type?: string;
+    is_crashed?: boolean;
+    event_type?: string;
+    error_context?: string;
+    crash_timestamp?: string;
+    process_name?: string;
+    application_identifier?: string;
+    triggered_by_thread?: string;
+    base_address?: string;
+    arch?: string;
+    threads?: Array<Record<string, any>>;
+}
+export interface LogContext {
+    message: string;
+    data?: any;
+}
+export interface NetworkRequestContext {
+    method: string;
+    status_code: number;
+    url: string;
+    fragments: string;
+    host: string;
+    schema: string;
+    status_text: string;
+    response_content_length: string;
+    duration: number;
+}
+export interface SnapshotContext {
+    timestamp: number;
+    errorCount: number;
+    viewCount: number;
+    actionCount: number;
+    hasRecording: boolean;
+}
+export interface CxRumEvent {
+    platform: string;
+    version_metadata: VersionMetaData;
+    session_context: SessionContext;
+    device_context: DeviceContext;
+    device_state: DeviceState;
+    view_context: ViewContextConfig;
+    event_context: EventContext;
+    error_context?: ErrorContext;
+    log_context?: LogContext;
+    network_request_context?: NetworkRequestContext;
+    snapshot_context?: SnapshotContext;
+    labels: CoralogixRumLabels;
+    spanId: string;
+    traceId: string;
+    environment: string;
+    timestamp: number;
+    isSnapshotEvent?: boolean;
+}
+export interface EditableCxRumEvent extends Omit<CxRumEvent, 'session_context' | 'timestamp'> {
+    session_context: Pick<SessionContext, keyof UserMetadata>;
+}
+export type BeforeSendResult = EditableCxRumEvent | null;
+export interface TraceParentInHeader {
+    enabled: boolean;
+    options?: {
+        /** urls outside of origin that should also add Traceparent to header */
+        propagateTraceHeaderCorsUrls?: Array<string | RegExp>;
+    };
+}
+export interface CoralogixStackFrame {
+    readonly functionName: string;
+    readonly fileName: string;
+    readonly lineNumber: number;
+    readonly columnNumber: number;
+}
+export interface CoralogixBrowserSdkConfig {
+    /** Publicly-visible `public_key` value */
+    public_key: string;
+    /** Sets a value for the `application` attribute */
+    application: string;
+    /** Coralogix account domain */
+    coralogixDomain: CoralogixDomain;
+    /** Sets a value for the 'app.version' attribute */
+    version: string;
+    /** Configuration for user context. */
+    user_context?: UserContextConfig;
+    /** Configuration for view context. */
+    view_context?: ViewContextConfig;
+    /** Turns on/off internal debug logging */
+    debug?: boolean;
+    /** Sets labels added to every Span. */
+    labels?: CoralogixRumLabels;
+    /**
+     * Applies for XHR and Fetch URLs. URLs that partially match any regex in ignoreUrls will not be traced.
+     * In addition, URLs that are _exact matches_ of strings in ignoreUrls will also not be traced.
+     * */
+    ignoreUrls?: Array<string | RegExp>;
+    /**
+     A pattern for error messages which should not be sent to Coralogix. By default, all errors will be sent.
+     * */
+    ignoreErrors?: Array<string | RegExp>;
+    /** Configuration for instrumentation modules. */
+    instrumentations?: CoralogixOtelWebOptionsInstrumentations;
+    /** Add trace context propagation in headers across service boundaries */
+    traceParentInHeader?: TraceParentInHeader;
+    /** Interval for fps sampling, defaults to 300 (5 minutes) */
+    fpsSamplingSeconds?: number;
+    /** Sets a value for the `environment` attribute */
+    environment?: string;
+    /** Percentage of overall sessions being tracked, defaults to 100%  */
+    sessionSampleRate?: number;
+    /** Collect IP data */
+    collectIPData?: boolean;
+    /** Enable event access and modification before sending to Coralogix, supporting content modification, and event discarding. */
+    beforeSend?: (event: EditableCxRumEvent) => BeforeSendResult;
+    /** Send requests through a proxy */
+    proxyUrl?: string;
+    /**
+     * JS refresh rate metric collection configuration.
+     */
+    jsRefreshRateSampleRate?: {
+        /** Duration of each FPS measurement window in milliseconds (default: 5000) */
+        sampleDurationMs?: number;
+        /** Interval between FPS measurements in milliseconds (default: 300000 = 5 minutes) */
+        sampleIntervalMs?: number;
+    };
+}
+export type HybridMetric = {
+    name: string;
+    value: number;
+    units: string;
+};
+export {};

package/src/model/UserContextConfig.d.ts

@@ -0,0 +1,8 @@
+export interface UserContextConfig {
+    user_id: string;
+    user_name: string;
+    user_email?: string;
+    user_metadata?: {
+        [key: string]: any;
+    };
+}

package/src/model/ViewContextConfig.d.ts

@@ -0,0 +1,3 @@
+export interface ViewContextConfig {
+    view: string;
+}

package/src/utils.d.ts

@@ -0,0 +1,5 @@
+import { CoralogixBrowserSdkConfig } from './model/Types';
+export declare const hrTimeToMilliseconds: ([seconds, nanoseconds]: [number, number]) => number;
+export declare const getUrlFragments: (url: string) => string;
+export declare function isSamplingOn(threshold: number): boolean;
+export declare function resolveCoralogixOtelWebConfig(config: CoralogixBrowserSdkConfig): CoralogixBrowserSdkConfig;