fiftyone.devicedetection.cloud 4.4.132 → 4.4.133

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fiftyone.devicedetection.cloud",
-  "version": "4.4.132",
+  "version": "4.4.133",
   "description": "Device detection cloud services for the 51Degrees Pipeline API",
   "keywords": [
     "51degrees",

package/readme.md

@@ -13,33 +13,54 @@ The device detection cloud engine makes use of the 51Degrees cloud API. As such
 
 This package requires the following additional packages:
 
-- **fiftyone.devicedetection.shared** - A Node.js module which contains shared functionality to build cloud and on-premise engines.
+- [**fiftyone.devicedetection.shared**](/fiftyone.devicedetection.shared#readme) - A Node.js module which contains shared functionality to build cloud and on-premise engines.
 
 ### Installation
 
 Using NPM call:
 
-`npm install fiftyone.devicedetection.cloud`
+```
+npm install fiftyone.devicedetection.cloud
+```
 
 ### Examples
 
-- **configureFromFile.js** - This example shows how to configure a pipeline from a configuration file using the pipelinebuilder's buildFromConfigurationFile method.
-- **failureToMatch.js** - This example shows how the hasValue function can help make sure that meaningful values are returned when checking properties returned from the device detection engine. It also illustrates how the "allowUnmatched" parameters can be used to alter these results.
-- **gettingStarted.js** - Getting started example of using the 51Degrees device detection 'Hash' algorithm to determine whether a given User-Agent corresponds to a mobile device or not.
-- **metaData.js** - This example shows how to get properties from a pipeline's processed flowData based on their metadata, the getProperties() method and also additional meta data properties on device detection data.
-- **webIntegration.js** - This example demonstrates the evidence.addFromRequest() method and client side JavaScript overrides by creating a web server, serving JavaScript created by the device detection engine and bundled together by a special JavaScript bundler engine. This JavaScript is then used on the client side to save a cookie so that when the device detection engine next processes the request (using the addFromRequest() method) it has a more accurate reading for properties set on the client side.
+For details of how to run the examples, please refer to [run examples](/run_examples.md).
+The tables below describe the examples that are available.
+
+| Example                                | Description |
+|----------------------------------------|-------------|
+| [configurator-console](/fiftyone.devicedetection.cloud/examples/cloud/configurator-console)                   | Shows how to call the cloud with the created key and how to access the values of the selected properties.|
+| [gettingstarted-console](/fiftyone.devicedetection.cloud/examples/cloud/gettingstarted-console)                 | How to use the 51Degrees Cloud service to determine details about a device based on its User-Agent and User-Agent Client Hints HTTP header values. |
+| [gettingstarted-web](/fiftyone.devicedetection.cloud/examples/cloud/gettingstarted-web)                     | How to use the 51Degrees Cloud service to determine details about a device as part of a simple web server. |
+| [metadata-console](/fiftyone.devicedetection.cloud/examples/cloud/metadata-console)                       | How to access the meta-data that relates to the device detection algorithm. |
+| [nativemodellookup-console](/fiftyone.devicedetection.cloud/examples/cloud/nativemodellookup-console)              | How to get device details based on a given 'native model name' using the 51Degrees cloud service. |
+| [taclookup-console](/fiftyone.devicedetection.cloud/examples/cloud/taclookup-console)                      | How to get device details based on a given TAC (Type Allocation Code) using the 51Degrees cloud service. |
+| [useragentclienthints-web](/fiftyone.devicedetection.cloud/examples/cloud/useragentclienthints-web)               | This is now deprecated. Kept for testing purposes. Please see **gettingstarted-web** instead.
+
 
 ## Tests
 
 In this repository, there are tests for the examples. 
 You will need to install jest to run them:
 
-`npm install jest --global`
+```
+npm install jest --global
+```
 
 You will also need to install any required packages for the examples in the **Examples** section.
 
-You need to obtain a 51Degrees cloud resource key from the [51Degrees Cloud Configurator](https://configure.51degrees.com/) and assign it to the environment variable `RESOURCE_KEY` in your test environment.
+Add a 51Degrees cloud resource key in the fiftyone.devicedetection/package.json file for cloud tests. You can obtain a resource key from the [51Degrees Cloud Configurator](https://configure.51degrees.com/) and assign it to the environment variable `RESOURCE_KEY` in your test environment.
+
+There are other environment variables that you will also need to set in your test environment before running all tests:
+- `TEST_SUPER_RESOURCE_KEY`: This key contains all `SetHeader*` properties.
+- `TEST_PLATFORM_RESOURCE_KEY`: This key contains only the `SetHeaderPlatform*` property but no other `SetHeader` properties.
+- `TEST_HARDWARE_RESOURCE_KEY`: This key contains only the `SetHeaderHardware*` property but no other `SetHeader` properties.
+- `TEST_BROWSER_RESOURCE_KEY`: This key contains only the `SetHeaderBrowser*` property but no other `SetHeader` properties.
+- `TEST_NO_SETHEADER_RESOURCE_KEY`: This key contains no `SetHeader` properties.
 
-To run the tests, navigate to the module directory and execute:
+To run the tests, execute the following command in the root directory or a sub-module directory:
 
-`npm test`
+```
+npm test
+```