@esri/telemetry-amazon 0.4.0 → 0.4.3

package/README.md

@@ -1,8 +1,21 @@
-# `ArcGIS Telemetry Amazon`
+# `@esri/telemetry-amazon`
 
-This library exports the `telemetry-amazon` plugin for the `Telemetry.js` package to interact with AWS Analytics store. This package uses the [analytics](https://github.com/DavidWells/analytics) and [@analytics/aws-pinpoint](https://github.com/DavidWells/analytics/tree/master/packages/analytics-plugin-aws-pinpoint) packages.
+> This is a plugin for the `Telemetry.js` package to interact with an AWS Analytics store. This package uses the third-party libraries, [analytics](https://github.com/DavidWells/analytics) and [@analytics/aws-pinpoint](https://github.com/DavidWells/analytics/tree/master/packages/analytics-plugin-aws-pinpoint) packages.
 
-## Installation
+## Table of Contents
+
+- [`@esri/telemetry-amazon`](#esritelemetry-amazon)
+  - [Table of Contents](#table-of-contents)
+  - [How to Use](#how-to-use)
+  - [Amazon Configuration](#amazon-configuration)
+  - [Example](#example)
+      - [`telemetry.logEvent(event)`](#telemetrylogeventevent)
+  - [Telemetry Sharing Permissions](#telemetry-sharing-permissions)
+    - [Portal Items](#portal-items)
+    - [Usage](#usage)
+  - [Issues](#issues)
+  - [Contributing](#contributing)
+  - [License](#license)
 
 ```sh
 npm install @esri/telemetry
@@ -11,7 +24,7 @@ npm install @esri/telemetry-amazon
 
 ## How to Use
 
-`@esri/telemetry-amazon` packages works in the client-side browser and (WIP server-side Node.js). To use, install the package, include it in your project, and create an instance of the plugin, and pass it as an `plugin` with [@esri/telemetry](../../README.md)
+`@esri/telemetry-amazon` packages works in the client-side browser and server-side Node.js. To use, install the package, include it in your project, create an instance of the plugin, and add it to the `plugins` array with [@esri/telemetry](../../README.md)
 
 Below is an example of how to use the telemetry-amazon plugin.
 
@@ -40,39 +53,57 @@ const telemetryOptions = {
 const telemetry = new Telemetry(telemetryOptions);
 
 telemetry.logPageView();
+
 telemetry.logEvent();
 ```
 
-After initializing `Telemetry.js`with the `telemetry-amazon`plugin, telemetry data will be sent to the AWS Pinpoint instance of the provided App.
+After initializing `Telemetry.js` with the `telemetry-amazon` plugin, telemetry data will be sent to the AWS Pinpoint instance of the provided App.
 
-### Amazon Analytics Configuration
+## Amazon Configuration
 
 - Get your app and user pool ID from AWS Pinpoint instance
-- Pass in options for `amazon` when initiating the Telemetry object
+- Pass in options object to create an instance of the plugin
 - the `fips` option determines if AWS FIPS endpoints are used for cognito and pinpoint requests
+- Pass in an object containing the mapping for your custom dimensions and metrics
+
+```js
+// or if you are using optional custom dimensions and/or custom metrics
+const googleTracker = new Amazon({
+  dimensions: {
+    datasetID: 1,
+    attribute: 2,
+    serviceQuery: 3,
+  },
+  metrics: {
+    duration: 1,
+    size: 2,
+  },
+});
+```
 
 If you need to disable tracking you can set `disabled: true` when initializing the `Telemetry` object. Then you can continue to call the methods on your instance of `Telemetry` without throwing exceptions or logging errors.
 
 Additionally, you can disable individual trackers when initializing the `Telemetry` object by passing `disabled: true` in the tracker options.
 
 ```js
-{
-  amazonOptions: {
-    disabled: true,
-    ...
-  }
-}
-
+const amazonTracker = new Amazon({
+  disabled: true,
+});
 ```
 
 Post initialization, it is possible to disable & enable specific trackers using `disableTracker` and `enableTracker` methods.
 
 ```js
 telemetry.disableTracker('amazon');
+
 telemetry.logPageView(); // no amazon page view logged
+
 telemetry.logEvent(); // no amazon event logged
+
 telemetry.enableTracker('amazon');
+
 telemetry.logPageView(); // amazon page view logged
+
 telemetry.logEvent(); // amazon event logged
 ```
 
@@ -109,7 +140,6 @@ telemetry.logEvent(event);
 
 ```js
 import Amazon from '@esri/telemetry-amazon'
-
 ...
 
 const getAccessParams = {
@@ -133,3 +163,29 @@ const setAccessParams = {
 
 const result = await Amazon.setAccessPermissions(setAccessParams: ISetAccessPermissionsParams)
 ```
+
+## Issues
+
+If something isn't working, please take a look at [previously logged issues](https://devtopia.esri.com/WebGIS/arcgis-telemetry.js/issues) first. Have you found a new bug? Create an issue [here](https://devtopia.esri.com/WebGIS/arcgis-telemetry.js/issues/new).
+
+## Contributing
+
+Esri welcomes contributions from anyone and everyone. Please see our [guidelines for contributing](../../CONTRIBUTING.md).
+
+## License
+
+Copyright © 2022 Esri
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+> http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+A copy of the license is available in the repository's [LICENSE](../../LICENSE) file.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/telemetry-amazon",
-  "version": "0.4.0",
+  "version": "0.4.3",
   "description": "Amazon plugin for 'Telemetry.js' library",
   "homepage": "https://devtopia.esri.com/WebGIS/arcgis-telemetry.js/packages/telemetry-amazon#readme",
   "license": "Apache-2.0",
@@ -44,14 +44,14 @@
     "@analytics/aws-pinpoint": "^0.7.1",
     "@esri/arcgis-rest-portal": "^3.4.3",
     "@esri/arcgis-rest-request": "^3.4.3",
-    "@esri/telemetry-shared": "^0.1.5",
+    "@esri/telemetry-shared": "^0.1.6",
     "analytics": "^0.7.18"
   },
   "devDependencies": {
-    "@esri/telemetry": "^4.2.1"
+    "@esri/telemetry": "^5.0.1"
   },
   "peerDependencies": {
-    "@esri/telemetry": "^4.0.0"
+    "@esri/telemetry": "^5.0.0"
   },
-  "gitHead": "0bf2fb00d5b5048ee22f57f973bf06895b733456"
+  "gitHead": "2ae804471adc25bd4545779be01344b145edd4eb"
 }