@artsy/cohesion 4.209.0 → 4.210.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.210.0 (Wed Oct 23 2024)
2
+
3
+ #### 🚀 Enhancement
4
+
5
+ - feat(EMI-2098): Add tappedNotification and tappedClearNotification to the schema [#533](https://github.com/artsy/cohesion/pull/533) ([@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.209.0 (Mon Oct 21 2024)
2
14
 
3
15
  #### 🚀 Enhancement
@@ -220,6 +220,31 @@ export interface TappedAuctionResultGroup extends TappedEntityGroup {
220
220
  export interface TappedBrowseSimilarArtworks extends TappedEntityGroup {
221
221
  action: ActionType.tappedBrowseSimilarArtworks;
222
222
  }
223
+ /**
224
+ * A user taps on clear (or swipes away) on a task notification in the app
225
+ *
226
+ * This schema describes events sent to Segment from [[tappedClearNotification]]
227
+ *
228
+ * @example
229
+ * ```
230
+ * {
231
+ * action: "tappedClearNotification",
232
+ * context_module : "Home",
233
+ * context_screen_owner_type: "Home",
234
+ * destination_path: "/orders/123",
235
+ * notification_id: "23424132",
236
+ * notification_category: "send_wire"
237
+ * }
238
+ * ```
239
+ */
240
+ export interface TappedClearNotification {
241
+ action: ActionType.tappedClearNotification;
242
+ context_module: ContextModule;
243
+ context_screen_owner_type: ScreenOwnerType;
244
+ destination_path: string;
245
+ notification_id: string;
246
+ notification_category: string;
247
+ }
223
248
  /**
224
249
  * A user taps a grouping of collections on iOS
225
250
  *
@@ -1065,6 +1090,31 @@ export interface TappedNewsSection {
1065
1090
  destination_screen_owner_type: ScreenOwnerType;
1066
1091
  destination_screen_owner_id: string;
1067
1092
  }
1093
+ /**
1094
+ * A user taps on a task notification in the app
1095
+ *
1096
+ * This schema describes events sent to Segment from [[tappedNotification]]
1097
+ *
1098
+ * @example
1099
+ * ```
1100
+ * {
1101
+ * action: "tappedNotification",
1102
+ * context_module : "Home",
1103
+ * context_screen_owner_type: "Home",
1104
+ * destination_path: "/orders/123",
1105
+ * notification_id: "23424132",
1106
+ * notification_category: "send_wire"
1107
+ * }
1108
+ * ```
1109
+ */
1110
+ export interface TappedNotification {
1111
+ action: ActionType.tappedNotification;
1112
+ context_module: ContextModule;
1113
+ context_screen_owner_type: ScreenOwnerType;
1114
+ destination_path: string;
1115
+ notification_id: string;
1116
+ notification_category: string;
1117
+ }
1068
1118
  /**
1069
1119
  * A user clicks on View Work on the notification page.
1070
1120
  *
@@ -23,7 +23,7 @@ import { FollowEvents } from "./SavesAndFollows";
23
23
  import { AddressAutoCompletionResult, ConsignmentArtistFailed, EditedAutocompletedAddress, FocusedOnPriceDatabaseSearchInput, FocusedOnSearchInput, SearchedPriceDatabase, SearchedWithNoResults, SearchedWithResults, SelectedItemFromAddressAutoCompletion, SelectedItemFromPriceDatabaseSearch, SelectedItemFromSearch, SelectedSearchSuggestionQuickNavigationItem } from "./Search";
24
24
  import { Share } from "./Share";
25
25
  import { SaleScreenLoadComplete, Screen, TimeOnPage } from "./System";
26
- import { TappedActivityGroup, TappedArticleGroup, TappedArticleShare, TappedArtistGroup, TappedArtistSeriesGroup, TappedArtworkGroup, TappedAuctionGroup, TappedAuctionResultGroup, TappedBid, TappedBrowseSimilarArtworks, TappedBuyNow, TappedCollectionGroup, TappedConsign, TappedConsignmentInquiry, TappedContactGallery, TappedCreateAlert, TappedExploreGroup, TappedFairCard, TappedFairGroup, TappedInfoBubble, TappedLearnMore, TappedLink, TappedMainArtworkGrid, TappedNavigationTab, TappedPartnerCard, TappedPromoSpace, TappedSell, TappedSellArtwork, TappedShowMore, TappedSkip, TappedTabBar, TappedVerifyIdentity, TappedViewingRoomCard, TappedViewingRoomGroup, TappedViewWork } from "./Tap";
26
+ import { TappedActivityGroup, TappedArticleGroup, TappedArticleShare, TappedArtistGroup, TappedArtistSeriesGroup, TappedArtworkGroup, TappedAuctionGroup, TappedAuctionResultGroup, TappedBid, TappedBrowseSimilarArtworks, TappedBuyNow, TappedClearNotification, TappedCollectionGroup, TappedConsign, TappedConsignmentInquiry, TappedContactGallery, TappedCreateAlert, TappedExploreGroup, TappedFairCard, TappedFairGroup, TappedInfoBubble, TappedLearnMore, TappedLink, TappedMainArtworkGrid, TappedNavigationTab, TappedNotification, TappedPartnerCard, TappedPromoSpace, TappedSell, TappedSellArtwork, TappedShowMore, TappedSkip, TappedTabBar, TappedVerifyIdentity, TappedViewingRoomCard, TappedViewingRoomGroup, TappedViewWork } from "./Tap";
27
27
  import { ToggledNotification, ToggledSavedSearch } from "./Toggle";
28
28
  import { UploadSizeLimitExceeded } from "./UploadSizeLimitExceeded";
29
29
  import { ToggledAccordion } from "./UserExperienceInteractions";
@@ -33,7 +33,7 @@ import { ViewedVideo } from "./Video";
33
33
  *
34
34
  * Each event describes one ActionType
35
35
  */
36
- export type Event = AddedArtworkToArtworkList | AddedToAlbum | AddToCalendar | AddCollectedArtwork | AddressAutoCompletionResult | ArtworkDetailsCompleted | AuctionPageView | AuctionResultsFilterParamsChanged | AuthImpression | BidPageView | CreatedAccount | CreatedArtworkList | ClickedActiveBid | ClickedActivityPanelNotificationItem | ClickedActivityPanelTab | ClickedAddFilters | ClickedAddMissingArtworksDetails | ClickedAddNewShippingAddress | ClickedAddWorksToFair | ClickedAlertsFilters | ClickedAppDownload | ClickedArticleGroup | ClickedArtistGroup | ClickedArtistSeriesGroup | ClickedArtworkGroup | ClickedAuctionGroup | ClickedAuctionResultItem | ClickedBuyerProtection | ClickedChangePage | ClickedChangePaymentMethod | ClickedChangeShippingAddress | ClickedChangeShippingMethod | ClickedCollectionGroup | ClickedCreateAlert | ClickedDeliveryMethod | ClickedEditArtwork | ClickedExpandFilterPanel | ClickedExpansionToggle | ClickedFairCard | ClickedFairGroup | ClickedGalleryGroup | ClickedLoadMore | ClickedMainArtworkGrid | ClickedMarketingModal | ClickedNavigationTab | ClickedNavBar | ClickedNotificationsBell | ClickedOfferOption | ClickedOnArtworkShippingWeight | ClickedOnArtworkShippingUnitsDropdown | ClickedOnBuyNowCheckbox | ClickedOnDuplicateArtwork | ClickedOnFramedMeasurements | ClickedOnFramedMeasurementsDropdown | ClickedOnLearnMore | ClickedOnMakeOfferCheckbox | ClickedOnPagination | ClickedOnPriceDisplayDropdown | ClickedOnReadMore | ClickedPublish | ClickedOnSubmitOrder | ClickedSnooze | ClickedUploadArtwork | ClickedPartnerCard | ClickedPartnerLink | ClickedPaymentMethod | ClickedPaymentDetails | CheckedAccountBalance | ClickedPromoSpace | ClickedRegisterToBid | ClickedSelectShippingOption | ClickedSendPartnerOffer | ClickedShippingAddress | ClickedShowGroup | ClickedShowMore | ClickedStartPartnerOffer | ClickedVerifyIdentity | ClickedViewingRoomCard | ClickedOfferActions | ClickedOrderPage | ClickedOrderSummary | ClickedDismissInquiry | ClickedMarkSpam | ClickedMarkSold | ClickedConversationsFilter | ClickedUpdateArtwork | ClickedValidationAddressOptions | ClickedCloseValidationAddressModal | ClickedViewWork | ClickedDownloadAppFooter | ClickedDownloadAppHeader | CommercialFilterParamsChanged | CompletedOfflineSync | CompletedOnboarding | ConfirmBid | ConfirmRegistrationPageview | ConsignmentArtistFailed | ConsignmentSubmitted | ContactInformationCompleted | CreatedAlbum | DeleteCollectedArtwork | EditedAlert | DeletedArtworkList | DeletedSavedSearch | EditCollectedArtwork | EditedArtworkList | EditedAutocompletedAddress | EditedSavedSearch | EditedUserProfile | EnterLiveAuction | ErrorMessageViewed | ExperimentViewed | EditProfileModalViewed | ItemViewed | UploadSizeLimitExceeded | FocusedOnConversationMessageInput | FocusedOnSearchInput | FocusedOnPriceDatabaseSearchInput | FollowEvents | Impression | MaxBidSelected | MyCollectionOnboardingCompleted | OnboardingUserInputData | PriceDatabaseFilterParamsChanged | PromptForReview | RailViewed | ValidationAddressViewed | RegistrationPageView | RegistrationSubmitted | ResetYourPassword | SaleScreenLoadComplete | SaveCollectedArtwork | SavedCookieConsentPreferences | Screen | SearchedPriceDatabase | SearchedWithNoResults | SearchedWithResults | SelectedItemFromSearch | SelectedItemFromPriceDatabaseSearch | SelectedItemFromAddressAutoCompletion | SelectedRecentPriceRange | SelectedSearchSuggestionQuickNavigationItem | SendOffersBannerViewed | SendOffersErrorMessage | SendOffersModalViewed | SentContent | SentConsignmentInquiry | SentConversationMessage | SentRequestPriceEstimate | Share | StartedOnboarding | SubmitAnotherArtwork | SuccessfullyLoggedIn | TappedActivityGroup | TappedArticleGroup | TappedArticleShare | TappedArtistGroup | TappedArtistSeriesGroup | TappedArtworkGroup | TappedAuctionGroup | TappedAuctionResultGroup | TappedBid | TappedBrowseSimilarArtworks | TappedBuyNow | TappedCollectedArtwork | TappedCollectedArtworkImages | TappedCollectionGroup | TappedConsign | TappedContactGallery | TappedConsignmentInquiry | TappedCreateAlert | TappedExploreGroup | TappedExploreMyCollection | TappedFairCard | TappedFairGroup | TappedInboxConversation | TappedInfoBubble | TappedLink | TappedNavigationTab | TappedNotificationsBell | TappedMainArtworkGrid | TappedMakeOffer | TappedMyCollectionInsightsMedianAuctionRailItem | TappedMyCollectionInsightsMedianAuctionPriceChartCareerHighlight | TappedMyCollectionInsightsMedianAuctionPriceChartCategory | TappedMyCollectionInsightsMedianAuctionPriceChartTimeframe | TappedMyCollectionAddArtworkArtist | TappedPartnerCard | TappedProductCapabilitiesGroup | TappedPromoSpace | TappedRequestPriceEstimate | TappedSell | TappedSellArtwork | TappedShowMore | TappedLearnMore | TappedSkip | TappedTabBar | TappedVerifyIdentity | TappedViewingRoomCard | TappedViewingRoomGroup | TappedViewOffer | TappedViewWork | TimeOnPage | ToggledAccordion | ToggledNotification | ToggledPresentationModeSetting | ToggledSavedSearch | TooltipViewed | UploadPhotosCompleted | ViewArtworkMyCollection | ViewedArtworkList | ViewedVideo | VisitMyCollection | VisitMyCollectionOnboardingSlide;
36
+ export type Event = AddedArtworkToArtworkList | AddedToAlbum | AddToCalendar | AddCollectedArtwork | AddressAutoCompletionResult | ArtworkDetailsCompleted | AuctionPageView | AuctionResultsFilterParamsChanged | AuthImpression | BidPageView | CreatedAccount | CreatedArtworkList | ClickedActiveBid | ClickedActivityPanelNotificationItem | ClickedActivityPanelTab | ClickedAddFilters | ClickedAddMissingArtworksDetails | ClickedAddNewShippingAddress | ClickedAddWorksToFair | ClickedAlertsFilters | ClickedAppDownload | ClickedArticleGroup | ClickedArtistGroup | ClickedArtistSeriesGroup | ClickedArtworkGroup | ClickedAuctionGroup | ClickedAuctionResultItem | ClickedBuyerProtection | ClickedChangePage | ClickedChangePaymentMethod | ClickedChangeShippingAddress | ClickedChangeShippingMethod | ClickedCollectionGroup | ClickedCreateAlert | ClickedDeliveryMethod | ClickedEditArtwork | ClickedExpandFilterPanel | ClickedExpansionToggle | ClickedFairCard | ClickedFairGroup | ClickedGalleryGroup | ClickedLoadMore | ClickedMainArtworkGrid | ClickedMarketingModal | ClickedNavigationTab | ClickedNavBar | ClickedNotificationsBell | ClickedOfferOption | ClickedOnArtworkShippingWeight | ClickedOnArtworkShippingUnitsDropdown | ClickedOnBuyNowCheckbox | ClickedOnDuplicateArtwork | ClickedOnFramedMeasurements | ClickedOnFramedMeasurementsDropdown | ClickedOnLearnMore | ClickedOnMakeOfferCheckbox | ClickedOnPagination | ClickedOnPriceDisplayDropdown | ClickedOnReadMore | ClickedPublish | ClickedOnSubmitOrder | ClickedSnooze | ClickedUploadArtwork | ClickedPartnerCard | ClickedPartnerLink | ClickedPaymentMethod | ClickedPaymentDetails | CheckedAccountBalance | ClickedPromoSpace | ClickedRegisterToBid | ClickedSelectShippingOption | ClickedSendPartnerOffer | ClickedShippingAddress | ClickedShowGroup | ClickedShowMore | ClickedStartPartnerOffer | ClickedVerifyIdentity | ClickedViewingRoomCard | ClickedOfferActions | ClickedOrderPage | ClickedOrderSummary | ClickedDismissInquiry | ClickedMarkSpam | ClickedMarkSold | ClickedConversationsFilter | ClickedUpdateArtwork | ClickedValidationAddressOptions | ClickedCloseValidationAddressModal | ClickedViewWork | ClickedDownloadAppFooter | ClickedDownloadAppHeader | CommercialFilterParamsChanged | CompletedOfflineSync | CompletedOnboarding | ConfirmBid | ConfirmRegistrationPageview | ConsignmentArtistFailed | ConsignmentSubmitted | ContactInformationCompleted | CreatedAlbum | DeleteCollectedArtwork | EditedAlert | DeletedArtworkList | DeletedSavedSearch | EditCollectedArtwork | EditedArtworkList | EditedAutocompletedAddress | EditedSavedSearch | EditedUserProfile | EnterLiveAuction | ErrorMessageViewed | ExperimentViewed | EditProfileModalViewed | ItemViewed | UploadSizeLimitExceeded | FocusedOnConversationMessageInput | FocusedOnSearchInput | FocusedOnPriceDatabaseSearchInput | FollowEvents | Impression | MaxBidSelected | MyCollectionOnboardingCompleted | OnboardingUserInputData | PriceDatabaseFilterParamsChanged | PromptForReview | RailViewed | ValidationAddressViewed | RegistrationPageView | RegistrationSubmitted | ResetYourPassword | SaleScreenLoadComplete | SaveCollectedArtwork | SavedCookieConsentPreferences | Screen | SearchedPriceDatabase | SearchedWithNoResults | SearchedWithResults | SelectedItemFromSearch | SelectedItemFromPriceDatabaseSearch | SelectedItemFromAddressAutoCompletion | SelectedRecentPriceRange | SelectedSearchSuggestionQuickNavigationItem | SendOffersBannerViewed | SendOffersErrorMessage | SendOffersModalViewed | SentContent | SentConsignmentInquiry | SentConversationMessage | SentRequestPriceEstimate | Share | StartedOnboarding | SubmitAnotherArtwork | SuccessfullyLoggedIn | TappedActivityGroup | TappedArticleGroup | TappedArticleShare | TappedArtistGroup | TappedArtistSeriesGroup | TappedArtworkGroup | TappedAuctionGroup | TappedAuctionResultGroup | TappedBid | TappedBrowseSimilarArtworks | TappedBuyNow | TappedClearNotification | TappedCollectedArtwork | TappedCollectedArtworkImages | TappedCollectionGroup | TappedConsign | TappedContactGallery | TappedConsignmentInquiry | TappedCreateAlert | TappedExploreGroup | TappedExploreMyCollection | TappedFairCard | TappedFairGroup | TappedInboxConversation | TappedInfoBubble | TappedLink | TappedNavigationTab | TappedNotification | TappedNotificationsBell | TappedMainArtworkGrid | TappedMakeOffer | TappedMyCollectionInsightsMedianAuctionRailItem | TappedMyCollectionInsightsMedianAuctionPriceChartCareerHighlight | TappedMyCollectionInsightsMedianAuctionPriceChartCategory | TappedMyCollectionInsightsMedianAuctionPriceChartTimeframe | TappedMyCollectionAddArtworkArtist | TappedPartnerCard | TappedProductCapabilitiesGroup | TappedPromoSpace | TappedRequestPriceEstimate | TappedSell | TappedSellArtwork | TappedShowMore | TappedLearnMore | TappedSkip | TappedTabBar | TappedVerifyIdentity | TappedViewingRoomCard | TappedViewingRoomGroup | TappedViewOffer | TappedViewWork | TimeOnPage | ToggledAccordion | ToggledNotification | ToggledPresentationModeSetting | ToggledSavedSearch | TooltipViewed | UploadPhotosCompleted | ViewArtworkMyCollection | ViewedArtworkList | ViewedVideo | VisitMyCollection | VisitMyCollectionOnboardingSlide;
37
37
  /**
38
38
  * The top-level actions an Event describes.
39
39
  *
@@ -800,6 +800,10 @@ export declare enum ActionType {
800
800
  * Corresponds to {@link TappedBuyNow}
801
801
  */
802
802
  tappedBuyNow = "tappedBuyNow",
803
+ /**
804
+ * Corresponds to {@link TappedClearNotification}
805
+ */
806
+ tappedClearNotification = "tappedClearNotification",
803
807
  /**
804
808
  * Corresponds to {@link TappedCollectedArtwork}
805
809
  */
@@ -908,6 +912,10 @@ export declare enum ActionType {
908
912
  * Corresponds to {@link TappedNavigationTab}
909
913
  */
910
914
  tappedNavigationTab = "tappedNavigationTab",
915
+ /**
916
+ * Corresponds to {@link TappedNotification}
917
+ */
918
+ tappedNotification = "tappedNotification",
911
919
  /**
912
920
  * Corresponds to {@link TappedNotificationsBell}
913
921
  */
@@ -210,6 +210,7 @@ exports.ActionType = ActionType;
210
210
  ActionType["tappedBid"] = "tappedBid";
211
211
  ActionType["tappedBrowseSimilarArtworks"] = "tappedBrowseSimilarArtworks";
212
212
  ActionType["tappedBuyNow"] = "tappedBuyNow";
213
+ ActionType["tappedClearNotification"] = "tappedClearNotification";
213
214
  ActionType["tappedCollectedArtwork"] = "tappedCollectedArtwork";
214
215
  ActionType["tappedCollectedArtworkImages"] = "tappedCollectedArtworkImages";
215
216
  ActionType["tappedCollectionGroup"] = "tappedCollectionGroup";
@@ -237,6 +238,7 @@ exports.ActionType = ActionType;
237
238
  ActionType["tappedMyCollectionInsightsMedianAuctionPriceChartTimeframe"] = "tappedMyCollectionInsightsMedianAuctionPriceChartTimeframe";
238
239
  ActionType["tappedMyCollectionInsightsMedianAuctionRailItem"] = "tappedMyCollectionInsightsMedianAuctionRailItem";
239
240
  ActionType["tappedNavigationTab"] = "tappedNavigationTab";
241
+ ActionType["tappedNotification"] = "tappedNotification";
240
242
  ActionType["tappedNotificationsBell"] = "tappedNotificationsBell";
241
243
  ActionType["tappedPartnerCard"] = "tappedPartnerCard";
242
244
  ActionType["tappedProductCapabilitiesGroup"] = "tappedProductCapabilitiesGroup";
@@ -11,6 +11,7 @@ export declare enum ContextModule {
11
11
  adServer = "adServer",
12
12
  activity = "activity",
13
13
  activityRail = "activityRail",
14
+ actNow = "actNow",
14
15
  alertsAll = "alertsAll",
15
16
  alertConfirmation = "alertConfirmation",
16
17
  alertDetails = "alertDetails",
@@ -25,6 +25,7 @@ exports.ContextModule = ContextModule;
25
25
  ContextModule["adServer"] = "adServer";
26
26
  ContextModule["activity"] = "activity";
27
27
  ContextModule["activityRail"] = "activityRail";
28
+ ContextModule["actNow"] = "actNow";
28
29
  ContextModule["alertsAll"] = "alertsAll";
29
30
  ContextModule["alertConfirmation"] = "alertConfirmation";
30
31
  ContextModule["alertDetails"] = "alertDetails";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@artsy/cohesion",
3
- "version": "4.209.0",
3
+ "version": "4.210.0",
4
4
  "description": "Analytics schema",
5
5
  "main": "dist/index.js",
6
6
  "publishConfig": {