@microsoft/applicationinsights-core-js 3.0.0-beta.2303-03 → 3.0.0-beta.2303-05

package/src/JavaScriptSDK.Interfaces/IDistributedTraceContext.ts

@@ -1,54 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-export interface IDistributedTraceContext {
-
-    /**
-     * Returns the current name of the page
-     */
-    getName(): string;
-
-    /**
-     * Sets the current name of the page
-     * @param pageName
-     */
-    setName(pageName: string): void;
-
-    /**
-     * Returns the unique identifier for a trace. All requests / spans from the same trace share the same traceId.
-     * Must be read from incoming headers or generated according to the W3C TraceContext specification,
-     * in a hex representation of 16-byte array. A.k.a. trace-id, TraceID or Distributed TraceID
-     */
-    getTraceId(): string;
-
-    /**
-     * Set the unique identifier for a trace. All requests / spans from the same trace share the same traceId.
-     * Must be conform to the W3C TraceContext specification, in a hex representation of 16-byte array.
-     * A.k.a. trace-id, TraceID or Distributed TraceID https://www.w3.org/TR/trace-context/#trace-id
-     */
-    setTraceId(newValue: string): void;
-
-    /**
-     * Self-generated 8-bytes identifier of the incoming request. Must be a hex representation of 8-byte array.
-     * Also know as the parentId, used to link requests together
-     */
-    getSpanId(): string;
-
-    /**
-     * Self-generated 8-bytes identifier of the incoming request. Must be a hex representation of 8-byte array.
-     * Also know as the parentId, used to link requests together
-     * https://www.w3.org/TR/trace-context/#parent-id
-     */
-    setSpanId(newValue: string): void;
-
-    /**
-     * An integer representation of the W3C TraceContext trace-flags.
-     */
-    getTraceFlags(): number | undefined;
-
-    /**
-     * https://www.w3.org/TR/trace-context/#trace-flags
-     * @param newValue
-     */
-    setTraceFlags(newValue?: number): void;
-}

package/src/JavaScriptSDK.Interfaces/IInstrumentHooks.ts

@@ -1,100 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import { IUnloadHook } from "./IUnloadHook";
-
-/**
- * A callback function that will be called for the wrapped instrumentation function
- * before the original function is executed.
- */
-export type InstrumentorHooksCallback = (funcArgs:IInstrumentCallDetails, ...orgArgs: any[]) => void;
-
-/**
- * The callbacks to call for the instrumented function, you must provide at least the request and/or response callbacks, both are not required.
- * You must always supply the error callback
- */
-export interface IInstrumentHooksCallbacks {
-    /**
-     * [Optional] Namespace details (same as the namespace used for events), useful for debugging and testing to
-     * identify the source of the instrumented hooks
-     */
-    ns?: string | string[];
-
-    /**
-     * The hook callback to call before the original function is called
-     */
-    req?: InstrumentorHooksCallback;
-
-    /**
-     * The hook callback to call after the original function was called
-     */
-    rsp?: InstrumentorHooksCallback;
-
-    /**
-     * The callback to call if the hook function causes an exception
-     */
-    hkErr?: InstrumentorHooksCallback;
-
-    /**
-     * The callback to call if the original function causes an exception, even if you
-     * supply a callback the original exception will still be thrown
-     */
-    fnErr?: InstrumentorHooksCallback;
-}
-
-/**
- * The holder of the specific instance callback
- */
-export interface IInstrumentHook extends IUnloadHook {
-    /** Unique Id for this callback on the hooked method */
-    id: number;
-
-    /** Holds the callbacks */
-    cbks: IInstrumentHooksCallbacks;
-
-    /** Remove this hook from the function */
-    rm: () => void;
-}
-
-export interface IInstrumentHooks {
-    i: number;               // Used to create unique ids
-    n: string;               // Function name
-    f: any;                  // Original Function
-    h: IInstrumentHook[];    // The hook
-}
-
-export interface IInstrumentCallDetails {
-    name: string;
-    inst: any;
-
-    /**
-     * This returns an object that the hook function can use to store hook specific
-     * context, it it not shared with any other hook instances and is unique for the
-     * current call.
-     * A hook implementation can use this to pass / share context between different
-     * hook callbacks eg. request/response requst/hookErrors etc.
-     */
-    ctx: () => any;
-
-    /**
-     * Allows the hook functions to replace the original arguments
-     * @param idx - The argument index (0 based)
-     * @param value - The new value for the argument
-     */
-    set: (idx:number, value:any) => void;
-
-    /**
-     * The result of the original method, only populated after the original method has returned
-     */
-    rslt?: any;
-
-    /**
-     * The error (exception) which occurred while executing the original method
-     */
-    err?: Error;
-
-    /**
-     * The Event object from (window.event) at the start of the original call
-     */
-    evt?: Event;
-}

package/src/JavaScriptSDK.Interfaces/INotificationListener.ts

@@ -1,39 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-"use strict";
-
-import { ITelemetryItem } from "./ITelemetryItem";
-import { IPerfEvent } from "./IPerfEvent";
-
-/**
- * An interface used for the notification listener.
- * @interface
- */
-export interface INotificationListener {
-    /**
-     * [Optional] A function called when events are sent.
-     * @param events - The array of events that have been sent.
-     */
-    eventsSent?: (events: ITelemetryItem[]) => void;
-    /**
-     * [Optional] A function called when events are discarded.
-     * @param events - The array of events that have been discarded.
-     * @param reason - The reason for discarding the events. The EventsDiscardedReason
-     * constant should be used to check the different values.
-     */
-    eventsDiscarded?: (events: ITelemetryItem[], reason: number) => void;
-
-    /**
-     * [Optional] A function called when the events have been requested to be sent to the sever.
-     * @param sendReason - The reason why the event batch is being sent.
-     * @param isAsync - A flag which identifies whether the requests are being sent in an async or sync manner.
-     */
-    eventsSendRequest?: (sendReason: number, isAsync?: boolean) => void;
-
-    /**
-     * [Optional] This event is sent if you have enabled perf events, they are primarily used to track internal performance testing and debugging
-     * the event can be displayed via the debug plugin extension.
-     * @param perfEvent
-     */
-    perfEvent?: (perfEvent: IPerfEvent) => void;
-}

package/src/JavaScriptSDK.Interfaces/INotificationManager.ts

@@ -1,52 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-import { ITelemetryItem } from "../JavaScriptSDK.Interfaces/ITelemetryItem";
-import { INotificationListener } from "../JavaScriptSDK.Interfaces/INotificationListener";
-import { IPerfEvent } from "./IPerfEvent";
-
-/**
- * Class to manage sending notifications to all the listeners.
- */
-export interface INotificationManager {
-    listeners: INotificationListener[];
-
-    /**
-     * Adds a notification listener.
-     * @param listener - The notification listener to be added.
-     */
-    addNotificationListener(listener: INotificationListener): void;
-
-    /**
-     * Removes all instances of the listener.
-     * @param listener - AWTNotificationListener to remove.
-     */
-    removeNotificationListener(listener: INotificationListener): void;
-
-    /**
-     * Notification for events sent.
-     * @param events - The array of events that have been sent.
-     */
-    eventsSent(events: ITelemetryItem[]): void;
-
-    /**
-     * Notification for events being discarded.
-     * @param events - The array of events that have been discarded by the SDK.
-     * @param reason - The reason for which the SDK discarded the events. The EventsDiscardedReason
-     * constant should be used to check the different values.
-     */
-    eventsDiscarded(events: ITelemetryItem[], reason: number): void;
-
-    /**
-     * [Optional] A function called when the events have been requested to be sent to the sever.
-     * @param sendReason - The reason why the event batch is being sent.
-     * @param isAsync - A flag which identifies whether the requests are being sent in an async or sync manner.
-     */
-    eventsSendRequest?(sendReason: number, isAsync: boolean): void;
-
-    /**
-     * [Optional] This event is sent if you have enabled perf events, they are primarily used to track internal performance testing and debugging
-     * the event can be displayed via the debug plugin extension.
-     * @param perfEvent - The perf event details
-     */
-    perfEvent?(perfEvent: IPerfEvent): void;
-}

package/src/JavaScriptSDK.Interfaces/IPerfEvent.ts

@@ -1,69 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-/**
- * This interface identifies the details of an internal performance event - it does not represent an outgoing reported event
- */
-export interface IPerfEvent {
-    /**
-     * The name of the performance event
-     */
-    name: string;
-
-    /**
-     * The start time of the performance event
-     */
-    start: number;
-
-    /**
-     * The payload (contents) of the perfEvent, may be null or only set after the event has completed depending on
-     * the runtime environment.
-     */
-    payload: any;
-
-    /**
-     * Is this occurring from an asynchronous event
-     */
-    isAsync: boolean;
-    
-    /**
-     * Identifies the total inclusive time spent for this event, including the time spent for child events,
-     * this will be undefined until the event is completed
-     */
-    time?: number;
-
-    /**
-     * Identifies the exclusive time spent in for this event (not including child events),
-     * this will be undefined until the event is completed.
-     */
-    exTime?: number;
-    /**
-     * The Parent event that was started before this event was created
-     */
-    parent?: IPerfEvent;
-
-    /**
-     * The child perf events that are contained within the total time of this event.
-     */
-    childEvts?: IPerfEvent[];
-
-    /**
-     * Identifies whether this event is a child event of a parent
-     */
-    isChildEvt: () => boolean;
-
-    /**
-     * Get the names additional context associated with this perf event
-     */
-    getCtx?: (key: string) => any;
-
-    /**
-     * Set the named additional context to be associated with this perf event, this will replace any existing value
-     */
-    setCtx?: (key: string, value: any) => void;
-
-    /**
-     * Mark this event as completed, calculating the total execution time.
-     */
-    complete: () => void;
-}

package/src/JavaScriptSDK.Interfaces/IPerfManager.ts

@@ -1,53 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-import { IPerfEvent } from "./../JavaScriptSDK.Interfaces/IPerfEvent";
-
-/**
- * Identifies an interface to a host that can provide an IPerfManager implementation
- */
-export interface IPerfManagerProvider {
-    /**
-     * Get the current performance manager
-     */
-    getPerfMgr(): IPerfManager;
-
-    /**
-     * Set the current performance manager
-     * @param perfMgr - The performance manager
-     */
-    setPerfMgr(perfMgr: IPerfManager): void;
-}
-
-/**
- * This defines an internal performance manager for tracking and reporting the internal performance of the SDK -- It does
- * not represent or report any event to the server.
- */
-export interface IPerfManager {
-    /**
-     * Create a new event and start timing, the manager may return null/undefined to indicate that it does not
-     * want to monitor this source event.
-     * @param src - The source name of the event
-     * @param payloadDetails - An optional callback function to fetch the payload details for the event.
-     * @param isAsync - Is the event occurring from a async event
-     */
-    create(src: string, payloadDetails?: () => any, isAsync?: boolean): IPerfEvent | null | undefined;
-
-    /**
-     * Complete the perfEvent and fire any notifications.
-     * @param perfEvent - Fire the event which will also complete the passed event
-     */
-    fire(perfEvent: IPerfEvent): void;
-
-    /**
-     * Set an execution context value
-     * @param key - The context key name
-     * @param value - The value
-     */
-    setCtx(key: string, value: any): void;
-
-    /**
-     * Get the execution context value
-     * @param key - The context key
-     */
-    getCtx(key: string): any;
-}

package/src/JavaScriptSDK.Interfaces/IProcessTelemetryContext.ts

@@ -1,157 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-"use strict";
-
-import { IConfigDefaults } from "../Config/IConfigDefaults";
-import { IAppInsightsCore } from "./IAppInsightsCore";
-import { IConfiguration } from "./IConfiguration";
-import { IDiagnosticLogger } from "./IDiagnosticLogger";
-import { ITelemetryItem } from "./ITelemetryItem";
-import { IPlugin, ITelemetryPlugin } from "./ITelemetryPlugin";
-import { ITelemetryPluginChain } from "./ITelemetryPluginChain";
-import { ITelemetryUnloadState } from "./ITelemetryUnloadState";
-import { ITelemetryUpdateState } from "./ITelemetryUpdateState";
-
-// export const enum GetExtCfgMergeType {
-//     None = 0,
-//     MergeDefaultOnly = 1,
-//     MergeDefaultFromRootOrDefault = 2,
-// }
-
-export interface IBaseProcessingContext {
-    /**
-     * The current core instance for the request
-     */
-    core: () => IAppInsightsCore;
-
-    /**
-     * THe current diagnostic logger for the request
-     */
-    diagLog: () => IDiagnosticLogger;
-
-    /**
-     * Gets the current core config instance
-     */
-    getCfg: () => IConfiguration;
-
-    /**
-     * Gets the named extension config
-     */
-    getExtCfg: <T>(identifier: string, defaultValue?: IConfigDefaults<T>) => T;
-
-    /**
-     * Gets the named config from either the named identifier extension or core config if neither exist then the
-     * default value is returned
-     * @param identifier - The named extension identifier
-     * @param field - The config field name
-     * @param defaultValue - The default value to return if no defined config exists
-     */
-    getConfig: (identifier: string, field: string, defaultValue?: number | string | boolean | string[] | RegExp[] | Function) => number | string | boolean | string[] | RegExp[] | Function;
-
-    /**
-     * Helper to allow plugins to check and possibly shortcut executing code only
-     * required if there is a nextPlugin
-     */
-    hasNext: () => boolean;
-
-    /**
-     * Returns the next configured plugin proxy
-     */
-    getNext: () => ITelemetryPluginChain;
-
-    /**
-     * Helper to set the next plugin proxy
-     */
-    setNext: (nextCtx: ITelemetryPluginChain) => void;
-
-    /**
-     * Synchronously iterate over the context chain running the callback for each plugin, once
-     * every plugin has been executed via the callback, any associated onComplete will be called.
-     * @param callback - The function call for each plugin in the context chain
-     */
-    iterate: <T extends ITelemetryPlugin = ITelemetryPlugin>(callback: (plugin: T) => void) => void;
-
-    /**
-     * Set the function to call when the current chain has executed all processNext or unloadNext items.
-     * @param onComplete - The onComplete to call
-     * @param that - The "this" value to use for the onComplete call, if not provided or undefined defaults to the current context
-     * @param args - Any additional arguments to pass to the onComplete function
-     */
-    onComplete: (onComplete: () => void, that?: any, ...args: any[]) => void;
-
-    /**
-     * Create a new context using the core and config from the current instance, returns a new instance of the same type
-     * @param plugins - The execution order to process the plugins, if null or not supplied
-     *                  then the current execution order will be copied.
-     * @param startAt - The plugin to start processing from, if missing from the execution
-     *                  order then the next plugin will be NOT set.
-     */
-    createNew: (plugins?: IPlugin[] | ITelemetryPluginChain, startAt?: IPlugin) => IBaseProcessingContext;
-}
-
-/**
- * The current context for the current call to processTelemetry(), used to support sharing the same plugin instance
- * between multiple AppInsights instances
- */
-export interface IProcessTelemetryContext extends IBaseProcessingContext {
-    /**
-     * Call back for telemetry processing before it it is sent
-     * @param env - This is the current event being reported
-     * @returns boolean (true) if there is no more plugins to process otherwise false or undefined (void)
-     */
-    processNext: (env: ITelemetryItem) => boolean | void;
-
-    /**
-     * Create a new context using the core and config from the current instance, returns a new instance of the same type
-     * @param plugins - The execution order to process the plugins, if null or not supplied
-     *                  then the current execution order will be copied.
-     * @param startAt - The plugin to start processing from, if missing from the execution
-     *                  order then the next plugin will be NOT set.
-     */
-     createNew: (plugins?: IPlugin[] | ITelemetryPluginChain, startAt?: IPlugin) => IProcessTelemetryContext;
-}
-
-/**
- * The current context for the current call to teardown() implementations, used to support when plugins are being removed
- * or the SDK is being unloaded.
- */
-export interface IProcessTelemetryUnloadContext extends IBaseProcessingContext {
-
-    /**
-     * This Plugin has finished unloading, so unload the next one
-     * @param uploadState - The state of the unload process
-     * @returns boolean (true) if there is no more plugins to process otherwise false or undefined (void)
-     */
-    processNext: (unloadState: ITelemetryUnloadState) => boolean | void;
-
-    /**
-     * Create a new context using the core and config from the current instance, returns a new instance of the same type
-     * @param plugins - The execution order to process the plugins, if null or not supplied
-     *                  then the current execution order will be copied.
-     * @param startAt - The plugin to start processing from, if missing from the execution
-     *                  order then the next plugin will be NOT set.
-     */
-     createNew: (plugins?: IPlugin[] | ITelemetryPluginChain, startAt?: IPlugin) => IProcessTelemetryUnloadContext;
-}
-
-/**
- * The current context for the current call to the plugin update() implementations, used to support the notifications
- * for when plugins are added, removed or the configuration was changed.
- */
-export interface IProcessTelemetryUpdateContext extends IBaseProcessingContext {
-    /**
-     * This Plugin has finished unloading, so unload the next one
-     * @param updateState - The update State
-     * @returns boolean (true) if there is no more plugins to process otherwise false or undefined (void)
-     */
-    processNext: (updateState: ITelemetryUpdateState) => boolean | void;
-
-    /**
-     * Create a new context using the core and config from the current instance, returns a new instance of the same type
-     * @param plugins - The execution order to process the plugins, if null or not supplied
-     *                  then the current execution order will be copied.
-     * @param startAt - The plugin to start processing from, if missing from the execution
-     *                  order then the next plugin will be NOT set.
-     */
-     createNew: (plugins?: IPlugin[] | ITelemetryPluginChain, startAt?: IPlugin) => IProcessTelemetryUpdateContext;
-}

package/src/JavaScriptSDK.Interfaces/ITelemetryInitializers.ts

@@ -1,17 +0,0 @@
-import { ITelemetryItem } from "./ITelemetryItem";
-import { ILegacyUnloadHook } from "./IUnloadHook";
-
-export declare type TelemetryInitializerFunction = <T extends ITelemetryItem>(item: T) => boolean | void;
-
-export interface ITelemetryInitializerHandler extends ILegacyUnloadHook {
-    remove(): void;
-}
-
-export interface ITelemetryInitializerContainer {
-    /**
-     * Add a telemetry processor to decorate or drop telemetry events.
-     * @param telemetryInitializer - The Telemetry Initializer function
-     * @returns - A ITelemetryInitializerHandler to enable the initializer to be removed
-     */
-    addTelemetryInitializer(telemetryInitializer: TelemetryInitializerFunction): ITelemetryInitializerHandler | void;
-}

package/src/JavaScriptSDK.Interfaces/ITelemetryItem.ts

@@ -1,62 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-"use strict";
-
-/**
- * Telemety item supported in Core
- */
-export interface ITelemetryItem {
-    /**
-     * CommonSchema Version of this SDK
-     */
-    ver?: string;
-
-    /**
-     * Unique name of the telemetry item
-     */
-    name: string;
-
-    /**
-     * Timestamp when item was sent
-     */
-    time?: string;
-
-    /**
-     * Identifier of the resource that uniquely identifies which resource data is sent to
-     */
-    iKey?: string;
-
-    /**
-     * System context properties of the telemetry item, example: ip address, city etc
-     */
-    ext?: {[key: string]: any};
-
-    /**
-     * System context property extensions that are not global (not in ctx)
-     */
-    tags?: Tags & Tags[]; // Tags[] will be deprecated.
-
-    /**
-     * Custom data
-     */
-    data?:ICustomProperties;
-
-    /**
-     * Telemetry type used for part B
-     */
-    baseType?: string;
-
-    /**
-     * Based on schema for part B
-     */
-    baseData?: { [key: string]: any };
-
-}
-
-export interface Tags {
-    [key: string]: any;
-}
-
-export interface ICustomProperties {
-    [key: string]: any;
-}