@artsy/cohesion 4.203.0 → 4.204.0

package/CHANGELOG.md

@@ -1,3 +1,16 @@
+# v4.204.0 (Wed Sep 11 2024)
+
+#### 🚀  Enhancement
+
+- chore: TappedHeroUnitsGroup > TappedHeroUnitGroup [#525](https://github.com/artsy/cohesion/pull/525) ([@dblandin](https://github.com/dblandin))
+- chore: tappedActivityGroup + tappedHeroUnitsGroup > destination_path [#525](https://github.com/artsy/cohesion/pull/525) ([@dblandin](https://github.com/dblandin))
+
+#### Authors: 1
+
+- devon blandin ([@dblandin](https://github.com/dblandin))
+
+---
+
 # v4.203.0 (Tue Sep 10 2024)
 
 #### 🚀  Enhancement

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

@@ -30,8 +30,26 @@ import { ActionType } from ".";
 export interface TappedArticleGroup extends TappedEntityGroup {
     action: ActionType.tappedArticleGroup;
 }
+/**
+ * A user taps a grouping of activity items
+ *
+ *  This schema describes events sent to Segment from [[tappedActivityGroup]]
+ *
+ *  @example
+ *  ```
+ *  {
+ *    action: "tappedActivityGroup",
+ *    context_module: "activityRail",
+ *    context_screen_owner_type: "home",
+ *    destination_path: "/show/grimm-fools-errand",
+ *    horizontal_slide_position: 1,
+ *    type: "thumbnail"
+ *  }
+ * ```
+ */
 export interface TappedActivityGroup extends TappedEntityGroup {
     action: ActionType.tappedActivityGroup;
+    destination_path?: string;
 }
 export interface TappedShowGroup extends TappedEntityGroup {
     action: ActionType.tappedShowGroup;
@@ -88,25 +106,23 @@ export interface TappedArtistSeriesGroup extends TappedEntityGroup {
 /**
  * A user taps a grouping of hero units
  *
- *  This schema describes events sent to Segment from [[tappedHeroUnitsGroup]]
+ *  This schema describes events sent to Segment from [[tappedHeroUnitGroup]]
  *
  *  @example
  *  ```
  *  {
- *    action: "tappedHeroUnitsGroup",
- *    context_module: "home-view-section-hero-units-rail",
+ *    action: "tappedHeroUnitGroup",
+ *    context_module: "heroUnitsRail",
  *    context_screen_owner_type: "home",
- *    destination_screen_owner_id: "5359794d1a1e86c3740001f7",
- *    destination_screen_owner_type: Collection,
- *    destination_screen_owner_url: "fair/fair-name"
+ *    destination_path: "/collection/art-for-large-spaces",
  *    horizontal_slide_position: 1,
  *    type: "thumbnail"
  *  }
  * ```
  */
-export interface TappedHeroUnitsGroup extends TappedEntityGroup {
-    action: ActionType.tappedHeroUnitsGroup;
-    destination_screen_owner_url: string;
+export interface TappedHeroUnitGroup extends TappedEntityGroup {
+    action: ActionType.tappedHeroUnitGroup;
+    destination_path?: string;
 }
 /**
  * A user taps a grouping of artworks on iOS
@@ -275,12 +291,12 @@ export interface TappedFairGroup extends TappedEntityGroup {
  * This schema describes events sent to Segment from [[tappedEntityGroup]]
  */
 export interface TappedEntityGroup {
-    action: ActionType.tappedActivityGroup | ActionType.tappedArticleGroup | ActionType.tappedShowGroup | ActionType.tappedArtistGroup | ActionType.tappedArtistSeriesGroup | ActionType.tappedArtworkGroup | ActionType.tappedAuctionGroup | ActionType.tappedAuctionResultGroup | ActionType.tappedBrowseSimilarArtworks | ActionType.tappedCollectionGroup | ActionType.tappedExploreGroup | ActionType.tappedFairGroup | ActionType.tappedViewingRoomGroup | ActionType.tappedHeroUnitsGroup;
+    action: ActionType.tappedActivityGroup | ActionType.tappedArticleGroup | ActionType.tappedShowGroup | ActionType.tappedArtistGroup | ActionType.tappedArtistSeriesGroup | ActionType.tappedArtworkGroup | ActionType.tappedAuctionGroup | ActionType.tappedAuctionResultGroup | ActionType.tappedBrowseSimilarArtworks | ActionType.tappedCollectionGroup | ActionType.tappedExploreGroup | ActionType.tappedFairGroup | ActionType.tappedViewingRoomGroup | ActionType.tappedHeroUnitGroup;
     context_module: ContextModule;
     context_screen_owner_type: ScreenOwnerType;
     context_screen_owner_id?: string;
     context_screen_owner_slug?: string;
-    destination_screen_owner_type: ScreenOwnerType;
+    destination_screen_owner_type?: ScreenOwnerType;
     destination_screen_owner_id?: string;
     destination_screen_owner_slug?: string;
     curation_boost?: boolean;

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

@@ -853,9 +853,9 @@ export declare enum ActionType {
      */
     tappedFairGroup = "tappedFairGroup",
     /**
-     * Corresponds to {@link TappedHeroUnitsGroup}
+     * Corresponds to {@link TappedHeroUnitGroup}
      */
-    tappedHeroUnitsGroup = "tappedHeroUnitsGroup",
+    tappedHeroUnitGroup = "tappedHeroUnitGroup",
     /**
      * Corresponds to {@link TappedInboxConversation}
      */

package/dist/Schema/Events/index.js

@@ -223,7 +223,7 @@ exports.ActionType = ActionType;
   ActionType["tappedExploreMyCollection"] = "tappedExploreMyCollection";
   ActionType["tappedFairCard"] = "tappedFairCard";
   ActionType["tappedFairGroup"] = "tappedFairGroup";
-  ActionType["tappedHeroUnitsGroup"] = "tappedHeroUnitsGroup";
+  ActionType["tappedHeroUnitGroup"] = "tappedHeroUnitGroup";
   ActionType["tappedInboxConversation"] = "tappedInboxConversation";
   ActionType["tappedInfoBubble"] = "tappedInfoBubble";
   ActionType["tappedLearnMore"] = "tappedLearnMore";

package/dist/Schema/Values/ContextModule.d.ts

@@ -106,6 +106,7 @@ export declare enum ContextModule {
     galleryTab = "galleryTab",
     geneHeader = "geneHeader",
     header = "header",
+    heroUnitsRail = "heroUnitsRail",
     inboxActiveBids = "inboxActiveBids",
     inboxClosedBids = "inboxClosedBids",
     inboxConversation = "inboxConversation",
@@ -216,4 +217,4 @@ export declare enum ContextModule {
 /**
  * Limited ContextModules available for web authentication events
  */
-export type AuthContextModule = ContextModule.activity | ContextModule.aboutTheWork | ContextModule.articleTab | ContextModule.artistHeader | ContextModule.artistRecentlySold | ContextModule.artistSeriesRail | ContextModule.artistSeriesTab | ContextModule.artistsTab | ContextModule.artistsToFollowRail | ContextModule.artworkClosedLotHeader | ContextModule.artworkGrid | ContextModule.artworkImage | ContextModule.artworkSidebar | ContextModule.artworksTab | ContextModule.associatedViewingRoom | ContextModule.auctionHome | ContextModule.auctionLots | ContextModule.auctionLotsEndingSoonRail | ContextModule.auctionRail | ContextModule.auctionResult | ContextModule.auctionResultComparableWorks | ContextModule.auctionResults | ContextModule.auctionSidebar | ContextModule.auctionsInfo | ContextModule.auctionTab | ContextModule.bannerPopUp | ContextModule.boothsTab | ContextModule.browseFair | ContextModule.categoryRail | ContextModule.collectionDescription | ContextModule.collectorProfile | ContextModule.consignSubmissionFlow | ContextModule.createAlert | ContextModule.currentShowsRail | ContextModule.fairInfo | ContextModule.fairOrganizerHeader | ContextModule.fairRail | ContextModule.fairsHeader | ContextModule.fairTab | ContextModule.featuredArtists | ContextModule.featuredArtistsRail | ContextModule.featuredGalleriesRail | ContextModule.footer | ContextModule.galleriesNearYouRail | ContextModule.galleryTab | ContextModule.geneHeader | ContextModule.header | ContextModule.inquiry | ContextModule.intextTooltip | ContextModule.liveAuctionRoom | ContextModule.liveAuctionsRail | ContextModule.lotsForYouRail | ContextModule.mainCarousel | ContextModule.marketingCollectionTab | ContextModule.minimalCTABanner | ContextModule.myCollectionAddArtworkAddArtist | ContextModule.myCollectionHome | ContextModule.navBar | ContextModule.newWorksByGalleriesYouFollowRail | ContextModule.newWorksForYouRail | ContextModule.notification | ContextModule.onboardingActivity | ContextModule.onboardingCollectorLevel | ContextModule.onboardingFlow | ContextModule.onboardingInterests | ContextModule.otherWorksByArtistRail | ContextModule.otherWorksFromPartnerRail | ContextModule.otherWorksFromShowRail | ContextModule.otherWorksInAuctionRail | ContextModule.partnerHeader | ContextModule.pastFairs | ContextModule.popularArtistsRail | ContextModule.popUpModal | ContextModule.presentingFair | ContextModule.presentingPartner | ContextModule.priceEstimate | ContextModule.recentlyViewedRail | ContextModule.recentPriceRanges | ContextModule.recommendedArtistsRail | ContextModule.relatedArtistsRail | ContextModule.relatedWorksRail | ContextModule.saveWorksCTA | ContextModule.showHeader | ContextModule.showInfo | ContextModule.showTab | ContextModule.standoutLots | ContextModule.tagHeader | ContextModule.topAuctionLotsRail | ContextModule.topTab | ContextModule.topWorksRail | ContextModule.trendingArtistsRail | ContextModule.trendingLots | ContextModule.viewingRoom | ContextModule.worksByArtistsYouFollowRail | ContextModule.worksByPopularArtistsRail | ContextModule.worksForSaleRail | ContextModule.sell | ContextModule.sellHeader | ContextModule.sellFooter | ContextModule.sellHowItWorks | ContextModule.sellStickyFooter;
+export type AuthContextModule = ContextModule.activity | ContextModule.aboutTheWork | ContextModule.articleTab | ContextModule.artistHeader | ContextModule.artistRecentlySold | ContextModule.artistSeriesRail | ContextModule.artistSeriesTab | ContextModule.artistsTab | ContextModule.artistsToFollowRail | ContextModule.artworkClosedLotHeader | ContextModule.artworkGrid | ContextModule.artworkImage | ContextModule.artworkSidebar | ContextModule.artworksTab | ContextModule.associatedViewingRoom | ContextModule.auctionHome | ContextModule.auctionLots | ContextModule.auctionLotsEndingSoonRail | ContextModule.auctionRail | ContextModule.auctionResult | ContextModule.auctionResultComparableWorks | ContextModule.auctionResults | ContextModule.auctionSidebar | ContextModule.auctionsInfo | ContextModule.auctionTab | ContextModule.bannerPopUp | ContextModule.boothsTab | ContextModule.browseFair | ContextModule.categoryRail | ContextModule.collectionDescription | ContextModule.collectorProfile | ContextModule.consignSubmissionFlow | ContextModule.createAlert | ContextModule.currentShowsRail | ContextModule.fairInfo | ContextModule.fairOrganizerHeader | ContextModule.fairRail | ContextModule.fairsHeader | ContextModule.fairTab | ContextModule.featuredArtists | ContextModule.featuredArtistsRail | ContextModule.featuredGalleriesRail | ContextModule.footer | ContextModule.galleriesNearYouRail | ContextModule.galleryTab | ContextModule.geneHeader | ContextModule.header | ContextModule.heroUnitsRail | ContextModule.inquiry | ContextModule.intextTooltip | ContextModule.liveAuctionRoom | ContextModule.liveAuctionsRail | ContextModule.lotsForYouRail | ContextModule.mainCarousel | ContextModule.marketingCollectionTab | ContextModule.minimalCTABanner | ContextModule.myCollectionAddArtworkAddArtist | ContextModule.myCollectionHome | ContextModule.navBar | ContextModule.newWorksByGalleriesYouFollowRail | ContextModule.newWorksForYouRail | ContextModule.notification | ContextModule.onboardingActivity | ContextModule.onboardingCollectorLevel | ContextModule.onboardingFlow | ContextModule.onboardingInterests | ContextModule.otherWorksByArtistRail | ContextModule.otherWorksFromPartnerRail | ContextModule.otherWorksFromShowRail | ContextModule.otherWorksInAuctionRail | ContextModule.partnerHeader | ContextModule.pastFairs | ContextModule.popularArtistsRail | ContextModule.popUpModal | ContextModule.presentingFair | ContextModule.presentingPartner | ContextModule.priceEstimate | ContextModule.recentlyViewedRail | ContextModule.recentPriceRanges | ContextModule.recommendedArtistsRail | ContextModule.relatedArtistsRail | ContextModule.relatedWorksRail | ContextModule.saveWorksCTA | ContextModule.showHeader | ContextModule.showInfo | ContextModule.showTab | ContextModule.standoutLots | ContextModule.tagHeader | ContextModule.topAuctionLotsRail | ContextModule.topTab | ContextModule.topWorksRail | ContextModule.trendingArtistsRail | ContextModule.trendingLots | ContextModule.viewingRoom | ContextModule.worksByArtistsYouFollowRail | ContextModule.worksByPopularArtistsRail | ContextModule.worksForSaleRail | ContextModule.sell | ContextModule.sellHeader | ContextModule.sellFooter | ContextModule.sellHowItWorks | ContextModule.sellStickyFooter;

package/dist/Schema/Values/ContextModule.js

@@ -120,6 +120,7 @@ exports.ContextModule = ContextModule;
   ContextModule["galleryTab"] = "galleryTab";
   ContextModule["geneHeader"] = "geneHeader";
   ContextModule["header"] = "header";
+  ContextModule["heroUnitsRail"] = "heroUnitsRail";
   ContextModule["inboxActiveBids"] = "inboxActiveBids";
   ContextModule["inboxClosedBids"] = "inboxClosedBids";
   ContextModule["inboxConversation"] = "inboxConversation";

package/package.json

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