@artsy/cohesion 4.74.0 → 4.75.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 +12 -0
- package/dist/Schema/Events/Click.d.ts +20 -1
- package/dist/Schema/Events/MyCollection.d.ts +2 -2
- package/dist/Schema/Events/index.d.ts +6 -2
- package/dist/Schema/Events/index.js +1 -0
- package/dist/Schema/Values/ContextModule.d.ts +1 -0
- package/dist/Schema/Values/ContextModule.js +1 -0
- package/dist/Schema/Values/OwnerType.d.ts +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,15 @@
|
|
|
1
|
+
# v4.75.0 (Thu Nov 17 2022)
|
|
2
|
+
|
|
3
|
+
#### 🚀 Enhancement
|
|
4
|
+
|
|
5
|
+
- feat (CX-3066): Update My Collection insights tracking events [#365](https://github.com/artsy/cohesion/pull/365) ([@MrSltun](https://github.com/MrSltun))
|
|
6
|
+
|
|
7
|
+
#### Authors: 1
|
|
8
|
+
|
|
9
|
+
- Sultan Al-Maari ([@MrSltun](https://github.com/MrSltun))
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
1
13
|
# v4.74.0 (Thu Nov 17 2022)
|
|
2
14
|
|
|
3
15
|
#### 🚀 Enhancement
|
|
@@ -180,6 +180,25 @@ export interface ClickedArtworkGroup extends ClickedEntityGroup {
|
|
|
180
180
|
export interface ClickedAuctionGroup extends ClickedEntityGroup {
|
|
181
181
|
action: ActionType.clickedAuctionGroup;
|
|
182
182
|
}
|
|
183
|
+
/**
|
|
184
|
+
* A user clicks a result of auctions on web
|
|
185
|
+
*
|
|
186
|
+
* This schema describes events sent to Segment from [[clickedEntityGroup]]
|
|
187
|
+
*
|
|
188
|
+
* @example
|
|
189
|
+
* ```
|
|
190
|
+
* {
|
|
191
|
+
* action: "clickedAuctionResultItem",
|
|
192
|
+
* context_module: "auctionResult",
|
|
193
|
+
* context_page_owner_type: "artistAuctionResults",
|
|
194
|
+
* expanded: true
|
|
195
|
+
* }
|
|
196
|
+
* ```
|
|
197
|
+
*/
|
|
198
|
+
export interface ClickedAuctionResultItem extends ClickedEntityGroup {
|
|
199
|
+
action: ActionType.clickedAuctionResultItem;
|
|
200
|
+
expended: boolean;
|
|
201
|
+
}
|
|
183
202
|
/**
|
|
184
203
|
* A user clicks a grouping of collections on web
|
|
185
204
|
*
|
|
@@ -386,7 +405,7 @@ export interface ClickedShowGroup extends ClickedEntityGroup {
|
|
|
386
405
|
* Shared interface for clicked group actions on web
|
|
387
406
|
*/
|
|
388
407
|
export interface ClickedEntityGroup {
|
|
389
|
-
action: ActionType.clickedArticleGroup | ActionType.clickedArtistGroup | ActionType.clickedArtistSeriesGroup | ActionType.clickedArtworkGroup | ActionType.clickedAuctionGroup | ActionType.clickedCollectionGroup | ActionType.clickedFairGroup | ActionType.clickedGalleryGroup | ActionType.clickedMainArtworkGrid | ActionType.clickedShowGroup;
|
|
408
|
+
action: ActionType.clickedArticleGroup | ActionType.clickedArtistGroup | ActionType.clickedArtistSeriesGroup | ActionType.clickedArtworkGroup | ActionType.clickedAuctionGroup | ActionType.clickedAuctionResultItem | ActionType.clickedCollectionGroup | ActionType.clickedFairGroup | ActionType.clickedGalleryGroup | ActionType.clickedMainArtworkGrid | ActionType.clickedShowGroup;
|
|
390
409
|
context_module: ContextModule;
|
|
391
410
|
context_page_owner_type: PageOwnerType;
|
|
392
411
|
context_page_owner_id?: string;
|
|
@@ -7,7 +7,7 @@ export type Platform = "web" | "mobile";
|
|
|
7
7
|
* @packageDocumentation
|
|
8
8
|
*/
|
|
9
9
|
/**
|
|
10
|
-
* A user taps "add artwork" to add an artwork to My Collection.
|
|
10
|
+
* A user taps or clicks "add artwork" to add an artwork to My Collection.
|
|
11
11
|
*
|
|
12
12
|
* This schema describes events sent to Segment from [[addCollectedArtwork]]
|
|
13
13
|
*
|
|
@@ -24,7 +24,7 @@ export type Platform = "web" | "mobile";
|
|
|
24
24
|
export interface AddCollectedArtwork {
|
|
25
25
|
action: ActionType.addCollectedArtwork;
|
|
26
26
|
context_module: ContextModule.myCollectionHome | ContextModule.myCollectionOnboarding;
|
|
27
|
-
context_owner_type: OwnerType.myCollection | OwnerType.myCollectionOnboarding;
|
|
27
|
+
context_owner_type: OwnerType.myCollection | OwnerType.myCollectionOnboarding | OwnerType.myCollectionInsights;
|
|
28
28
|
platform: Platform;
|
|
29
29
|
}
|
|
30
30
|
/**
|
|
@@ -2,7 +2,7 @@ import { ClickedActivityPanelNotificationItem, ClickedActivityPanelTab, ClickedN
|
|
|
2
2
|
import { AddToCalendar } from "./AddToCalendar";
|
|
3
3
|
import { AuctionPageView, BidPageView, ClickedActiveBid, ClickedRegisterToBid, ConfirmBid, ConfirmRegistrationPageview, EnterLiveAuction, MaxBidSelected, RegistrationPageView, RegistrationSubmitted } from "./Auction";
|
|
4
4
|
import { AuthImpression, CompletedOnboarding, CreatedAccount, OnboardingUserInputData, ResetYourPassword, StartedOnboarding, SuccessfullyLoggedIn } from "./Authentication";
|
|
5
|
-
import { CheckedAccountBalance, ClickedAddNewShippingAddress, ClickedAddWorksToFair, ClickedAppDownload, ClickedArticleGroup, ClickedArtistGroup, ClickedArtistSeriesGroup, ClickedArtworkGroup, ClickedAuctionGroup, ClickedBuyerProtection, ClickedChangePage, ClickedChangePaymentMethod, ClickedChangeShippingAddress, ClickedChangeShippingMethod, ClickedCollectionGroup, ClickedCreateAlert, ClickedDeliveryMethod, ClickedEditArtwork, ClickedExpansionToggle, ClickedFairCard, ClickedFairGroup, ClickedGalleryGroup, ClickedLoadMore, ClickedMainArtworkGrid, ClickedNavigationTab, ClickedOfferActions, ClickedOfferOption, ClickedOnArtworkShippingUnitsDropdown, ClickedOnArtworkShippingWeight, ClickedOnFramedMeasurements, ClickedOnFramedMeasurementsDropdown, ClickedOnSubmitOrder, ClickedOrderPage, ClickedPartnerCard, ClickedPartnerLink, ClickedPaymentDetails, ClickedPaymentMethod, ClickedPromoSpace, ClickedSelectShippingOption, ClickedShippingAddress, ClickedShowGroup, ClickedShowMore, ClickedSnooze, ClickedVerifyIdentity, ClickedViewingRoomCard } from "./Click";
|
|
5
|
+
import { CheckedAccountBalance, ClickedAddNewShippingAddress, ClickedAddWorksToFair, ClickedAppDownload, ClickedArticleGroup, ClickedArtistGroup, ClickedArtistSeriesGroup, ClickedArtworkGroup, ClickedAuctionGroup, ClickedAuctionResultItem, ClickedBuyerProtection, ClickedChangePage, ClickedChangePaymentMethod, ClickedChangeShippingAddress, ClickedChangeShippingMethod, ClickedCollectionGroup, ClickedCreateAlert, ClickedDeliveryMethod, ClickedEditArtwork, ClickedExpansionToggle, ClickedFairCard, ClickedFairGroup, ClickedGalleryGroup, ClickedLoadMore, ClickedMainArtworkGrid, ClickedNavigationTab, ClickedOfferActions, ClickedOfferOption, ClickedOnArtworkShippingUnitsDropdown, ClickedOnArtworkShippingWeight, ClickedOnFramedMeasurements, ClickedOnFramedMeasurementsDropdown, ClickedOnSubmitOrder, ClickedOrderPage, ClickedPartnerCard, ClickedPartnerLink, ClickedPaymentDetails, ClickedPaymentMethod, ClickedPromoSpace, ClickedSelectShippingOption, ClickedShippingAddress, ClickedShowGroup, ClickedShowMore, ClickedSnooze, ClickedVerifyIdentity, ClickedViewingRoomCard } from "./Click";
|
|
6
6
|
import { ArtworkDetailsCompleted, ConsignmentSubmitted, ContactInformationCompleted, SubmitAnotherArtwork, UploadPhotosCompleted, ViewArtworkMyCollection } from "./Consignments";
|
|
7
7
|
import { FocusedOnConversationMessageInput, SentConversationMessage, TappedInboxConversation, TappedMakeOffer, TappedViewOffer } from "./Conversations";
|
|
8
8
|
import { ExperimentViewed } from "./ExperimentViewed";
|
|
@@ -27,7 +27,7 @@ import { ViewedVideo } from "./Video";
|
|
|
27
27
|
*
|
|
28
28
|
* Each event describes one ActionType
|
|
29
29
|
*/
|
|
30
|
-
export type Event = AddToCalendar | AddCollectedArtwork | ArtworkDetailsCompleted | AuctionPageView | AuctionResultsFilterParamsChanged | AuthImpression | BidPageView | CreatedAccount | ClickedActiveBid | ClickedActivityPanelNotificationItem | ClickedActivityPanelTab | ClickedAddNewShippingAddress | ClickedAddWorksToFair | ClickedAppDownload | ClickedArticleGroup | ClickedArtistGroup | ClickedArtistSeriesGroup | ClickedArtworkGroup | ClickedAuctionGroup | ClickedBuyerProtection | ClickedChangePage | ClickedChangePaymentMethod | ClickedChangeShippingAddress | ClickedChangeShippingMethod | ClickedCollectionGroup | ClickedCreateAlert | ClickedDeliveryMethod | ClickedEditArtwork | ClickedExpansionToggle | ClickedFairCard | ClickedFairGroup | ClickedGalleryGroup | ClickedLoadMore | ClickedMainArtworkGrid | ClickedNavigationTab | ClickedNotificationsBell | ClickedOfferOption | ClickedOnArtworkShippingWeight | ClickedOnArtworkShippingUnitsDropdown | ClickedOnFramedMeasurements | ClickedOnFramedMeasurementsDropdown | ClickedOnSubmitOrder | ClickedSnooze | ClickedPartnerCard | ClickedPartnerLink | ClickedPaymentMethod | ClickedPaymentDetails | CheckedAccountBalance | ClickedPromoSpace | ClickedRegisterToBid | ClickedSelectShippingOption | ClickedShippingAddress | ClickedShowGroup | ClickedShowMore | ClickedVerifyIdentity | ClickedViewingRoomCard | ClickedOfferActions | ClickedOrderPage | CommercialFilterParamsChanged | CompletedOnboarding | ConfirmBid | ConfirmRegistrationPageview | ConsignmentArtistFailed | ConsignmentSubmitted | ContactInformationCompleted | DeleteCollectedArtwork | DeletedSavedSearch | EditCollectedArtwork | EditedSavedSearch | EnterLiveAuction | ExperimentViewed | FocusedOnConversationMessageInput | FocusedOnSearchInput | FocusedOnPriceDatabaseSearchInput | FollowEvents | Impression | MaxBidSelected | MyCollectionOnboardingCompleted | OnboardingUserInputData | PriceDatabaseFilterParamsChanged | PromptForReview | RegistrationPageView | RegistrationSubmitted | ResetYourPassword | SaleScreenLoadComplete | SaveCollectedArtwork | Screen | SearchedPriceDatabase | SearchedReverseImageWithNoResults | SearchedReverseImageWithResults | SearchedWithNoResults | SelectedArtworkFromReverseImageSearch | SelectedItemFromSearch | SelectedItemFromPriceDatabaseSearch | SentConversationMessage | SentRequestPriceEstimate | Share | StartedOnboarding | SubmitAnotherArtwork | SuccessfullyLoggedIn | TappedArticleGroup | TappedArtistGroup | TappedArtistSeriesGroup | TappedArtworkGroup | TappedAuctionGroup | TappedAuctionResultGroup | TappedBid | TappedBuyNow | TappedCollectedArtwork | TappedCollectedArtworkImages | TappedCollectionGroup | TappedConsign | TappedContactGallery | TappedCreateAlert | TappedExploreGroup | TappedExploreMyCollection | TappedFairCard | TappedFairGroup | TappedInboxConversation | TappedInfoBubble | TappedLink | TappedNavigationTab | TappedMainArtworkGrid | TappedMakeOffer | TappedMyCollectionInsightsMedianAuctionRailItem | TappedMyCollectionInsightsMedianAuctionPriceChartCareerHighlight | TappedMyCollectionInsightsMedianAuctionPriceChartCategory | TappedMyCollectionInsightsMedianAuctionPriceChartTimeframe | TappedPartnerCard | TappedPickImageFromLibrary | TappedPromoSpace | TappedRequestPriceEstimate | TappedReverseImageSearch | TappedSell | TappedSellArtwork | TappedShowMore | TappedLearnMore | TappedSkip | TappedTabBar | TappedToggleCameraFlash | TappedVerifyIdentity | TappedViewingRoomCard | TappedViewingRoomGroup | TappedViewOffer | TimeOnPage | ToggledAccordion | ToggledNotification | ToggledSavedSearch | UploadPhotosCompleted | ViewArtworkMyCollection | ViewedVideo | VisitMyCollection | VisitMyCollectionOnboardingSlide;
|
|
30
|
+
export type Event = AddToCalendar | AddCollectedArtwork | ArtworkDetailsCompleted | AuctionPageView | AuctionResultsFilterParamsChanged | AuthImpression | BidPageView | CreatedAccount | ClickedActiveBid | ClickedActivityPanelNotificationItem | ClickedActivityPanelTab | ClickedAddNewShippingAddress | ClickedAddWorksToFair | ClickedAppDownload | ClickedArticleGroup | ClickedArtistGroup | ClickedArtistSeriesGroup | ClickedArtworkGroup | ClickedAuctionGroup | ClickedAuctionResultItem | ClickedBuyerProtection | ClickedChangePage | ClickedChangePaymentMethod | ClickedChangeShippingAddress | ClickedChangeShippingMethod | ClickedCollectionGroup | ClickedCreateAlert | ClickedDeliveryMethod | ClickedEditArtwork | ClickedExpansionToggle | ClickedFairCard | ClickedFairGroup | ClickedGalleryGroup | ClickedLoadMore | ClickedMainArtworkGrid | ClickedNavigationTab | ClickedNotificationsBell | ClickedOfferOption | ClickedOnArtworkShippingWeight | ClickedOnArtworkShippingUnitsDropdown | ClickedOnFramedMeasurements | ClickedOnFramedMeasurementsDropdown | ClickedOnSubmitOrder | ClickedSnooze | ClickedPartnerCard | ClickedPartnerLink | ClickedPaymentMethod | ClickedPaymentDetails | CheckedAccountBalance | ClickedPromoSpace | ClickedRegisterToBid | ClickedSelectShippingOption | ClickedShippingAddress | ClickedShowGroup | ClickedShowMore | ClickedVerifyIdentity | ClickedViewingRoomCard | ClickedOfferActions | ClickedOrderPage | CommercialFilterParamsChanged | CompletedOnboarding | ConfirmBid | ConfirmRegistrationPageview | ConsignmentArtistFailed | ConsignmentSubmitted | ContactInformationCompleted | DeleteCollectedArtwork | DeletedSavedSearch | EditCollectedArtwork | EditedSavedSearch | EnterLiveAuction | ExperimentViewed | FocusedOnConversationMessageInput | FocusedOnSearchInput | FocusedOnPriceDatabaseSearchInput | FollowEvents | Impression | MaxBidSelected | MyCollectionOnboardingCompleted | OnboardingUserInputData | PriceDatabaseFilterParamsChanged | PromptForReview | RegistrationPageView | RegistrationSubmitted | ResetYourPassword | SaleScreenLoadComplete | SaveCollectedArtwork | Screen | SearchedPriceDatabase | SearchedReverseImageWithNoResults | SearchedReverseImageWithResults | SearchedWithNoResults | SelectedArtworkFromReverseImageSearch | SelectedItemFromSearch | SelectedItemFromPriceDatabaseSearch | SentConversationMessage | SentRequestPriceEstimate | Share | StartedOnboarding | SubmitAnotherArtwork | SuccessfullyLoggedIn | TappedArticleGroup | TappedArtistGroup | TappedArtistSeriesGroup | TappedArtworkGroup | TappedAuctionGroup | TappedAuctionResultGroup | TappedBid | TappedBuyNow | TappedCollectedArtwork | TappedCollectedArtworkImages | TappedCollectionGroup | TappedConsign | TappedContactGallery | TappedCreateAlert | TappedExploreGroup | TappedExploreMyCollection | TappedFairCard | TappedFairGroup | TappedInboxConversation | TappedInfoBubble | TappedLink | TappedNavigationTab | TappedMainArtworkGrid | TappedMakeOffer | TappedMyCollectionInsightsMedianAuctionRailItem | TappedMyCollectionInsightsMedianAuctionPriceChartCareerHighlight | TappedMyCollectionInsightsMedianAuctionPriceChartCategory | TappedMyCollectionInsightsMedianAuctionPriceChartTimeframe | TappedPartnerCard | TappedPickImageFromLibrary | TappedPromoSpace | TappedRequestPriceEstimate | TappedReverseImageSearch | TappedSell | TappedSellArtwork | TappedShowMore | TappedLearnMore | TappedSkip | TappedTabBar | TappedToggleCameraFlash | TappedVerifyIdentity | TappedViewingRoomCard | TappedViewingRoomGroup | TappedViewOffer | TimeOnPage | ToggledAccordion | ToggledNotification | ToggledSavedSearch | UploadPhotosCompleted | ViewArtworkMyCollection | ViewedVideo | VisitMyCollection | VisitMyCollectionOnboardingSlide;
|
|
31
31
|
/**
|
|
32
32
|
* The top-level actions an Event describes.
|
|
33
33
|
*
|
|
@@ -114,6 +114,10 @@ export declare enum ActionType {
|
|
|
114
114
|
* Corresponds to {@link ClickedAuctionGroup}
|
|
115
115
|
*/
|
|
116
116
|
clickedAuctionGroup = "clickedAuctionGroup",
|
|
117
|
+
/**
|
|
118
|
+
* * Corresponds to {@link ClickedAuctionResultItem}
|
|
119
|
+
*/
|
|
120
|
+
clickedAuctionResultItem = "clickedAuctionResultItem",
|
|
117
121
|
/**
|
|
118
122
|
* Corresponds to {@link ClickedBuyerProtection}
|
|
119
123
|
*/
|
|
@@ -40,6 +40,7 @@ exports.ActionType = ActionType;
|
|
|
40
40
|
ActionType["clickedArtistSeriesGroup"] = "clickedArtistSeriesGroup";
|
|
41
41
|
ActionType["clickedArtworkGroup"] = "clickedArtworkGroup";
|
|
42
42
|
ActionType["clickedAuctionGroup"] = "clickedAuctionGroup";
|
|
43
|
+
ActionType["clickedAuctionResultItem"] = "clickedAuctionResultItem";
|
|
43
44
|
ActionType["clickedBuyerProtection"] = "clickedBuyerProtection";
|
|
44
45
|
ActionType["clickedChangePage"] = "clickedChangePage";
|
|
45
46
|
ActionType["clickedChangePaymentMethod"] = "clickedChangePaymentMethod";
|
|
@@ -101,6 +101,7 @@ export declare enum ContextModule {
|
|
|
101
101
|
myCollectionArtworkAbout = "myCollectionArtworkAbout",
|
|
102
102
|
myCollectionComparableWorks = "myCollectionComparableWorks",
|
|
103
103
|
myCollectionHome = "myCollectionHome",
|
|
104
|
+
myCollectionInsights = "myCollectionInsights",
|
|
104
105
|
myCollectionInsightsMedianAuctionRail = "myCollectionInsightsMedianAuctionRail",
|
|
105
106
|
myCollectionInsightsMedianAuctionPriceChart = "myCollectionInsightsMedianAuctionPriceChart",
|
|
106
107
|
myCollectionMarketSignals = "myCollectionMarketSignals",
|
|
@@ -115,6 +115,7 @@ exports.ContextModule = ContextModule;
|
|
|
115
115
|
ContextModule["myCollectionArtworkAbout"] = "myCollectionArtworkAbout";
|
|
116
116
|
ContextModule["myCollectionComparableWorks"] = "myCollectionComparableWorks";
|
|
117
117
|
ContextModule["myCollectionHome"] = "myCollectionHome";
|
|
118
|
+
ContextModule["myCollectionInsights"] = "myCollectionInsights";
|
|
118
119
|
ContextModule["myCollectionInsightsMedianAuctionRail"] = "myCollectionInsightsMedianAuctionRail";
|
|
119
120
|
ContextModule["myCollectionInsightsMedianAuctionPriceChart"] = "myCollectionInsightsMedianAuctionPriceChart";
|
|
120
121
|
ContextModule["myCollectionMarketSignals"] = "myCollectionMarketSignals";
|
|
@@ -88,4 +88,4 @@ export type ScreenOwnerType = OwnerType.allArtistSeries | OwnerType.article | Ow
|
|
|
88
88
|
/**
|
|
89
89
|
* Owner types available in web/mobile web
|
|
90
90
|
*/
|
|
91
|
-
export type PageOwnerType = OwnerType.article | OwnerType.articles | OwnerType.artist | OwnerType.artists | OwnerType.artistAuctionResults | OwnerType.artistSeries | OwnerType.artwork | OwnerType.auctions | OwnerType.collect | OwnerType.collection | OwnerType.collections | OwnerType.consign | OwnerType.fair | OwnerType.fairs | OwnerType.galleries | OwnerType.gene | OwnerType.home | OwnerType.onboarding | OwnerType.ordersAccept | OwnerType.ordersCounter | OwnerType.ordersNewPayment | OwnerType.ordersOffer | OwnerType.ordersPayment | OwnerType.ordersRespond | OwnerType.ordersReview | OwnerType.ordersShipping | OwnerType.ordersSubmitted | OwnerType.partner | OwnerType.partnerShowsArtworks | OwnerType.priceDatabase | OwnerType.profile | OwnerType.sale | OwnerType.savedSearch | OwnerType.savedSearches | OwnerType.search | OwnerType.show | OwnerType.shows | OwnerType.tag | OwnerType.user | OwnerType.viewingRoom | OwnerType.viewingRooms | OwnerType.worksForYou;
|
|
91
|
+
export type PageOwnerType = OwnerType.article | OwnerType.articles | OwnerType.artist | OwnerType.artists | OwnerType.artistAuctionResults | OwnerType.artistSeries | OwnerType.artwork | OwnerType.auctions | OwnerType.collect | OwnerType.collection | OwnerType.collections | OwnerType.consign | OwnerType.fair | OwnerType.fairs | OwnerType.galleries | OwnerType.gene | OwnerType.home | OwnerType.myCollectionArtworkInsights | OwnerType.myCollectionInsights | OwnerType.onboarding | OwnerType.ordersAccept | OwnerType.ordersCounter | OwnerType.ordersNewPayment | OwnerType.ordersOffer | OwnerType.ordersPayment | OwnerType.ordersRespond | OwnerType.ordersReview | OwnerType.ordersShipping | OwnerType.ordersSubmitted | OwnerType.partner | OwnerType.partnerShowsArtworks | OwnerType.priceDatabase | OwnerType.profile | OwnerType.sale | OwnerType.savedSearch | OwnerType.savedSearches | OwnerType.search | OwnerType.show | OwnerType.shows | OwnerType.tag | OwnerType.user | OwnerType.viewingRoom | OwnerType.viewingRooms | OwnerType.worksForYou;
|