@microsoft/1ds-post-js 3.2.10 → 4.0.0

package/dist-esm/src/BatchNotificationActions.d.ts

@@ -1,36 +0,0 @@
-/**
-* BatchNotificationActions.ts
-* @author Nev Wylie (newylie)
-* @copyright Microsoft 2020
-*/
-import { EventBatch } from "./EventBatch";
-import { EventBatchNotificationReason } from "./DataModels";
-import { EventSendType } from "@microsoft/1ds-core-js";
-export type BatchNotificationAction = (batches: EventBatch[], reason?: EventBatchNotificationReason, isSyncRequest?: boolean, sendType?: EventSendType) => void;
-export interface BatchNotificationActions {
-    /**
-     * Attempts have been made to send the events but all failed.
-     * Requeue the events (if possible) for resending.
-     */
-    requeue?: BatchNotificationAction;
-    /**
-     * The batch is about to be sent
-     */
-    send?: BatchNotificationAction;
-    /**
-     * The batch has been sent acknowledged by the server
-     */
-    sent?: BatchNotificationAction;
-    /**
-     * The events of the batch have been dropped
-     */
-    drop?: BatchNotificationAction;
-    /**
-     * The events of the batch have been dropped after being sent but not acknowledged
-     */
-    rspFail?: BatchNotificationAction;
-    /**
-     * Default callback action to call when no specific action could be identified for the reason
-     */
-    oth?: BatchNotificationAction;
-}

package/dist-esm/src/ClockSkewManager.d.ts

@@ -1,38 +0,0 @@
-/**
-* ClockSkewManager.ts
-* @author Abhilash Panwar (abpanwar)
-* @copyright Microsoft 2018
-*/
-/**
-* Class to manage clock skew correction.
-*/
-export default class ClockSkewManager {
-    constructor();
-    /**
-     * Determine if the request can be sent.
-     * @returns True if requests can be sent, false otherwise.
-     */
-    allowRequestSending(): boolean;
-    /**
-     * Tells the ClockSkewManager that it should assume that the first request has now been sent,
-     * If this method had not yet been called AND the clock Skew had not been set this will set
-     * allowRequestSending to false until setClockSet() is called.
-     */
-    firstRequestSent(): void;
-    /**
-     * Determine if clock skew headers should be added to the request.
-     * @returns True if clock skew headers should be added, false otherwise.
-     */
-    shouldAddClockSkewHeaders(): boolean;
-    /**
-     * Gets the clock skew header value.
-     * @returns The clock skew header value.
-     */
-    getClockSkewHeaderValue(): string;
-    /**
-     * Sets the clock skew header value. Once clock skew is set this method
-     * is no-op.
-     * @param timeDeltaInMillis - Time delta to be saved as the clock skew header value.
-     */
-    setClockSkew(timeDeltaInMillis?: string): void;
-}

package/dist-esm/src/DataModels.d.ts

@@ -1,405 +0,0 @@
-/**
-* DataModels.ts
-* @author Abhilash Panwar (abpanwar) and Hector Hernandez (hectorh)
-* @copyright Microsoft 2018
-* File containing the interfaces for Post channel module.
-*/
-import { IExtendedTelemetryItem, NotificationManager, IDiagnosticLogger, ITelemetryPlugin, IProcessTelemetryContext, IValueSanitizer } from "@microsoft/1ds-core-js";
-/** IPayloadData describes interface of payload sent via POST channel */
-export interface IPayloadData {
-    urlString: string;
-    data: Uint8Array | string;
-    headers?: {
-        [name: string]: string;
-    };
-    timeout?: number;
-    disableXhrSync?: boolean;
-    disableFetchKeepAlive?: boolean;
-}
-/**
- * Defines the function signature for the Payload Preprocessor.
- * @param payload - The Initial constructed payload that if not modified should be passed onto the callback function.
- * @param callback - The preprocessor MUST call the callback function to ensure that the events are sent to the server, failing to call WILL result in dropped events.
- * The modifiedBuffer argument can be either the original payload or may be modified by performing GZipping of the payload and adding the content header.
- * @param isSync - A boolean flag indicating whether this request was initiated as part of a sync response (unload / flush request), this is for informative only.
- * e.g the preprocessor may wish to not perform any GZip operations if the request was a sync request which is normally called as part of an unload request.
- */
-export type PayloadPreprocessorFunction = (payload: IPayloadData, callback: (modifiedBuffer: IPayloadData) => void, isSync?: boolean) => void;
-/**
- * Defines the function signature of a payload listener, which is called after the payload has been sent to the server. The listener is passed
- * both the initial payload object and any altered (modified) payload from a preprocessor so it can determine what payload it may want to log or send.
- * Used by the Remove DDV extension to listen to server send events.
- * @param orgPayload - The initially constructed payload object
- * @param sendPayload - The alternative (possibly modified by a preprocessor) payload
- * @param isSync - A boolean flag indicating whether this request was initiated as part of a sync response (unload / flush request), this is for informative only.
- * @param isBeaconSend - A boolean flag indicating whether the payload was sent using the navigator.sendBeacon() API.
- */
-export type PayloadListenerFunction = (orgPayload: IPayloadData, sendPayload?: IPayloadData, isSync?: boolean, isBeaconSend?: boolean) => void;
-/**
- * The IChannelConfiguration interface holds the configuration details passed to Post module.
- */
-export interface IChannelConfiguration {
-    /**
-     * [Optional] The number of events that can be kept in memory before the SDK starts to drop events. By default, this is 10,000.
-     */
-    eventsLimitInMem?: number;
-    /**
-     * [Optional] Sets the maximum number of immediate latency events that will be cached in memory before the SDK starts to drop other
-     * immediate events only, does not drop normal and real time latency events as immediate events have their own internal queue. Under
-     * normal situations immediate events are scheduled to be sent in the next Javascript execution cycle, so the typically number of
-     * immediate events is small (~1), the only time more than one event may be present is when the channel is paused or immediate send
-     * is disabled (via manual transmit profile). By default max number of events is 500 and the default transmit time is 0ms.
-     */
-    immediateEventLimit?: number;
-    /**
-     * [Optional] If defined, when the number of queued events reaches or exceeded this limit this will cause the queue to be immediately
-     * flushed rather than waiting for the normal timers. Defaults to undefined.
-     */
-    autoFlushEventsLimit?: number;
-    /**
-     * [Optional] If defined allows you to disable the auto batch (iKey set of requests) flushing logic. This is in addition to the
-     * default transmission profile timers, autoFlushEventsLimit and eventsLimitInMem config values.
-     */
-    disableAutoBatchFlushLimit?: boolean;
-    /**
-     * [Optional] The HTTP override that should be used to send requests, as an IXHROverride object.
-     * By default during the unload of a page or if the event specifies that it wants to use sendBeacon() or sync fetch (with keep-alive),
-     * this override will NOT be called. You can now change this behavior by enabling the 'alwaysUseXhrOverride' configuration value.
-     * The payload data (first argument) now also includes any configured 'timeout' (defaults to undefined) and whether you should avoid
-     * creating any synchronous XHR requests 'disableXhrSync' (defaults to false/undefined)
-     */
-    httpXHROverride?: IXHROverride;
-    /**
-    * Override for Instrumentation key
-    */
-    overrideInstrumentationKey?: string;
-    /**
-    * Override for Endpoint where telemetry data is sent
-    */
-    overrideEndpointUrl?: string;
-    /**
-     * The master off switch.  Do not send any data if set to TRUE
-     */
-    disableTelemetry?: boolean;
-    /**
-     * MC1 and MS0 cookies will not be returned from Collector endpoint.
-     */
-    ignoreMc1Ms0CookieProcessing?: boolean;
-    /**
-    * Override for setTimeout
-    */
-    setTimeoutOverride?: typeof setTimeout;
-    /**
-    * Override for clearTimeout
-    */
-    clearTimeoutOverride?: typeof clearTimeout;
-    /**
-     * [Optional] POST channel preprocessing function. Can be used to gzip the payload before transmission and to set the appropriate
-     * Content-Encoding header. The preprocessor is explicitly not called during teardown when using the sendBeacon() API.
-     */
-    payloadPreprocessor?: PayloadPreprocessorFunction;
-    /**
-     * [Optional] POST channel listener function, used for enabling logging or reporting (RemoteDDVChannel) of the payload that is being sent.
-     */
-    payloadListener?: PayloadListenerFunction;
-    /**
-     * [Optional] By default additional timing metrics details are added to each event after they are sent to allow you to review how long it took
-     * to create serialized request. As not all implementations require this level of detail and it's now possible to get the same metrics via
-     * the IPerfManager and IPerfEvent we are enabling these details to be disabled. Default value is false to retain the previous behavior,
-     * if you are not using these metrics and performance is a concern then it is recommended to set this value to true.
-     */
-    disableEventTimings?: boolean;
-    /**
-     * [Optional] The value sanitizer to use while constructing the envelope.
-     */
-    valueSanitizer?: IValueSanitizer;
-    /**
-     * [Optional] During serialization, when an object is identified, should the object be serialized by JSON.stringify(theObject); (when true) otherwise by theObject.toString().
-     * Defaults to false
-     */
-    stringifyObjects?: boolean;
-    /**
-     * [Optional] Enables support for objects with compound keys which indirectly represent an object where the "key" of the object contains a "." as part of it's name.
-     * @example
-     * ```typescript
-     * event: { "somedata.embeddedvalue": 123 }
-     * ```
-     */
-    enableCompoundKey?: boolean;
-    /**
-     * [Optional] Switch to disable the v8 optimizeObject() calls used to provide better serialization performance. Defaults to false.
-     */
-    disableOptimizeObj?: boolean;
-    /**
-     * [Optional] By default a "Cache-Control" header will be added to the outbound payloads with the value "no-cache, no-store", this is to
-     * avoid instances where Chrome can "Stall" requests which use the same outbound URL.
-     */
-    /**
-     * [Optional] Either an array or single value identifying the requested TransportType type that should be used.
-     * This is used during initialization to identify the requested send transport, it will be ignored if a httpXHROverride is provided.
-     */
-    transports?: number | number[];
-    /**
-     * [Optional] Either an array or single value identifying the requested TransportType type(s) that should be used during unload or events
-     * marked as sendBeacon. This is used during initialization to identify the requested send transport, it will be ignored if a httpXHROverride
-     * is provided and alwaysUseXhrOverride is true.
-     */
-    unloadTransports?: number | number[];
-    /**
-     * [Optional] A flag to enable or disable the usage of the sendBeacon() API (if available). If running on ReactNative this defaults
-     * to `false` for all other cases it defaults to `true`.
-     */
-    useSendBeacon?: boolean;
-    /**
-     * [Optional] A flag to disable the usage of the [fetch with keep-alive](https://javascript.info/fetch-api#keepalive) support.
-     */
-    disableFetchKeepAlive?: boolean;
-    /**
-    * [Optional] Avoid adding request headers to the outgoing request that would cause a pre-flight (OPTIONS) request to be sent for each request.
-    * This currently defaults to true but will be changed once the collector handles additional settings to allow the browser to better cache any
-    * previous OPTIONS response, at which point some of the current dynamic values sent on the query string will be moved to a header.
-    */
-    avoidOptions?: boolean;
-    /**
-     * [Optional] Specify a timeout (in ms) to apply to requests when sending requests using XHR, XDR or fetch requests. Defaults to undefined
-     * and therefore the runtime defaults (normally zero for browser environments)
-     */
-    xhrTimeout?: number;
-    /**
-     * [Optional] When using Xhr for sending requests disable sending as synchronous during unload or synchronous flush.
-     * You should enable this feature for IE (when there is no sendBeacon() or fetch (with keep-alive)) and you have clients
-     * that end up blocking the UI during page unloading. This will cause ALL XHR requests to be sent asynchronously which
-     * during page unload may result in the lose of telemetry.
-     */
-    disableXhrSync?: boolean;
-    /**
-     * [Optional] By default during unload (or when you specify to use sendBeacon() or sync fetch (with keep-alive) for an event) the SDK
-     * ignores any provided httpXhrOverride and attempts to use sendBeacon() or fetch(with keep-alive) when they are available.
-     * When this configuration option is true any provided httpXhrOverride will always be used, so any provided httpXhrOverride will
-     * also need to "handle" the synchronous unload scenario.
-     */
-    alwaysUseXhrOverride?: boolean;
-    /**
-     * [Optional] Identifies the number of times any single event will be retried if it receives a failed (retirable) response, this
-     * causes the event to be internally "requeued" and resent in the next batch. As each normal batched send request is retried at
-     * least once before starting to increase the internal backoff send interval, normally batched events will generally be attempted
-     * the next nearest even number of times. This means that the total number of actual send attempts will almost always be even
-     * (setting to 5 will cause 6 requests), unless using manual synchronous flushing (calling flush(false)) which is not subject to
-     * request level retry attempts.
-     * Defaults to 6 times.
-     */
-    maxEventRetryAttempts?: number;
-    /**
-     * [Optional] Identifies the number of times any single event will be retried if it receives a failed (retriable) response as part
-     * of processing / flushing events once a page unload state has been detected, this causes the event to be internally "requeued"
-     * and resent in the next batch, which during page unload. Unlike the normal batching process, send requests are never retried,
-     * so the value listed here is always the maximum number of attempts for any single event.
-     * Defaults to 2 times.
-     * Notes:
-     * The SDK by default will use the sendBeacon() API if it exists which is treated as a fire and forget successful response, so for
-     * environments that support or supply this API the events won't be retried (because they will be deeded to be successfully sent).
-     * When an environment (IE) doesn't support sendBeacon(), this will cause multiple synchronous (by default) XMLHttpRequests to be sent,
-     * which will block the UI until a response is received. You can disable ALL synchronous XHR requests by setting the 'disableXhrSync'
-     * configuration setting and/or changing this value to 0 or 1.
-     */
-    maxUnloadEventRetryAttempts?: number;
-    /**
-     * [Optional] flag to indicate whether the sendBeacon and fetch (with keep-alive flag) should add the "NoResponseBody" query string
-     * value to indicate that the server should return a 204 for successful requests. Defaults to true
-     */
-    addNoResponse?: boolean;
-}
-/**
- * SendPOSTFunction type defines how an HTTP POST request is sent to an ingestion server
- * @param payload - The payload object that should be sent, contains the url, bytes/string and headers for the request
- * @param oncomplete - The function to call once the request has completed whether a success, failure or timeout
- * @param sync - A boolean flag indicating whether the request should be sent as a synchronous request.
- */
-export type SendPOSTFunction = (payload: IPayloadData, oncomplete: (status: number, headers: {
-    [headerName: string]: string;
-}, response?: string) => void, sync?: boolean) => void;
-/**
- * The IXHROverride interface overrides the way HTTP requests are sent.
- */
-export interface IXHROverride {
-    /**
-     * This method sends data to the specified URI using a POST request. If sync is true,
-     * then the request is sent synchronously. The <i>oncomplete</i> function should always be called after the request is
-     * completed (either successfully or timed out or failed due to errors).
-     */
-    sendPOST: SendPOSTFunction;
-}
-/**
- * An interface which extends the telemetry event to track send attempts.
- */
-export interface IPostTransmissionTelemetryItem extends IExtendedTelemetryItem {
-    /**
-     * The number of times the telemtry item has been attempted to be sent.
-     */
-    sendAttempt?: number;
-}
-/**
- * Real Time profile (default profile). RealTime Latency events are sent every 1 sec and
- * Normal Latency events are sent every 2 sec.
- */
-export declare const RT_PROFILE = "REAL_TIME";
-/**
- * Near Real Time profile. RealTime Latency events are sent every 3 sec and
- * Normal Latency events are sent every 6 sec.
- */
-export declare const NRT_PROFILE = "NEAR_REAL_TIME";
-/**
- * Best Effort. RealTime Latency events are sent every 9 sec and
- * Normal Latency events are sent every 18 sec.
- */
-export declare const BE_PROFILE = "BEST_EFFORT";
-/**
- * An interface representing Collector Web responses.
- */
-export interface ICollectorResult {
-    /**
-    * Number of events accepted.
-    */
-    acc?: number;
-    /**
-   * Number of events rejected.
-   */
-    rej?: number;
-    /**
-     * Web Result.
-     */
-    webResult?: ICollectorWebResult;
-}
-/**
- * An interface representing Collector Web responses.
- */
-export interface ICollectorWebResult {
-    /**
-     * MSFPC cookie.
-     */
-    msfpc?: string;
-    /**
-     * Authentication error.
-     */
-    authError?: string;
-    /**
-     * Auth Login URL.
-     */
-    authLoginUrl?: string;
-}
-/**
- * Post channel interface
- */
-export interface IPostChannel extends ITelemetryPlugin {
-    /**
-     * Diagnostic logger
-     */
-    diagLog: (itemCtx?: IProcessTelemetryContext) => IDiagnosticLogger;
-    /**
-     * Notification manager
-     */
-    _notificationManager: NotificationManager | undefined;
-    /**
-    * Override for setTimeout
-    */
-    _setTimeoutOverride?: (callback: (...args: any[]) => void, ms: number, ...args: any[]) => any;
-    /**
-     * Backs off transmission. This exponentially increases all the timers.
-     */
-    _backOffTransmission(): void;
-    /**
-    * Clears back off for transmission.
-    */
-    _clearBackOff(): void;
-    /**
-    * Add handler to be executed with request response text.
-    */
-    addResponseHandler(responseHandler: (responseText: string) => void): void;
-}
-/**
- * This is an internal notification reason used by the HttpManager to report the reason for notification events
- * it contains general events as well as specific sections which encompass other enum values such as
- * SendRequestReason, EventsDiscardedReason and general HttpStatus values.
- */
-export declare const enum EventBatchNotificationReason {
-    /**
-     * Unable to send the batch as the outbound connection channel is paused
-     */
-    Paused = 1,
-    /**
-     * The events failed to send or retry, so requeue them
-     */
-    RequeueEvents = 100,
-    /**
-     * The Batch was successfully sent and a response received, equivalent to the HttpStatusCode of 200
-     */
-    Complete = 200,
-    /**
-     * No specific reason was specified or normal event schedule / timer
-     */
-    SendingUndefined = 1000,
-    /**
-     * Events are being sent based on the normal event schedule / timer.
-     */
-    SendingNormalSchedule = 1001,
-    /**
-     * A manual flush request was received
-     */
-    SendingManualFlush = 1001,
-    /**
-     * Unload event is being processed
-     */
-    SendingUnload = 1002,
-    /**
-     * The event(s) being sent are sync events
-     */
-    SendingSyncEvent = 1003,
-    /**
-     * The Channel was resumed
-     */
-    SendingResumed = 1004,
-    /**
-     * The event(s) being sent as a retry
-     */
-    SendingRetry = 1005,
-    /**
-     * Maximum batch size would be exceeded
-     */
-    SendingMaxBatchSize = 1010,
-    /**
-     * The Maximum number of events have already been queued
-     */
-    SendingMaxQueuedEvents = 1020,
-    /**
-     * The final value for a Sending notification
-     */
-    SendingEventMax = 1999,
-    EventsDropped = 8000,
-    NonRetryableStatus = 8001,
-    InvalidEvent = 8002,
-    SizeLimitExceeded = 8003,
-    KillSwitch = 8004,
-    QueueFull = 8005,
-    EventsDroppedMax = 8999,
-    /**
-     * Represents the range Http Status codes 000-999 as 9000-9999
-     */
-    ResponseFailure = 9000,
-    /**
-     * Represents the range Http Status codes 200-299
-     */
-    PartialSuccess = 9200,
-    /**
-     * Represents the range Http Status codes 300-399
-     */
-    ClientConfigFailure = 9300,
-    /**
-     * Represents the range Http Status codes 400-499
-     */
-    ClientFailure = 9400,
-    /**
-     * Represents the range Http Status codes 500-599
-     */
-    ServerFailure = 9500,
-    ResponseFailureMax = 9999
-}

package/dist-esm/src/EventBatch.d.ts

@@ -1,47 +0,0 @@
-import { IPostTransmissionTelemetryItem } from "./DataModels";
-/**
-* This class defines a "batch" events related to a specific iKey, it is used by the PostChannel and HttpManager
-* to collect and transfer ownership of events without duplicating them in-memory. This reduces the previous
-* array duplication and shared ownership issues that occurred due to race conditions caused by the async nature
-* of sending requests.
-*/
-export declare class EventBatch {
-    /**
-     * Creates a new Event Batch object
-     * @param iKey The iKey associated with this batch of events
-     */
-    static create(iKey: string, theEvents?: IPostTransmissionTelemetryItem[]): EventBatch;
-    /**
-     * Returns the iKey associated with this batch of events
-     */
-    iKey: () => string;
-    /**
-     * Returns the first msfpc value from the batch
-     */
-    Msfpc: () => string;
-    /**
-     * Returns the number of events contained in the batch
-     */
-    count: () => number;
-    events: () => IPostTransmissionTelemetryItem[];
-    /**
-     * Add all of the events to the current batch, if the max number of events would be exceeded then no
-     * events are added.
-     * @param theEvents - The events that needs to be batched.
-     * @returns The number of events added.
-     */
-    addEvent: (theEvents: IPostTransmissionTelemetryItem) => boolean;
-    /**
-     * Split this batch into 2 with any events > fromEvent returned in the new batch and all other
-     * events are kept in the current batch.
-     * @param fromEvent The first event to remove from the current batch.
-     * @param numEvents The number of events to be removed from the current batch and returned in the new one. Defaults to all trailing events
-     */
-    split: (fromEvent: number, numEvents?: number) => EventBatch;
-    /**
-     * Private constructor so that caller is forced to use the static create method.
-     * @param iKey - The iKey to associate with the events (not validated)
-     * @param addEvents - The optional collection of events to assign to this batch - defaults to an empty array.
-     */
-    private constructor();
-}

package/dist-esm/src/HttpManager.d.ts

@@ -1,88 +0,0 @@
-import { EventSendType, IExtendedAppInsightsCore, SendRequestReason } from "@microsoft/1ds-core-js";
-import { BatchNotificationActions } from "./BatchNotificationActions";
-import { IPostChannel, IXHROverride, PayloadListenerFunction, PayloadPreprocessorFunction } from "./DataModels";
-import { EventBatch } from "./EventBatch";
-import { IChannelConfiguration } from "./Index";
-import { ITimeoutOverrideWrapper } from "./TimeoutOverrideWrapper";
-/**
- * Class managing the sending of requests.
- */
-export declare class HttpManager {
-    sendHook: PayloadPreprocessorFunction | undefined;
-    sendListener: PayloadListenerFunction | undefined;
-    _responseHandlers: Array<(responseText: string) => void>;
-    /**
-     * @constructor
-     * @param requestQueue   - The queue that contains the requests to be sent.
-     */
-    constructor(maxEventsPerBatch: number, maxConnections: number, maxRequestRetriesBeforeBackoff: number, actions: BatchNotificationActions, timeoutOverride: ITimeoutOverrideWrapper);
-    /**
-     * @constructor
-     * @param requestQueue   - The queue that contains the requests to be sent.
-     * @param endpointUrl   - The collector url to which the requests must be sent.
-     * @param postManager   - The post manager that we should add requests back to if needed.
-     * @param httpInterface - The http interface that should be used to send HTTP requests.
-     * @param channelConfig - The IChannelConfiguration the should be used to get additional configuration
-     */
-    initialize(endpointUrl: string, core: IExtendedAppInsightsCore, postChannel: IPostChannel, httpInterface: IXHROverride, channelConfig?: IChannelConfiguration): void;
-    /**
-     * Add query string parameter to url
-     * @param name   - Query string name.
-     * @param value  - Query string value.
-     */
-    addQueryStringParameter(name: string, value: string): void;
-    /**
-     * Add header to request
-     * @param name   - Header name.
-     * @param value  - Header value.
-     */
-    addHeader(name: string, value: string): void;
-    /**
-     * Add the batch of events to the queue for sending
-     * @param batch The batch with the events to send
-     * @returns True if the http manager has accepted the batch (including if the batch is empty) otherwise false
-     */
-    addBatch(batch: EventBatch): boolean;
-    /**
-     * Check if there is an idle connection and we can send a request.
-     * @returns True if there is an idle connection, false otherwise.
-     */
-    canSendRequest(): boolean;
-    /**
-     * Send requests in the request queue up if there is an idle connection, sending is
-     * not pause and clock skew manager allows sending request.
-     * @param sendType - Identifies how the batched events should be send, defaults to Batched
-     * @param sendReason   - The reason the batch is being sent
-     */
-    sendQueuedRequests(sendType?: EventSendType, sendReason?: SendRequestReason): void;
-    /**
-     * Check if there are no active requests being sent.
-     * @returns True if idle, false otherwise.
-     */
-    isCompletelyIdle(): boolean;
-    /**
-     * Inform the HttpManager that a page unload event was received
-     */
-    setUnloading(value: boolean): void;
-    /**
-     * Queue all the remaining requests to be sent. The requests will be
-     * sent using HTML5 Beacons if they are available.
-     */
-    teardown(): void;
-    /**
-     * Pause the sending of requests. No new requests will be sent.
-     */
-    pause(): void;
-    /**
-     * Resume the sending of requests.
-     */
-    resume(): void;
-    /**
-     * Sends the batches synchronously to the collector. This api is used to send a batches immediate event.
-     *
-     * @param batch - The batch of events to be sent.
-     * @param sendReason   - The reason the batch is being sent
-     * @param sendType - Identifies the sending type to use when sending the batch
-     */
-    sendSynchronousBatch(batch: EventBatch, sendType?: EventSendType, sendReason?: SendRequestReason): void;
-}