@artsy/cohesion 4.67.0 → 4.68.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.68.0 (Wed Oct 19 2022)
2
+
3
+ #### 🚀 Enhancement
4
+
5
+ - feat(FX-4379): Activity Panel tracking events [#356](https://github.com/artsy/cohesion/pull/356) ([@nickskalkin](https://github.com/nickskalkin))
6
+
7
+ #### Authors: 1
8
+
9
+ - Nikita Skalkin ([@nickskalkin](https://github.com/nickskalkin))
10
+
11
+ ---
12
+
1
13
  # v4.67.0 (Tue Oct 18 2022)
2
14
 
3
15
  #### 🚀 Enhancement
@@ -0,0 +1,60 @@
1
+ /**
2
+ * Schema describing Activity Panel related events
3
+ * @packageDocumentation
4
+ */
5
+ import { ActionType } from ".";
6
+ /**
7
+ * A user clicked on a notifications bell.
8
+ *
9
+ * This schema describes events sent to Segment from [[clickedNotificationsBell]]
10
+ *
11
+ * @example
12
+ * ```
13
+ * {
14
+ * action: "clickedNotificationsBell",
15
+ * user_id: "5bd8b675776bd6002c86526c"
16
+ * }
17
+ * ```
18
+ */
19
+ export interface ClickedNotificationsBell {
20
+ action: ActionType.clickedNotificationsBell;
21
+ user_id: string;
22
+ }
23
+ /**
24
+ * A user clicked on a notification in Activity Panel.
25
+ *
26
+ * This schema describes events sent to Segment from [[clickedActivityPanelNotificationItem]]
27
+ *
28
+ * @example
29
+ * ```
30
+ * {
31
+ * action: "clickedActivityPanelNotificationItem",
32
+ * user_id: "5bd8b675776bd6002c86526c",
33
+ * notification_type: "ARTWORK_ALERT"
34
+ * }
35
+ * ```
36
+ */
37
+ export interface ClickedActivityPanelNotificationItem {
38
+ action: ActionType.clickedActivityPanelNotificationItem;
39
+ user_id: string;
40
+ notification_type: string;
41
+ }
42
+ /**
43
+ * A user clicked on a tab in Activity Panel.
44
+ *
45
+ * This schema describes events sent to Segment from [[clickedActivityPanelTab]]
46
+ *
47
+ * @example
48
+ * ```
49
+ * {
50
+ * action: "clickedActivityPanelTab",
51
+ * user_id: "5bd8b675776bd6002c86526c",
52
+ * tab_name: "Alerts"
53
+ * }
54
+ * ```
55
+ */
56
+ export interface ClickedActivityPanelTab {
57
+ action: ActionType.clickedActivityPanelTab;
58
+ user_id: string;
59
+ tab_name: string;
60
+ }
@@ -0,0 +1 @@
1
+ "use strict";
@@ -1,4 +1,5 @@
1
1
  import { AddToCalendar } from "./AddToCalendar";
2
+ import { ClickedActivityPanelNotificationItem, ClickedActivityPanelTab, ClickedNotificationsBell } from "./ActivityPanel";
2
3
  import { AuctionPageView, BidPageView, ClickedActiveBid, ClickedRegisterToBid, ConfirmBid, ConfirmRegistrationPageview, EnterLiveAuction, MaxBidSelected, RegistrationPageView, RegistrationSubmitted } from "./Auction";
3
4
  import { AuthImpression, CompletedOnboarding, CreatedAccount, OnboardingUserInputData, ResetYourPassword, StartedOnboarding, SuccessfullyLoggedIn } from "./Authentication";
4
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";
@@ -24,7 +25,7 @@ import { ToggledAccordion } from "./UserExperienceInteractions";
24
25
  *
25
26
  * Each event describes one ActionType
26
27
  */
27
- 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 | ClickedPartnerLink | ClickedPaymentMethod | ClickedPaymentDetails | CheckedAccountBalance | ClickedPromoSpace | ClickedRegisterToBid | ClickedSelectShippingOption | ClickedShippingAddress | ClickedShowGroup | ClickedShowMore | ClickedVerifyIdentity | ClickedViewingRoomCard | ClickedOfferActions | ClickedOrderPage | CommercialFilterParamsChanged | CompletedOnboarding | ConfirmBid | ConfirmRegistrationPageview | ConsignmentArtistFailed | ConsignmentSubmitted | 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;
28
+ 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 | 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;
28
29
  /**
29
30
  * The top-level actions an Event describes.
30
31
  *
@@ -67,6 +68,14 @@ export declare enum ActionType {
67
68
  * Corresponds to {@link ClickedActiveBid}
68
69
  */
69
70
  clickedActiveBid = "clickedActiveBid",
71
+ /**
72
+ * Corresponds to {@link ClickedActivityPanelNotificationItem}
73
+ */
74
+ clickedActivityPanelNotificationItem = "clickedActivityPanelNotificationItem",
75
+ /**
76
+ * Corresponds to {@link ClickedActivityPanelTab}
77
+ */
78
+ clickedActivityPanelTab = "clickedActivityPanelTab",
70
79
  /**
71
80
  * Corresponds to {@link ClickedAddNewShippingAddress}
72
81
  */
@@ -175,6 +184,10 @@ export declare enum ActionType {
175
184
  * Corresponds to {@link ClickedNavigationTab}
176
185
  */
177
186
  clickedNavigationTab = "clickedNavigationTab",
187
+ /**
188
+ * Corresponds to {@link ClickedNotificationsBell}
189
+ */
190
+ clickedNotificationsBell = "clickedNotificationsBell",
178
191
  /**
179
192
  * Corresponds to {@link ClickedOfferActions}
180
193
  */
@@ -29,6 +29,8 @@ exports.ActionType = ActionType;
29
29
  ActionType["bidPageView"] = "bidPageView";
30
30
  ActionType["checkedAccountBalance"] = "checkedAccountBalance";
31
31
  ActionType["clickedActiveBid"] = "clickedActiveBid";
32
+ ActionType["clickedActivityPanelNotificationItem"] = "clickedActivityPanelNotificationItem";
33
+ ActionType["clickedActivityPanelTab"] = "clickedActivityPanelTab";
32
34
  ActionType["clickedAddNewShippingAddress"] = "clickedAddNewShippingAddress";
33
35
  ActionType["clickedAddWorksToFair"] = "clickedAddWorksToFair";
34
36
  ActionType["clickedAppDownload"] = "clickedAppDownload";
@@ -56,6 +58,7 @@ exports.ActionType = ActionType;
56
58
  ActionType["clickedMainArtworkGrid"] = "clickedMainArtworkGrid";
57
59
  ActionType["clickedMyCollectionInsightsMedianAuctionRailItem"] = "clickedMyCollectionInsightsMedianAuctionRailItem";
58
60
  ActionType["clickedNavigationTab"] = "clickedNavigationTab";
61
+ ActionType["clickedNotificationsBell"] = "clickedNotificationsBell";
59
62
  ActionType["clickedOfferActions"] = "clickedOfferActions";
60
63
  ActionType["clickedOfferOption"] = "clickedOfferOption";
61
64
  ActionType["clickedOnArtworkShippingUnitsDropdown"] = "clickedOnArtworkShippingUnitsDropdown";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@artsy/cohesion",
3
- "version": "4.67.0",
3
+ "version": "4.68.0",
4
4
  "description": "Analytics schema",
5
5
  "main": "dist/index.js",
6
6
  "publishConfig": {