@microsoft/applicationinsights-core-js 3.0.0-beta.2303-02 → 3.0.0-beta.2303-04

package/src/JavaScriptSDK.Interfaces/ITelemetryPlugin.ts

@@ -1,94 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-"use strict";
-
-import { IAppInsightsCore } from "./IAppInsightsCore";
-import { IConfiguration } from "./IConfiguration";
-import { IProcessTelemetryContext, IProcessTelemetryUnloadContext, IProcessTelemetryUpdateContext } from "./IProcessTelemetryContext";
-import { ITelemetryItem } from "./ITelemetryItem";
-import { ITelemetryPluginChain } from "./ITelemetryPluginChain";
-import { ITelemetryUnloadState } from "./ITelemetryUnloadState";
-import { ITelemetryUpdateState } from "./ITelemetryUpdateState";
-
-export interface ITelemetryProcessor {
-    /**
-     * Call back for telemetry processing before it it is sent
-     * @param env - This is the current event being reported
-     * @param itemCtx - This is the context for the current request, ITelemetryPlugin instances
-     * can optionally use this to access the current core instance or define / pass additional information
-     * to later plugins (vs appending items to the telemetry item)
-     */
-    processTelemetry: (env: ITelemetryItem, itemCtx?: IProcessTelemetryContext) => void;
-   
-    /**
-     * The the plugin should re-evaluate configuration and update any cached configuration settings or
-     * plugins. If implemented this method will be called whenever a plugin is added or removed and if
-     * the configuration has bee updated.
-     * @param updateCtx - This is the context that should be used during updating.
-     * @param updateState - The details / state of the update process, it holds details like the current and previous configuration.
-     * @returns boolean - true if the plugin has or will call updateCtx.processNext(), this allows the plugin to perform any asynchronous operations.
-     */
-    update?: (updateCtx: IProcessTelemetryUpdateContext, updateState: ITelemetryUpdateState) => void | boolean;
-}
-
-/**
- * Configuration provided to SDK core
- */
-export interface ITelemetryPlugin extends ITelemetryProcessor, IPlugin {
-    /**
-     * Set next extension for telemetry processing, this is not optional as plugins should use the
-     * processNext() function of the passed IProcessTelemetryContext instead. It is being kept for
-     * now for backward compatibility only.
-     */
-    setNextPlugin?: (next: ITelemetryPlugin | ITelemetryPluginChain) => void;
-    
-    /**
-     * Priority of the extension
-     */
-    readonly priority: number;
-}
-
-export interface IPlugin {
-    /**
-     * Initialize plugin loaded by SDK
-     * @param config - The config for the plugin to use
-     * @param core - The current App Insights core to use for initializing this plugin instance
-     * @param extensions - The complete set of extensions to be used for initializing the plugin
-     * @param pluginChain - [Optional] specifies the current plugin chain which identifies the
-     * set of plugins and the order they should be executed for the current request.
-     */
-    initialize: (config: IConfiguration, core: IAppInsightsCore, extensions: IPlugin[], pluginChain?: ITelemetryPluginChain) => void;
-    
-    /**
-     * Returns a value that indicates whether the plugin has already been previously initialized.
-     * New plugins should implement this method to avoid being initialized more than once.
-     */
-    isInitialized?: () => boolean;
-
-    /**
-     * Tear down the plugin and remove any hooked value, the plugin should be removed so that it is no longer initialized and
-     * therefore could be re-initialized after being torn down. The plugin should ensure that once this has been called any further
-     * processTelemetry calls are ignored and it just calls the processNext() with the provided context.
-     * @param unloadCtx - This is the context that should be used during unloading.
-     * @param unloadState - The details / state of the unload process, it holds details like whether it should be unloaded synchronously or asynchronously and the reason for the unload.
-     * @returns boolean - true if the plugin has or will call processNext(), this for backward compatibility as previously teardown was synchronous and returned nothing.
-     */
-    teardown?: (unloadCtx: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState) => void | boolean;
-
-    /**
-     * Extension name
-     */
-    readonly identifier: string;
-
-    /**
-     * Plugin version (available in data.properties.version in common schema)
-     */
-    readonly version?: string;
-
-    /**
-     * The App Insights core to use for backward compatibility.
-     * Therefore the interface will be able to access the core without needing to cast to "any".
-     * [optional] any 3rd party plugins which are already implementing this interface don't fail to compile.
-     */
-    core?: IAppInsightsCore
-}

package/src/JavaScriptSDK.Interfaces/ITelemetryPluginChain.ts

@@ -1,30 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import { IProcessTelemetryUnloadContext } from "./IProcessTelemetryContext";
-import { ITelemetryPlugin, ITelemetryProcessor } from "./ITelemetryPlugin";
-import { ITelemetryUnloadState } from "./ITelemetryUnloadState";
-
-/**
- * Configuration provided to SDK core
- */
-export interface ITelemetryPluginChain extends ITelemetryProcessor {
-
-    /**
-     * Returns the underlying plugin that is being proxied for the processTelemetry call
-     */
-    getPlugin: () => ITelemetryPlugin;
-
-    /**
-     * Returns the next plugin
-     */
-    getNext: () => ITelemetryPluginChain;
-
-    /**
-     * This plugin is being unloaded and should remove any hooked events and cleanup any global/scoped values, after this
-     * call the plugin will be removed from the telemetry processing chain and will no longer receive any events..
-     * @param unloadCtx - The unload context to use for this call.
-     * @param unloadState - The details of the unload operation
-     */
-    unload?: (unloadCtx: IProcessTelemetryUnloadContext, unloadState: ITelemetryUnloadState) => void;
-}

package/src/JavaScriptSDK.Interfaces/ITelemetryUnloadState.ts

@@ -1,10 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import { TelemetryUnloadReason } from "../JavaScriptSDK.Enums/TelemetryUnloadReason";
-
-export interface ITelemetryUnloadState {
-    reason: TelemetryUnloadReason;
-    isAsync: boolean;
-    flushComplete?: boolean;
-}

package/src/JavaScriptSDK.Interfaces/ITelemetryUpdateState.ts

@@ -1,44 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import { TelemetryUpdateReason } from "../JavaScriptSDK.Enums/TelemetryUpdateReason";
-import { IConfiguration } from "./IConfiguration";
-import { IPlugin } from "./ITelemetryPlugin";
-
-export interface ITelemetryUpdateState {
-
-    /**
-     * Identifies the reason for the update notification, this is a bitwise numeric value
-     */
-    reason: TelemetryUpdateReason;
-
-    /**
-     * This is a new active configuration that should be used
-     */
-    cfg?: IConfiguration,
-
-    /**
-     * The detected changes
-     */
-    oldCfg?: IConfiguration,
-
-     /**
-     * If this is a configuration update this was the previous configuration that was used
-     */
-    newConfig?: IConfiguration,
-
-    /**
-     * Was the new config requested to be merged with the existing config
-     */
-    merge?: boolean,
-
-    /**
-     * This holds a collection of plugins that have been added (if the reason identifies that one or more plugins have been added)
-     */
-    added?: IPlugin[];
-
-    /**
-     * This holds a collection of plugins that have been removed (if the reason identifies that one or more plugins have been removed)
-     */
-    removed?: IPlugin[]
-}

package/src/JavaScriptSDK.Interfaces/ITraceParent.ts

@@ -1,38 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-/**
- * This interface represents the components of a W3C traceparent header
- */
-export interface ITraceParent {
-    /**
-     * The version of the definition, this MUST be a string with a length of 2 and only contain lowercase
-     * hexadecimal characters. A value of 'ff' is considered to be an invalid version.
-     */
-    version: string;
-
-    /**
-     * This is the ID of the whole trace forest and is used to uniquely identify a distributed trace
-     * through a system. It is represented as a 32-character string of lowercase hexadecimal characters,
-     * for example, 4bf92f3577b34da6a3ce929d0e0e4736.
-     * All characters as zero (00000000000000000000000000000000) is considered an invalid value.
-     */
-    traceId: string;
-
-    /**
-     * This is the ID of the current request as known by the caller (in some tracing systems, this is also
-     * known as the parent-id, where a span is the execution of a client request). It is represented as an
-     * 16-character string of lowercase hexadecimal characters, for example, 00f067aa0ba902b7.
-     * All bytes as zero (0000000000000000) is considered an invalid value.
-     */
-    spanId: string;
-
-    /**
-     * An 8-bit value of flags that controls tracing such as sampling, trace level, etc. These flags are
-     * recommendations given by the caller rather than strict rules to follow.
-     * As this is a bit field, you cannot interpret flags by decoding the hex value and looking at the resulting
-     * number. For example, a flag 00000001 could be encoded as 01 in hex, or 09 in hex if present with the flag
-     * 00001000. A common mistake in bit fields is forgetting to mask when interpreting flags.
-     */
-    traceFlags: number;
-}

package/src/JavaScriptSDK.Interfaces/IUnloadHook.ts

@@ -1,22 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-/**
- * An interface which provides automatic removal during unloading of the component
- */
-export interface IUnloadHook {
-    /**
-     * Self remove the referenced component
-     */
-    rm: () => void;
-}
-
-/**
- * An alternate interface which provides automatic removal during unloading of the component
- */
-export interface ILegacyUnloadHook {
-    /**
-     * Legacy Self remove the referenced component
-     */
-    remove: () => void;
-}

package/src/JavaScriptSDK.Interfaces/IUnloadableComponent.ts

@@ -1,17 +0,0 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
-// Licensed under the MIT License.
-
-import { IProcessTelemetryUnloadContext } from "./IProcessTelemetryContext";
-import { ITelemetryUnloadState } from "./ITelemetryUnloadState";
-
-export interface IUnloadableComponent {
-    /**
-    * Teardown / Unload hook to allow implementations to perform some additional unload operations before the BaseTelemetryPlugin
-    * finishes it's removal.
-    * @param unloadCtx - This is the context that should be used during unloading.
-    * @param unloadState - The details / state of the unload process, it holds details like whether it should be unloaded synchronously or asynchronously and the reason for the unload.
-    * @param asyncCallback - An optional callback that the plugin must call if it returns true to inform the caller that it has completed any async unload/teardown operations.
-    * @returns boolean - true if the plugin has or will call asyncCallback, this allows the plugin to perform any asynchronous operations.
-    */
-    _doUnload?: (unloadCtx?: IProcessTelemetryUnloadContext, unloadState?: ITelemetryUnloadState, asyncCallback?: () => void) => void | boolean;
-}