@artsy/cohesion 4.55.0 → 4.56.0

package/CHANGELOG.md

@@ -1,3 +1,20 @@
+# v4.56.0 (Tue Jul 05 2022)
+
+#### 🚀  Enhancement
+
+- [AS-3293] Adding new events for CMS tracking [#341](https://github.com/artsy/cohesion/pull/341) ([@daytavares](https://github.com/daytavares))
+
+#### 🔩 Dependency Updates
+
+- Bump jsdom from 16.2.2 to 16.7.0 [#340](https://github.com/artsy/cohesion/pull/340) ([@dependabot[bot]](https://github.com/dependabot[bot]))
+
+#### Authors: 2
+
+- [@dependabot[bot]](https://github.com/dependabot[bot])
+- Dayane Tavares ([@daytavares](https://github.com/daytavares))
+
+---
+
 # v4.55.0 (Wed Jun 22 2022)
 
 #### 🚀  Enhancement

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

@@ -609,6 +609,74 @@ export interface ClickedOnFramedMeasurementsDropdown {
     context_page_owner_type: PageOwnerType;
     context_page_owner_id?: string;
 }
+/**
+ * A Partner clicks on one of the options (Accept collector's offer, Send a counteroffer, Decline collector's offer)
+ * for offers on the orders page on CMS.
+ *
+ * This schema describes events sent to Segment from [[clickedOfferActions]]
+ *
+ *  @example
+ *  ```
+ *  {
+ *    action: "clickedOfferActions",
+ *    context_page_owner_type: "order",
+ *    context_page_owner_id: "60de173a47476c000fd5c4cc"
+ *    order_id: "60de173a47476c000fd5c4cc"
+ *    label: "Accept collector's offer"
+ *    artwork_id: "60de173a47476c000fd5c4cc"
+ *    flow: offer
+ *    partner_id: "60de173a47476c000fd5c4cc"
+ *  }
+ * ```
+ */
+export interface ClickedOfferActions {
+    action: ActionType.clickedOfferActions;
+    context_module: ContextModule;
+    context_page_owner_type: PageOwnerType;
+    context_page_owner_id?: string;
+    order_id: string;
+    label: string;
+    artwork_id: string;
+    flow: string;
+    partner_id: string;
+}
+/**
+ * A Partner clicks on one of the the CTAs on the orders page on the orders page on CMS.
+ * - Confirm order
+ * - Confirm shipping contact and confirm order
+ * - Accept offer
+ * - Confirm shipping contact and accept offer
+ * - Decline offer
+ * - Send a counter offer
+ * - Confirm shipping contact and send counter offer
+ *
+ * This schema describes events sent to Segment from [[clickedOrderPage]]
+ *
+ *  @example
+ *  ```
+ *  {
+ *    action: "clickedOrderPage",
+ *    context_page_owner_type: "order",
+ *    context_page_owner_id: "60de173a47476c000fd5c4cc"
+ *    order_id: "60de173a47476c000fd5c4cc"
+ *    label: "Confirm order"
+ *    artwork_id: "60de173a47476c000fd5c4cc"
+ *    flow: buy
+ *    partner_id: "60de173a47476c000fd5c4cc"
+ *  }
+ * ```
+ */
+export interface ClickedOrderPage {
+    action: ActionType.clickedOrderPage;
+    context_module: ContextModule;
+    context_page_owner_type: PageOwnerType;
+    context_page_owner_id?: string;
+    order_id: string;
+    label: string;
+    artwork_id: string;
+    flow: string;
+    partner_id: string;
+}
 /**
  *  User clicks on submit order on the orders review page.
  *

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

@@ -1,7 +1,7 @@
 import { AddToCalendar } from "./AddToCalendar";
 import { AuctionPageView, 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, ClickedPartnerLink, ClickedPaymentDetails, ClickedPaymentMethod, ClickedPromoSpace, ClickedSelectShippingOption, ClickedShippingAddress, ClickedShowGroup, ClickedShowMore, ClickedSnooze, ClickedVerifyIdentity, ClickedViewingRoomCard } from "./Click";
+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, ClickedPartnerLink, ClickedPaymentDetails, ClickedPaymentMethod, ClickedPromoSpace, ClickedSelectShippingOption, ClickedShippingAddress, ClickedShowGroup, ClickedShowMore, ClickedSnooze, ClickedVerifyIdentity, ClickedViewingRoomCard, ClickedOfferActions, ClickedOrderPage } from "./Click";
 import { ArtworkDetailsCompleted, ConsignmentSubmitted, SubmitAnotherArtwork, UploadPhotosCompleted, ViewArtworkMyCollection } from "./Consignments";
 import { FocusedOnConversationMessageInput, SentConversationMessage, TappedInboxConversation, TappedMakeOffer, TappedViewOffer } from "./Conversations";
 import { ExperimentViewed } from "./ExperimentViewed";
@@ -22,7 +22,7 @@ import { ToggledAccordion } from "./UserExperienceInteractions";
  *
  * Each event describes one ActionType
  */
-export declare type Event = AddToCalendar | AddCollectedArtwork | ArtworkDetailsCompleted | AuctionPageView | 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 | ClickedPartnerLink | ClickedPaymentMethod | ClickedPaymentDetails | ClickedPromoSpace | ClickedRegisterToBid | ClickedSelectShippingOption | ClickedShippingAddress | ClickedShowGroup | ClickedShowMore | ClickedVerifyIdentity | ClickedViewingRoomCard | CommercialFilterParamsChanged | ConfirmBid | ConfirmRegistrationPageview | ConsignmentArtistFailed | ConsignmentSubmitted | DeleteCollectedArtwork | DeletedSavedSearch | EditCollectedArtwork | EditedSavedSearch | EnterLiveAuction | ExperimentViewed | FocusedOnConversationMessageInput | FocusedOnSearchInput | FocusedOnPriceDatabaseSearchInput | FollowEvents | Impression | MaxBidSelected | OnboardingUserInputData | PriceDatabaseFilterParamsChanged | PromptForReview | RegistrationPageView | RegistrationSubmitted | ResetYourPassword | SaleScreenLoadComplete | Screen | SearchedPriceDatabase | SearchedWithNoResults | SelectedItemFromSearch | SelectedItemFromPriceDatabaseSearch | SentConversationMessage | SentRequestPriceEstimate | 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 | TappedSellArtwork | TappedShowMore | TappedLearnMore | TappedSkip | TappedTabBar | TappedVerifyIdentity | TappedViewingRoomCard | TappedViewingRoomGroup | TappedViewOffer | TimeOnPage | ToggledAccordion | ToggledNotification | ToggledSavedSearch | UploadPhotosCompleted | ViewArtworkMyCollection;
+export declare type Event = AddToCalendar | AddCollectedArtwork | ArtworkDetailsCompleted | AuctionPageView | 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 | ClickedPartnerLink | ClickedPaymentMethod | ClickedPaymentDetails | ClickedPromoSpace | ClickedRegisterToBid | ClickedSelectShippingOption | ClickedShippingAddress | ClickedShowGroup | ClickedShowMore | ClickedVerifyIdentity | ClickedViewingRoomCard | ClickedOfferActions | ClickedOrderPage | CommercialFilterParamsChanged | ConfirmBid | ConfirmRegistrationPageview | ConsignmentArtistFailed | ConsignmentSubmitted | DeleteCollectedArtwork | DeletedSavedSearch | EditCollectedArtwork | EditedSavedSearch | EnterLiveAuction | ExperimentViewed | FocusedOnConversationMessageInput | FocusedOnSearchInput | FocusedOnPriceDatabaseSearchInput | FollowEvents | Impression | MaxBidSelected | OnboardingUserInputData | PriceDatabaseFilterParamsChanged | PromptForReview | RegistrationPageView | RegistrationSubmitted | ResetYourPassword | SaleScreenLoadComplete | Screen | SearchedPriceDatabase | SearchedWithNoResults | SelectedItemFromSearch | SelectedItemFromPriceDatabaseSearch | SentConversationMessage | SentRequestPriceEstimate | 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 | TappedSellArtwork | TappedShowMore | TappedLearnMore | TappedSkip | TappedTabBar | TappedVerifyIdentity | TappedViewingRoomCard | TappedViewingRoomGroup | TappedViewOffer | TimeOnPage | ToggledAccordion | ToggledNotification | ToggledSavedSearch | UploadPhotosCompleted | ViewArtworkMyCollection;
 /**
  * The top-level actions an Event describes.
  *
@@ -254,6 +254,14 @@ export declare enum ActionType {
      * Corresponds to {@link ClickedViewingRoomCard}
      */
     clickedViewingRoomCard = "clickedViewingRoomCard",
+    /**
+     * Corresponds to {@link ClickedOfferActions}
+     */
+    clickedOfferActions = "clickedOfferActions",
+    /**
+   * Corresponds to {@link ClickedOrderPage}
+   */
+    clickedOrderPage = "clickedOrderPage",
     /**
      * Corresponds to {@link CommercialFilterParamsChanged}
      */

package/dist/Schema/Events/index.js

@@ -76,6 +76,8 @@ exports.ActionType = ActionType;
   ActionType["clickedTooltip"] = "clickedTooltip";
   ActionType["clickedVerifyIdentity"] = "clickedVerifyIdentity";
   ActionType["clickedViewingRoomCard"] = "clickedViewingRoomCard";
+  ActionType["clickedOfferActions"] = "clickedOfferActions";
+  ActionType["clickedOrderPage"] = "clickedOrderPage";
   ActionType["commercialFilterParamsChanged"] = "commercialFilterParamsChanged";
   ActionType["confirmBid"] = "confirmBid";
   ActionType["confirmRegistrationPageview"] = "confirmRegistrationPageview";

package/package.json

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