@artsy/cohesion 4.14.0 → 4.15.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.15.0 (Thu Oct 14 2021)
2
+
3
+ #### 🚀 Enhancement
4
+
5
+ - Adding new events to Cohesion [#255](https://github.com/artsy/cohesion/pull/255) ([@audrey-thenot](https://github.com/audrey-thenot))
6
+
7
+ #### Authors: 1
8
+
9
+ - [@audrey-thenot](https://github.com/audrey-thenot)
10
+
11
+ ---
12
+
1
13
  # v4.14.0 (Wed Oct 13 2021)
2
14
 
3
15
  #### 🚀 Enhancement
@@ -71,7 +71,7 @@ export interface TappedInboxConversation {
71
71
  partner_id: string;
72
72
  }
73
73
  /**
74
- * A user taps the make offer button
74
+ * A user taps the make offer button either on an artwork page (BNMO) or inquiry conversation.
75
75
  *
76
76
  * This schema describes events sent to Segment from [[tappedMakeOffer]]
77
77
  *
@@ -86,8 +86,10 @@ export interface TappedInboxConversation {
86
86
  */
87
87
  export interface TappedMakeOffer {
88
88
  action: ActionType.tappedMakeOffer;
89
- context_owner_type: OwnerType.conversation;
90
- impulse_conversation_id: string;
89
+ context_owner_type: OwnerType;
90
+ context_owner_slug?: string;
91
+ context_owner_id?: string;
92
+ impulse_conversation_id?: string;
91
93
  }
92
94
  /**
93
95
  * A user taps to view an offer
@@ -656,3 +656,67 @@ export interface TappedCreateAlert {
656
656
  context_screen_owner_id?: string;
657
657
  context_screen_owner_slug?: string;
658
658
  }
659
+ /**
660
+ * A user taps "Bid" on an artwork page inside an Auction
661
+ *
662
+ * This schema describes events sent to Segment from [[tappedBid]]
663
+ *
664
+ * @example
665
+ * ```
666
+ * {
667
+ * action: "tappedBid",
668
+ * context_owner_type: "Artwork",
669
+ * context_owner_slug: "radna-segal-pearl",
670
+ * context_owner_id: "6164889300d643000db86504",
671
+ * }
672
+ * ```
673
+ */
674
+ export interface TappedBid {
675
+ action: ActionType.tappedBid;
676
+ context_owner_type: ScreenOwnerType;
677
+ context_owner_id: string;
678
+ context_owner_slug: string;
679
+ }
680
+ /**
681
+ * A user taps "Buy Now" on an artwork page (BNMO)
682
+ *
683
+ * This schema describes events sent to Segment from [[tappedBuyNow]]
684
+ *
685
+ * @example
686
+ * ```
687
+ * {
688
+ * action: "tappedBuyNow",
689
+ * context_owner_type: "Artwork",
690
+ * context_owner_slug: "radna-segal-pearl",
691
+ * context_owner_id: "6164889300d643000db86504",
692
+ * }
693
+ * ```
694
+ */
695
+ export interface TappedBuyNow {
696
+ action: ActionType.tappedBuyNow;
697
+ context_owner_type: ScreenOwnerType;
698
+ context_owner_id: string;
699
+ context_owner_slug: string;
700
+ }
701
+ /**
702
+ * A user taps on 'Contact Gallery' on an artwork page
703
+ *
704
+ * This schema describes events sent to Segment from [[tappedContactGallery]]
705
+ *
706
+ * @example
707
+ * ```
708
+ * {
709
+ * action: "tappedContactGallery",
710
+ * context_owner_type: "Artwork",
711
+ * context_owner_slug: "radna-segal-pearl",
712
+ * context_owner_id: "6164889300d643000db86504",
713
+
714
+ * }
715
+ * ```
716
+ */
717
+ export interface TappedContactGallery {
718
+ action: ActionType.tappedContactGallery;
719
+ context_owner_type: OwnerType;
720
+ context_owner_slug: string;
721
+ context_owner_id: string;
722
+ }
@@ -9,14 +9,14 @@ import { FollowEvents } from "./SavesAndFollows";
9
9
  import { ConsignmentArtistFailed, FocusedOnPriceDatabaseSearchInput, FocusedOnSearchInput, SearchedPriceDatabase, SearchedWithNoResults, SelectedItemFromPriceDatabaseSearch, SelectedItemFromSearch } from "./Search";
10
10
  import { Share } from "./Share";
11
11
  import { SaleScreenLoadComplete, Screen, TimeOnPage } from "./System";
12
- import { TappedArticleGroup, TappedArtistGroup, TappedArtistSeriesGroup, TappedArtworkGroup, TappedAuctionGroup, TappedAuctionResultGroup, TappedCollectionGroup, TappedConsign, TappedCreateAlert, TappedExploreGroup, TappedFairCard, TappedFairGroup, TappedInfoBubble, TappedLink, TappedMainArtworkGrid, TappedNavigationTab, TappedPartnerCard, TappedPromoSpace, TappedSell, TappedShowMore, TappedTabBar, TappedVerifyIdentity, TappedViewingRoomCard, TappedViewingRoomGroup } from "./Tap";
12
+ import { TappedArticleGroup, TappedArtistGroup, TappedArtistSeriesGroup, TappedArtworkGroup, TappedAuctionGroup, TappedAuctionResultGroup, TappedBid, TappedBuyNow, TappedCollectionGroup, TappedConsign, TappedContactGallery, TappedCreateAlert, TappedExploreGroup, TappedFairCard, TappedFairGroup, TappedInfoBubble, TappedLink, TappedMainArtworkGrid, TappedNavigationTab, TappedPartnerCard, TappedPromoSpace, TappedSell, TappedShowMore, TappedTabBar, TappedVerifyIdentity, TappedViewingRoomCard, TappedViewingRoomGroup } from "./Tap";
13
13
  import { ToggledNotification, ToggledSavedSearch } from "./Toggle";
14
14
  /**
15
15
  * Master list of valid schemas for analytics actions
16
16
  *
17
17
  * Each event describes one ActionType
18
18
  */
19
- export declare type Event = AddToCalendar | AddCollectedArtwork | AuctionResultsFilterParamsChanged | AuthImpression | CreatedAccount | ClickedAddNewShippingAddress | ClickedAddWorksToFair | ClickedAppDownload | ClickedArticleGroup | ClickedArtistGroup | ClickedArtistSeriesGroup | ClickedArtworkGroup | ClickedAuctionGroup | ClickedBuyerProtection | ClickedChangePage | ClickedChangePaymentMethod | ClickedChangeShippingAddress | ClickedChangeShippingMethod | ClickedCollectionGroup | ClickedDeliveryMethod | ClickedEditArtwork | ClickedExpansionToggle | ClickedFairCard | ClickedFairGroup | ClickedGalleryGroup | ClickedLoadMore | ClickedMainArtworkGrid | ClickedNavigationTab | ClickedOnArtworkShippingWeight | ClickedOnArtworkShippingUnitsDropdown | ClickedOnFramedMeasurements | ClickedOnFramedMeasurementsDropdown | ClickedOnSubmitOrder | ClickedSnooze | ClickedPartnerCard | ClickedPromoSpace | ClickedSelectShippingOption | ClickedShippingAddress | ClickedShowGroup | ClickedShowMore | ClickedVerifyIdentity | ClickedViewingRoomCard | CommercialFilterParamsChanged | ConsignmentArtistFailed | DeleteCollectedArtwork | DeletedSavedSearch | EditCollectedArtwork | EditedSavedSearch | FocusedOnConversationMessageInput | FocusedOnSearchInput | FocusedOnPriceDatabaseSearchInput | FollowEvents | OnboardingUserInputData | PriceDatabaseFilterParamsChanged | ResetYourPassword | SaleScreenLoadComplete | Screen | SearchedPriceDatabase | SearchedWithNoResults | SelectedItemFromSearch | SelectedItemFromPriceDatabaseSearch | SentConversationMessage | Share | SuccessfullyLoggedIn | TappedArticleGroup | TappedArtistGroup | TappedArtistSeriesGroup | TappedArtworkGroup | TappedAuctionGroup | TappedAuctionResultGroup | TappedCollectedArtwork | TappedCollectedArtworkImages | TappedCollectionGroup | TappedConsign | TappedCreateAlert | TappedExploreGroup | TappedFairCard | TappedFairGroup | TappedInboxConversation | TappedInfoBubble | TappedLink | TappedNavigationTab | TappedMainArtworkGrid | TappedMakeOffer | TappedPartnerCard | TappedPromoSpace | TappedSell | TappedShowMore | TappedTabBar | TappedVerifyIdentity | TappedViewingRoomCard | TappedViewingRoomGroup | TappedViewOffer | TimeOnPage | ToggledNotification | ToggledSavedSearch;
19
+ export declare type Event = AddToCalendar | AddCollectedArtwork | AuctionResultsFilterParamsChanged | AuthImpression | CreatedAccount | ClickedAddNewShippingAddress | ClickedAddWorksToFair | ClickedAppDownload | ClickedArticleGroup | ClickedArtistGroup | ClickedArtistSeriesGroup | ClickedArtworkGroup | ClickedAuctionGroup | ClickedBuyerProtection | ClickedChangePage | ClickedChangePaymentMethod | ClickedChangeShippingAddress | ClickedChangeShippingMethod | ClickedCollectionGroup | ClickedDeliveryMethod | ClickedEditArtwork | ClickedExpansionToggle | ClickedFairCard | ClickedFairGroup | ClickedGalleryGroup | ClickedLoadMore | ClickedMainArtworkGrid | ClickedNavigationTab | ClickedOnArtworkShippingWeight | ClickedOnArtworkShippingUnitsDropdown | ClickedOnFramedMeasurements | ClickedOnFramedMeasurementsDropdown | ClickedOnSubmitOrder | ClickedSnooze | ClickedPartnerCard | ClickedPromoSpace | ClickedSelectShippingOption | ClickedShippingAddress | ClickedShowGroup | ClickedShowMore | ClickedVerifyIdentity | ClickedViewingRoomCard | CommercialFilterParamsChanged | ConsignmentArtistFailed | DeleteCollectedArtwork | DeletedSavedSearch | EditCollectedArtwork | EditedSavedSearch | FocusedOnConversationMessageInput | FocusedOnSearchInput | FocusedOnPriceDatabaseSearchInput | FollowEvents | OnboardingUserInputData | PriceDatabaseFilterParamsChanged | ResetYourPassword | SaleScreenLoadComplete | Screen | SearchedPriceDatabase | SearchedWithNoResults | SelectedItemFromSearch | SelectedItemFromPriceDatabaseSearch | SentConversationMessage | Share | 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 | TappedSell | TappedShowMore | TappedTabBar | TappedVerifyIdentity | TappedViewingRoomCard | TappedViewingRoomGroup | TappedViewOffer | TimeOnPage | ToggledNotification | ToggledSavedSearch;
20
20
  /**
21
21
  * The top-level actions an Event describes.
22
22
  *
@@ -196,6 +196,10 @@ export declare enum ActionType {
196
196
  * Corresponds to {@link ConsignmentArtistFailed}
197
197
  */
198
198
  consignmentArtistFailed = "consignmentArtistFailed",
199
+ /**
200
+ * Corresponds to {@link ContactGallery}
201
+ */
202
+ contactGallery = "contactGallery",
199
203
  /**
200
204
  * Corresponds to {@link CreatedAccount}
201
205
  */
@@ -324,6 +328,14 @@ export declare enum ActionType {
324
328
  * Corresponds to {@link TappedAuctionResultGroup}
325
329
  */
326
330
  tappedAuctionResultGroup = "tappedAuctionResultGroup",
331
+ /**
332
+ * Corresponds to {@link TappedBid}
333
+ */
334
+ tappedBid = "tappedBid",
335
+ /**
336
+ * Corresponds to {@link TappedBuyNow}
337
+ */
338
+ tappedBuyNow = "tappedBuyNow",
327
339
  /**
328
340
  * Corresponds to {@link TappedCollectedArtwork}
329
341
  */
@@ -340,6 +352,10 @@ export declare enum ActionType {
340
352
  * Corresponds to {@link TappedConsign}
341
353
  */
342
354
  tappedConsign = "tappedConsign",
355
+ /**
356
+ * Corresponds to {@link TappedContactGallery}
357
+ */
358
+ tappedContactGallery = "tappedContactGallery",
343
359
  /**
344
360
  * Corresponds to {@link TappedCreateAlert}
345
361
  */
@@ -63,6 +63,7 @@ exports.ActionType = ActionType;
63
63
  ActionType["clickedViewingRoomCard"] = "clickedViewingRoomCard";
64
64
  ActionType["commercialFilterParamsChanged"] = "commercialFilterParamsChanged";
65
65
  ActionType["consignmentArtistFailed"] = "consignmentArtistFailed";
66
+ ActionType["contactGallery"] = "contactGallery";
66
67
  ActionType["createdAccount"] = "createdAccount";
67
68
  ActionType["deleteCollectedArtwork"] = "deleteCollectedArtwork";
68
69
  ActionType["deletedSavedSearch"] = "deletedSavedSearch";
@@ -95,10 +96,13 @@ exports.ActionType = ActionType;
95
96
  ActionType["tappedArtworkGroup"] = "tappedArtworkGroup";
96
97
  ActionType["tappedAuctionGroup"] = "tappedAuctionGroup";
97
98
  ActionType["tappedAuctionResultGroup"] = "tappedAuctionResultGroup";
99
+ ActionType["tappedBid"] = "tappedBid";
100
+ ActionType["tappedBuyNow"] = "tappedBuyNow";
98
101
  ActionType["tappedCollectedArtwork"] = "tappedCollectedArtwork";
99
102
  ActionType["tappedCollectedArtworkImages"] = "tappedCollectedArtworkImages";
100
103
  ActionType["tappedCollectionGroup"] = "tappedCollectionGroup";
101
104
  ActionType["tappedConsign"] = "tappedConsign";
105
+ ActionType["tappedContactGallery"] = "tappedContactGallery";
102
106
  ActionType["tappedCreateAlert"] = "tappedCreateAlert";
103
107
  ActionType["tappedExploreGroup"] = "tappedExploreGroup";
104
108
  ActionType["tappedFairGroup"] = "tappedFairGroup";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@artsy/cohesion",
3
- "version": "4.14.0",
3
+ "version": "4.15.0",
4
4
  "description": "Analytics schema",
5
5
  "main": "dist/index.js",
6
6
  "publishConfig": {