@artsy/cohesion 4.44.0 → 4.45.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/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,22 @@
|
|
|
1
|
+
# v4.45.0 (Mon May 02 2022)
|
|
2
|
+
|
|
3
|
+
#### 🚀 Enhancement
|
|
4
|
+
|
|
5
|
+
- Adds auctionPageView and documentation [#315](https://github.com/artsy/cohesion/pull/315) ([@abhitip](https://github.com/abhitip))
|
|
6
|
+
|
|
7
|
+
#### 🏠 Internal
|
|
8
|
+
|
|
9
|
+
- chore(deps): update dep typescript from 4.6.3 to v4.6.4 [#326](https://github.com/artsy/cohesion/pull/326) ([@renovate-bot](https://github.com/renovate-bot))
|
|
10
|
+
- chore(deps): update yarn orb from 6.1.0 to v6.2.0 [#324](https://github.com/artsy/cohesion/pull/324) ([@renovate-bot](https://github.com/renovate-bot))
|
|
11
|
+
- chore(deps): update auto orb from 2.0.0 to v2.1.0 [#323](https://github.com/artsy/cohesion/pull/323) ([@renovate-bot](https://github.com/renovate-bot))
|
|
12
|
+
|
|
13
|
+
#### Authors: 2
|
|
14
|
+
|
|
15
|
+
- Abhiti Prabahar ([@abhitip](https://github.com/abhitip))
|
|
16
|
+
- WhiteSource Renovate ([@renovate-bot](https://github.com/renovate-bot))
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
1
20
|
# v4.44.0 (Mon Apr 25 2022)
|
|
2
21
|
|
|
3
22
|
#### 🚀 Enhancement
|
|
@@ -5,6 +5,43 @@
|
|
|
5
5
|
import { ContextModule } from "../Values/ContextModule";
|
|
6
6
|
import { OwnerType } from "../Values/OwnerType";
|
|
7
7
|
import { ActionType } from ".";
|
|
8
|
+
/**
|
|
9
|
+
* A user viewed an auction page. This is a track event that fires in addition to the pageview event for marketing tool purposes.
|
|
10
|
+
*
|
|
11
|
+
* This schema describes events sent to Segment from [[auctionPageView]]
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* ```
|
|
15
|
+
* {
|
|
16
|
+
* action: "auctionPageView",
|
|
17
|
+
* auction_slug: "impact-project-healthy-minds",
|
|
18
|
+
* sale_id: "622ba9ec812d93000bc8e95d",
|
|
19
|
+
* user_id: "5bd8b675776bd6002c86526c"
|
|
20
|
+
* }
|
|
21
|
+
* ```
|
|
22
|
+
*/
|
|
23
|
+
export interface AuctionPageView {
|
|
24
|
+
action: ActionType.auctionPageView;
|
|
25
|
+
auction_slug: string;
|
|
26
|
+
sale_id: string;
|
|
27
|
+
user_id: string;
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* A user viewed a bid page. This is a track event that fires in addition to the pageview event for marketing tool purposes.
|
|
31
|
+
*
|
|
32
|
+
* This schema describes events sent to Segment from [[bidPageView]]
|
|
33
|
+
*
|
|
34
|
+
* @example
|
|
35
|
+
* ```
|
|
36
|
+
* {
|
|
37
|
+
* action: "bidPageView",
|
|
38
|
+
* artwork_slug: "hank-willis-thomas-love-over-rules-15"
|
|
39
|
+
* auction_slug: "impact-project-healthy-minds",
|
|
40
|
+
* sale_id: "622ba9ec812d93000bc8e95d",
|
|
41
|
+
* user_id: "5bd8b675776bd6002c86526c"
|
|
42
|
+
* }
|
|
43
|
+
* ```
|
|
44
|
+
*/
|
|
8
45
|
export interface BidPageView {
|
|
9
46
|
action: ActionType.bidPageView;
|
|
10
47
|
artwork_slug: string;
|
|
@@ -12,12 +49,43 @@ export interface BidPageView {
|
|
|
12
49
|
sale_id: string;
|
|
13
50
|
user_id: string;
|
|
14
51
|
}
|
|
52
|
+
/**
|
|
53
|
+
* A user clicked on one of their active bids.
|
|
54
|
+
*
|
|
55
|
+
* This schema describes events sent to Segment from [[clickedActiveBid]]
|
|
56
|
+
*
|
|
57
|
+
* @example
|
|
58
|
+
* ```
|
|
59
|
+
* {
|
|
60
|
+
* action: "clickedActiveBid",
|
|
61
|
+
* artwork_slug: "hank-willis-thomas-love-over-rules-15"
|
|
62
|
+
* auction_slug: "impact-project-healthy-minds",
|
|
63
|
+
* user_id: "5bd8b675776bd6002c86526c"
|
|
64
|
+
* }
|
|
65
|
+
* ```
|
|
66
|
+
*/
|
|
15
67
|
export interface ClickedActiveBid {
|
|
16
68
|
action: ActionType.clickedActiveBid;
|
|
17
69
|
artwork_slug: string;
|
|
18
70
|
auction_slug: string;
|
|
19
71
|
user_id: string;
|
|
20
72
|
}
|
|
73
|
+
/**
|
|
74
|
+
* A user clicks to register to bid.
|
|
75
|
+
*
|
|
76
|
+
* This schema describes events sent to Segment from [[clickedRegisterToBid]]
|
|
77
|
+
*
|
|
78
|
+
* @example
|
|
79
|
+
* ```
|
|
80
|
+
* {
|
|
81
|
+
* action: "clickedRegisterToBid",
|
|
82
|
+
* context_module: "auctionHome",
|
|
83
|
+
* context_owner_id: "622ba9ec812d93000bc8e95d",
|
|
84
|
+
* context_owner_slug: "impact-project-healthy-minds",
|
|
85
|
+
* context_owner_type: "auction"
|
|
86
|
+
* }
|
|
87
|
+
* ```
|
|
88
|
+
*/
|
|
21
89
|
export interface ClickedRegisterToBid {
|
|
22
90
|
action: ActionType.clickedRegisterToBid;
|
|
23
91
|
context_module: ContextModule.auctionHome;
|
|
@@ -25,30 +93,116 @@ export interface ClickedRegisterToBid {
|
|
|
25
93
|
context_owner_slug: string;
|
|
26
94
|
context_owner_type: OwnerType.auction;
|
|
27
95
|
}
|
|
96
|
+
/**
|
|
97
|
+
* A user confirms their bid.
|
|
98
|
+
*
|
|
99
|
+
* This schema describes events sent to Segment from [[confirmBid]]
|
|
100
|
+
*
|
|
101
|
+
* @example
|
|
102
|
+
* ```
|
|
103
|
+
* {
|
|
104
|
+
* action: "confirmBid",
|
|
105
|
+
* bidder_id: "5bd8b675776bd6002c86526c",
|
|
106
|
+
* bidder_position_id: "622ba9ec812d93000bc8e95d"
|
|
107
|
+
* }
|
|
108
|
+
* ```
|
|
109
|
+
*/
|
|
28
110
|
export interface ConfirmBid {
|
|
29
111
|
action: ActionType.confirmBid;
|
|
30
112
|
bidder_id: string;
|
|
31
113
|
bidder_position_id: string;
|
|
32
114
|
}
|
|
115
|
+
/**
|
|
116
|
+
* A user views the confirm registration page. This is a track event that fires in addition to the pageview event for marketing tool purposes.
|
|
117
|
+
*
|
|
118
|
+
* This schema describes events sent to Segment from [[confirmRegistrationPageview]]
|
|
119
|
+
*
|
|
120
|
+
* @example
|
|
121
|
+
* ```
|
|
122
|
+
* {
|
|
123
|
+
* action: "confirmBid",
|
|
124
|
+
* context_module: "auctionHome"
|
|
125
|
+
* }
|
|
126
|
+
* ```
|
|
127
|
+
*/
|
|
33
128
|
export interface ConfirmRegistrationPageview {
|
|
34
129
|
action: ActionType.confirmRegistrationPageview;
|
|
35
130
|
context_module: ContextModule.auctionHome;
|
|
36
131
|
}
|
|
132
|
+
/**
|
|
133
|
+
* A user enters a live auction.
|
|
134
|
+
*
|
|
135
|
+
* This schema describes events sent to Segment from [[enterLiveAuction]]
|
|
136
|
+
*
|
|
137
|
+
* @example
|
|
138
|
+
* ```
|
|
139
|
+
* {
|
|
140
|
+
* action: "enterLiveAuction",
|
|
141
|
+
* context_module: "auction_home",
|
|
142
|
+
* destination_path: "/auction/impact-project-healthy-minds",
|
|
143
|
+
* subject: "Enter Live Auction"
|
|
144
|
+
* }
|
|
145
|
+
* ```
|
|
146
|
+
*/
|
|
37
147
|
export interface EnterLiveAuction {
|
|
38
148
|
action: ActionType.enterLiveAuction;
|
|
39
149
|
context_module: ContextModule.auctionHome;
|
|
40
150
|
destination_path: string;
|
|
41
151
|
subject: string;
|
|
42
152
|
}
|
|
153
|
+
/**
|
|
154
|
+
* A user selects their max bid.
|
|
155
|
+
*
|
|
156
|
+
* This schema describes events sent to Segment from [[maxBidSelected]]
|
|
157
|
+
*
|
|
158
|
+
* @example
|
|
159
|
+
* ```
|
|
160
|
+
* {
|
|
161
|
+
* action: "maxBidSelected",
|
|
162
|
+
* bidder_id: "5bd8b675776bd6002c86526c",
|
|
163
|
+
* selected_max_bid_minor: 100
|
|
164
|
+
* }
|
|
165
|
+
* ```
|
|
166
|
+
*/
|
|
43
167
|
export interface MaxBidSelected {
|
|
44
168
|
action: ActionType.maxBidSelected;
|
|
45
169
|
bidder_id: string;
|
|
46
170
|
selected_max_bid_minor: number;
|
|
47
171
|
}
|
|
172
|
+
/**
|
|
173
|
+
* A user views the auction registration page. This is a track event that fires in addition to the pageview event for marketing tool purposes.
|
|
174
|
+
*
|
|
175
|
+
* This schema describes events sent to Segment from [[registrationPageView]]
|
|
176
|
+
*
|
|
177
|
+
* @example
|
|
178
|
+
* ```
|
|
179
|
+
* {
|
|
180
|
+
* action: "registrationPageView",
|
|
181
|
+
* context_module: "auctionHome"
|
|
182
|
+
* }
|
|
183
|
+
* ```
|
|
184
|
+
*/
|
|
48
185
|
export interface RegistrationPageView {
|
|
49
186
|
action: ActionType.registrationPageView;
|
|
50
187
|
context_module: ContextModule.auctionHome;
|
|
51
188
|
}
|
|
189
|
+
/**
|
|
190
|
+
* A user submits their auction registration.
|
|
191
|
+
*
|
|
192
|
+
* This schema describes events sent to Segment from [[registrationSubmitted]]
|
|
193
|
+
*
|
|
194
|
+
* @example
|
|
195
|
+
* ```
|
|
196
|
+
* {
|
|
197
|
+
* action: "registrationSubmitted",
|
|
198
|
+
* auction_slug: "impact-project-healthy-minds",
|
|
199
|
+
* auction_state: "live",
|
|
200
|
+
* bidder_id: "5bd8b675776bd6002c86526c",
|
|
201
|
+
* sale_id: "622ba9ec812d93000bc8e95d",
|
|
202
|
+
* user_id: "5bd8b675776bd6002c86526c"
|
|
203
|
+
* }
|
|
204
|
+
* ```
|
|
205
|
+
*/
|
|
52
206
|
export interface RegistrationSubmitted {
|
|
53
207
|
action: ActionType.registrationSubmitted;
|
|
54
208
|
auction_slug: string;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { AddToCalendar } from "./AddToCalendar";
|
|
2
|
-
import { BidPageView, ClickedActiveBid, ClickedRegisterToBid, ConfirmBid, ConfirmRegistrationPageview, EnterLiveAuction, MaxBidSelected, RegistrationPageView, RegistrationSubmitted } from "./Auction";
|
|
2
|
+
import { AuctionPageView, BidPageView, ClickedActiveBid, ClickedRegisterToBid, ConfirmBid, ConfirmRegistrationPageview, EnterLiveAuction, MaxBidSelected, RegistrationPageView, RegistrationSubmitted } from "./Auction";
|
|
3
3
|
import { AuthImpression, CreatedAccount, OnboardingUserInputData, ResetYourPassword, SuccessfullyLoggedIn } from "./Authentication";
|
|
4
4
|
import { ClickedAddNewShippingAddress, ClickedAddWorksToFair, ClickedAppDownload, ClickedArticleGroup, ClickedArtistGroup, ClickedArtistSeriesGroup, ClickedArtworkGroup, ClickedAuctionGroup, ClickedBuyerProtection, ClickedChangePage, ClickedChangePaymentMethod, ClickedChangeShippingAddress, ClickedChangeShippingMethod, ClickedCollectionGroup, ClickedCreateAlert, ClickedDeliveryMethod, ClickedEditArtwork, ClickedExpansionToggle, ClickedFairCard, ClickedFairGroup, ClickedGalleryGroup, ClickedLoadMore, ClickedMainArtworkGrid, ClickedNavigationTab, ClickedOfferOption, ClickedOnArtworkShippingUnitsDropdown, ClickedOnArtworkShippingWeight, ClickedOnFramedMeasurements, ClickedOnFramedMeasurementsDropdown, ClickedOnSubmitOrder, ClickedPartnerCard, ClickedPaymentMethod, ClickedPaymentDetails, ClickedPromoSpace, ClickedSelectShippingOption, ClickedShippingAddress, ClickedShowGroup, ClickedShowMore, ClickedSnooze, ClickedVerifyIdentity, ClickedViewingRoomCard } from "./Click";
|
|
5
5
|
import { ArtworkDetailsCompleted, ConsignmentSubmitted, SubmitAnotherArtwork, UploadPhotosCompleted, ViewArtworkMyCollection } from "./Consignments";
|
|
@@ -21,7 +21,7 @@ import { ToggledAccordion } from "./UserExperienceInteractions";
|
|
|
21
21
|
*
|
|
22
22
|
* Each event describes one ActionType
|
|
23
23
|
*/
|
|
24
|
-
export declare type Event = AddToCalendar | AddCollectedArtwork | ArtworkDetailsCompleted | AuctionResultsFilterParamsChanged | AuthImpression | BidPageView | CreatedAccount | ClickedActiveBid | ClickedAddNewShippingAddress | ClickedAddWorksToFair | ClickedAppDownload | ClickedArticleGroup | ClickedArtistGroup | ClickedArtistSeriesGroup | ClickedArtworkGroup | ClickedAuctionGroup | ClickedBuyerProtection | ClickedChangePage | ClickedChangePaymentMethod | ClickedChangeShippingAddress | ClickedChangeShippingMethod | ClickedCollectionGroup | ClickedCreateAlert | ClickedDeliveryMethod | ClickedEditArtwork | ClickedExpansionToggle | ClickedFairCard | ClickedFairGroup | ClickedGalleryGroup | ClickedLoadMore | ClickedMainArtworkGrid | ClickedNavigationTab | ClickedOfferOption | ClickedOnArtworkShippingWeight | ClickedOnArtworkShippingUnitsDropdown | ClickedOnFramedMeasurements | ClickedOnFramedMeasurementsDropdown | ClickedOnSubmitOrder | ClickedSnooze | ClickedPartnerCard | ClickedPaymentMethod | ClickedPaymentDetails | ClickedPromoSpace | ClickedRegisterToBid | ClickedSelectShippingOption | ClickedShippingAddress | ClickedShowGroup | ClickedShowMore | ClickedVerifyIdentity | ClickedViewingRoomCard | CommercialFilterParamsChanged | ConfirmBid | ConfirmRegistrationPageview | ConsignmentArtistFailed | ConsignmentSubmitted | DeleteCollectedArtwork | DeletedSavedSearch | EditCollectedArtwork | EditedSavedSearch | EnterLiveAuction | ExperimentViewed | FocusedOnConversationMessageInput | FocusedOnSearchInput | FocusedOnPriceDatabaseSearchInput | FollowEvents | MaxBidSelected | OnboardingUserInputData | PriceDatabaseFilterParamsChanged | PromptForReview | RegistrationPageView | RegistrationSubmitted | ResetYourPassword | SaleScreenLoadComplete | Screen | SearchedPriceDatabase | SearchedWithNoResults | SelectedItemFromSearch | SelectedItemFromPriceDatabaseSearch | SentConversationMessage | Share | SubmitAnotherArtwork | SuccessfullyLoggedIn | TappedArticleGroup | TappedArtistGroup | TappedArtistSeriesGroup | TappedArtworkGroup | TappedAuctionGroup | TappedAuctionResultGroup | TappedBid | TappedBuyNow | TappedCollectedArtwork | TappedCollectedArtworkImages | TappedCollectionGroup | TappedConsign | TappedContactGallery | TappedCreateAlert | TappedExploreGroup | TappedFairCard | TappedFairGroup | TappedInboxConversation | TappedInfoBubble | TappedLink | TappedNavigationTab | TappedMainArtworkGrid | TappedMakeOffer | TappedPartnerCard | TappedPromoSpace | TappedRequestPriceEstimate | TappedSell | TappedSellArtwork | TappedShowMore | TappedLearnMore | TappedSkip | TappedTabBar | TappedVerifyIdentity | TappedViewingRoomCard | TappedViewingRoomGroup | TappedViewOffer | TimeOnPage | ToggledAccordion | ToggledNotification | ToggledSavedSearch | UploadPhotosCompleted | ViewArtworkMyCollection;
|
|
24
|
+
export declare type Event = AddToCalendar | AddCollectedArtwork | ArtworkDetailsCompleted | AuctionPageView | AuctionResultsFilterParamsChanged | AuthImpression | BidPageView | CreatedAccount | ClickedActiveBid | ClickedAddNewShippingAddress | ClickedAddWorksToFair | ClickedAppDownload | ClickedArticleGroup | ClickedArtistGroup | ClickedArtistSeriesGroup | ClickedArtworkGroup | ClickedAuctionGroup | ClickedBuyerProtection | ClickedChangePage | ClickedChangePaymentMethod | ClickedChangeShippingAddress | ClickedChangeShippingMethod | ClickedCollectionGroup | ClickedCreateAlert | ClickedDeliveryMethod | ClickedEditArtwork | ClickedExpansionToggle | ClickedFairCard | ClickedFairGroup | ClickedGalleryGroup | ClickedLoadMore | ClickedMainArtworkGrid | ClickedNavigationTab | ClickedOfferOption | ClickedOnArtworkShippingWeight | ClickedOnArtworkShippingUnitsDropdown | ClickedOnFramedMeasurements | ClickedOnFramedMeasurementsDropdown | ClickedOnSubmitOrder | ClickedSnooze | ClickedPartnerCard | ClickedPaymentMethod | ClickedPaymentDetails | ClickedPromoSpace | ClickedRegisterToBid | ClickedSelectShippingOption | ClickedShippingAddress | ClickedShowGroup | ClickedShowMore | ClickedVerifyIdentity | ClickedViewingRoomCard | CommercialFilterParamsChanged | ConfirmBid | ConfirmRegistrationPageview | ConsignmentArtistFailed | ConsignmentSubmitted | DeleteCollectedArtwork | DeletedSavedSearch | EditCollectedArtwork | EditedSavedSearch | EnterLiveAuction | ExperimentViewed | FocusedOnConversationMessageInput | FocusedOnSearchInput | FocusedOnPriceDatabaseSearchInput | FollowEvents | MaxBidSelected | OnboardingUserInputData | PriceDatabaseFilterParamsChanged | PromptForReview | RegistrationPageView | RegistrationSubmitted | ResetYourPassword | SaleScreenLoadComplete | Screen | SearchedPriceDatabase | SearchedWithNoResults | SelectedItemFromSearch | SelectedItemFromPriceDatabaseSearch | SentConversationMessage | Share | SubmitAnotherArtwork | SuccessfullyLoggedIn | TappedArticleGroup | TappedArtistGroup | TappedArtistSeriesGroup | TappedArtworkGroup | TappedAuctionGroup | TappedAuctionResultGroup | TappedBid | TappedBuyNow | TappedCollectedArtwork | TappedCollectedArtworkImages | TappedCollectionGroup | TappedConsign | TappedContactGallery | TappedCreateAlert | TappedExploreGroup | TappedFairCard | TappedFairGroup | TappedInboxConversation | TappedInfoBubble | TappedLink | TappedNavigationTab | TappedMainArtworkGrid | TappedMakeOffer | TappedPartnerCard | TappedPromoSpace | TappedRequestPriceEstimate | TappedSell | TappedSellArtwork | TappedShowMore | TappedLearnMore | TappedSkip | TappedTabBar | TappedVerifyIdentity | TappedViewingRoomCard | TappedViewingRoomGroup | TappedViewOffer | TimeOnPage | ToggledAccordion | ToggledNotification | ToggledSavedSearch | UploadPhotosCompleted | ViewArtworkMyCollection;
|
|
25
25
|
/**
|
|
26
26
|
* The top-level actions an Event describes.
|
|
27
27
|
*
|
|
@@ -44,6 +44,10 @@ export declare enum ActionType {
|
|
|
44
44
|
* Corresponds to {@link ArtworkDetailsCompleted}
|
|
45
45
|
*/
|
|
46
46
|
artworkDetailsCompleted = "artworkDetailsCompleted",
|
|
47
|
+
/**
|
|
48
|
+
* Corresponds to {@link AuctionPageView}
|
|
49
|
+
*/
|
|
50
|
+
auctionPageView = "auctionPageView",
|
|
47
51
|
/**
|
|
48
52
|
* Corresponds to {@link AuctionResultsFilterParamsChanged}
|
|
49
53
|
*/
|
|
@@ -24,6 +24,7 @@ exports.ActionType = ActionType;
|
|
|
24
24
|
ActionType["addToCalendar"] = "addToCalendar";
|
|
25
25
|
ActionType["addCollectedArtwork"] = "addCollectedArtwork";
|
|
26
26
|
ActionType["artworkDetailsCompleted"] = "artworkDetailsCompleted";
|
|
27
|
+
ActionType["auctionPageView"] = "auctionPageView";
|
|
27
28
|
ActionType["auctionResultsFilterParamsChanged"] = "auctionResultsFilterParamsChanged";
|
|
28
29
|
ActionType["bidPageView"] = "bidPageView";
|
|
29
30
|
ActionType["clickedActiveBid"] = "clickedActiveBid";
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@artsy/cohesion",
|
|
3
|
-
"version": "4.
|
|
3
|
+
"version": "4.45.0",
|
|
4
4
|
"description": "Analytics schema",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"publishConfig": {
|
|
@@ -47,7 +47,7 @@
|
|
|
47
47
|
"lint-staged": "10.1.7",
|
|
48
48
|
"prettier": "2.0.5",
|
|
49
49
|
"typedoc": "0.17.7",
|
|
50
|
-
"typescript": "4.6.
|
|
50
|
+
"typescript": "4.6.4"
|
|
51
51
|
},
|
|
52
52
|
"dependencies": {
|
|
53
53
|
"core-js": "3"
|