@artsy/cohesion 4.170.0 → 4.172.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.172.0 (Fri Apr 19 2024)
2
+
3
+ #### 🚀 Enhancement
4
+
5
+ - chore: private artwork tracking updates [#490](https://github.com/artsy/cohesion/pull/490) ([@Mitch-Henson](https://github.com/Mitch-Henson))
6
+
7
+ #### Authors: 1
8
+
9
+ - Mitchell Henson ([@Mitch-Henson](https://github.com/Mitch-Henson))
10
+
11
+ ---
12
+
13
+ # v4.171.0 (Wed Apr 17 2024)
14
+
15
+ #### 🚀 Enhancement
16
+
17
+ - chore: AMBER-591 - add private artwork tracking methods [#489](https://github.com/artsy/cohesion/pull/489) ([@Mitch-Henson](https://github.com/Mitch-Henson))
18
+
19
+ #### Authors: 1
20
+
21
+ - Mitchell Henson ([@Mitch-Henson](https://github.com/Mitch-Henson))
22
+
23
+ ---
24
+
1
25
  # v4.170.0 (Fri Apr 12 2024)
2
26
 
3
27
  #### 🚀 Enhancement
@@ -1976,3 +1976,47 @@ export interface ClickedUpdateArtwork {
1976
1976
  partner_id: string;
1977
1977
  artwork_id: string;
1978
1978
  }
1979
+ /**
1980
+ * A user clicks on the read more link on the private artwork page.
1981
+ *
1982
+ * This schema describes events sent to Segment from [[ClickedOnReadMore]]
1983
+ *
1984
+ * @example
1985
+ * ```
1986
+ * {
1987
+ * action: "clickedOnReadMore",
1988
+ * context_module: "About the work" | "About the artist" | "Sidebar",
1989
+ * subject: "Read more"
1990
+ * type: "Link"
1991
+ * }
1992
+ * ```
1993
+ */
1994
+ export interface ClickedOnReadMore {
1995
+ action: ActionType.clickedOnReadMore;
1996
+ context_module: string;
1997
+ subject: string;
1998
+ type: string;
1999
+ }
2000
+ /**
2001
+ * A user clicks on the learn more link on the private artwork page.
2002
+ *
2003
+ * This schema describes events sent to Segment from [[ClickedOnLearnMore]]
2004
+ *
2005
+ * @example
2006
+ * ```
2007
+ * {
2008
+ * action: "clickedOnLearnMore",
2009
+ * context_module: "Sidebar",
2010
+ * subject: "Learn more"
2011
+ * type: "Link"
2012
+ * flow: "Shipping" | "Artsy Guarantee"
2013
+ * }
2014
+ * ```
2015
+ */
2016
+ export interface ClickedOnLearnMore {
2017
+ action: ActionType.clickedOnLearnMore;
2018
+ context_module: string;
2019
+ subject: string;
2020
+ type: string;
2021
+ flow: string;
2022
+ }
@@ -3,7 +3,7 @@ import { AddToCalendar } from "./AddToCalendar";
3
3
  import { AddedArtworkToArtworkList, CreatedArtworkList, DeletedArtworkList, EditedArtworkList, ViewedArtworkList } from "./ArtworkLists";
4
4
  import { AuctionPageView, BidPageView, ClickedActiveBid, ClickedRegisterToBid, ConfirmBid, ConfirmRegistrationPageview, EnterLiveAuction, MaxBidSelected, RegistrationPageView, RegistrationSubmitted } from "./Auction";
5
5
  import { AuthImpression, CompletedOnboarding, CreatedAccount, OnboardingUserInputData, ResetYourPassword, StartedOnboarding, SuccessfullyLoggedIn } from "./Authentication";
6
- import { CheckedAccountBalance, ClickedAddFilters, ClickedAddMissingArtworksDetails, ClickedAddNewShippingAddress, ClickedAddWorksToFair, ClickedAlertsFilters, ClickedAppDownload, ClickedArticleGroup, ClickedArtistGroup, ClickedArtistSeriesGroup, ClickedArtworkGroup, ClickedAuctionGroup, ClickedAuctionResultItem, ClickedBuyerProtection, ClickedChangePage, ClickedChangePaymentMethod, ClickedChangeShippingAddress, ClickedChangeShippingMethod, ClickedCloseValidationAddressModal, ClickedCollectionGroup, ClickedConversationsFilter, ClickedCreateAlert, ClickedDeliveryMethod, ClickedDismissInquiry, ClickedEditArtwork, ClickedExpandFilterPanel, ClickedExpansionToggle, ClickedFairCard, ClickedFairGroup, ClickedGalleryGroup, ClickedLoadMore, ClickedMainArtworkGrid, ClickedMarketingModal, ClickedMarkSold, ClickedMarkSpam, ClickedNavBar, ClickedNavigationTab, ClickedOfferActions, ClickedOfferOption, ClickedOnArtworkShippingUnitsDropdown, ClickedOnArtworkShippingWeight, ClickedOnBuyNowCheckbox, ClickedOnDuplicateArtwork, ClickedOnFramedMeasurements, ClickedOnFramedMeasurementsDropdown, ClickedOnMakeOfferCheckbox, ClickedOnPagination, ClickedOnPriceDisplayDropdown, ClickedOnSubmitOrder, ClickedOrderPage, ClickedOrderSummary, ClickedPartnerCard, ClickedPartnerLink, ClickedPaymentDetails, ClickedPaymentMethod, ClickedPromoSpace, ClickedPublish, ClickedSelectShippingOption, ClickedSendPartnerOffer, ClickedShippingAddress, ClickedShowGroup, ClickedShowMore, ClickedSnooze, ClickedStartPartnerOffer, ClickedUpdateArtwork, ClickedUploadArtwork, ClickedValidationAddressOptions, ClickedVerifyIdentity, ClickedViewingRoomCard } from "./Click";
6
+ import { CheckedAccountBalance, ClickedAddFilters, ClickedAddMissingArtworksDetails, ClickedAddNewShippingAddress, ClickedAddWorksToFair, ClickedAlertsFilters, ClickedAppDownload, ClickedArticleGroup, ClickedArtistGroup, ClickedArtistSeriesGroup, ClickedArtworkGroup, ClickedAuctionGroup, ClickedAuctionResultItem, ClickedBuyerProtection, ClickedChangePage, ClickedChangePaymentMethod, ClickedChangeShippingAddress, ClickedChangeShippingMethod, ClickedCloseValidationAddressModal, ClickedCollectionGroup, ClickedConversationsFilter, ClickedCreateAlert, ClickedDeliveryMethod, ClickedDismissInquiry, ClickedEditArtwork, ClickedExpandFilterPanel, ClickedExpansionToggle, ClickedFairCard, ClickedFairGroup, ClickedGalleryGroup, ClickedLoadMore, ClickedMainArtworkGrid, ClickedMarketingModal, ClickedMarkSold, ClickedMarkSpam, ClickedNavBar, ClickedNavigationTab, ClickedOfferActions, ClickedOfferOption, ClickedOnArtworkShippingUnitsDropdown, ClickedOnArtworkShippingWeight, ClickedOnBuyNowCheckbox, ClickedOnDuplicateArtwork, ClickedOnFramedMeasurements, ClickedOnFramedMeasurementsDropdown, ClickedOnLearnMore, ClickedOnMakeOfferCheckbox, ClickedOnPagination, ClickedOnPriceDisplayDropdown, ClickedOnReadMore, ClickedOnSubmitOrder, ClickedOrderPage, ClickedOrderSummary, ClickedPartnerCard, ClickedPartnerLink, ClickedPaymentDetails, ClickedPaymentMethod, ClickedPromoSpace, ClickedPublish, ClickedSelectShippingOption, ClickedSendPartnerOffer, ClickedShippingAddress, ClickedShowGroup, ClickedShowMore, ClickedSnooze, ClickedStartPartnerOffer, ClickedUpdateArtwork, ClickedUploadArtwork, ClickedValidationAddressOptions, ClickedVerifyIdentity, ClickedViewingRoomCard } from "./Click";
7
7
  import { EditedUserProfile } from "./CollectorProfile";
8
8
  import { ArtworkDetailsCompleted, ConsignmentSubmitted, ContactInformationCompleted, SentConsignmentInquiry, SubmitAnotherArtwork, UploadPhotosCompleted, ViewArtworkMyCollection } from "./Consignments";
9
9
  import { FocusedOnConversationMessageInput, SentConversationMessage, TappedInboxConversation, TappedMakeOffer, TappedViewOffer } from "./Conversations";
@@ -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 | ClickedOnFramedMeasurements | ClickedOnFramedMeasurementsDropdown | ClickedOnMakeOfferCheckbox | ClickedOnDuplicateArtwork | ClickedOnPagination | ClickedOnPriceDisplayDropdown | 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 | CommercialFilterParamsChanged | CompletedOfflineSync | CompletedOnboarding | ConfirmBid | ConfirmRegistrationPageview | ConsignmentArtistFailed | ConsignmentSubmitted | ContactInformationCompleted | CreatedAlbum | DeleteCollectedArtwork | EditedAlert | DeletedArtworkList | DeletedSavedSearch | EditCollectedArtwork | EditedArtworkList | EditedAutocompletedAddress | EditedSavedSearch | EditedUserProfile | EnterLiveAuction | ErrorMessageViewed | ExperimentViewed | 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 | TappedMainArtworkGrid | TappedMakeOffer | TappedMyCollectionInsightsMedianAuctionRailItem | TappedMyCollectionInsightsMedianAuctionPriceChartCareerHighlight | TappedMyCollectionInsightsMedianAuctionPriceChartCategory | TappedMyCollectionInsightsMedianAuctionPriceChartTimeframe | TappedPartnerCard | TappedProductCapabilitiesGroup | TappedPromoSpace | TappedRequestPriceEstimate | TappedSell | TappedSellArtwork | TappedShowMore | TappedLearnMore | TappedSkip | TappedTabBar | TappedVerifyIdentity | TappedViewingRoomCard | TappedViewingRoomGroup | TappedViewOffer | 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 | CommercialFilterParamsChanged | CompletedOfflineSync | CompletedOnboarding | ConfirmBid | ConfirmRegistrationPageview | ConsignmentArtistFailed | ConsignmentSubmitted | ContactInformationCompleted | CreatedAlbum | DeleteCollectedArtwork | EditedAlert | DeletedArtworkList | DeletedSavedSearch | EditCollectedArtwork | EditedArtworkList | EditedAutocompletedAddress | EditedSavedSearch | EditedUserProfile | EnterLiveAuction | ErrorMessageViewed | ExperimentViewed | 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 | TappedMainArtworkGrid | TappedMakeOffer | TappedMyCollectionInsightsMedianAuctionRailItem | TappedMyCollectionInsightsMedianAuctionPriceChartCareerHighlight | TappedMyCollectionInsightsMedianAuctionPriceChartCategory | TappedMyCollectionInsightsMedianAuctionPriceChartTimeframe | TappedPartnerCard | TappedProductCapabilitiesGroup | TappedPromoSpace | TappedRequestPriceEstimate | TappedSell | TappedSellArtwork | TappedShowMore | TappedLearnMore | TappedSkip | TappedTabBar | TappedVerifyIdentity | TappedViewingRoomCard | TappedViewingRoomGroup | TappedViewOffer | 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
  *
@@ -256,6 +256,10 @@ export declare enum ActionType {
256
256
  * Corresponds to {@link ClickedOnBuyNowCheckbox}
257
257
  */
258
258
  clickedOnBuyNowCheckbox = "clickedOnBuyNowCheckbox",
259
+ /**
260
+ * Corresponds to {@link ClickedOnDuplicateArtwork}
261
+ */
262
+ clickedOnDuplicateArtwork = "clickedOnDuplicateArtwork",
259
263
  /**
260
264
  * Corresponds to {@link ClickedOnFramedMeasurements}
261
265
  */
@@ -265,13 +269,13 @@ export declare enum ActionType {
265
269
  */
266
270
  clickedOnFramedMeasurementsDropdown = "clickedOnFramedMeasurementsDropdown",
267
271
  /**
268
- * Corresponds to {@link ClickedOnMakeOfferCheckbox}
272
+ * Corresponds to {@link ClickedOnLearnMore}
269
273
  */
270
- clickedOnMakeOfferCheckbox = "clickedOnMakeOfferCheckbox",
274
+ clickedOnLearnMore = "clickedOnLearnMore",
271
275
  /**
272
- * Corresponds to {@link ClickedOnDuplicateArtwork}
276
+ * Corresponds to {@link ClickedOnMakeOfferCheckbox}
273
277
  */
274
- clickedOnDuplicateArtwork = "clickedOnDuplicateArtwork",
278
+ clickedOnMakeOfferCheckbox = "clickedOnMakeOfferCheckbox",
275
279
  /**
276
280
  * Corresponds to {@link ClickedOnPagination}
277
281
  */
@@ -284,6 +288,10 @@ export declare enum ActionType {
284
288
  * Corresponds to {@link ClickedPublish}
285
289
  */
286
290
  clickedPublish = "clickedPublish",
291
+ /**
292
+ * Corresponds to {@link ClickedOnReadMore}
293
+ */
294
+ clickedOnReadMore = "clickedOnReadMore",
287
295
  /**
288
296
  * Corresponds to {@link ClickedOnSubmitOrder}
289
297
  */
@@ -74,13 +74,15 @@ exports.ActionType = ActionType;
74
74
  ActionType["clickedOnArtworkShippingUnitsDropdown"] = "clickedOnArtworkShippingUnitsDropdown";
75
75
  ActionType["clickedOnArtworkShippingWeight"] = "clickedOnArtworkShippingWeight";
76
76
  ActionType["clickedOnBuyNowCheckbox"] = "clickedOnBuyNowCheckbox";
77
+ ActionType["clickedOnDuplicateArtwork"] = "clickedOnDuplicateArtwork";
77
78
  ActionType["clickedOnFramedMeasurements"] = "clickedOnFramedMeasurements";
78
79
  ActionType["clickedOnFramedMeasurementsDropdown"] = "clickedOnFramedMeasurementsDropdown";
80
+ ActionType["clickedOnLearnMore"] = "clickedOnLearnMore";
79
81
  ActionType["clickedOnMakeOfferCheckbox"] = "clickedOnMakeOfferCheckbox";
80
- ActionType["clickedOnDuplicateArtwork"] = "clickedOnDuplicateArtwork";
81
82
  ActionType["clickedOnPagination"] = "clickedOnPagination";
82
83
  ActionType["clickedOnPriceDisplayDropdown"] = "clickedOnPriceDisplayDropdown";
83
84
  ActionType["clickedPublish"] = "clickedPublish";
85
+ ActionType["clickedOnReadMore"] = "clickedOnReadMore";
84
86
  ActionType["clickedOnSubmitOrder"] = "clickedOnSubmitOrder";
85
87
  ActionType["clickedOrderPage"] = "clickedOrderPage";
86
88
  ActionType["clickedOrderSummary"] = "clickedOrderSummary";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@artsy/cohesion",
3
- "version": "4.170.0",
3
+ "version": "4.172.0",
4
4
  "description": "Analytics schema",
5
5
  "main": "dist/index.js",
6
6
  "publishConfig": {