@artsy/cohesion 4.131.0 → 4.133.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,27 @@
1
+ # v4.133.0 (Mon Jul 03 2023)
2
+
3
+ #### 🚀 Enhancement
4
+
5
+ - Add SearchedWithResults event [#440](https://github.com/artsy/cohesion/pull/440) ([@nickskalkin](https://github.com/nickskalkin))
6
+
7
+ #### Authors: 1
8
+
9
+ - Nikita Skalkin ([@nickskalkin](https://github.com/nickskalkin))
10
+
11
+ ---
12
+
13
+ # v4.132.0 (Fri Jun 16 2023)
14
+
15
+ #### 🚀 Enhancement
16
+
17
+ - feat(article): Add article mobile events [#439](https://github.com/artsy/cohesion/pull/439) ([@damassi](https://github.com/damassi))
18
+
19
+ #### Authors: 1
20
+
21
+ - Christopher Pappas ([@damassi](https://github.com/damassi))
22
+
23
+ ---
24
+
1
25
  # v4.131.0 (Thu Jun 15 2023)
2
26
 
3
27
  #### 🚀 Enhancement
@@ -83,6 +83,31 @@ export interface SearchedWithNoResults {
83
83
  destination_owner_type?: PageOwnerType;
84
84
  query: string;
85
85
  }
86
+ /**
87
+ * A user searches with results
88
+ *
89
+ * This schema describes events sent to Segment from [[searchedWithResults]]
90
+ *
91
+ * @example
92
+ * ```
93
+ * {
94
+ * action: "searchedWithResults",
95
+ * context_module: "header",
96
+ * context_owner_type: "home",
97
+ * destination_owner_type: "search",
98
+ * query: "Banksy"
99
+ * }
100
+ * ```
101
+ */
102
+ export interface SearchedWithResults {
103
+ action: ActionType.searchedWithResults;
104
+ context_module: ContextModule;
105
+ context_owner_type: PageOwnerType;
106
+ context_owner_id?: string;
107
+ context_owner_slug?: string;
108
+ destination_owner_type?: PageOwnerType;
109
+ query: string;
110
+ }
86
111
  /**
87
112
  * A user queries the Artsy Price Database, including the artist_id, string queried, and applied filters
88
113
  *
@@ -241,6 +241,29 @@ export interface TappedEntityGroup {
241
241
  type: EntityModuleType;
242
242
  }
243
243
  export type EntityModuleHeight = "single" | "double";
244
+ /**
245
+ * A user taps the Article Share button in iOS
246
+ *
247
+ * This schema describes events sent to Segment from [[tappedArticleShare]]
248
+ *
249
+ * @example
250
+ * ```
251
+ * {
252
+ * action: "tappedArticleShare",
253
+ * context_module: "article",
254
+ * context_screen_owner_type: "article",
255
+ * context_screen_owner_id: "some-article-id",
256
+ * context_screen_owner_id: "some-article-slug",
257
+ * }
258
+ * ```
259
+ */
260
+ export interface TappedArticleShare {
261
+ action: ActionType.tappedArticleShare;
262
+ context_module: ContextModule;
263
+ context_screen_owner_type: ScreenOwnerType;
264
+ context_screen_owner_id: string;
265
+ context_screen_owner_slug: string;
266
+ }
244
267
  /**
245
268
  * A user taps a Consign button in iOS
246
269
  *
@@ -20,10 +20,10 @@ import { PromptForReview } from "./PromptForReview";
20
20
  import { SearchedReverseImageWithNoResults, SearchedReverseImageWithResults, SelectedArtworkFromReverseImageSearch, TappedPickImageFromLibrary, TappedReverseImageSearch, TappedToggleCameraFlash } from "./ReverseImageSearch";
21
21
  import { DeletedSavedSearch, EditedSavedSearch } from "./SavedSearch";
22
22
  import { FollowEvents } from "./SavesAndFollows";
23
- import { ConsignmentArtistFailed, FocusedOnPriceDatabaseSearchInput, FocusedOnSearchInput, SearchedPriceDatabase, SearchedWithNoResults, SelectedItemFromPriceDatabaseSearch, SelectedItemFromSearch, SelectedSearchSuggestionQuickNavigationItem } from "./Search";
23
+ import { ConsignmentArtistFailed, FocusedOnPriceDatabaseSearchInput, FocusedOnSearchInput, SearchedPriceDatabase, SearchedWithNoResults, SearchedWithResults, SelectedItemFromPriceDatabaseSearch, SelectedItemFromSearch, SelectedSearchSuggestionQuickNavigationItem } from "./Search";
24
24
  import { Share } from "./Share";
25
25
  import { SaleScreenLoadComplete, Screen, TimeOnPage } from "./System";
26
- import { TappedArticleGroup, TappedArtistGroup, TappedArtistSeriesGroup, TappedArtworkGroup, TappedAuctionGroup, TappedAuctionResultGroup, TappedBid, TappedBuyNow, TappedCollectionGroup, TappedConsign, TappedConsignmentInquiry, TappedContactGallery, TappedCreateAlert, TappedExploreGroup, TappedFairCard, TappedFairGroup, TappedInfoBubble, TappedLearnMore, TappedLink, TappedMainArtworkGrid, TappedNavigationTab, TappedPartnerCard, TappedPromoSpace, TappedSell, TappedSellArtwork, TappedShowMore, TappedSkip, TappedTabBar, TappedVerifyIdentity, TappedViewingRoomCard, TappedViewingRoomGroup } from "./Tap";
26
+ import { TappedArticleGroup, TappedArticleShare, TappedArtistGroup, TappedArtistSeriesGroup, TappedArtworkGroup, TappedAuctionGroup, TappedAuctionResultGroup, TappedBid, TappedBuyNow, TappedCollectionGroup, TappedConsign, TappedConsignmentInquiry, TappedContactGallery, TappedCreateAlert, TappedExploreGroup, TappedFairCard, TappedFairGroup, TappedInfoBubble, TappedLearnMore, TappedLink, TappedMainArtworkGrid, TappedNavigationTab, TappedPartnerCard, TappedPromoSpace, TappedSell, TappedSellArtwork, TappedShowMore, TappedSkip, TappedTabBar, TappedVerifyIdentity, TappedViewingRoomCard, TappedViewingRoomGroup } 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 | AddToCalendar | AddCollectedArtwork | ArtworkDetailsCompleted | AuctionPageView | AuctionResultsFilterParamsChanged | AuthImpression | BidPageView | CreatedAccount | CreatedArtworkList | 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 | ClickedOnBuyNowCheckbox | ClickedOnFramedMeasurements | ClickedOnFramedMeasurementsDropdown | ClickedOnMakeOfferCheckbox | ClickedOnDuplicateArtwork | ClickedOnPriceDisplayDropdown | ClickedPublish | ClickedOnSubmitOrder | ClickedSnooze | ClickedPartnerCard | ClickedPartnerLink | ClickedPaymentMethod | ClickedPaymentDetails | CheckedAccountBalance | ClickedPromoSpace | ClickedRegisterToBid | ClickedSelectShippingOption | ClickedShippingAddress | ClickedShowGroup | ClickedShowMore | ClickedVerifyIdentity | ClickedViewingRoomCard | ClickedOfferActions | ClickedOrderPage | ClickedOrderSummary | ClickedDismissInquiry | ClickedMarkSpam | ClickedMarkSold | ClickedConversationsFilter | CommercialFilterParamsChanged | CompletedOnboarding | ConfirmBid | ConfirmRegistrationPageview | ConsignmentArtistFailed | ConsignmentSubmitted | ContactInformationCompleted | DeleteCollectedArtwork | DeletedArtworkList | DeletedSavedSearch | EditCollectedArtwork | EditedArtworkList | EditedSavedSearch | EditedUserProfile | EnterLiveAuction | ErrorMessageViewed | ExperimentViewed | ItemViewed | UploadSizeLimitExceeded | FocusedOnConversationMessageInput | FocusedOnSearchInput | FocusedOnPriceDatabaseSearchInput | FollowEvents | Impression | MaxBidSelected | MyCollectionOnboardingCompleted | OnboardingUserInputData | PriceDatabaseFilterParamsChanged | PromptForReview | RailViewed | RegistrationPageView | RegistrationSubmitted | ResetYourPassword | SaleScreenLoadComplete | SaveCollectedArtwork | SavedCookieConsentPreferences | Screen | SearchedPriceDatabase | SearchedReverseImageWithNoResults | SearchedReverseImageWithResults | SearchedWithNoResults | SelectedArtworkFromReverseImageSearch | SelectedItemFromSearch | SelectedItemFromPriceDatabaseSearch | SelectedRecentPriceRange | SelectedSearchSuggestionQuickNavigationItem | SentConsignmentInquiry | SentConversationMessage | SentRequestPriceEstimate | Share | StartedOnboarding | SubmitAnotherArtwork | SuccessfullyLoggedIn | TappedArticleGroup | TappedArtistGroup | TappedArtistSeriesGroup | TappedArtworkGroup | TappedAuctionGroup | TappedAuctionResultGroup | TappedBid | TappedBuyNow | TappedCollectedArtwork | TappedCollectedArtworkImages | TappedCollectionGroup | TappedConsign | TappedContactGallery | TappedConsignmentInquiry | TappedCreateAlert | TappedExploreGroup | TappedExploreMyCollection | TappedFairCard | TappedFairGroup | TappedInboxConversation | TappedInfoBubble | TappedLink | TappedNavigationTab | TappedMainArtworkGrid | TappedMakeOffer | TappedMyCollectionInsightsMedianAuctionRailItem | TappedMyCollectionInsightsMedianAuctionPriceChartCareerHighlight | TappedMyCollectionInsightsMedianAuctionPriceChartCategory | TappedMyCollectionInsightsMedianAuctionPriceChartTimeframe | TappedPartnerCard | TappedPickImageFromLibrary | TappedProductCapabilitiesGroup | TappedPromoSpace | TappedRequestPriceEstimate | TappedReverseImageSearch | TappedSell | TappedSellArtwork | TappedShowMore | TappedLearnMore | TappedSkip | TappedTabBar | TappedToggleCameraFlash | TappedVerifyIdentity | TappedViewingRoomCard | TappedViewingRoomGroup | TappedViewOffer | TimeOnPage | ToggledAccordion | ToggledNotification | ToggledSavedSearch | TooltipViewed | UploadPhotosCompleted | ViewArtworkMyCollection | ViewedArtworkList | ViewedVideo | VisitMyCollection | VisitMyCollectionOnboardingSlide;
36
+ export type Event = AddedArtworkToArtworkList | AddToCalendar | AddCollectedArtwork | ArtworkDetailsCompleted | AuctionPageView | AuctionResultsFilterParamsChanged | AuthImpression | BidPageView | CreatedAccount | CreatedArtworkList | 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 | ClickedOnBuyNowCheckbox | ClickedOnFramedMeasurements | ClickedOnFramedMeasurementsDropdown | ClickedOnMakeOfferCheckbox | ClickedOnDuplicateArtwork | ClickedOnPriceDisplayDropdown | ClickedPublish | ClickedOnSubmitOrder | ClickedSnooze | ClickedPartnerCard | ClickedPartnerLink | ClickedPaymentMethod | ClickedPaymentDetails | CheckedAccountBalance | ClickedPromoSpace | ClickedRegisterToBid | ClickedSelectShippingOption | ClickedShippingAddress | ClickedShowGroup | ClickedShowMore | ClickedVerifyIdentity | ClickedViewingRoomCard | ClickedOfferActions | ClickedOrderPage | ClickedOrderSummary | ClickedDismissInquiry | ClickedMarkSpam | ClickedMarkSold | ClickedConversationsFilter | CommercialFilterParamsChanged | CompletedOnboarding | ConfirmBid | ConfirmRegistrationPageview | ConsignmentArtistFailed | ConsignmentSubmitted | ContactInformationCompleted | DeleteCollectedArtwork | DeletedArtworkList | DeletedSavedSearch | EditCollectedArtwork | EditedArtworkList | EditedSavedSearch | EditedUserProfile | EnterLiveAuction | ErrorMessageViewed | ExperimentViewed | ItemViewed | UploadSizeLimitExceeded | FocusedOnConversationMessageInput | FocusedOnSearchInput | FocusedOnPriceDatabaseSearchInput | FollowEvents | Impression | MaxBidSelected | MyCollectionOnboardingCompleted | OnboardingUserInputData | PriceDatabaseFilterParamsChanged | PromptForReview | RailViewed | RegistrationPageView | RegistrationSubmitted | ResetYourPassword | SaleScreenLoadComplete | SaveCollectedArtwork | SavedCookieConsentPreferences | Screen | SearchedPriceDatabase | SearchedReverseImageWithNoResults | SearchedReverseImageWithResults | SearchedWithNoResults | SearchedWithResults | SelectedArtworkFromReverseImageSearch | SelectedItemFromSearch | SelectedItemFromPriceDatabaseSearch | SelectedRecentPriceRange | SelectedSearchSuggestionQuickNavigationItem | SentConsignmentInquiry | SentConversationMessage | SentRequestPriceEstimate | Share | StartedOnboarding | SubmitAnotherArtwork | SuccessfullyLoggedIn | TappedArticleGroup | TappedArticleShare | TappedArtistGroup | TappedArtistSeriesGroup | TappedArtworkGroup | TappedAuctionGroup | TappedAuctionResultGroup | TappedBid | TappedBuyNow | TappedCollectedArtwork | TappedCollectedArtworkImages | TappedCollectionGroup | TappedConsign | TappedContactGallery | TappedConsignmentInquiry | TappedCreateAlert | TappedExploreGroup | TappedExploreMyCollection | TappedFairCard | TappedFairGroup | TappedInboxConversation | TappedInfoBubble | TappedLink | TappedNavigationTab | TappedMainArtworkGrid | TappedMakeOffer | TappedMyCollectionInsightsMedianAuctionRailItem | TappedMyCollectionInsightsMedianAuctionPriceChartCareerHighlight | TappedMyCollectionInsightsMedianAuctionPriceChartCategory | TappedMyCollectionInsightsMedianAuctionPriceChartTimeframe | TappedPartnerCard | TappedPickImageFromLibrary | TappedProductCapabilitiesGroup | TappedPromoSpace | TappedRequestPriceEstimate | TappedReverseImageSearch | TappedSell | TappedSellArtwork | TappedShowMore | TappedLearnMore | TappedSkip | TappedTabBar | TappedToggleCameraFlash | TappedVerifyIdentity | TappedViewingRoomCard | TappedViewingRoomGroup | TappedViewOffer | TimeOnPage | ToggledAccordion | ToggledNotification | ToggledSavedSearch | TooltipViewed | UploadPhotosCompleted | ViewArtworkMyCollection | ViewedArtworkList | ViewedVideo | VisitMyCollection | VisitMyCollectionOnboardingSlide;
37
37
  /**
38
38
  * The top-level actions an Event describes.
39
39
  *
@@ -540,6 +540,10 @@ export declare enum ActionType {
540
540
  * Corresponds to {@link SearchedWithNoResults}
541
541
  */
542
542
  searchedWithNoResults = "searchedWithNoResults",
543
+ /**
544
+ * Corresponds to {@link SearchedWithResults}
545
+ */
546
+ searchedWithResults = "searchedWithResults",
543
547
  /**
544
548
  * Corresponds to {@link SelectArtistFromSearch}
545
549
  */
@@ -604,6 +608,10 @@ export declare enum ActionType {
604
608
  * Corresponds to {@link TappedArticleGroup}
605
609
  */
606
610
  tappedArticleGroup = "tappedArticleGroup",
611
+ /**
612
+ * Corresponds to {@link TappedArticleShare}
613
+ */
614
+ tappedArticleShare = "tappedArticleShare",
607
615
  /**
608
616
  * Corresponds to {@link TappedArtistGroup}
609
617
  */
@@ -145,6 +145,7 @@ exports.ActionType = ActionType;
145
145
  ActionType["searchedReverseImageWithNoResults"] = "searchedReverseImageWithNoResults";
146
146
  ActionType["searchedReverseImageWithResults"] = "searchedReverseImageWithResults";
147
147
  ActionType["searchedWithNoResults"] = "searchedWithNoResults";
148
+ ActionType["searchedWithResults"] = "searchedWithResults";
148
149
  ActionType["selectArtistFromSearch"] = "selectArtistFromSearch";
149
150
  ActionType["selectArtworkFromGrid"] = "selectArtworkFromGrid";
150
151
  ActionType["selectedArtworkFromReverseImageSearch"] = "selectedArtworkFromReverseImageSearch";
@@ -161,6 +162,7 @@ exports.ActionType = ActionType;
161
162
  ActionType["submitAnotherArtwork"] = "submitAnotherArtwork";
162
163
  ActionType["successfullyLoggedIn"] = "successfullyLoggedIn";
163
164
  ActionType["tappedArticleGroup"] = "tappedArticleGroup";
165
+ ActionType["tappedArticleShare"] = "tappedArticleShare";
164
166
  ActionType["tappedArtistGroup"] = "tappedArtistGroup";
165
167
  ActionType["tappedArtistSeriesGroup"] = "tappedArtistSeriesGroup";
166
168
  ActionType["tappedArtworkGroup"] = "tappedArtworkGroup";
@@ -10,6 +10,7 @@ export declare enum ContextModule {
10
10
  adServer = "adServer",
11
11
  articleArtist = "articleArtist",
12
12
  articleRail = "articleRail",
13
+ article = "article",
13
14
  articles = "articles",
14
15
  articleTab = "articleTab",
15
16
  artistAuctionResults = "artistAuctionResults",
@@ -24,6 +24,7 @@ exports.ContextModule = ContextModule;
24
24
  ContextModule["adServer"] = "adServer";
25
25
  ContextModule["articleArtist"] = "articleArtist";
26
26
  ContextModule["articleRail"] = "articleRail";
27
+ ContextModule["article"] = "article";
27
28
  ContextModule["articles"] = "articles";
28
29
  ContextModule["articleTab"] = "articleTab";
29
30
  ContextModule["artistAuctionResults"] = "artistAuctionResults";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@artsy/cohesion",
3
- "version": "4.131.0",
3
+ "version": "4.133.0",
4
4
  "description": "Analytics schema",
5
5
  "main": "dist/index.js",
6
6
  "publishConfig": {