@artsy/cohesion 4.72.0 → 4.73.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,15 @@
1
+ # v4.73.0 (Sat Nov 12 2022)
2
+
3
+ #### 🚀 Enhancement
4
+
5
+ - feat(CX-3055): Add tappedExploreMyCollection and myCollectionOnboardingCompleted actions (hf my collection onboarding) [#362](https://github.com/artsy/cohesion/pull/362) ([@dariakoko](https://github.com/dariakoko))
6
+
7
+ #### Authors: 1
8
+
9
+ - Daria Kozlova ([@dariakoko](https://github.com/dariakoko))
10
+
11
+ ---
12
+
1
13
  # v4.72.0 (Thu Nov 10 2022)
2
14
 
3
15
  #### 🚀 Enhancement
@@ -0,0 +1,51 @@
1
+ import { ContextModule } from "../Values/ContextModule";
2
+ import { OwnerType } from "../Values/OwnerType";
3
+ import { ActionType } from ".";
4
+ /**
5
+ * A user taps "Explore My Collection" (onboarding flow) on the "Do more on Artsy".
6
+ *
7
+ * This schema describes events sent to Segment from [[tappedExploreMyCollection]]
8
+ *
9
+ * @example
10
+ * ```
11
+ * {
12
+ * action: "tappedExploreMyCollection",
13
+ * context_screen: "home",
14
+ * context_screen_owner_type: "home"
15
+ * context_module: "doMoreOnArtsy",
16
+ * destination_screen_owner_type: "myCollectionOnboarding",
17
+ * }
18
+ * ```
19
+ */
20
+ export interface TappedExploreMyCollection {
21
+ action: ActionType.tappedExploreMyCollection;
22
+ context_screen: OwnerType.home;
23
+ context_screen_owner_type: OwnerType.home;
24
+ context_module: ContextModule.doMoreOnArtsy;
25
+ destination_screen_owner_type: OwnerType.myCollectionOnboarding;
26
+ }
27
+ /**
28
+ * A user completed onboarding (=reached the last screen).
29
+ *
30
+ * This schema describes events sent to Segment from [[myCollectionOnboardingCompleted]]
31
+ *
32
+ * @example
33
+ * ```
34
+ * {
35
+ * action: "myCollectionOnboardingCompleted",
36
+ * context_owner_type: "myCollectionOnboarding"
37
+ * context_screen_owner_type: "myCollectionOnboarding"
38
+ * context_module: "myCollectionOnboarding",
39
+ * destination_screen_owner_type: "myCollectionOnboarding",
40
+ * user_id: "5bd8b675776bd6002c86526c"
41
+ * }
42
+ * ```
43
+ */
44
+ export interface MyCollectionOnboardingCompleted {
45
+ action: ActionType.myCollectionOnboardingCompleted;
46
+ context_owner_type: OwnerType.myCollectionOnboarding;
47
+ context_screen_owner_type: OwnerType.myCollectionOnboarding;
48
+ context_module: ContextModule.myCollectionOnboarding;
49
+ destination_screen_owner_type: OwnerType.myCollectionOnboarding;
50
+ user_id: string;
51
+ }
@@ -0,0 +1 @@
1
+ "use strict";
@@ -7,6 +7,7 @@ import { ArtworkDetailsCompleted, ConsignmentSubmitted, ContactInformationComple
7
7
  import { FocusedOnConversationMessageInput, SentConversationMessage, TappedInboxConversation, TappedMakeOffer, TappedViewOffer } from "./Conversations";
8
8
  import { ExperimentViewed } from "./ExperimentViewed";
9
9
  import { AuctionResultsFilterParamsChanged, CommercialFilterParamsChanged, PriceDatabaseFilterParamsChanged } from "./FilterAndSort";
10
+ import { MyCollectionOnboardingCompleted, TappedExploreMyCollection } from "./HomeFeedMyCollectionOnboarding";
10
11
  import { Impression } from "./Impression";
11
12
  import { AddCollectedArtwork, DeleteCollectedArtwork, EditCollectedArtwork, SaveCollectedArtwork, SentRequestPriceEstimate, TappedCollectedArtwork, TappedCollectedArtworkImages, TappedRequestPriceEstimate } from "./MyCollection";
12
13
  import { TappedMyCollectionInsightsMedianAuctionPriceChartCareerHighlight, TappedMyCollectionInsightsMedianAuctionPriceChartCategory, TappedMyCollectionInsightsMedianAuctionPriceChartTimeframe, TappedMyCollectionInsightsMedianAuctionRailItem } from "./MyCollectionInsights";
@@ -26,7 +27,7 @@ import { ViewedVideo } from "./Video";
26
27
  *
27
28
  * Each event describes one ActionType
28
29
  */
29
- export declare 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 | 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 | 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;
30
+ export declare 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;
30
31
  /**
31
32
  * The top-level actions an Event describes.
32
33
  *
@@ -381,6 +382,10 @@ export declare enum ActionType {
381
382
  * Corresponds to {@link MaxBidSelected}
382
383
  */
383
384
  maxBidSelected = "maxBidSelected",
385
+ /**
386
+ * Corresponds to {@link MyCollectionOnboardingCompleted}
387
+ */
388
+ myCollectionOnboardingCompleted = "myCollectionOnboardingCompleted",
384
389
  /**
385
390
  * Corresponds to {@link OnboardingUserInputData}
386
391
  */
@@ -533,6 +538,10 @@ export declare enum ActionType {
533
538
  * Corresponds to {@link TappedExploreGroup}
534
539
  */
535
540
  tappedExploreGroup = "tappedExploreGroup",
541
+ /**
542
+ * Corresponds to {@link TappedExploreMyCollection}
543
+ */
544
+ tappedExploreMyCollection = "tappedExploreMyCollection",
536
545
  /**
537
546
  * Corresponds to {@link TappedFairCard}
538
547
  */
@@ -107,6 +107,7 @@ exports.ActionType = ActionType;
107
107
  ActionType["followedPartner"] = "followedPartner";
108
108
  ActionType["impression"] = "impression";
109
109
  ActionType["maxBidSelected"] = "maxBidSelected";
110
+ ActionType["myCollectionOnboardingCompleted"] = "myCollectionOnboardingCompleted";
110
111
  ActionType["onboardingUserInputData"] = "onboardingUserInputData";
111
112
  ActionType["priceDatabaseFilterParamsChanged"] = "priceDatabaseFilterParamsChanged";
112
113
  ActionType["promptForReview"] = "promptForReview";
@@ -145,6 +146,7 @@ exports.ActionType = ActionType;
145
146
  ActionType["tappedContactGallery"] = "tappedContactGallery";
146
147
  ActionType["tappedCreateAlert"] = "tappedCreateAlert";
147
148
  ActionType["tappedExploreGroup"] = "tappedExploreGroup";
149
+ ActionType["tappedExploreMyCollection"] = "tappedExploreMyCollection";
148
150
  ActionType["tappedFairCard"] = "tappedFairCard";
149
151
  ActionType["tappedFairGroup"] = "tappedFairGroup";
150
152
  ActionType["tappedInboxConversation"] = "tappedInboxConversation";
@@ -56,6 +56,7 @@ export declare enum ContextModule {
56
56
  curatedHighlightsRail = "curatedHighlightsRail",
57
57
  currentAuctions = "currentAuctions",
58
58
  currentShowsRail = "currentShowsRail",
59
+ doMoreOnArtsy = "doMoreOnArtsy",
59
60
  exhibitorsTab = "exhibitorsTab",
60
61
  fairCard = "fairCard",
61
62
  fairHome = "fairHome",
@@ -103,6 +104,7 @@ export declare enum ContextModule {
103
104
  myCollectionInsightsMedianAuctionRail = "myCollectionInsightsMedianAuctionRail",
104
105
  myCollectionInsightsMedianAuctionPriceChart = "myCollectionInsightsMedianAuctionPriceChart",
105
106
  myCollectionMarketSignals = "myCollectionMarketSignals",
107
+ myCollectionOnboarding = "myCollectionOnboarding",
106
108
  newWorksByArtistsYouFollowRail = "newWorksByArtistsYouFollowRail",
107
109
  newWorksForYouRail = "newWorksForYouRail",
108
110
  newWorksByGalleriesYouFollowRail = "newWorksByGalleriesYouFollowRail",
@@ -70,6 +70,7 @@ exports.ContextModule = ContextModule;
70
70
  ContextModule["curatedHighlightsRail"] = "curatedHighlightsRail";
71
71
  ContextModule["currentAuctions"] = "currentAuctions";
72
72
  ContextModule["currentShowsRail"] = "currentShowsRail";
73
+ ContextModule["doMoreOnArtsy"] = "doMoreOnArtsy";
73
74
  ContextModule["exhibitorsTab"] = "exhibitorsTab";
74
75
  ContextModule["fairCard"] = "fairCard";
75
76
  ContextModule["fairHome"] = "fairHome";
@@ -117,6 +118,7 @@ exports.ContextModule = ContextModule;
117
118
  ContextModule["myCollectionInsightsMedianAuctionRail"] = "myCollectionInsightsMedianAuctionRail";
118
119
  ContextModule["myCollectionInsightsMedianAuctionPriceChart"] = "myCollectionInsightsMedianAuctionPriceChart";
119
120
  ContextModule["myCollectionMarketSignals"] = "myCollectionMarketSignals";
121
+ ContextModule["myCollectionOnboarding"] = "myCollectionOnboarding";
120
122
  ContextModule["newWorksByArtistsYouFollowRail"] = "newWorksByArtistsYouFollowRail";
121
123
  ContextModule["newWorksForYouRail"] = "newWorksForYouRail";
122
124
  ContextModule["newWorksByGalleriesYouFollowRail"] = "newWorksByGalleriesYouFollowRail";
@@ -46,6 +46,7 @@ export declare enum OwnerType {
46
46
  myCollectionArtworkInsights = "MyCollectionArtworkInsights",
47
47
  myCollectionInsights = "myCollectionInsights",
48
48
  myCollectionInsightsMedianAuctionPrice = "myCollectionInsightsMedianAuctionPrice",
49
+ myCollectionOnboarding = "myCollectionOnboarding",
49
50
  newWorksForYou = "newWorksForYou",
50
51
  onboarding = "onboarding",
51
52
  ordersAccept = "orders-accept",
@@ -83,7 +84,7 @@ export declare enum OwnerType {
83
84
  /**
84
85
  * Owner types available in iOS/Android
85
86
  */
86
- export declare type ScreenOwnerType = OwnerType.allArtistSeries | OwnerType.article | OwnerType.articles | OwnerType.artist | OwnerType.artistAuctionResults | OwnerType.artistSeries | OwnerType.artwork | OwnerType.auctionResult | OwnerType.auctionResultsForArtistsYouFollow | OwnerType.auctions | OwnerType.cityGuideGuide | OwnerType.cityGuideMap | OwnerType.cityPicker | OwnerType.collection | OwnerType.consign | OwnerType.consignmentFlow | OwnerType.consignmentSubmission | OwnerType.conversation | OwnerType.conversationMakeOfferConfirmArtwork | OwnerType.explore | OwnerType.fair | OwnerType.fairArtworks | OwnerType.gene | OwnerType.home | OwnerType.inbox | OwnerType.inboxBids | OwnerType.inboxConversation | OwnerType.inboxInquiries | OwnerType.myCollection | OwnerType.myCollectionAddArtworkArtist | OwnerType.myCollectionArtwork | OwnerType.myCollectionArtwork | OwnerType.myCollectionArtworkAbout | OwnerType.myCollectionArtworkInsights | OwnerType.myCollectionInsights | OwnerType.myCollectionInsightsMedianAuctionPrice | OwnerType.newWorksForYou | OwnerType.onboarding | OwnerType.partner | OwnerType.profile | OwnerType.sale | OwnerType.reverseImageSearch | OwnerType.saleInformation | OwnerType.savedSearch | OwnerType.savedSearches | OwnerType.savesAndFollows | OwnerType.search | OwnerType.sell | OwnerType.show | OwnerType.shows | OwnerType.tag | OwnerType.viewingRoom | OwnerType.viewingRoomArtworkPage | OwnerType.viewingRoomArtworks | OwnerType.viewingRoomList | OwnerType.worksForYou;
87
+ export declare type ScreenOwnerType = OwnerType.allArtistSeries | OwnerType.article | OwnerType.articles | OwnerType.artist | OwnerType.artistAuctionResults | OwnerType.artistSeries | OwnerType.artwork | OwnerType.auctionResult | OwnerType.auctionResultsForArtistsYouFollow | OwnerType.auctions | OwnerType.cityGuideGuide | OwnerType.cityGuideMap | OwnerType.cityPicker | OwnerType.collection | OwnerType.consign | OwnerType.consignmentFlow | OwnerType.consignmentSubmission | OwnerType.conversation | OwnerType.conversationMakeOfferConfirmArtwork | OwnerType.explore | OwnerType.fair | OwnerType.fairArtworks | OwnerType.gene | OwnerType.home | OwnerType.inbox | OwnerType.inboxBids | OwnerType.inboxConversation | OwnerType.inboxInquiries | OwnerType.myCollection | OwnerType.myCollectionAddArtworkArtist | OwnerType.myCollectionArtwork | OwnerType.myCollectionArtwork | OwnerType.myCollectionArtworkAbout | OwnerType.myCollectionArtworkInsights | OwnerType.myCollectionInsights | OwnerType.myCollectionInsightsMedianAuctionPrice | OwnerType.myCollectionOnboarding | OwnerType.newWorksForYou | OwnerType.onboarding | OwnerType.partner | OwnerType.profile | OwnerType.sale | OwnerType.reverseImageSearch | OwnerType.saleInformation | OwnerType.savedSearch | OwnerType.savedSearches | OwnerType.savesAndFollows | OwnerType.search | OwnerType.sell | OwnerType.show | OwnerType.shows | OwnerType.tag | OwnerType.viewingRoom | OwnerType.viewingRoomArtworkPage | OwnerType.viewingRoomArtworks | OwnerType.viewingRoomList | OwnerType.worksForYou;
87
88
  /**
88
89
  * Owner types available in web/mobile web
89
90
  */
@@ -64,6 +64,7 @@ exports.OwnerType = OwnerType;
64
64
  OwnerType["myCollectionArtworkInsights"] = "MyCollectionArtworkInsights";
65
65
  OwnerType["myCollectionInsights"] = "myCollectionInsights";
66
66
  OwnerType["myCollectionInsightsMedianAuctionPrice"] = "myCollectionInsightsMedianAuctionPrice";
67
+ OwnerType["myCollectionOnboarding"] = "myCollectionOnboarding";
67
68
  OwnerType["newWorksForYou"] = "newWorksForYou";
68
69
  OwnerType["onboarding"] = "onboarding";
69
70
  OwnerType["ordersAccept"] = "orders-accept";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@artsy/cohesion",
3
- "version": "4.72.0",
3
+ "version": "4.73.0",
4
4
  "description": "Analytics schema",
5
5
  "main": "dist/index.js",
6
6
  "publishConfig": {