o11y 236.0.2 → 238.1.2

package/dist/modules/o11y/client/collectors/core-collector/CoreCollector.d.ts

@@ -1,31 +1,49 @@
 import { Environment, LogCollector, LogMeta, MetricsCollector, MetricsExtractorMethods, Schema } from '../../interfaces';
 import { SchematizedData } from 'o11y/shared';
-export declare enum UploadMode {
-    fetchBinary = 0,
-    fetchFile = 1,
-    noUpload = 2
-}
+import { UploadMode } from './UploadMode';
+import { CoreCollectorOptions } from './interfaces/CoreCollectorOptions';
+import { CoreEnvelopeContents } from './interfaces/CoreEnvelopeContents';
+import { UploadResult } from './interfaces/UploadResult';
 export declare class CoreCollector implements LogCollector, MetricsCollector {
-    private readonly _apiEndpoint?;
-    private readonly _uploadMode?;
-    readonly environment?: Environment;
     private readonly _messageBuffers;
     private readonly _coreEnvelopeType;
     private _intervalHandle;
     private _metricsExtractors;
-    private _staticAttributes;
+    private readonly _staticAttributes;
     private _immediateUpload;
-    private _instr;
-    constructor(_apiEndpoint?: string, _uploadMode?: UploadMode, environment?: Environment);
-    getIsCollectDisabled(): boolean;
-    getProtoEncodedCoreEnvelope(): Uint8Array;
-    getByteSize(): number;
-    private _isFull;
+    private readonly _messagesLimit;
+    private readonly _metricsLimit;
+    private readonly _formDataKey;
+    private readonly _uploadFailedListener;
+    private _uploadInterval;
+    private _uploadEndpoint;
+    private _uploadMode;
+    private readonly _emptySize;
+    private _messageSize;
+    constructor(uploadEndpoint?: string, uploadMode?: UploadMode, environment?: Environment, options?: CoreCollectorOptions);
+    get uploadInterval(): number;
+    set uploadInterval(uploadInterval: number);
+    get uploadEndpoint(): string;
+    set uploadEndpoint(uploadEndpoint: string);
+    get uploadMode(): UploadMode;
+    set uploadMode(uploadMode: UploadMode);
+    getByteSize(accuracy?: number): number;
     private _stopTimer;
     private _restartTimer;
-    collect(schema: Schema, data: SchematizedData, logMeta: LogMeta): void;
+    collect(schema: Schema, data: SchematizedData, logMeta: LogMeta): Promise<UploadResult>;
     private _shouldUpload;
     private _upload;
-    private _getProtoEncodedCoreEnvelope;
+    private _uploadContents;
+    private _checkUploadState;
+    upload(contents?: CoreEnvelopeContents): Promise<UploadResult>;
+    get hasData(): boolean;
+    get messagesCount(): number;
+    get metricsCount(): number;
+    getProtoEncodedCoreEnvelope(): Uint8Array;
+    getContentsOfCoreEnvelope(): CoreEnvelopeContents;
+    private _getContentsOfCoreEnvelope;
+    private _buildProtoEncodedCoreEnvelope;
+    private _buildProtoEncodedCoreEnvelopeFrom;
+    private _encodeCoreEnvelope;
     receiveMetricsExtractors(metricsExtractors: MetricsExtractorMethods): void;
 }

package/dist/modules/o11y/client/collectors/core-collector/CoreEnvelopeBuilder.d.ts

@@ -1,15 +1,19 @@
 import { Metric } from '../../interfaces';
-import { CoreEnvelope } from './CoreEnvelope';
-import { LogMessage } from './LogMessage';
-import { StaticAttributes } from './StaticAttributes';
+import { CoreEnvelope } from './interfaces/CoreEnvelope';
+import { LogMessage } from './interfaces/LogMessage';
+import { StaticAttributes } from './interfaces/StaticAttributes';
+import { UpCounter } from '../metrics/UpCounter';
+import { ValueRecorder } from '../metrics/ValueRecorder';
 export declare const coreEnvelopeKey = "o11y";
 export declare class CoreEnvelopeBuilder {
     private _envelope;
     constructor();
     withStaticAttributes(staticAttributes: StaticAttributes): CoreEnvelopeBuilder;
     withLogs(schemaName: string, logs: LogMessage[]): CoreEnvelopeBuilder;
-    private _getMetricTags;
-    withUpCounters(metrics: Metric<number>[]): CoreEnvelopeBuilder;
-    withValueRecorders(metrics: Metric<number[]>[]): CoreEnvelopeBuilder;
+    private static _getMetricTags;
+    static getUpCounters(metrics: Metric<number>[], reset?: boolean): UpCounter[];
+    static getValueRecorders(metrics: Metric<number[]>[], reset?: boolean): ValueRecorder[];
+    withUpCounters(upCounters: UpCounter[]): CoreEnvelopeBuilder;
+    withValueRecorders(valueRecorders: ValueRecorder[]): CoreEnvelopeBuilder;
     build(): CoreEnvelope;
 }

package/dist/modules/o11y/client/collectors/core-collector/UploadMode.d.ts

@@ -0,0 +1,5 @@
+export declare enum UploadMode {
+    fetchBinary = 0,
+    fetchFile = 1,
+    noUpload = 2
+}

package/dist/modules/o11y/client/collectors/core-collector/interfaces/CoreCollectorOptions.d.ts

@@ -0,0 +1,8 @@
+import { UploadResult } from './UploadResult';
+export interface CoreCollectorOptions {
+    maxUniqueSchemas?: number;
+    messagesLimit?: number;
+    metricsLimit?: number;
+    formDataKeyName?: string;
+    uploadFailedListener?: (ur: UploadResult) => unknown;
+}

package/dist/modules/o11y/client/collectors/core-collector/{CoreEnvelope.d.ts → interfaces/CoreEnvelope.d.ts}

@@ -1,7 +1,7 @@
 import { StaticAttributes } from './StaticAttributes';
 import { CoreEnvelopeDiagnostics } from './CoreEnvelopeDiagnostics';
 import { MessageBundle } from './MessageBundle';
-import { Metrics } from '../metrics/Metrics';
+import { Metrics } from '../../metrics/Metrics';
 export interface CoreEnvelope {
     diagnostics: CoreEnvelopeDiagnostics;
     bundles: MessageBundle[];

package/dist/modules/o11y/client/collectors/core-collector/interfaces/CoreEnvelopeContents.d.ts

@@ -0,0 +1,11 @@
+import { UpCounter } from 'src/collectors/metrics/UpCounter';
+import { ValueRecorder } from 'src/collectors/metrics/ValueRecorder';
+import { Schema } from 'src/interfaces';
+import { LogMessage } from './LogMessage';
+import { StaticAttributes } from './StaticAttributes';
+export interface CoreEnvelopeContents {
+    messages?: Map<Schema, LogMessage[]>;
+    upCounters?: UpCounter[];
+    valueRecorders?: ValueRecorder[];
+    staticAttributes: StaticAttributes;
+}

package/dist/modules/o11y/{collectors/collectors/core-collector → client/collectors/core-collector/interfaces}/LogMessage.d.ts

@@ -1,4 +1,4 @@
-import { EncodedSchematizedPayload } from '../EncodedSchematizedPayload';
+import { EncodedSchematizedPayload } from '../../EncodedSchematizedPayload';
 export interface LogMessage {
     timestamp: number;
     data: Uint8Array;

package/dist/modules/o11y/client/collectors/core-collector/interfaces/UploadResult.d.ts

@@ -0,0 +1,6 @@
+import { CoreEnvelopeContents } from './CoreEnvelopeContents';
+export interface UploadResult {
+    response?: Response;
+    envelopeContents?: CoreEnvelopeContents;
+    error?: unknown;
+}

package/dist/modules/o11y/client/collectors/protobuf-util.d.ts

@@ -2,7 +2,7 @@ import { Type } from 'protobufjs';
 import { LogMeta, Schema, SchematizedPayload } from '../interfaces';
 import { EncodedSchematizedPayload } from './EncodedSchematizedPayload';
 import { SchematizedData } from 'o11y/shared';
-import { LogMessage } from './core-collector/LogMessage';
+import { LogMessage } from './core-collector/interfaces/LogMessage';
 declare class ProtobufUtil {
     private readonly _typeStore;
     getSchemaType(schema: Schema): Type;

package/dist/modules/o11y/client/interfaces/Instrumentation.d.ts

@@ -1,4 +1,5 @@
 import { LightningElement, MetricsTags, SchematizedData } from 'o11y/shared';
+import { LogPromptListener } from 'src/shared/TypeDefinitions';
 import { Activity } from './Activity';
 import { Schema } from './Schema';
 export interface Instrumentation {
@@ -8,4 +9,5 @@ export interface Instrumentation {
     domEvent(e: Event, handledBy: HTMLElement | LightningElement, schema?: Schema, data?: SchematizedData, auto?: boolean): void;
     incrementCounter(operation: string, increment?: number, hasError?: boolean, tags?: MetricsTags): void;
     trackValue(operation: string, value: number, hasError?: boolean, tags?: MetricsTags): void;
+    registerForLogPrompt(listener: LogPromptListener): void;
 }

package/dist/modules/o11y/client/interfaces/InstrumentedAppMethods.d.ts

@@ -11,4 +11,5 @@ export interface InstrumentedAppMethods extends Instrumentation {
     deactivateClickTracker(): void;
     networkInstrumentation(options: boolean | NetworkInstrumentationOptions): void;
     disableBuffering(): void;
+    promptLogCollection(reason?: string): void;
 }

package/dist/modules/o11y/client/interfaces/Nextgen.d.ts

@@ -1,6 +1,6 @@
 import { Instrumentation } from './Instrumentation';
 import { InstrumentedAppMethods } from './InstrumentedAppMethods';
 export interface Nextgen {
-    registerApp(name: string): InstrumentedAppMethods | undefined;
+    registerApp(name: string, enableBuffering?: boolean): InstrumentedAppMethods | undefined;
     getInstrumentation(name: string): Instrumentation;
 }

package/dist/modules/o11y/client/library/InstrumentationImpl.d.ts

@@ -5,6 +5,7 @@ import { MetricsImpl } from './MetricsImpl';
 import { NextgenImpl } from './NextgenImpl';
 import { PublicSafety } from './PublicSafety';
 import { LightningElement, MetricsTags, SchematizedData } from 'o11y/shared';
+import { LogPromptListener } from 'src/shared/TypeDefinitions';
 export declare class InstrumentationImpl implements Instrumentation, MetricsReporter {
     private readonly _nextGen;
     private readonly _name;
@@ -35,4 +36,5 @@ export declare class InstrumentationImpl implements Instrumentation, MetricsRepo
     private _checkInputs;
     getUpCounters(): Metric<number>[];
     getValueRecorders(): Metric<number[]>[];
+    registerForLogPrompt(listener: LogPromptListener): void;
 }

package/dist/modules/o11y/client/library/NextgenImpl.d.ts

@@ -2,6 +2,7 @@ import { BufferedLog, Instrumentation, InstrumentedAppMethods, LogCollector, Met
 import { AutomaticClickTracker } from './AutomaticClickTracker';
 import { SchematizedData } from 'o11y/shared';
 import { LogCollectorOptions } from 'src/interfaces/LogCollectorOptions';
+import { LogPromptListener } from 'src/shared/TypeDefinitions';
 export declare class NextgenImpl implements Nextgen {
     private readonly _logCollectors;
     private readonly _instruments;
@@ -16,6 +17,7 @@ export declare class NextgenImpl implements Nextgen {
     private static _collectorFailureLimit;
     private _isBufferingEnabled;
     private _buffer;
+    private readonly _logCollectionListeners;
     get pagePayloadProvider(): PayloadProvider;
     set pagePayloadProvider(provider: PayloadProvider);
     get appPayloadProvider(): PayloadProvider;
@@ -35,4 +37,6 @@ export declare class NextgenImpl implements Nextgen {
     registerMetricsCollector(collector: MetricsCollector): void;
     private getAllUpCounters;
     private getAllValueRecorders;
+    registerForLogPrompt(listener: LogPromptListener): void;
+    promptLogCollection(reason: string): void;
 }

package/dist/modules/o11y/client/shared/LazyMapToList.d.ts

@@ -1,13 +1,13 @@
 export declare class LazyMapToList<Key, ElementType> {
     private readonly _lazyMap;
     private _maxSize;
-    private _byteSizeOfValues;
     constructor(maxSize?: number);
     get maxSize(): number;
-    get byteSizeOfValues(): number;
+    get size(): number;
     push(key: Key, value: ElementType): boolean;
-    extractMessages(key: Key, extractAll?: boolean): Array<ElementType>;
+    getMessages(key: Key, extract?: boolean): Array<ElementType>;
+    getAllMessages(extract?: boolean): Map<Key, Array<ElementType>>;
+    extractMessages(key: Key): Array<ElementType>;
     extractAllMessages(): Map<Key, Array<ElementType>>;
     get totalItemCount(): number;
-    private _getObjectSize;
 }

package/dist/modules/o11y/client/shared/TypeDefinitions.d.ts

@@ -9,6 +9,7 @@ export declare type LightningElement = {
     };
 };
 export declare type MetricsTags = Record<string, number | string | boolean>;
+export declare type LogPromptListener = (reason?: string) => unknown;
 export declare type ProtoOptions = {
     [k: string]: any;
 };
@@ -17,4 +18,5 @@ export declare type AnyNestedObject = IEnum | IType | IService | AnyExtensionFie
 export declare type PbjsNestedObjectDescriptor = {
     [k: string]: AnyNestedObject;
 };
+export declare type ObjectType = Record<string | number | symbol, unknown>;
 export {};

package/dist/modules/o11y/client/shared/Utility.d.ts

@@ -12,15 +12,18 @@ declare class Utility {
     markProduction(): void;
     private checkArgument;
     requireArgument<T>(argument: T, argumentName: string, argKind?: unknown): void;
+    requireArgumentIfDefined<T>(argument: T, argumentName: string, argKind: unknown): boolean;
     checkForDenyListedValues<T>(argument: T, argumentName: string, denyList: ReadonlyArray<T>): void;
     checkForReservedCharacters(argument: string, argumentName: string, reservedChars: ReadonlyArray<string>): void;
     generateUniqueId(length?: number): string;
     getXpath(_element: HTMLElement): string;
     getAge(timestamp: number): number;
     getConnectionType(): string;
-    clone(value: any): any;
+    clone<T>(value: T): T;
     definedValueOrDefault<T>(value: T, defaultValue: T): T;
     getGlobal(): typeof globalThis;
+    getIsBeaconSupported(): boolean;
+    estimateObjectSize(object: unknown): number;
 }
 export declare const utility: Readonly<Utility>;
 export {};

package/dist/modules/o11y/collectors/collectors/core-collector/CoreCollector.d.ts

@@ -1,31 +1,49 @@
 import { Environment, LogCollector, LogMeta, MetricsCollector, MetricsExtractorMethods, Schema } from '../../interfaces';
 import { SchematizedData } from 'o11y/shared';
-export declare enum UploadMode {
-    fetchBinary = 0,
-    fetchFile = 1,
-    noUpload = 2
-}
+import { UploadMode } from './UploadMode';
+import { CoreCollectorOptions } from './interfaces/CoreCollectorOptions';
+import { CoreEnvelopeContents } from './interfaces/CoreEnvelopeContents';
+import { UploadResult } from './interfaces/UploadResult';
 export declare class CoreCollector implements LogCollector, MetricsCollector {
-    private readonly _apiEndpoint?;
-    private readonly _uploadMode?;
-    readonly environment?: Environment;
     private readonly _messageBuffers;
     private readonly _coreEnvelopeType;
     private _intervalHandle;
     private _metricsExtractors;
-    private _staticAttributes;
+    private readonly _staticAttributes;
     private _immediateUpload;
-    private _instr;
-    constructor(_apiEndpoint?: string, _uploadMode?: UploadMode, environment?: Environment);
-    getIsCollectDisabled(): boolean;
-    getProtoEncodedCoreEnvelope(): Uint8Array;
-    getByteSize(): number;
-    private _isFull;
+    private readonly _messagesLimit;
+    private readonly _metricsLimit;
+    private readonly _formDataKey;
+    private readonly _uploadFailedListener;
+    private _uploadInterval;
+    private _uploadEndpoint;
+    private _uploadMode;
+    private readonly _emptySize;
+    private _messageSize;
+    constructor(uploadEndpoint?: string, uploadMode?: UploadMode, environment?: Environment, options?: CoreCollectorOptions);
+    get uploadInterval(): number;
+    set uploadInterval(uploadInterval: number);
+    get uploadEndpoint(): string;
+    set uploadEndpoint(uploadEndpoint: string);
+    get uploadMode(): UploadMode;
+    set uploadMode(uploadMode: UploadMode);
+    getByteSize(accuracy?: number): number;
     private _stopTimer;
     private _restartTimer;
-    collect(schema: Schema, data: SchematizedData, logMeta: LogMeta): void;
+    collect(schema: Schema, data: SchematizedData, logMeta: LogMeta): Promise<UploadResult>;
     private _shouldUpload;
     private _upload;
-    private _getProtoEncodedCoreEnvelope;
+    private _uploadContents;
+    private _checkUploadState;
+    upload(contents?: CoreEnvelopeContents): Promise<UploadResult>;
+    get hasData(): boolean;
+    get messagesCount(): number;
+    get metricsCount(): number;
+    getProtoEncodedCoreEnvelope(): Uint8Array;
+    getContentsOfCoreEnvelope(): CoreEnvelopeContents;
+    private _getContentsOfCoreEnvelope;
+    private _buildProtoEncodedCoreEnvelope;
+    private _buildProtoEncodedCoreEnvelopeFrom;
+    private _encodeCoreEnvelope;
     receiveMetricsExtractors(metricsExtractors: MetricsExtractorMethods): void;
 }

package/dist/modules/o11y/collectors/collectors/core-collector/CoreEnvelopeBuilder.d.ts

@@ -1,15 +1,19 @@
 import { Metric } from '../../interfaces';
-import { CoreEnvelope } from './CoreEnvelope';
-import { LogMessage } from './LogMessage';
-import { StaticAttributes } from './StaticAttributes';
+import { CoreEnvelope } from './interfaces/CoreEnvelope';
+import { LogMessage } from './interfaces/LogMessage';
+import { StaticAttributes } from './interfaces/StaticAttributes';
+import { UpCounter } from '../metrics/UpCounter';
+import { ValueRecorder } from '../metrics/ValueRecorder';
 export declare const coreEnvelopeKey = "o11y";
 export declare class CoreEnvelopeBuilder {
     private _envelope;
     constructor();
     withStaticAttributes(staticAttributes: StaticAttributes): CoreEnvelopeBuilder;
     withLogs(schemaName: string, logs: LogMessage[]): CoreEnvelopeBuilder;
-    private _getMetricTags;
-    withUpCounters(metrics: Metric<number>[]): CoreEnvelopeBuilder;
-    withValueRecorders(metrics: Metric<number[]>[]): CoreEnvelopeBuilder;
+    private static _getMetricTags;
+    static getUpCounters(metrics: Metric<number>[], reset?: boolean): UpCounter[];
+    static getValueRecorders(metrics: Metric<number[]>[], reset?: boolean): ValueRecorder[];
+    withUpCounters(upCounters: UpCounter[]): CoreEnvelopeBuilder;
+    withValueRecorders(valueRecorders: ValueRecorder[]): CoreEnvelopeBuilder;
     build(): CoreEnvelope;
 }

package/dist/modules/o11y/collectors/collectors/core-collector/UploadMode.d.ts

@@ -0,0 +1,5 @@
+export declare enum UploadMode {
+    fetchBinary = 0,
+    fetchFile = 1,
+    noUpload = 2
+}

package/dist/modules/o11y/collectors/collectors/core-collector/interfaces/CoreCollectorOptions.d.ts

@@ -0,0 +1,8 @@
+import { UploadResult } from './UploadResult';
+export interface CoreCollectorOptions {
+    maxUniqueSchemas?: number;
+    messagesLimit?: number;
+    metricsLimit?: number;
+    formDataKeyName?: string;
+    uploadFailedListener?: (ur: UploadResult) => unknown;
+}

package/dist/modules/o11y/{shared/collectors/core-collector → collectors/collectors/core-collector/interfaces}/CoreEnvelope.d.ts

@@ -1,7 +1,7 @@
 import { StaticAttributes } from './StaticAttributes';
 import { CoreEnvelopeDiagnostics } from './CoreEnvelopeDiagnostics';
 import { MessageBundle } from './MessageBundle';
-import { Metrics } from '../metrics/Metrics';
+import { Metrics } from '../../metrics/Metrics';
 export interface CoreEnvelope {
     diagnostics: CoreEnvelopeDiagnostics;
     bundles: MessageBundle[];

package/dist/modules/o11y/collectors/collectors/core-collector/interfaces/CoreEnvelopeContents.d.ts

@@ -0,0 +1,11 @@
+import { UpCounter } from 'src/collectors/metrics/UpCounter';
+import { ValueRecorder } from 'src/collectors/metrics/ValueRecorder';
+import { Schema } from 'src/interfaces';
+import { LogMessage } from './LogMessage';
+import { StaticAttributes } from './StaticAttributes';
+export interface CoreEnvelopeContents {
+    messages?: Map<Schema, LogMessage[]>;
+    upCounters?: UpCounter[];
+    valueRecorders?: ValueRecorder[];
+    staticAttributes: StaticAttributes;
+}

package/dist/modules/o11y/{shared/collectors/core-collector → collectors/collectors/core-collector/interfaces}/LogMessage.d.ts

@@ -1,4 +1,4 @@
-import { EncodedSchematizedPayload } from '../EncodedSchematizedPayload';
+import { EncodedSchematizedPayload } from '../../EncodedSchematizedPayload';
 export interface LogMessage {
     timestamp: number;
     data: Uint8Array;

package/dist/modules/o11y/collectors/collectors/core-collector/interfaces/UploadResult.d.ts

@@ -0,0 +1,6 @@
+import { CoreEnvelopeContents } from './CoreEnvelopeContents';
+export interface UploadResult {
+    response?: Response;
+    envelopeContents?: CoreEnvelopeContents;
+    error?: unknown;
+}

package/dist/modules/o11y/collectors/collectors/protobuf-util.d.ts

@@ -2,7 +2,7 @@ import { Type } from 'protobufjs';
 import { LogMeta, Schema, SchematizedPayload } from '../interfaces';
 import { EncodedSchematizedPayload } from './EncodedSchematizedPayload';
 import { SchematizedData } from 'o11y/shared';
-import { LogMessage } from './core-collector/LogMessage';
+import { LogMessage } from './core-collector/interfaces/LogMessage';
 declare class ProtobufUtil {
     private readonly _typeStore;
     getSchemaType(schema: Schema): Type;