@artsy/cohesion 4.103.0 → 4.104.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# v4.104.0 (Thu Feb 23 2023)
+
+#### 🚀  Enhancement
+
+- feat: add rail viewed event [#403](https://github.com/artsy/cohesion/pull/403) ([@MounirDhahri](https://github.com/MounirDhahri))
+
+#### Authors: 1
+
+- Mounir Dhahri ([@MounirDhahri](https://github.com/MounirDhahri))
+
+---
+
 # v4.103.0 (Thu Feb 23 2023)
 
 #### 🚀  Enhancement

package/dist/Schema/Events/ImpressionTracking.d.ts

@@ -0,0 +1,29 @@
+import { ContextModule } from "../Values/ContextModule";
+import { OwnerType } from "../Values/OwnerType";
+import { ActionType } from ".";
+/**
+ * Schemas describing rail_viewed events
+ * @packageDocumentation
+ */
+/**
+ * A user sees a rail of content
+ *
+ * This schema describes events sent to Segment from [[RailViewed]].
+ *
+ *  @example
+ *  ```
+ *  {
+ *    action: "rail_viewed",
+ *    context_screen: "home",
+ *    context_module: "Home"
+ *    position_y: 2, // optional
+ *  }
+ * ```
+ *
+ */
+export interface RailViewed {
+    action: ActionType.railViewed;
+    context_module: ContextModule;
+    context_screen: OwnerType;
+    position_y?: number;
+}

package/dist/Schema/Events/ImpressionTracking.js

@@ -0,0 +1 @@
+"use strict";

package/dist/Schema/Events/index.d.ts

@@ -10,6 +10,7 @@ import { ExperimentViewed } from "./ExperimentViewed";
 import { AuctionResultsFilterParamsChanged, CommercialFilterParamsChanged, PriceDatabaseFilterParamsChanged, SelectedRecentPriceRange } from "./FilterAndSort";
 import { MyCollectionOnboardingCompleted, TappedExploreMyCollection, VisitMyCollection, VisitMyCollectionOnboardingSlide } from "./HomeFeedMyCollectionOnboarding";
 import { Impression } from "./Impression";
+import { RailViewed } from "./ImpressionTracking";
 import { AddCollectedArtwork, DeleteCollectedArtwork, EditCollectedArtwork, SaveCollectedArtwork, SentRequestPriceEstimate, TappedCollectedArtwork, TappedCollectedArtworkImages, TappedRequestPriceEstimate } from "./MyCollection";
 import { TappedMyCollectionInsightsMedianAuctionPriceChartCareerHighlight, TappedMyCollectionInsightsMedianAuctionPriceChartCategory, TappedMyCollectionInsightsMedianAuctionPriceChartTimeframe, TappedMyCollectionInsightsMedianAuctionRailItem } from "./MyCollectionInsights";
 import { PromptForReview } from "./PromptForReview";
@@ -29,7 +30,7 @@ import { ViewedVideo } from "./Video";
  *
  * Each event describes one ActionType
  */
-export type Event = AddToCalendar | AddCollectedArtwork | ArtworkDetailsCompleted | AuctionPageView | AuctionResultsFilterParamsChanged | AuthImpression | BidPageView | CreatedAccount | 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 | ClickedOnFramedMeasurements | ClickedOnFramedMeasurementsDropdown | ClickedOnPriceDisplayDropdown | ClickedOnSubmitOrder | ClickedSnooze | ClickedPartnerCard | ClickedPartnerLink | ClickedPaymentMethod | ClickedPaymentDetails | CheckedAccountBalance | ClickedPromoSpace | ClickedRegisterToBid | ClickedSelectShippingOption | ClickedShippingAddress | ClickedShowGroup | ClickedShowMore | ClickedVerifyIdentity | ClickedViewingRoomCard | ClickedOfferActions | ClickedOrderPage | ClickedOrderSummary | ClickedDismissInquiry | ClickedMarkSpam | ClickedConversationsFilter | CommercialFilterParamsChanged | CompletedOnboarding | ConfirmBid | ConfirmRegistrationPageview | ConsignmentArtistFailed | ConsignmentSubmitted | ContactInformationCompleted | DeleteCollectedArtwork | DeletedSavedSearch | EditCollectedArtwork | EditedSavedSearch | EditedUserProfile | EnterLiveAuction | ExperimentViewed | UploadSizeLimitExceeded | FocusedOnConversationMessageInput | FocusedOnSearchInput | FocusedOnPriceDatabaseSearchInput | FollowEvents | Impression | MaxBidSelected | MyCollectionOnboardingCompleted | OnboardingUserInputData | PriceDatabaseFilterParamsChanged | PromptForReview | RegistrationPageView | RegistrationSubmitted | ResetYourPassword | SaleScreenLoadComplete | SaveCollectedArtwork | Screen | SearchedPriceDatabase | SearchedReverseImageWithNoResults | SearchedReverseImageWithResults | SearchedWithNoResults | SelectedArtworkFromReverseImageSearch | SelectedItemFromSearch | SelectedItemFromPriceDatabaseSearch | SelectedRecentPriceRange | 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 | TappedPromoSpace | TappedRequestPriceEstimate | TappedReverseImageSearch | TappedSell | TappedSellArtwork | TappedShowMore | TappedLearnMore | TappedSkip | TappedTabBar | TappedToggleCameraFlash | TappedVerifyIdentity | TappedViewingRoomCard | TappedViewingRoomGroup | TappedViewOffer | TimeOnPage | ToggledAccordion | ToggledNotification | ToggledSavedSearch | UploadPhotosCompleted | ViewArtworkMyCollection | ViewedVideo | VisitMyCollection | VisitMyCollectionOnboardingSlide;
+export type Event = AddToCalendar | AddCollectedArtwork | ArtworkDetailsCompleted | AuctionPageView | AuctionResultsFilterParamsChanged | AuthImpression | BidPageView | CreatedAccount | 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 | ClickedOnFramedMeasurements | ClickedOnFramedMeasurementsDropdown | ClickedOnPriceDisplayDropdown | ClickedOnSubmitOrder | ClickedSnooze | ClickedPartnerCard | ClickedPartnerLink | ClickedPaymentMethod | ClickedPaymentDetails | CheckedAccountBalance | ClickedPromoSpace | ClickedRegisterToBid | ClickedSelectShippingOption | ClickedShippingAddress | ClickedShowGroup | ClickedShowMore | ClickedVerifyIdentity | ClickedViewingRoomCard | ClickedOfferActions | ClickedOrderPage | ClickedOrderSummary | ClickedDismissInquiry | ClickedMarkSpam | ClickedConversationsFilter | CommercialFilterParamsChanged | CompletedOnboarding | ConfirmBid | ConfirmRegistrationPageview | ConsignmentArtistFailed | ConsignmentSubmitted | ContactInformationCompleted | DeleteCollectedArtwork | DeletedSavedSearch | EditCollectedArtwork | EditedSavedSearch | EditedUserProfile | EnterLiveAuction | ExperimentViewed | UploadSizeLimitExceeded | FocusedOnConversationMessageInput | FocusedOnSearchInput | FocusedOnPriceDatabaseSearchInput | FollowEvents | Impression | MaxBidSelected | MyCollectionOnboardingCompleted | OnboardingUserInputData | PriceDatabaseFilterParamsChanged | PromptForReview | RailViewed | RegistrationPageView | RegistrationSubmitted | ResetYourPassword | SaleScreenLoadComplete | SaveCollectedArtwork | Screen | SearchedPriceDatabase | SearchedReverseImageWithNoResults | SearchedReverseImageWithResults | SearchedWithNoResults | SelectedArtworkFromReverseImageSearch | SelectedItemFromSearch | SelectedItemFromPriceDatabaseSearch | SelectedRecentPriceRange | 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 | TappedPromoSpace | TappedRequestPriceEstimate | TappedReverseImageSearch | TappedSell | TappedSellArtwork | TappedShowMore | TappedLearnMore | TappedSkip | TappedTabBar | TappedToggleCameraFlash | TappedVerifyIdentity | TappedViewingRoomCard | TappedViewingRoomGroup | TappedViewOffer | TimeOnPage | ToggledAccordion | ToggledNotification | ToggledSavedSearch | UploadPhotosCompleted | ViewArtworkMyCollection | ViewedVideo | VisitMyCollection | VisitMyCollectionOnboardingSlide;
 /**
  * The top-level actions an Event describes.
  *
@@ -436,6 +437,10 @@ export declare enum ActionType {
      * Corresponds to {@link PromptForReview}
      */
     promptForReview = "promptForReview",
+    /**
+     * Corresponds to {@link RailViewed}
+     */
+    railViewed = "railViewed",
     /**
      * Corresponds to {@link RegistrationPageView}
      */

package/dist/Schema/Events/index.js

@@ -120,6 +120,7 @@ exports.ActionType = ActionType;
   ActionType["onboardingUserInputData"] = "onboardingUserInputData";
   ActionType["priceDatabaseFilterParamsChanged"] = "priceDatabaseFilterParamsChanged";
   ActionType["promptForReview"] = "promptForReview";
+  ActionType["railViewed"] = "railViewed";
   ActionType["registrationPageView"] = "registrationPageView";
   ActionType["registrationSubmitted"] = "registrationSubmitted";
   ActionType["resetYourPassword"] = "resetYourPassword";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@artsy/cohesion",
-  "version": "4.103.0",
+  "version": "4.104.0",
   "description": "Analytics schema",
   "main": "dist/index.js",
   "publishConfig": {