@microsoft/1ds-post-js 4.0.0 → 4.0.2-nightly3.2307-24

package/README.md

@@ -1,13 +1,3 @@
----
-ArtifactType: npm package.
-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 Post Plugin
 
 ## Description
@@ -15,7 +5,7 @@ ms.reviewedBy: ramthi
 
 ## npm
 
-Packages available [here](https://msasg.visualstudio.com/Shared%20Data/_artifacts/feed/1DS-SDK/Npm/%40microsoft%2F1ds-post-js/overview/4.0.0).
+Packages available [here](https://www.npmjs.com/package/@microsoft/1ds-post-js).
 
 ## Basic Usage
 
@@ -46,7 +36,7 @@ appInsightsCore.initialize(coreConfig, []);
 
 ## Configuration
 
-### [IChannelConfiguration](https://1dsdocs.azurewebsites.net/api/webSDK/chnl/post/3.0/f/interfaces/ichannelconfiguration.html)
+### [IChannelConfiguration](https://microsoft.github.io/ApplicationInsights-JS/webSdk/1ds-post-js/interfaces/IChannelConfiguration.html)
 
 | Config | Description | Type
 |----------------|--------------|----
@@ -61,7 +51,7 @@ appInsightsCore.initialize(coreConfig, []);
 |  payloadPreprocessor |POST channel preprocessing function. Can be used to gzip the payload (and set appropriate HTTP headers) before transmission. |[Function](./src/DataModels.ts)
 |  payloadListener |POST channel function hook to listen to events being sent, called after the batched events have been committed to be sent. Also used by Remote DDV Channel to send requests. |[Function](./src/DataModels.ts)
 | disableEventTimings | [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 users require this level of detail and it's now possible to get the same metrics via the IPerfManager and IPerfEvent, so you can now disabled this previous level. 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. | boolean
-| valueSanitizer | [Optional] The value sanitizer to use while constructing the envelope, if not provided the default sanitizeProperty() method is called to validate and convert the fields for serialization. The path / fields names are based on the format of the envelope (serialized object) as defined via the [Common Schema 4.0](https://1dsdocs.azurewebsites.net/schema/README.html) specification. | IValueSanitizer
+| valueSanitizer | [Optional] The value sanitizer to use while constructing the envelope, if not provided the default sanitizeProperty() method is called to validate and convert the fields for serialization. The path / fields names are based on the format of the envelope (serialized object) as defined via the [Common Schema 4.0](https://aka.ms/CommonSchema) specification. | IValueSanitizer
 | stringifyObjects | [Optional] During serialization, when an object is identified should the object serialized by true => JSON.stringify(theObject); otherwise theObject.toString(). Defaults to false. | boolean
 | enableCompoundKey | [Optional] Enables support for objects with compound keys which indirectly represent an object eg. event: { "somedata.embeddedvalue": 123 }  where the "key" of the object contains a "." as part of it's name.  Defaults to false. | boolean
 | disableOptimizeObj | [Optional] Switch to disable the v8 `optimizeObject()` calls used to provide better serialization performance. Defaults to false. | boolean
@@ -77,7 +67,7 @@ appInsightsCore.initialize(coreConfig, []);
 | maxUnloadEventRetryAttempts<br /><sub><i>(Since 3.1.11+)</i></sub> | [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.<br/>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. | number<br/>Default: 2
 | addNoResponse <br /><sub><i>(Since 3.2.8+)</i></sub> | [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. | boolean<br/>Default: true
 
-### [IXHROverride](https://1dsdocs.azurewebsites.net/api/webSDK/chnl/post/3.0/f/interfaces/ixhroverride.html)
+### [IXHROverride](https://microsoft.github.io/ApplicationInsights-JS/webSdk/1ds-post-js/interfaces/IXHROverride.html)
 
 |  Config   | Description | Type
 |----------------|----------------------------------------|----|
@@ -261,16 +251,16 @@ let postChannelConfig: IChannelConfiguration = {
 To ensure that the service can continue to accept events that are sent from the SDK, some paths and fields are explicitly blocked and are never processed
 via any configured valueSanitizer. These fields are blocked at the serialization level and cannot be overridden.
 
-The path / fields names are based on the format of the envelope (serialized object) as defined via the [Common Schema 4.0](https://1dsdocs.azurewebsites.net/schema/README.html) specification, so the path / field names used for the IValueSanitizer are based on how the data is serialized to the service (CS 4.0 location) and not specifically the location
+The path / fields names are based on the format of the envelope (serialized object) as defined via the [Common Schema 4.0](https://aka.ms/CommonSchema) specification, so the path / field names used for the IValueSanitizer are based on how the data is serialized to the service (CS 4.0 location) and not specifically the location
 on the event object you pass into the track methods (unless they are the same).
 
 The currently configured set of fields include
 
 ### Excluded Part A fields
 
-- All direct top-level fields of the envelope, this includes "ver"; "name"; "time" and "iKey". see [Common Schema 4.0 - Part A](https://1dsdocs.azurewebsites.net/schema/PartA/README.html) for all defined fields. Note: This exclusion does does not match sub-keys (objects) like "ext", "data" and "properties".
-- All fields of the web extension, this includes all fields and sub keys of "ext.web" (example fields include "ext.web.browser"; "ext.web.domain"; "ext.web.consentDetails"). see [Common Schema 4.0 - Part A Extension - web](https://1dsdocs.azurewebsites.net/schema/PartA/web.html) for the complete set of defined fields.
-- All fields and paths of the metadata extension, this includes all fields and sub keys of "ext.metadata". see [Common Schema 4.0 - Part A Extension - metadata](https://1dsdocs.azurewebsites.net/schema/PartA/metadata.html) for the complete set of defined fields.
+- All direct top-level fields of the envelope, this includes "ver"; "name"; "time" and "iKey". see [Common Schema 4.0 - Part A](https://aka.ms/CommonSchema/PartA) for all defined fields. Note: This exclusion does does not match sub-keys (objects) like "ext", "data" and "properties".
+- All fields of the web extension, this includes all fields and sub keys of "ext.web" (example fields include "ext.web.browser"; "ext.web.domain"; "ext.web.consentDetails"). see [Common Schema 4.0 - Part A Extension - web](https://aka.ms/CommonSchema/PartA/Web) for the complete set of defined fields.
+- All fields and paths of the metadata extension, this includes all fields and sub keys of "ext.metadata". see [Common Schema 4.0 - Part A Extension - metadata](https://aka.ms/CommonSchema/PartA/MetaData) for the complete set of defined fields.
 
 ## Synchronous Events
 
@@ -323,17 +313,11 @@ There are effectively 2 scenarios where you should consider adding the `sync` pr
 
 ## API documentation
 
-[https://1dsdocs.azurewebsites.net/api/webSDK/chnl/post/3.0/f/index.html](https://1dsdocs.azurewebsites.net/api/webSDK/chnl/post/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-post-js/index.html)
 
 ## 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 getting started](https://aka.ms/1dsjs).
 
 ## Data Collection