@artsy/cohesion 4.195.0 → 4.196.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# v4.196.0 (Tue Jul 30 2024)
+
+#### 🚀  Enhancement
+
+- chore(EMI-1969): Collector signals schema [#516](https://github.com/artsy/cohesion/pull/516) ([@erikdstock](https://github.com/erikdstock))
+
+#### Authors: 1
+
+- Erik ([@erikdstock](https://github.com/erikdstock))
+
+---
+
 # v4.195.0 (Mon Jul 22 2024)
 
 #### 🚀  Enhancement

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

@@ -169,11 +169,15 @@ export interface ClickedArtistSeriesGroup extends ClickedEntityGroup {
  *    destination_page_owner_slug: "romain-jacquet-lagreze-makeshift-garden-hong-kong",
  *    horizontal_slide_position: 1,
  *    type: "thumbnail"
+ *    signal_labels: ["Limited-Time Offer"],
  *  }
  * ```
  */
 export interface ClickedArtworkGroup extends ClickedEntityGroup {
     action: ActionType.clickedArtworkGroup;
+    signal_labels?: string[];
+    signal_lot_watcher_count?: number;
+    signal_bid_count?: number;
 }
 /**
  * A user clicks a grouping of auctions on web
@@ -191,11 +195,16 @@ export interface ClickedArtworkGroup extends ClickedEntityGroup {
  *    destination_page_owner_slug: "forum-auctions-colour-theory-4",
  *    horizontal_slide_position: 3,
  *    type: "thumbnail"
+ *    signal_lot_watcher_count: 2,
+ *    signal_bid_count: 1
  *  }
  * ```
  */
 export interface ClickedAuctionGroup extends ClickedEntityGroup {
     action: ActionType.clickedAuctionGroup;
+    signal_labels?: string[];
+    signal_lot_watcher_count?: number;
+    signal_bid_count?: number;
 }
 /**
  * A user clicks a result of auctions on web
@@ -276,6 +285,7 @@ export interface ClickedBuyerProtection {
  *    context_owner_id: "6164889300d643000db86504",
  *    impulse_conversation_id: "198",
  *    flow: "Buy now" | "Partner offer"
+ *    signal_labels: ["Limited-Time Offer"],
  *  }
  * ```
  */
@@ -286,6 +296,57 @@ export interface ClickedBuyNow {
     context_owner_id: string;
     impulse_conversation_id?: string;
     flow?: string;
+    signal_labels?: string[];
+    signal_lot_watcher_count?: number;
+    signal_bid_count?: number;
+}
+/**
+ * User clicks "Contact Gallery" on an artwork page (BNMO)
+ *
+ * This schema describes events sent to Segment from [[clickedContactGallery]]
+ * @example
+ * ```
+ *  {
+ *    action: "clickedContactGallery",
+ *    context_owner_type: "Artwork",
+ *    context_owner_slug: "radna-segal-pearl",
+ *    context_owner_id: "6164889300d643000db86504",
+ *    signal_labels: ["Limited-Time Offer"],
+ *  }
+ * ```
+ */
+export interface ClickedContactGallery {
+    action: ActionType.tappedContactGallery;
+    context_owner_type: OwnerType;
+    context_owner_slug: string;
+    context_owner_id: string;
+    signal_labels?: string[];
+    signal_lot_watcher_count?: number;
+    signal_bid_count?: number;
+}
+/** A user taps "Bid" on an artwork page inside an Auction
+ *
+ * This schema describes events sent to Segment from [[tappedBid]]
+ *
+ *  @example
+ *  ```
+ *  {
+ *    action: "clickedBid",
+ *    context_owner_type: "Artwork",
+ *    context_owner_slug: "radna-segal-pearl",
+ *    context_owner_id: "6164889300d643000db86504",
+ *    signal_lot_watcher_count: 2,
+ *    signal_bid_count: 1
+ *  }
+ */
+export interface ClickedBid {
+    action: ActionType.clickedBid;
+    context_owner_type: OwnerType;
+    context_owner_id: string;
+    context_owner_slug: string;
+    signal_labels?: string[];
+    signal_lot_watcher_count?: number;
+    signal_bid_count?: number;
 }
 /**
  *  User clicks on Change Payment Method on the orders review page.
@@ -509,6 +570,7 @@ export interface ClickedFairCard {
  *    destination_page_owner_id: "53188b0d8b3b8192bb0005ae",
  *    destination_page_owner_slug: "damien-hirst-anatomy-of-an-angel",
  *    type: "thumbnail"
+ *    signal_labels: ["Limited-Time Offer"],
  *  }
  * ```
  */
@@ -524,6 +586,9 @@ export interface ClickedMainArtworkGrid {
     type: "thumbnail";
     position?: number;
     sort?: string;
+    signal_labels?: string[];
+    signal_lot_watcher_count?: number;
+    signal_bid_count?: number;
 }
 /**
  * A user clicks on a navigation tab on web.

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

@@ -102,11 +102,15 @@ export interface TappedArtistSeriesGroup extends TappedEntityGroup {
  *    horizontal_slide_position: 1,
  *    module_height: "single",
  *    type: "thumbnail"
+ *    signal_labels: ["Limited-Time Offer"],
  *  }
  * ```
  */
 export interface TappedArtworkGroup extends TappedEntityGroup {
     action: ActionType.tappedArtworkGroup;
+    signal_labels?: string[];
+    signal_lot_watcher_count?: number;
+    signal_bid_count?: number;
 }
 /**
  * A user taps a grouping of auctions on iOS
@@ -125,11 +129,16 @@ export interface TappedArtworkGroup extends TappedEntityGroup {
  *    horizontal_slide_position: 3,
  *    module_height: "double",
  *    type: "thumbnail"
+ *    signal_lot_watcher_count: 2,
+ *    signal_bid_count: 1
  *  }
  * ```
  */
 export interface TappedAuctionGroup extends TappedEntityGroup {
     action: ActionType.tappedAuctionGroup;
+    signal_labels?: string[];
+    signal_lot_watcher_count?: number;
+    signal_bid_count?: number;
 }
 /**
  * A user taps a grouping of auction results on iOS
@@ -376,6 +385,7 @@ export interface TappedInfoBubble {
  *    destination_screen_owner_id: "53188b0d8b3b8192bb0005ae",
  *    destination_screen_owner_slug: "damien-hirst-anatomy-of-an-angel",
  *    type: "thumbnail"
+ *    signal_labels: ["Limited-Time Offer"],
  *  }
  * ```
  */
@@ -393,6 +403,9 @@ export interface TappedMainArtworkGrid {
     sort?: string;
     type: "thumbnail";
     query?: string;
+    signal_labels?: string[];
+    signal_lot_watcher_count?: number;
+    signal_bid_count?: number;
 }
 /**
  * A user taps the promo space on the iOS home screen
@@ -712,6 +725,8 @@ export interface TappedCreateAlert {
  *    context_owner_type: "Artwork",
  *    context_owner_slug: "radna-segal-pearl",
  *    context_owner_id: "6164889300d643000db86504",
+ *    signal_lot_watcher_count: 2,
+ *    signal_bid_count: 1
  *  }
  * ```
  */
@@ -720,6 +735,9 @@ export interface TappedBid {
     context_owner_type: ScreenOwnerType;
     context_owner_id: string;
     context_owner_slug: string;
+    signal_labels?: string[];
+    signal_lot_watcher_count?: number;
+    signal_bid_count?: number;
 }
 /**
  * A user taps "Purchase" on an artwork page (BNMO)
@@ -735,6 +753,7 @@ export interface TappedBid {
  *    context_owner_id: "6164889300d643000db86504",
  *    impulse_conversation_id: "198",
  *    flow: "Buy now" | "Partner offer"
+ *    signal_labels: ["Limited-Time Offer"],
  *  }
  * ```
  */
@@ -745,6 +764,9 @@ export interface TappedBuyNow {
     context_owner_slug: string;
     impulse_conversation_id?: string;
     flow?: "Buy now" | "Partner offer";
+    signal_labels?: string[];
+    signal_lot_watcher_count?: number;
+    signal_bid_count?: number;
 }
 /**
  * A user taps on 'Contact Gallery' on an artwork page
@@ -758,7 +780,7 @@ export interface TappedBuyNow {
  *    context_owner_type: "Artwork",
  *    context_owner_slug: "radna-segal-pearl",
  *    context_owner_id: "6164889300d643000db86504",
-
+ *    signal_labels: ["Limited-Time Offer"],
  *  }
  * ```
  */
@@ -767,6 +789,9 @@ export interface TappedContactGallery {
     context_owner_type: OwnerType;
     context_owner_slug: string;
     context_owner_id: string;
+    signal_labels?: string[];
+    signal_lot_watcher_count?: number;
+    signal_bid_count?: number;
 }
 /**
  * A user taps a Skip button on My Collection add artwork flow

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

@@ -3,7 +3,7 @@ import { AddToCalendar } from "./AddToCalendar";
 import { AddedArtworkToArtworkList, CreatedArtworkList, DeletedArtworkList, EditedArtworkList, ViewedArtworkList } from "./ArtworkLists";
 import { AuctionPageView, BidPageView, ClickedActiveBid, ClickedRegisterToBid, ConfirmBid, ConfirmRegistrationPageview, EnterLiveAuction, MaxBidSelected, RegistrationPageView, RegistrationSubmitted } from "./Auction";
 import { AuthImpression, CompletedOnboarding, CreatedAccount, OnboardingUserInputData, ResetYourPassword, StartedOnboarding, SuccessfullyLoggedIn } from "./Authentication";
-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, ClickedViewWork, ClickedDownloadAppHeader, ClickedDownloadAppFooter } from "./Click";
+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, ClickedDownloadAppFooter, ClickedDownloadAppHeader, 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, ClickedViewWork } from "./Click";
 import { EditedUserProfile } from "./CollectorProfile";
 import { ArtworkDetailsCompleted, ConsignmentSubmitted, ContactInformationCompleted, SentConsignmentInquiry, SubmitAnotherArtwork, UploadPhotosCompleted, ViewArtworkMyCollection } from "./Consignments";
 import { FocusedOnConversationMessageInput, SentConversationMessage, TappedInboxConversation, TappedMakeOffer, TappedViewOffer } from "./Conversations";
@@ -14,8 +14,8 @@ import { AddedToAlbum, CompletedOfflineSync, CreatedAlbum, SentContent, ToggledP
 import { TappedProductCapabilitiesGroup } from "./HomeFeedArtsyOnboarding";
 import { MyCollectionOnboardingCompleted, TappedExploreMyCollection, VisitMyCollection, VisitMyCollectionOnboardingSlide } from "./HomeFeedMyCollectionOnboarding";
 import { Impression } from "./Impression";
-import { ErrorMessageViewed, ItemViewed, RailViewed, SendOffersBannerViewed, SendOffersErrorMessage, SendOffersModalViewed, TooltipViewed, ValidationAddressViewed, EditProfileModalViewed } from "./ImpressionTracking";
-import { AddCollectedArtwork, DeleteCollectedArtwork, EditCollectedArtwork, SaveCollectedArtwork, SentRequestPriceEstimate, TappedCollectedArtwork, TappedCollectedArtworkImages, TappedRequestPriceEstimate, TappedMyCollectionAddArtworkArtist } from "./MyCollection";
+import { EditProfileModalViewed, ErrorMessageViewed, ItemViewed, RailViewed, SendOffersBannerViewed, SendOffersErrorMessage, SendOffersModalViewed, TooltipViewed, ValidationAddressViewed } from "./ImpressionTracking";
+import { AddCollectedArtwork, DeleteCollectedArtwork, EditCollectedArtwork, SaveCollectedArtwork, SentRequestPriceEstimate, TappedCollectedArtwork, TappedCollectedArtworkImages, TappedMyCollectionAddArtworkArtist, TappedRequestPriceEstimate } from "./MyCollection";
 import { TappedMyCollectionInsightsMedianAuctionPriceChartCareerHighlight, TappedMyCollectionInsightsMedianAuctionPriceChartCategory, TappedMyCollectionInsightsMedianAuctionPriceChartTimeframe, TappedMyCollectionInsightsMedianAuctionRailItem } from "./MyCollectionInsights";
 import { PromptForReview } from "./PromptForReview";
 import { DeletedSavedSearch, EditedAlert, EditedSavedSearch } from "./SavedSearch";
@@ -155,6 +155,10 @@ export declare enum ActionType {
     /**
      *    * Corresponds to {@link ClickedAuctionResultItem}
      */
+    /**
+     * Corresponds to {@link ClickedBid}
+     */
+    clickedBid = "clickedBid",
     clickedAuctionResultItem = "clickedAuctionResultItem",
     /**
      * Corresponds to {@link ClickedBuyerProtection}
@@ -188,6 +192,10 @@ export declare enum ActionType {
      * Corresponds to {@link ClickedCompleteYourProfile}
      */
     clickedCompleteYourProfile = "clickedCompleteYourProfile",
+    /**
+     * Corresponds to {@link ClickedCompleteYourProfile}
+     */
+    clickedContactGallery = "clickedContactGallery",
     /**
      * Corresponds to {@link ClickedCreateAlert}
      */
@@ -449,12 +457,12 @@ export declare enum ActionType {
      */
     commercialFilterParamsChanged = "commercialFilterParamsChanged",
     /**
-   * Corresponds to {@link clickedDownloadAppFooter}
-   */
+     * Corresponds to {@link clickedDownloadAppFooter}
+     */
     clickedDownloadAppFooter = "clickedDownloadAppFooter",
     /**
-   * Corresponds to {@link clickedDownloadAppHeader}
-   */
+     * Corresponds to {@link clickedDownloadAppHeader}
+     */
     clickedDownloadAppHeader = "clickedDownloadAppHeader",
     /**
      * Corresponds to {@link CompletedOfflineSync}
@@ -713,8 +721,8 @@ export declare enum ActionType {
      */
     sendOffersModalViewed = "sendOffersModalViewed",
     /**
-   * Corresponds to {@link EditProfileModalViewed}
-   */
+     * Corresponds to {@link EditProfileModalViewed}
+     */
     editProfileModalViewed = "editProfileModalViewed",
     /**
      * Corresponds to {@link sentArtworkInquiry}

package/dist/Schema/Events/index.js

@@ -48,6 +48,7 @@ exports.ActionType = ActionType;
   ActionType["clickedArtistSeriesGroup"] = "clickedArtistSeriesGroup";
   ActionType["clickedArtworkGroup"] = "clickedArtworkGroup";
   ActionType["clickedAuctionGroup"] = "clickedAuctionGroup";
+  ActionType["clickedBid"] = "clickedBid";
   ActionType["clickedAuctionResultItem"] = "clickedAuctionResultItem";
   ActionType["clickedBuyerProtection"] = "clickedBuyerProtection";
   ActionType["clickedBuyNow"] = "clickedBuyNow";
@@ -57,6 +58,7 @@ exports.ActionType = ActionType;
   ActionType["clickedChangeShippingMethod"] = "clickedChangeShippingMethod";
   ActionType["clickedCollectionGroup"] = "clickedCollectionGroup";
   ActionType["clickedCompleteYourProfile"] = "clickedCompleteYourProfile";
+  ActionType["clickedContactGallery"] = "clickedContactGallery";
   ActionType["clickedCreateAlert"] = "clickedCreateAlert";
   ActionType["clickedDeliveryMethod"] = "clickedDeliveryMethod";
   ActionType["clickedEditArtwork"] = "clickedEditArtwork";

package/package.json

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