@chordcommerce/analytics 1.5.1 → 1.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -6
- package/package.json +1 -2
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @chordcommerce/analytics
|
|
2
2
|
|
|
3
3
|
The `@chordcommerce/analytics` library provides simple methods for sending tracking events to Chord from your website, with an optional debugging mode to validate event properties.
|
|
4
4
|
|
|
@@ -6,11 +6,11 @@ The `@chordcommerce/analytics` library provides simple methods for sending track
|
|
|
6
6
|
|
|
7
7
|
Visit [docs.chord.co](https://docs.chord.co/analytics-getting-started) for guides, examples, and an API reference.
|
|
8
8
|
|
|
9
|
-
##
|
|
9
|
+
## Requirements
|
|
10
10
|
|
|
11
11
|
A CDP Javascript library must be installed in your project. Currently, only Segment's [analytics.js](https://www.npmjs.com/package/@segment/analytics-next) library is supported.
|
|
12
12
|
|
|
13
|
-
##
|
|
13
|
+
## Installation
|
|
14
14
|
|
|
15
15
|
To install `@chordcommerce/analytics`, run the following command in your project directory:
|
|
16
16
|
|
|
@@ -20,7 +20,7 @@ npm install @chordcommerce/analytics
|
|
|
20
20
|
yarn add @chordcommerce/analytics
|
|
21
21
|
```
|
|
22
22
|
|
|
23
|
-
##
|
|
23
|
+
## Usage
|
|
24
24
|
|
|
25
25
|
First, ensure that a CDP Javascript library is installed and configured in your project. Then, initialize `@chordcommerce/analytics` as follows:
|
|
26
26
|
|
|
@@ -58,7 +58,7 @@ chord.trackCartViewed({ cart }) // sends a "Cart Viewed" event to the CDP
|
|
|
58
58
|
| `metadata.platform.type` | true | The type of platform where the event originated. Either `web` or `pos`. |
|
|
59
59
|
| `metadata.store.domain` | true | The domain of the site where the event originated. For Shopify, this should be the store slug that comes before `.myshopify.com`. |
|
|
60
60
|
|
|
61
|
-
###
|
|
61
|
+
### Formatters
|
|
62
62
|
|
|
63
63
|
Formatters are Javascript functions that are used to construct tracking event properties. There are two types of formatters, objects and events. You must define object formatters. Event formatters are optional. See [Chord’s documentation](https://docs.chord.co/analytics-getting-started#fgWx7) for more details and example formatters.
|
|
64
64
|
|
|
@@ -81,6 +81,6 @@ A formatter can be provided for each event. This formatter is used to transform
|
|
|
81
81
|
|
|
82
82
|
See [Chord’s documentation](https://docs.chord.co/analytics-getting-started) for a full API reference.
|
|
83
83
|
|
|
84
|
-
##
|
|
84
|
+
## Support
|
|
85
85
|
|
|
86
86
|
For support with setup and configuration, please contact Chord directly at **help@chord.co**.
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@chordcommerce/analytics",
|
|
3
3
|
"description": "Chord Commerce event tracking",
|
|
4
|
-
"version": "1.
|
|
4
|
+
"version": "1.6.0",
|
|
5
5
|
"author": "Chord Commerce <help@chord.co> (https://www.chord.co)",
|
|
6
6
|
"type": "module",
|
|
7
7
|
"main": "dist/index.js",
|
|
@@ -27,7 +27,6 @@
|
|
|
27
27
|
"zod": "^3.22.4"
|
|
28
28
|
},
|
|
29
29
|
"devDependencies": {
|
|
30
|
-
"@chordcommerce/eslint-config": "^1.0.1",
|
|
31
30
|
"@types/jest": "^29.5.11",
|
|
32
31
|
"jest": "^29.7.0",
|
|
33
32
|
"jest-environment-jsdom": "^29.7.0",
|