@microsoft/1ds-core-js 4.0.1 → 4.0.2-nightly3.2307-25

package/README.md

@@ -1,13 +1,3 @@
----
-ArtifactType: npm package, javascript from CDN.
-Documentation: https://1dsdocs.azurewebsites.net/getting-started/javascript-getting_started.html
-Language: typescript
-Platform: various
-Stackoverflow: N/A
-Tags: 1DSJSSDK
-ms.reviewedAt: 02/21/2019
-ms.reviewedBy: ramthi
----
 # Microsoft 1DS Web SDK Core
 
 ## Description
@@ -16,7 +6,7 @@ ms.reviewedBy: ramthi
 
 ## npm
 
-Packages available [here](https://msasg.visualstudio.com/Shared%20Data/_artifacts/feed/1DS-SDK/Npm/%40microsoft%2F1ds-core-js/overview/4.0.1).
+Packages available [here](https://www.npmjs.com/package/@microsoft/1ds-core-js).
 
 ## Basic Usage
 
@@ -37,7 +27,7 @@ appInsightsCore.initialize(coreConfig, []);
 
 ## Configuration
 
-### [IExtendedConfiguration](https://1dsdocs.azurewebsites.net/api/webSDK/utl/core/3.0/f/interfaces/iextendedconfiguration.html)
+### [IExtendedConfiguration](https://microsoft.github.io/ApplicationInsights-JS/webSdk/1ds-core-js/interfaces/IExtendedConfiguration.html)
 
 |  Config   | Description | Type
 |----------------|----------------------------------------|----|
@@ -58,21 +48,21 @@ appInsightsCore.initialize(coreConfig, []);
 | cookiePath | Custom cookie path. This is helpful if you want to share Application Insights cookies behind an application gateway.<br>If `cookieCfg.path` is defined it will take precedence over this value. | alias for [`cookieCfg.path`](#ICookieMgrConfig)<br>[Optional]<br>(Since 3.1.0) |
 |  anonCookieName     |Name of the Anon cookie.  The value will be set in the qsp header to collector requests.  Collector will use this value to look for specific cookie to use for anid property.|string
 | enablePerfMgr | [Optional] When enabled (true) this will create local perfEvents for code that has been instrumented to emit perfEvents (via the doPerf() helper). This can be used to identify performance issues within the SDK based on your usage or optionally within your own instrumented code. [More details are available by the basic documentation](https://github.com/microsoft/ApplicationInsights-JS/blob/master/docs/PerformanceMonitoring.md). Since v2.4.0| boolean<br/>Defaults to false
-| perfEvtsSendAll | [Optional] When _enablePerfMgr_ is enabled and the [IPerfManager](https://github.com/microsoft/ApplicationInsights-JS/blob/master/shared/AppInsightsCore/src/JavaScriptSDK.Interfaces/IPerfManager.ts) fires a [INotificationManager](https://github.com/microsoft/ApplicationInsights-JS/blob/master/shared/AppInsightsCore/src/JavaScriptSDK.Interfaces/INotificationManager.ts).perfEvent() this flag determines whether an event is fired (and sent to all listeners) for all events (true) or only for 'parent' events (false &lt;default&gt;).<br />A parent [IPerfEvent](https://github.com/microsoft/ApplicationInsights-JS/blob/master/shared/AppInsightsCore/src/JavaScriptSDK.Interfaces/IPerfEvent.ts) is an event where no other IPerfEvent is still running at the point of this event being created and it's _parent_ property is not null or undefined. Since v2.4.0 | boolean<br />Defaults to false
+| perfEvtsSendAll | [Optional] When _enablePerfMgr_ is enabled and the [IPerfManager](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-core-js/interfaces/IPerfManager.html) fires a [INotificationManager](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-core-js/interfaces/INotificationManager.html).perfEvent() this flag determines whether an event is fired (and sent to all listeners) for all events (true) or only for 'parent' events (false &lt;default&gt;).<br />A parent [IPerfEvent](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-core-js/interfaces/IPerfEvent.html) is an event where no other IPerfEvent is still running at the point of this event being created and it's _parent_ property is not null or undefined. Since v2.4.0 | boolean<br />Defaults to false
 | idLength | [Optional] Identifies the default length used to generate new random session and user id's. Defaults to 22, previous default value was 5 (v2.4.2 or less), if you need to keep the previous maximum length you should set this value to 5. | number<br />Default: 22 
 | disableEventTimings | [Optional] Disables additional internal event timings that are added during processing of events, the timings are not sent as part telemetry items to the server. | boolean<br/>Default: false
 | enableCompoundKey | [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.<br />Example: <code>event: { "somedata.embeddedvalue": 123 } </code> | boolean<br />Default: false
 | disablePageUnloadEvents | [Optional] An array of the page unload events that you would like to be ignored, special note there must be at least one valid unload event hooked, if you list all or the runtime environment only supports a listed "disabled" event it will still be hooked, if required by the SDK.<br /> Unload events include "beforeunload", "unload", "visibilitychange" (with 'hidden' state) and "pagehide"| string[]<br />Default: not specified
 | disablePageShowEvents | [Optional] An array of page show events that you would like to be ignored, special note there must be at lease one valid show event hooked, if you list all or the runtime environment only supports a listed (disabled) event it will STILL be hooked, if required by the SDK.<br/> Page Show events include "pageshow" and "visibilitychange" (with 'visible' state)| string[]<br /> Default: not specified
 
-### [IPropertyStorageOverride](https://1dsdocs.azurewebsites.net/api/webSDK/utl/core/3.0/f/interfaces/ipropertystorageoverride.html)
+### [IPropertyStorageOverride](https://microsoft.github.io/ApplicationInsights-JS/webSdk/1ds-core-js/interfaces/IPropertyStorageOverride.html)
 
 |  Config   | Description | Type
 |----------------|----------------------------------------|----|
 |  setProperty     |A function for passing key value pairs to be stored.| function
 |  getProperty     | A function that gets a value for a given key.| function
 
-### [ICookieMgrConfig](https://github.com/microsoft/ApplicationInsights-JS/blob/master/shared/AppInsightsCore/src/JavaScriptSDK.Interfaces/ICookieMgr.ts#L53)
+### [ICookieMgrConfig](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-core-js/interfaces/ICookieMgrConfig.html)
 
 Cookie Configuration for instance based cookie management added in version 3.1.0.
 
@@ -91,16 +81,16 @@ Cookie Configuration for instance based cookie management added in version 3.1.0
 
 From version 3.1.0, cookie management is now available directly from the instance and can be disabled and re-enabled after initialization.
 
-If cookie usage is disabled during initialization via the `disableCookiesUsage` configurations, you can now re-enable via the [ICookieMgr](https://github.com/microsoft/ApplicationInsights-JS/blob/master/shared/AppInsightsCore/src/JavaScriptSDK.Interfaces/ICookieMgr.ts) `setEnabled` function.
+If cookie usage is disabled during initialization via the `disableCookiesUsage` configurations, you can now re-enable via the [ICookieMgr](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-core-js/interfaces/ICookieMgr.html) `setEnabled` function.
 
 The instance based cookie management also replaces the previous CoreUtils and global functions of `disableCookies()`, `setCookie(...)`, `getCookie(...)` and `deleteCookie(...)`. And to benefit from the tree-shaking enhancements also introduced as part of version 3.1.0 you should no longer uses the global functions.
 
 ### Simplified Usage of new instance Cookie Manager
 
-- oneDs.[getCookieMgr()](https://github.com/microsoft/ApplicationInsights-JS/blob/master/shared/AppInsightsCore/src/JavaScriptSDK.Interfaces/ICookieMgr.ts).setEnabled(true/false)
-- oneDs.[getCookieMgr()](https://github.com/microsoft/ApplicationInsights-JS/blob/master/shared/AppInsightsCore/src/JavaScriptSDK.Interfaces/ICookieMgr.ts).set("MyCookie", "thevalue");
-- oneDs.[getCookieMgr()](https://github.com/microsoft/ApplicationInsights-JS/blob/master/shared/AppInsightsCore/src/JavaScriptSDK.Interfaces/ICookieMgr.ts).get("MyCookie");
-- oneDs.[getCookieMgr()](https://github.com/microsoft/ApplicationInsights-JS/blob/master/shared/AppInsightsCore/src/JavaScriptSDK.Interfaces/ICookieMgr.ts).del("MyCookie");
+- oneDs.[getCookieMgr()](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-core-js/interfaces/ICookieMgr.html).setEnabled(true/false)
+- oneDs.[getCookieMgr()](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-core-js/interfaces/ICookieMgr.html).set("MyCookie", "thevalue");
+- oneDs.[getCookieMgr()](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-core-js/interfaces/ICookieMgr.html).get("MyCookie");
+- oneDs.[getCookieMgr()](https://microsoft.github.io/ApplicationInsights-JS/webSdk/applicationinsights-core-js/interfaces/ICookieMgr.html).del("MyCookie");
 
 ### Blocking individual cookies
 
@@ -121,17 +111,11 @@ var coreConfig: IExtendedConfiguration = {
 
 ## API documentation
 
-[https://1dsdocs.azurewebsites.net/api/webSDK/utl/core/3.0/f/index.html](https://1dsdocs.azurewebsites.net/api/webSDK/utl/core/3.0/f/index.html)
-
-## Sample App
-
-[React sample App](https://msasg.visualstudio.com/Shared%20Data/_git/1DS.JavaScript.SampleApps.React?path=%2FREADME.md&version=GBmaster&_a=preview).
-
-[React Native sample App](https://msasg.visualstudio.com/Shared%20Data/_git/1DS.JavaScript.SampleApps.ReactNative?path=%2FREADME.md&version=GBmaster&_a=preview).
+[Typedoc generated API reference](https://microsoft.github.io/ApplicationInsights-JS/webSdk/1ds-core-js)
 
 ## Learn More
 
-You can learn more in [1DS First party getting started](https://1dsdocs.azurewebsites.net/getting-started/javascript-getting_started.html).
+You can learn more in [1DS First party (Internal) getting started](https://aka.ms/1dsjs).
 
 ## Data Collection