fleek-track-analytics 1.16.3 → 1.16.5
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/.vscode/settings.json +2 -1
- package/README.md +13 -10
- package/lib/event-map/event-data-types/vendor-app/price-suggestions/price-suggestions-events.d.ts +8 -0
- package/lib/event-map/event-map.d.ts +2 -0
- package/lib/event-map/event-map.js +1 -0
- package/lib/event-map/event-map.js.map +1 -1
- package/package.json +1 -1
package/.vscode/settings.json
CHANGED
package/README.md
CHANGED
|
@@ -5,10 +5,12 @@ with trace(session) management.
|
|
|
5
5
|
|
|
6
6
|
### Table of Contents
|
|
7
7
|
|
|
8
|
-
- [
|
|
8
|
+
- [fleek-track-analytics](#fleek-track-analytics)
|
|
9
|
+
- [Table of Contents](#table-of-contents)
|
|
10
|
+
- [How to Integrate](#how-to-integrate)
|
|
9
11
|
- [How to setup for development](#how-to-setup-for-development)
|
|
10
|
-
- [How to change event map](#how-to-change-event-map)
|
|
11
12
|
- [How to publish changes to npm](#how-to-publish-changes-to-npm)
|
|
13
|
+
- [How to change event map](#how-to-change-event-map)
|
|
12
14
|
|
|
13
15
|
---
|
|
14
16
|
|
|
@@ -53,7 +55,7 @@ const analyticsWrapper = new TrackAnalytics({
|
|
|
53
55
|
platform: 'REACT_NATIVE',
|
|
54
56
|
App: 'CONSUMER_APP',
|
|
55
57
|
segment: true,
|
|
56
|
-
segmentKey: process.env.EXPO_PUBLIC_SEGMENT_KEY || '', //provide the segment key
|
|
58
|
+
segmentKey: process.env.EXPO_PUBLIC_SEGMENT_KEY || '', //provide the segment key
|
|
57
59
|
devMode: __DEV__,
|
|
58
60
|
errorHandler: analyticsException,
|
|
59
61
|
});
|
|
@@ -87,10 +89,10 @@ analyticsWrapper.track(EVENT_NAMES.HOME_SCREEN_VIEWED, {
|
|
|
87
89
|
})
|
|
88
90
|
```
|
|
89
91
|
|
|
90
|
-
Note: Each event name is configured to have specify param type defination via `EVENT_MAP`. In the example above, if one more property is added in the parameters, the typescript will error.
|
|
91
|
-
How to declare events in the `EVENT_MAP` is explained here.
|
|
92
|
+
Note: Each event name is configured to have specify param type defination via `EVENT_MAP`. In the example above, if one more property is added in the parameters, the typescript will error.
|
|
93
|
+
How to declare events in the `EVENT_MAP` is explained here.
|
|
92
94
|
|
|
93
|
-
You can also use the base events given by segment smillarly
|
|
95
|
+
You can also use the base events given by segment smillarly
|
|
94
96
|
|
|
95
97
|
```ts
|
|
96
98
|
|
|
@@ -114,7 +116,7 @@ yarn && yarn build
|
|
|
114
116
|
3. Login to npm with fleek credentials. (Acquire the credentials from the team members)
|
|
115
117
|
|
|
116
118
|
|
|
117
|
-
# How to publish changes to npm
|
|
119
|
+
# How to publish changes to npm
|
|
118
120
|
|
|
119
121
|
1. After updating the code, change the package json to a new version based on following rules
|
|
120
122
|
- If changes in library code upgrade as minor release patch. Example `1.1.20` to `1.2.20`
|
|
@@ -127,13 +129,13 @@ yarn build && npm publish
|
|
|
127
129
|
|
|
128
130
|
# How to update event map
|
|
129
131
|
|
|
130
|
-
In order to build reliability in event data consistency across platform, `.track()` function expets event name and event properties to be type defined before use. The function defination for track is hence,
|
|
132
|
+
In order to build reliability in event data consistency across platform, `.track()` function expets event name and event properties to be type defined before use. The function defination for track is hence,
|
|
131
133
|
|
|
132
134
|
```ts
|
|
133
135
|
type track = <T extends EVENT_NAMES>(eventName: T, eventParams: EVENT_MAP[T]) => Promise<void> | void
|
|
134
136
|
```
|
|
135
137
|
|
|
136
|
-
# How to change event map
|
|
138
|
+
# How to change event map
|
|
137
139
|
|
|
138
140
|
1. Setup the the fleek-track-analytics repo by steps given here.
|
|
139
141
|
|
|
@@ -163,7 +165,7 @@ export interface IMyNewEvent {
|
|
|
163
165
|
id: string;
|
|
164
166
|
city: string,
|
|
165
167
|
prop1: number,
|
|
166
|
-
prop2: boolean
|
|
168
|
+
prop2: boolean
|
|
167
169
|
}
|
|
168
170
|
|
|
169
171
|
```
|
|
@@ -191,5 +193,6 @@ export interface IMyNewEvent {
|
|
|
191
193
|
yarn upgrade fleek-track-analytics --latest
|
|
192
194
|
```
|
|
193
195
|
7. Post upgrade the `eventmap` will be updated and available to use (without rebuilding the app if it is already running)
|
|
196
|
+
8. After adding an event here, you also need to update the mapping on [Segment website](https://app.segment.com/joinfleek/destinations/actions-mixpanel/sources/fleek-customer-app/instances/660fd99488053261afc7b686/actions/64o9zGEeDcJcAKXuxWdJFA)
|
|
194
197
|
|
|
195
198
|
|
package/lib/event-map/event-data-types/vendor-app/price-suggestions/price-suggestions-events.d.ts
CHANGED
|
@@ -22,14 +22,22 @@ export interface IQuantitySuggestionShown {
|
|
|
22
22
|
export interface IQuantityFieldEdited {
|
|
23
23
|
quantity_edited: string;
|
|
24
24
|
field_index: number;
|
|
25
|
+
l3_category_names: string[];
|
|
26
|
+
brand_names: string[];
|
|
25
27
|
}
|
|
26
28
|
export interface IPriceFieldEdited {
|
|
27
29
|
price_edited: string;
|
|
28
30
|
field_index: number;
|
|
31
|
+
l3_category_names: string[];
|
|
32
|
+
brand_names: string[];
|
|
29
33
|
}
|
|
30
34
|
export interface IPriceTierAdded {
|
|
31
35
|
field_index: number;
|
|
36
|
+
l3_category_names: string[];
|
|
37
|
+
brand_names: string[];
|
|
32
38
|
}
|
|
33
39
|
export interface IPriceTierRemoved {
|
|
34
40
|
field_index: number;
|
|
41
|
+
l3_category_names: string[];
|
|
42
|
+
brand_names: string[];
|
|
35
43
|
}
|
|
@@ -374,6 +374,7 @@ export declare enum EVENT_NAMES {
|
|
|
374
374
|
REVIEWS_TAB_CLICKED = "reviews_tab_clicked",
|
|
375
375
|
REVIEWS_TRANSLATE_CLICKED = "reviews_translate_clicked",
|
|
376
376
|
REVIEWS_UPVOTE_CLICKED = "reviews_upvote_clicked",
|
|
377
|
+
REVIEW_CAROUSEL_SCROLLED = "review_carousel_scrolled",
|
|
377
378
|
PRICING_SUGGESTIONS_VIEWED = "pricing_suggestion_viewed",
|
|
378
379
|
PRICING_SUGGESTIONS_SUBMIT = "pricing_suggestion_submit",
|
|
379
380
|
SUGGESTED_QUANTITY_SHOWN = "suggested_quantity_shown",
|
|
@@ -658,6 +659,7 @@ export interface EVENT_MAP {
|
|
|
658
659
|
[EVENT_NAMES.REVIEWS_TAB_CLICKED]: IEmptyEventData;
|
|
659
660
|
[EVENT_NAMES.REVIEWS_TRANSLATE_CLICKED]: IEmptyEventData;
|
|
660
661
|
[EVENT_NAMES.REVIEWS_UPVOTE_CLICKED]: IEmptyEventData;
|
|
662
|
+
[EVENT_NAMES.REVIEW_CAROUSEL_SCROLLED]: IEmptyEventData;
|
|
661
663
|
[EVENT_NAMES.PRICING_SUGGESTIONS_VIEWED]: IPriceSuggestionsViewed;
|
|
662
664
|
[EVENT_NAMES.PRICING_SUGGESTIONS_SUBMIT]: IPriceSuggestionsSubmit;
|
|
663
665
|
[EVENT_NAMES.SUGGESTED_QUANTITY_SHOWN]: IQuantitySuggestionShown;
|
|
@@ -264,6 +264,7 @@ var EVENT_NAMES;
|
|
|
264
264
|
EVENT_NAMES["REVIEWS_TAB_CLICKED"] = "reviews_tab_clicked";
|
|
265
265
|
EVENT_NAMES["REVIEWS_TRANSLATE_CLICKED"] = "reviews_translate_clicked";
|
|
266
266
|
EVENT_NAMES["REVIEWS_UPVOTE_CLICKED"] = "reviews_upvote_clicked";
|
|
267
|
+
EVENT_NAMES["REVIEW_CAROUSEL_SCROLLED"] = "review_carousel_scrolled";
|
|
267
268
|
EVENT_NAMES["PRICING_SUGGESTIONS_VIEWED"] = "pricing_suggestion_viewed";
|
|
268
269
|
EVENT_NAMES["PRICING_SUGGESTIONS_SUBMIT"] = "pricing_suggestion_submit";
|
|
269
270
|
EVENT_NAMES["SUGGESTED_QUANTITY_SHOWN"] = "suggested_quantity_shown";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"event-map.js","sourceRoot":"","sources":["../../src/event-map/event-map.ts"],"names":[],"mappings":";;;AA6NA,IAAY,
|
|
1
|
+
{"version":3,"file":"event-map.js","sourceRoot":"","sources":["../../src/event-map/event-map.ts"],"names":[],"mappings":";;;AA6NA,IAAY,WA0XX;AA1XD,WAAY,WAAW;IACrB,uDAAwC,CAAA;IACxC,4DAA6C,CAAA;IAC7C,4EAA6D,CAAA;IAC7D,wEAAyD,CAAA;IACzD,4DAA6C,CAAA;IAC7C,0CAA2B,CAAA;IAC3B,sEAAuD,CAAA;IACvD,sDAAuC,CAAA;IACvC,wEAAyD,CAAA;IACzD,8DAA+C,CAAA;IAC/C,0CAA2B,CAAA;IAC3B,kDAAmC,CAAA;IAGnC,0CAA2B,CAAA;IAC3B,oDAAqC,CAAA;IACrC,kEAAmD,CAAA;IACnD,sDAAuC,CAAA;IAGvC,8DAA+C,CAAA;IAC/C,8DAA+C,CAAA;IAG/C,0DAA2C,CAAA;IAC3C,sDAAuC,CAAA;IACvC,gGAAiF,CAAA;IACjF,2EAA4D,CAAA;IAC5D,4EAA6D,CAAA;IAC7D,sDAAuC,CAAA;IACvC,4EAA6D,CAAA;IAC7D,wEAAyD,CAAA;IACzD,wEAAyD,CAAA;IACzD,iEAAkD,CAAA;IAClD,6DAA8C,CAAA;IAC9C,4DAA6C,CAAA;IAC7C,4EAA6D,CAAA;IAC7D,wDAAyC,CAAA;IACzC,kEAAmD,CAAA;IACnD,gFAAiE,CAAA;IAGjE,gDAAiC,CAAA;IACjC,kDAAmC,CAAA;IACnC,gEAAiD,CAAA;IACjD,mEAAoD,CAAA;IACpD,oDAAqC,CAAA;IACrC,sDAAuC,CAAA;IACvC,4DAA6C,CAAA;IAC7C,wEAAyD,CAAA;IACzD,sDAAuC,CAAA;IACvC,wDAAyC,CAAA;IAGzC,wDAAyC,CAAA;IACzC,4DAA6C,CAAA;IAG7C,gEAAiD,CAAA;IACjD,gEAAiD,CAAA;IACjD,2DAA4C,CAAA;IAC5C,oEAAqD,CAAA;IACrD,sDAAuC,CAAA;IAGvC,oFAAqE,CAAA;IACrE,sFAAuE,CAAA;IACvE,oFAAqE,CAAA;IACrE,8DAA+C,CAAA;IAC/C,wEAAyD,CAAA;IACzD,8CAA+B,CAAA;IAC/B,oFAAqE,CAAA;IAErE,sEAAuD,CAAA;IACvD,kEAAmD,CAAA;IACnD,oEAAqD,CAAA;IACrD,uEAAwD,CAAA;IACxD,4DAA6C,CAAA;IAC7C,sEAAuD,CAAA;IACvD,sEAAuD,CAAA;IAGvD,4CAA6B,CAAA;IAC7B,gDAAiC,CAAA;IAGjC,gDAAiC,CAAA;IACjC,4DAA6C,CAAA;IAG7C,wDAAyC,CAAA;IAGzC,gDAAiC,CAAA;IACjC,8CAA+B,CAAA;IAG/B,oEAAqD,CAAA;IACrD,oEAAqD,CAAA;IACrD,sEAAuD,CAAA;IACvD,wEAAyD,CAAA;IACzD,0EAA2D,CAAA;IAC3D,oEAAqD,CAAA;IAGrD,8CAA+B,CAAA;IAG/B,oDAAqC,CAAA;IAGrC,oDAAqC,CAAA;IACrC,oDAAqC,CAAA;IAErC,gEAAiD,CAAA;IAGjD,8CAA+B,CAAA;IAC/B,0CAA2B,CAAA;IAC3B,gDAAiC,CAAA;IACjC,0CAA2B,CAAA;IAC3B,gDAAiC,CAAA;IACjC,wDAAyC,CAAA;IACzC,0CAA2B,CAAA;IAC3B,kEAAmD,CAAA;IAGnD,4EAA6D,CAAA;IAC7D,0FAA2E,CAAA;IAC3E,sFAAuE,CAAA;IACvE,oFAAqE,CAAA;IACrE,0GAA2F,CAAA;IAC3F,8EAA+D,CAAA;IAC/D,0FAA2E,CAAA;IAC3E,0FAA2E,CAAA;IAC3E,0FAA2E,CAAA;IAC3E,0FAA2E,CAAA;IAC3E,0FAA2E,CAAA;IAC3E,0FAA2E,CAAA;IAC3E,0FAA2E,CAAA;IAC3E,0FAA2E,CAAA;IAC3E,8EAA+D,CAAA;IAC/D,8EAA+D,CAAA;IAC/D,kFAAmE,CAAA;IACnE,sEAAuD,CAAA;IAGvD,0EAA2D,CAAA;IAC3D,sFAAuE,CAAA;IACvE,oFAAqE,CAAA;IACrE,0EAA2D,CAAA;IAC3D,0EAA2D,CAAA;IAG3D,4DAA6C,CAAA;IAG7C,4DAA6C,CAAA;IAC7C,oEAAqD,CAAA;IACrD,gDAAiC,CAAA;IAEjC,wDAAyC,CAAA;IACzC,oEAAqD,CAAA;IACrD,oEAAqD,CAAA;IACrD,gEAAiD,CAAA;IACjD,8DAA+C,CAAA;IAE/C,oEAAqD,CAAA;IACrD,gEAAiD,CAAA;IACjD,8DAA+C,CAAA;IAE/C,4EAA6D,CAAA;IAC7D,wEAAyD,CAAA;IACzD,sEAAuD,CAAA;IAGvD,4DAA6C,CAAA;IAC7C,gEAAiD,CAAA;IACjD,sGAAuF,CAAA;IACvF,sGAAuF,CAAA;IAGvF,wDAAyC,CAAA;IAGzC,oEAAqD,CAAA;IACrD,kEAAmD,CAAA;IAEnD,kDAAmC,CAAA;IACnC,kEAAmD,CAAA;IACnD,kDAAmC,CAAA;IACnC,4DAA6C,CAAA;IAC7C,kEAAmD,CAAA;IACnD,gDAAiC,CAAA;IACjC,sEAAuD,CAAA;IACvD,oEAAqD,CAAA;IACrD,4DAA6C,CAAA;IAC7C,kEAAmD,CAAA;IACnD,kFAAmE,CAAA;IACnE,0EAA2D,CAAA;IAC3D,4EAA6D,CAAA;IAC7D,gDAAiC,CAAA;IAEjC,0DAA2C,CAAA;IAC3C,gDAAiC,CAAA;IAEjC,kEAAmD,CAAA;IACnD,sEAAuD,CAAA;IACvD,4EAA6D,CAAA;IAC7D,gFAAiE,CAAA;IAGjE,4DAA6C,CAAA;IAC7C,gDAAiC,CAAA;IACjC,0DAA2C,CAAA;IAC3C,oEAAqD,CAAA;IACrD,kDAAmC,CAAA;IACnC,8DAA+C,CAAA;IAC/C,kDAAmC,CAAA;IACnC,oDAAqC,CAAA;IACrC,kDAAmC,CAAA;IACnC,8DAA+C,CAAA;IAC/C,0CAA2B,CAAA;IAC3B,8EAA+D,CAAA;IAC/D,gEAAiD,CAAA;IACjD,oDAAqC,CAAA;IACrC,kEAAmD,CAAA;IACnD,oDAAqC,CAAA;IACrC,0EAA2D,CAAA;IAC3D,gDAAiC,CAAA;IAGjC,8DAA+C,CAAA;IAC/C,gEAAiD,CAAA;IACjD,8EAA+D,CAAA;IAG/D,kFAAmE,CAAA;IACnE,oFAAqE,CAAA;IACrE,wDAAyC,CAAA;IACzC,gFAAiE,CAAA;IACjE,gDAAiC,CAAA;IACjC,8EAA+D,CAAA;IAC/D,wEAAyD,CAAA;IACzD,wEAAyD,CAAA;IACzD,sEAAuD,CAAA;IACvD,wEAAyD,CAAA;IACzD,wEAAyD,CAAA;IACzD,sEAAuD,CAAA;IACvD,gFAAiE,CAAA;IACjE,0EAA2D,CAAA;IAC3D,0GAA2F,CAAA;IAC3F,8DAA+C,CAAA;IAE/C,kEAAmD,CAAA;IACnD,kEAAmD,CAAA;IACnD,kEAAmD,CAAA;IAEnD,8DAA+C,CAAA;IAG/C,6DAA8C,CAAA;IAC9C,yEAA0D,CAAA;IAC1D,6EAA8D,CAAA;IAC9D,uFAAwE,CAAA;IACxE,uFAAwE,CAAA;IACxE,kEAAmD,CAAA;IAGnD,4EAA6D,CAAA;IAC7D,4EAA6D,CAAA;IAG7D,wGAAyF,CAAA;IACzF,kFAAmE,CAAA;IAGnE,sFAAuE,CAAA;IACvE,0FAA2E,CAAA;IAC3E,wGAAyF,CAAA;IACzF,0GAA2F,CAAA;IAC3F,gHAAiG,CAAA;IACjG,oFAAqE,CAAA;IACrE,wFAAyE,CAAA;IAGzE,wGAAyF,CAAA;IAGzF,wEAAyD,CAAA;IACzD,4EAA6D,CAAA;IAC7D,sEAAuD,CAAA;IACvD,sFAAuE,CAAA;IACvE,gFAAiE,CAAA;IACjE,wEAAyD,CAAA;IAGzD,gFAAiE,CAAA;IACjE,oEAAqD,CAAA;IAErD,oEAAqD,CAAA;IAGrD,gEAAiD,CAAA;IACjD,kEAAmD,CAAA;IACnD,oFAAqE,CAAA;IACrE,oFAAqE,CAAA;IACrE,wEAAyD,CAAA;IACzD,wEAAyD,CAAA;IACzD,oHAAqG,CAAA;IACrG,oHAAqG,CAAA;IAErG,kFAAmE,CAAA;IACnE,gFAAiE,CAAA;IACjE,sFAAuE,CAAA;IAEvE,oGAAqF,CAAA;IACrF,kHAAmG,CAAA;IAEnG,6FAA8E,CAAA;IAC9E,4DAA6C,CAAA;IAC7C,4DAA6C,CAAA;IAC7C,8DAA+C,CAAA;IAC/C,oFAAqE,CAAA;IAErE,wEAAyD,CAAA;IACzD,wEAAyD,CAAA;IACzD,gFAAiE,CAAA;IACjE,kGAAmF,CAAA;IACnF,8DAA+C,CAAA;IAC/C,4EAA6D,CAAA;IAC7D,sEAAuD,CAAA;IACvD,sEAAuD,CAAA;IACvD,sFAAuE,CAAA;IAGvE,oEAAqD,CAAA;IACrD,4DAA6C,CAAA;IAG7C,4DAA6C,CAAA;IAC7C,4EAA6D,CAAA;IAC7D,kEAAmD,CAAA;IACnD,0DAA2C,CAAA;IAC3C,gEAAiD,CAAA;IACjD,0DAA2C,CAAA;IAC3C,sEAAuD,CAAA;IACvD,gEAAiD,CAAA;IACjD,oEAAqD,CAAA;IAGrD,uEAAwD,CAAA;IACxD,uEAAwD,CAAA;IAExD,oEAAqD,CAAA;IACrD,8DAA+C,CAAA;IAC/C,wDAAyC,CAAA;IACzC,wDAAyC,CAAA;IACzC,4DAA6C,CAAA;IAG7C,wFAAyE,CAAA;IAGzE,kDAAmC,CAAA;IACnC,oEAAqD,CAAA;IACrD,kDAAmC,CAAA;IACnC,0DAA2C,CAAA;IAG3C,sEAAuD,CAAA;IACvD,oDAAqC,CAAA;IACrC,kEAAmD,CAAA;IACnD,wDAAyC,CAAA;IACzC,wDAAyC,CAAA;IACzC,8EAA+D,CAAA;IAC/D,kEAAmD,CAAA;AACrD,CAAC,EA1XW,WAAW,2BAAX,WAAW,QA0XtB"}
|