@artsy/cohesion 4.35.0 → 4.36.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# v4.36.0 (Mon Mar 14 2022)
+
+#### 🚀  Enhancement
+
+- feat(auction): Add auction events [#310](https://github.com/artsy/cohesion/pull/310) ([@damassi](https://github.com/damassi))
+
+#### Authors: 1
+
+- Christopher Pappas ([@damassi](https://github.com/damassi))
+
+---
+
 # v4.35.0 (Fri Mar 11 2022)
 
 #### 🚀  Enhancement

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

@@ -0,0 +1,59 @@
+/**
+ * Schema describing 'auction/id' events
+ * @packageDocumentation
+ */
+import { ContextModule } from "../Values/ContextModule";
+import { OwnerType } from "../Values/OwnerType";
+import { ActionType } from ".";
+export interface BidPageView {
+    action: ActionType.bidPageView;
+    artwork_slug: string;
+    auction_slug: string;
+    sale_id: string;
+    user_id: string;
+}
+export interface ClickedActiveBid {
+    action: ActionType.clickedActiveBid;
+    artwork_slug: string;
+    auction_slug: string;
+    user_id: string;
+}
+export interface ClickedRegisterToBid {
+    action: ActionType.clickedRegisterToBid;
+    context_module: ContextModule.auctionHome;
+    context_owner_id: string;
+    context_owner_slug: string;
+    context_owner_type: OwnerType.auction;
+}
+export interface ConfirmBid {
+    action: ActionType.confirmBid;
+    bidder_id: string;
+    bidder_position_id: string;
+}
+export interface ConfirmRegistrationPageview {
+    action: ActionType.confirmRegistrationPageview;
+    context_module: ContextModule.auctionHome;
+}
+export interface EnterLiveAuction {
+    action: ActionType.enterLiveAuction;
+    context_module: ContextModule.auctionHome;
+    destination_path: string;
+    subject: string;
+}
+export interface MaxBidSelected {
+    action: ActionType.maxBidSelected;
+    bidder_id: string;
+    selected_max_bid_minor: number;
+}
+export interface RegistrationPageView {
+    action: ActionType.registrationPageView;
+    context_module: ContextModule.auctionHome;
+}
+export interface RegistrationSubmitted {
+    action: ActionType.registrationSubmitted;
+    auction_slug: string;
+    auction_state: string;
+    bidder_id: string;
+    sale_id: string;
+    user_id: string;
+}

package/dist/Schema/Events/Auction.js

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

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

@@ -1,4 +1,5 @@
 import { AddToCalendar } from "./AddToCalendar";
+import { BidPageView, ClickedActiveBid, ClickedRegisterToBid, ConfirmBid, ConfirmRegistrationPageview, EnterLiveAuction, MaxBidSelected, RegistrationPageView, RegistrationSubmitted } from "./Auction";
 import { AuthImpression, CreatedAccount, OnboardingUserInputData, ResetYourPassword, SuccessfullyLoggedIn } from "./Authentication";
 import { ClickedAddNewShippingAddress, ClickedAddWorksToFair, ClickedAppDownload, ClickedArticleGroup, ClickedArtistGroup, ClickedArtistSeriesGroup, ClickedArtworkGroup, ClickedAuctionGroup, ClickedBuyerProtection, ClickedChangePage, ClickedChangePaymentMethod, ClickedChangeShippingAddress, ClickedChangeShippingMethod, ClickedCollectionGroup, ClickedCreateAlert, ClickedDeliveryMethod, ClickedEditArtwork, ClickedExpansionToggle, ClickedFairCard, ClickedFairGroup, ClickedGalleryGroup, ClickedLoadMore, ClickedMainArtworkGrid, ClickedNavigationTab, ClickedOfferOption, ClickedOnArtworkShippingUnitsDropdown, ClickedOnArtworkShippingWeight, ClickedOnFramedMeasurements, ClickedOnFramedMeasurementsDropdown, ClickedOnSubmitOrder, ClickedPartnerCard, ClickedPromoSpace, ClickedSelectShippingOption, ClickedShippingAddress, ClickedShowGroup, ClickedShowMore, ClickedSnooze, ClickedVerifyIdentity, ClickedViewingRoomCard } from "./Click";
 import { ArtworkDetailsCompleted, ConsignmentSubmitted, SubmitAnotherArtwork, UploadPhotosCompleted, ViewArtworkMyCollection } from "./Consignments";
@@ -19,7 +20,7 @@ import { ToggledAccordion } from "./UserExperienceInteractions";
  *
  * Each event describes one ActionType
  */
-export declare type Event = AddToCalendar | AddCollectedArtwork | ArtworkDetailsCompleted | AuctionResultsFilterParamsChanged | AuthImpression | CreatedAccount | ClickedAddNewShippingAddress | ClickedAddWorksToFair | ClickedAppDownload | ClickedArticleGroup | ClickedArtistGroup | ClickedArtistSeriesGroup | ClickedArtworkGroup | ClickedAuctionGroup | ClickedBuyerProtection | ClickedChangePage | ClickedChangePaymentMethod | ClickedChangeShippingAddress | ClickedChangeShippingMethod | ClickedCollectionGroup | ClickedCreateAlert | ClickedDeliveryMethod | ClickedEditArtwork | ClickedExpansionToggle | ClickedFairCard | ClickedFairGroup | ClickedGalleryGroup | ClickedLoadMore | ClickedMainArtworkGrid | ClickedNavigationTab | ClickedOfferOption | ClickedOnArtworkShippingWeight | ClickedOnArtworkShippingUnitsDropdown | ClickedOnFramedMeasurements | ClickedOnFramedMeasurementsDropdown | ClickedOnSubmitOrder | ClickedSnooze | ClickedPartnerCard | ClickedPromoSpace | ClickedSelectShippingOption | ClickedShippingAddress | ClickedShowGroup | ClickedShowMore | ClickedVerifyIdentity | ClickedViewingRoomCard | CommercialFilterParamsChanged | ConsignmentArtistFailed | ConsignmentSubmitted | DeleteCollectedArtwork | DeletedSavedSearch | EditCollectedArtwork | EditedSavedSearch | FocusedOnConversationMessageInput | FocusedOnSearchInput | FocusedOnPriceDatabaseSearchInput | FollowEvents | OnboardingUserInputData | PriceDatabaseFilterParamsChanged | PromptForReview | ResetYourPassword | SaleScreenLoadComplete | Screen | SearchedPriceDatabase | SearchedWithNoResults | SelectedItemFromSearch | SelectedItemFromPriceDatabaseSearch | SentConversationMessage | Share | SubmitAnotherArtwork | SuccessfullyLoggedIn | TappedArticleGroup | TappedArtistGroup | TappedArtistSeriesGroup | TappedArtworkGroup | TappedAuctionGroup | TappedAuctionResultGroup | TappedBid | TappedBuyNow | TappedCollectedArtwork | TappedCollectedArtworkImages | TappedCollectionGroup | TappedConsign | TappedContactGallery | TappedCreateAlert | TappedExploreGroup | TappedFairCard | TappedFairGroup | TappedInboxConversation | TappedInfoBubble | TappedLink | TappedNavigationTab | TappedMainArtworkGrid | TappedMakeOffer | TappedPartnerCard | TappedPromoSpace | TappedRequestPriceEstimate | TappedSell | TappedShowMore | TappedTabBar | TappedVerifyIdentity | TappedViewingRoomCard | TappedViewingRoomGroup | TappedViewOffer | TimeOnPage | ToggledAccordion | ToggledNotification | ToggledSavedSearch | UploadPhotosCompleted | ViewArtworkMyCollection;
+export declare type Event = AddToCalendar | AddCollectedArtwork | ArtworkDetailsCompleted | AuctionResultsFilterParamsChanged | AuthImpression | BidPageView | CreatedAccount | ClickedActiveBid | ClickedAddNewShippingAddress | ClickedAddWorksToFair | ClickedAppDownload | ClickedArticleGroup | ClickedArtistGroup | ClickedArtistSeriesGroup | ClickedArtworkGroup | ClickedAuctionGroup | ClickedBuyerProtection | ClickedChangePage | ClickedChangePaymentMethod | ClickedChangeShippingAddress | ClickedChangeShippingMethod | ClickedCollectionGroup | ClickedCreateAlert | ClickedDeliveryMethod | ClickedEditArtwork | ClickedExpansionToggle | ClickedFairCard | ClickedFairGroup | ClickedGalleryGroup | ClickedLoadMore | ClickedMainArtworkGrid | ClickedNavigationTab | ClickedOfferOption | ClickedOnArtworkShippingWeight | ClickedOnArtworkShippingUnitsDropdown | ClickedOnFramedMeasurements | ClickedOnFramedMeasurementsDropdown | ClickedOnSubmitOrder | ClickedSnooze | ClickedPartnerCard | ClickedPromoSpace | ClickedRegisterToBid | ClickedSelectShippingOption | ClickedShippingAddress | ClickedShowGroup | ClickedShowMore | ClickedVerifyIdentity | ClickedViewingRoomCard | CommercialFilterParamsChanged | ConfirmBid | ConfirmRegistrationPageview | ConsignmentArtistFailed | ConsignmentSubmitted | DeleteCollectedArtwork | DeletedSavedSearch | EditCollectedArtwork | EditedSavedSearch | EnterLiveAuction | FocusedOnConversationMessageInput | FocusedOnSearchInput | FocusedOnPriceDatabaseSearchInput | FollowEvents | MaxBidSelected | OnboardingUserInputData | PriceDatabaseFilterParamsChanged | PromptForReview | RegistrationPageView | RegistrationSubmitted | ResetYourPassword | SaleScreenLoadComplete | Screen | SearchedPriceDatabase | SearchedWithNoResults | SelectedItemFromSearch | SelectedItemFromPriceDatabaseSearch | SentConversationMessage | Share | SubmitAnotherArtwork | SuccessfullyLoggedIn | TappedArticleGroup | TappedArtistGroup | TappedArtistSeriesGroup | TappedArtworkGroup | TappedAuctionGroup | TappedAuctionResultGroup | TappedBid | TappedBuyNow | TappedCollectedArtwork | TappedCollectedArtworkImages | TappedCollectionGroup | TappedConsign | TappedContactGallery | TappedCreateAlert | TappedExploreGroup | TappedFairCard | TappedFairGroup | TappedInboxConversation | TappedInfoBubble | TappedLink | TappedNavigationTab | TappedMainArtworkGrid | TappedMakeOffer | TappedPartnerCard | TappedPromoSpace | TappedRequestPriceEstimate | TappedSell | TappedShowMore | TappedTabBar | TappedVerifyIdentity | TappedViewingRoomCard | TappedViewingRoomGroup | TappedViewOffer | TimeOnPage | ToggledAccordion | ToggledNotification | ToggledSavedSearch | UploadPhotosCompleted | ViewArtworkMyCollection;
 /**
  * The top-level actions an Event describes.
  *
@@ -46,6 +47,14 @@ export declare enum ActionType {
      * Corresponds to {@link AuctionResultsFilterParamsChanged}
      */
     auctionResultsFilterParamsChanged = "auctionResultsFilterParamsChanged",
+    /**
+     * Corresponds to {@link BidPageView}
+     */
+    bidPageView = "bidPageView",
+    /**
+     * Corresponds to {@link ClickedActiveBid}
+     */
+    clickedActiveBid = "clickedActiveBid",
     /**
      * Corresponds to {@link ClickedAddNewShippingAddress}
      */
@@ -179,6 +188,10 @@ export declare enum ActionType {
      * Corresponds to {@link ClickedPromoSpace}
      */
     clickedPromoSpace = "clickedPromoSpace",
+    /**
+     * Corresponds to {@link ClickedRegisterToBid}
+     */
+    clickedRegisterToBid = "clickedRegisterToBid",
     /**
      * Corresponds to {@link ClickedSelectShippingOption}
      */
@@ -207,6 +220,14 @@ export declare enum ActionType {
      * Corresponds to {@link CommercialFilterParamsChanged}
      */
     commercialFilterParamsChanged = "commercialFilterParamsChanged",
+    /**
+     * Corresponds to {@link ConfirmBid}
+     */
+    confirmBid = "confirmBid",
+    /**
+     * Corresponds to {@link ConfirmRegistrationPageview}
+     */
+    confirmRegistrationPageview = "confirmRegistrationPageview",
     /**
      * Corresponds to {@link ConsignmentArtistFailed}
      */
@@ -243,6 +264,10 @@ export declare enum ActionType {
      * Corresponds to {@link EditedSavedSearch}
      */
     editedSavedSearch = "editedSavedSearch",
+    /**
+     * Corresponds to {@link EnterLiveAuction}
+     */
+    enterLiveAuction = "enterLiveAuction",
     /**
      * Corresponds to {@link FocusedOnConversationMessageInput}
      */
@@ -271,6 +296,10 @@ export declare enum ActionType {
      * Corresponds to {@link FollowedPartner}
      */
     followedPartner = "followedPartner",
+    /**
+     * Corresponds to {@link MaxBidSelected}
+     */
+    maxBidSelected = "maxBidSelected",
     /**
      * Corresponds to {@link OnboardingUserInputData}
      */
@@ -283,6 +312,14 @@ export declare enum ActionType {
      * Corresponds to {@link PromptForReview}
      */
     promptForReview = "promptForReview",
+    /**
+     * Corresponds to {@link RegistrationPageView}
+     */
+    registrationPageView = "registrationPageView",
+    /**
+     * Corresponds to {@link RegistrationSubmitted}
+     */
+    registrationSubmitted = "registrationSubmitted",
     /**
      * Corresponds to {@link ResetYourPassword}
      */
@@ -448,8 +485,8 @@ export declare enum ActionType {
      */
     tappedRegisterToBid = "tappedRegisterToBid",
     /**
-    * Corresponds to {@link TappedRequestPriceEstimate}
-    */
+     * Corresponds to {@link TappedRequestPriceEstimate}
+     */
     tappedRequestPriceEstimate = "tappedRequestPriceEstimate",
     /**
      * Corresponds to {@link TappedSell}

package/dist/Schema/Events/index.js

@@ -25,6 +25,8 @@ exports.ActionType = ActionType;
   ActionType["addCollectedArtwork"] = "addCollectedArtwork";
   ActionType["artworkDetailsCompleted"] = "artworkDetailsCompleted";
   ActionType["auctionResultsFilterParamsChanged"] = "auctionResultsFilterParamsChanged";
+  ActionType["bidPageView"] = "bidPageView";
+  ActionType["clickedActiveBid"] = "clickedActiveBid";
   ActionType["clickedAddNewShippingAddress"] = "clickedAddNewShippingAddress";
   ActionType["clickedAddWorksToFair"] = "clickedAddWorksToFair";
   ActionType["clickedAppDownload"] = "clickedAppDownload";
@@ -58,6 +60,7 @@ exports.ActionType = ActionType;
   ActionType["clickedSnooze"] = "clickedSnooze";
   ActionType["clickedPartnerCard"] = "clickedPartnerCard";
   ActionType["clickedPromoSpace"] = "clickedPromoSpace";
+  ActionType["clickedRegisterToBid"] = "clickedRegisterToBid";
   ActionType["clickedSelectShippingOption"] = "clickedSelectShippingOption";
   ActionType["clickedShippingAddress"] = "clickedShippingAddress";
   ActionType["clickedShowGroup"] = "clickedShowGroup";
@@ -65,6 +68,8 @@ exports.ActionType = ActionType;
   ActionType["clickedVerifyIdentity"] = "clickedVerifyIdentity";
   ActionType["clickedViewingRoomCard"] = "clickedViewingRoomCard";
   ActionType["commercialFilterParamsChanged"] = "commercialFilterParamsChanged";
+  ActionType["confirmBid"] = "confirmBid";
+  ActionType["confirmRegistrationPageview"] = "confirmRegistrationPageview";
   ActionType["consignmentArtistFailed"] = "consignmentArtistFailed";
   ActionType["consignmentSubmitted"] = "consignmentSubmitted";
   ActionType["contactInformationCompleted"] = "contactInformationCompleted";
@@ -74,6 +79,7 @@ exports.ActionType = ActionType;
   ActionType["deletedSavedSearch"] = "deletedSavedSearch";
   ActionType["editCollectedArtwork"] = "editCollectedArtwork";
   ActionType["editedSavedSearch"] = "editedSavedSearch";
+  ActionType["enterLiveAuction"] = "enterLiveAuction";
   ActionType["focusedOnConversationMessageInput"] = "focusedOnConversationMessageInput";
   ActionType["focusedOnSearchInput"] = "focusedOnSearchInput";
   ActionType["focusedOnPriceDatabaseSearchInput"] = "focusedOnPriceDatabaseSearchInput";
@@ -81,9 +87,12 @@ exports.ActionType = ActionType;
   ActionType["followedFair"] = "followedFair";
   ActionType["followedGene"] = "followedGene";
   ActionType["followedPartner"] = "followedPartner";
+  ActionType["maxBidSelected"] = "maxBidSelected";
   ActionType["onboardingUserInputData"] = "onboardingUserInputData";
   ActionType["priceDatabaseFilterParamsChanged"] = "priceDatabaseFilterParamsChanged";
   ActionType["promptForReview"] = "promptForReview";
+  ActionType["registrationPageView"] = "registrationPageView";
+  ActionType["registrationSubmitted"] = "registrationSubmitted";
   ActionType["resetYourPassword"] = "resetYourPassword";
   ActionType["saleScreenLoadComplete"] = "saleScreenLoadComplete";
   ActionType["screen"] = "screen";

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

@@ -12,6 +12,7 @@ export declare enum OwnerType {
     artistAuctionResults = "artistAuctionResults",
     artistSeries = "artistSeries",
     artwork = "artwork",
+    auction = "auction",
     auctionResult = "auctionResult",
     auctionResultsForArtistsYouFollow = "auctionResultsForArtistsYouFollow",
     auctionResultsRail = "auctionResultsRail",

package/dist/Schema/Values/OwnerType.js

@@ -30,6 +30,7 @@ exports.OwnerType = OwnerType;
   OwnerType["artistAuctionResults"] = "artistAuctionResults";
   OwnerType["artistSeries"] = "artistSeries";
   OwnerType["artwork"] = "artwork";
+  OwnerType["auction"] = "auction";
   OwnerType["auctionResult"] = "auctionResult";
   OwnerType["auctionResultsForArtistsYouFollow"] = "auctionResultsForArtistsYouFollow";
   OwnerType["auctionResultsRail"] = "auctionResultsRail";

package/package.json

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