@artsy/cohesion 4.379.0 → 4.381.0--canary.722.15553.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,3 +1,15 @@
1
+ # v4.380.0 (Tue Jun 30 2026)
2
+
3
+ #### 🚀 Enhancement
4
+
5
+ - feat: counter offer tracking [#721](https://github.com/artsy/cohesion/pull/721) ([@xander-pero](https://github.com/xander-pero))
6
+
7
+ #### Authors: 1
8
+
9
+ - [@xander-pero](https://github.com/xander-pero)
10
+
11
+ ---
12
+
1
13
  # v4.379.0 (Tue Jun 30 2026)
2
14
 
3
15
  #### 🚀 Enhancement
@@ -763,6 +763,33 @@ export interface ClickedOfferOption {
763
763
  amount: number;
764
764
  currency: string;
765
765
  }
766
+ /**
767
+ * A user clicks a counter offer option on the counter offer page
768
+ *
769
+ * This schema describes events sent to Segment from [[ClickedCounterOfferOption]]
770
+ *
771
+ * @example
772
+ * ```
773
+ * {
774
+ * action: "clickedCounterOfferOption",
775
+ * context_module: "ordersCounter",
776
+ * context_page_owner_type: "orders-respond",
777
+ * context_page_owner_id: "dd0cbbb5-300b-4c49-92a1-fed55b077fa9",
778
+ * option: "accept" | "counter" | "decline",
779
+ * amount?: 2000,
780
+ * currency?: "USD"
781
+ * }
782
+ * ```
783
+ */
784
+ export interface ClickedCounterOfferOption {
785
+ action: ActionType.clickedCounterOfferOption;
786
+ context_module: ContextModule;
787
+ context_page_owner_type: PageOwnerType;
788
+ context_page_owner_id: string;
789
+ option: "accept" | "counter" | "decline";
790
+ amount?: number;
791
+ currency?: string;
792
+ }
766
793
  /**
767
794
  * A Partner clicks on Artwork weight (without packaging) bar in the artwork edit page
768
795
  * in CMS.
@@ -2505,6 +2532,69 @@ export interface SubmittedOffer {
2505
2532
  flow: string;
2506
2533
  credit_card_wallet_type?: string;
2507
2534
  }
2535
+ /**
2536
+ * A user submits a counter offer in response to a gallery counter offer.
2537
+ *
2538
+ * This schema describes events sent to Segment from [[SubmittedCounterOffer]]
2539
+ *
2540
+ * @example
2541
+ * ```
2542
+ * {
2543
+ * action: "submittedCounterOffer",
2544
+ * context_module: "ordersReview",
2545
+ * context_page_owner_type: "orders-respond",
2546
+ * context_page_owner_id: "b0ac7b78-ee9b-4fa8-b0ca-b726169db217",
2547
+ * }
2548
+ * ```
2549
+ */
2550
+ export interface SubmittedCounterOffer {
2551
+ action: ActionType.submittedCounterOffer;
2552
+ context_module: ContextModule;
2553
+ context_page_owner_type: PageOwnerType;
2554
+ context_page_owner_id: string;
2555
+ }
2556
+ /**
2557
+ * A user accepts a gallery's counter offer.
2558
+ *
2559
+ * This schema describes events sent to Segment from [[AcceptedOffer]]
2560
+ *
2561
+ * @example
2562
+ * ```
2563
+ * {
2564
+ * action: "acceptedOffer",
2565
+ * context_module: "ordersReview",
2566
+ * context_page_owner_type: "orders-respond",
2567
+ * context_page_owner_id: "b0ac7b78-ee9b-4fa8-b0ca-b726169db217",
2568
+ * }
2569
+ * ```
2570
+ */
2571
+ export interface AcceptedOffer {
2572
+ action: ActionType.acceptedOffer;
2573
+ context_module: ContextModule;
2574
+ context_page_owner_type: PageOwnerType;
2575
+ context_page_owner_id: string;
2576
+ }
2577
+ /**
2578
+ * A user declines a gallery's counter offer.
2579
+ *
2580
+ * This schema describes events sent to Segment from [[DeclinedOffer]]
2581
+ *
2582
+ * @example
2583
+ * ```
2584
+ * {
2585
+ * action: "declinedOffer",
2586
+ * context_module: "ordersReview",
2587
+ * context_page_owner_type: "orders-respond",
2588
+ * context_page_owner_id: "b0ac7b78-ee9b-4fa8-b0ca-b726169db217",
2589
+ * }
2590
+ * ```
2591
+ */
2592
+ export interface DeclinedOffer {
2593
+ action: ActionType.declinedOffer;
2594
+ context_module: ContextModule;
2595
+ context_page_owner_type: PageOwnerType;
2596
+ context_page_owner_id: string;
2597
+ }
2508
2598
  /**
2509
2599
  * A user submits an order. Includes normal and express checkout flows.
2510
2600
  *
@@ -2723,7 +2813,7 @@ export interface ClickedArtistArtworkImage {
2723
2813
  destination_page_owner_slug: string;
2724
2814
  }
2725
2815
  /**
2726
- * A user clicks on Terms and Conditions link during checkout or counteroffer flow
2816
+ * A user clicks on Terms and Conditions link during checkout or counter offer flow
2727
2817
  *
2728
2818
  * This schema describes events sent to Segment from [[ClickedTermsAndConditions]]
2729
2819
  *
@@ -108,3 +108,26 @@ export interface ToggledArtistBio {
108
108
  context_page_owner_slug: string;
109
109
  expand: boolean;
110
110
  }
111
+ /**
112
+ * A user toggles the offer history section on the counter offer flow
113
+ *
114
+ * This schema describes events sent to Segment from [[ToggledOfferHistory]]
115
+ *
116
+ * @example
117
+ * ```
118
+ * {
119
+ * action: "toggledOfferHistory",
120
+ * context_module : "ordersCounter",
121
+ * context_page_owner_type: "orders-respond",
122
+ * context_page_owner_id: "57e60c68-a198-431e-8a02-6ecb01e3a99b",
123
+ * expanded: true | false
124
+ * }
125
+ * ```
126
+ */
127
+ export interface ToggledOfferHistory {
128
+ action: ActionType.toggledOfferHistory;
129
+ context_module: ContextModule;
130
+ context_page_owner_type: PageOwnerType;
131
+ context_page_owner_id: string;
132
+ expanded: boolean;
133
+ }
@@ -3,7 +3,7 @@ import { AddToCalendar } from "./AddToCalendar";
3
3
  import { AddedArtworkToArtworkList, CreatedArtworkList, DeletedArtworkList, EditedArtworkList, ViewedArtworkList, ViewedSharedArtworkList } from "./ArtworkLists";
4
4
  import { AuctionPageView, BidPageView, ClickedActiveBid, ClickedRegisterToBid, ConfirmBid, ConfirmRegistrationPageview, EnterLiveAuction, MaxBidSelected, RegistrationPageView, RegistrationSubmitted } from "./Auction";
5
5
  import { AuthImpression, CompletedOnboarding, CreatedAccount, OnboardingUserInputData, ResetYourPassword, StartedOnboarding, SuccessfullyLoggedIn } from "./Authentication";
6
- import { CheckedAccountBalance, ClickedAddFilters, ClickedAddMissingArtworksDetails, ClickedAddNewShippingAddress, ClickedAddWorksToFair, ClickedAlertsFilters, ClickedAppDownload, ClickedArticleGroup, ClickedArtistArtworkImage, ClickedArtistGroup, ClickedArtistSeriesGroup, ClickedArtworkGroup, ClickedAskSpecialist, ClickedAuctionGroup, ClickedAuctionResultItem, ClickedBid, ClickedBuyerProtection, ClickedBuyNow, ClickedCancelExpressCheckout, ClickedChangeOfferOption, ClickedChangePage, ClickedChangePaymentMethod, ClickedChangeShippingAddress, ClickedChangeShippingMethod, ClickedCloseValidationAddressModal, ClickedCollectionGroup, ClickedCompleteYourProfile, ClickedContactGallery, ClickedConversationsFilter, ClickedCreateAlert, ClickedCV, ClickedDeliveryMethod, ClickedDismissInquiry, ClickedDownloadAppFooter, ClickedDownloadAppHeader, ClickedEditAlert, ClickedEditArtwork, ClickedEditShippingAddress, ClickedEstimateShippingCost, ClickedExpandFilterPanel, ClickedExpansionToggle, ClickedExpressCheckout, ClickedFairCard, ClickedFairGroup, ClickedFulfillmentTab, ClickedGalleryGroup, ClickedGene, ClickedHeader, ClickedHeroUnitGroup, ClickedImmersiveView, ClickedImportFees, ClickedLoadMore, ClickedMainArtworkGrid, ClickedMakeOffer, ClickedMarketingModal, ClickedMarkSold, ClickedMarkSpam, ClickedNavBar, ClickedNavigationTab, ClickedOfferActions, ClickedOfferOption, ClickedOnArtworkShippingUnitsDropdown, ClickedOnArtworkShippingWeight, ClickedOnBuyNowCheckbox, ClickedOnDuplicateArtwork, ClickedOnFramedMeasurements, ClickedOnFramedMeasurementsDropdown, ClickedOnLearnMore, ClickedOnMakeOfferCheckbox, ClickedOnPagination, ClickedOnPriceDisplayDropdown, ClickedOnReadMore, ClickedOrderArtworkImage, ClickedOrderPage, ClickedOrderProgression, ClickedOrderSummary, ClickedPartnerCard, ClickedPartnerLink, ClickedPaymentDetails, ClickedPaymentMethod, ClickedPromoSpace, ClickedPublish, ClickedSaveAsTemplate, ClickedSelectShippingOption, ClickedSendPartnerOffer, ClickedShippingAddress, ClickedShowGroup, ClickedShowMore, ClickedSnooze, ClickedStartPartnerOffer, ClickedTermsAndConditions, ClickedUpdateArtwork, ClickedUploadArtwork, ClickedValidationAddressOptions, ClickedVerifyIdentity, ClickedViewingRoomCard, ClickedViewWork, ClickedVisitHelpCenter, SubmittedOffer, SubmittedOrder } from "./Click";
6
+ import { AcceptedOffer, CheckedAccountBalance, ClickedAddFilters, ClickedAddMissingArtworksDetails, ClickedAddNewShippingAddress, ClickedAddWorksToFair, ClickedAlertsFilters, ClickedAppDownload, ClickedArticleGroup, ClickedArtistArtworkImage, ClickedArtistGroup, ClickedArtistSeriesGroup, ClickedArtworkGroup, ClickedAskSpecialist, ClickedAuctionGroup, ClickedAuctionResultItem, ClickedBid, ClickedBuyerProtection, ClickedBuyNow, ClickedCancelExpressCheckout, ClickedChangeOfferOption, ClickedChangePage, ClickedChangePaymentMethod, ClickedChangeShippingAddress, ClickedChangeShippingMethod, ClickedCloseValidationAddressModal, ClickedCollectionGroup, ClickedCompleteYourProfile, ClickedContactGallery, ClickedConversationsFilter, ClickedCounterOfferOption, ClickedCreateAlert, ClickedCV, ClickedDeliveryMethod, ClickedDismissInquiry, ClickedDownloadAppFooter, ClickedDownloadAppHeader, ClickedEditAlert, ClickedEditArtwork, ClickedEditShippingAddress, ClickedEstimateShippingCost, ClickedExpandFilterPanel, ClickedExpansionToggle, ClickedExpressCheckout, ClickedFairCard, ClickedFairGroup, ClickedFulfillmentTab, ClickedGalleryGroup, ClickedGene, ClickedHeader, ClickedHeroUnitGroup, ClickedImmersiveView, ClickedImportFees, ClickedLoadMore, ClickedMainArtworkGrid, ClickedMakeOffer, ClickedMarketingModal, ClickedMarkSold, ClickedMarkSpam, ClickedNavBar, ClickedNavigationTab, ClickedOfferActions, ClickedOfferOption, ClickedOnArtworkShippingUnitsDropdown, ClickedOnArtworkShippingWeight, ClickedOnBuyNowCheckbox, ClickedOnDuplicateArtwork, ClickedOnFramedMeasurements, ClickedOnFramedMeasurementsDropdown, ClickedOnLearnMore, ClickedOnMakeOfferCheckbox, ClickedOnPagination, ClickedOnPriceDisplayDropdown, ClickedOnReadMore, ClickedOrderArtworkImage, ClickedOrderPage, ClickedOrderProgression, ClickedOrderSummary, ClickedPartnerCard, ClickedPartnerLink, ClickedPaymentDetails, ClickedPaymentMethod, ClickedPromoSpace, ClickedPublish, ClickedSaveAsTemplate, ClickedSelectShippingOption, ClickedSendPartnerOffer, ClickedShippingAddress, ClickedShowGroup, ClickedShowMore, ClickedSnooze, ClickedStartPartnerOffer, ClickedTermsAndConditions, ClickedUpdateArtwork, ClickedUploadArtwork, ClickedValidationAddressOptions, ClickedVerifyIdentity, ClickedViewingRoomCard, ClickedViewWork, ClickedVisitHelpCenter, DeclinedOffer, SubmittedCounterOffer, SubmittedOffer, SubmittedOrder } from "./Click";
7
7
  import { EditedUserProfile, TappedEditedProfile } from "./CollectorProfile";
8
8
  import { ArtworkDetailsCompleted, ConsignmentSubmitted, ContactInformationCompleted, SentConsignmentInquiry, SubmitAnotherArtwork, UploadPhotosCompleted, ViewArtworkMyCollection } from "./Consignments";
9
9
  import { FocusedOnConversationMessageInput, SentConversationMessage, TappedInboxConversation, TappedMakeOffer, TappedViewOffer } from "./Conversations";
@@ -28,7 +28,7 @@ import { ClickedOpenInNewTabButton, ClickedShareButton, Share } from "./Share";
28
28
  import { SwipedInfiniteDiscoveryArtwork, SwipedUp } from "./Swipe";
29
29
  import { SaleScreenLoadComplete, Screen, TimeOnPage } from "./System";
30
30
  import { Tapped3Dots, TappedActivityGroup, TappedArticleGroup, TappedArticleShare, TappedArtistGroup, TappedArtistSeriesGroup, TappedArtworkGroup, TappedAskSpecialist, TappedAuctionGroup, TappedAuctionResultGroup, TappedBid, TappedBrowseSimilarArtworks, TappedBuyerProtection, TappedBuyNow, TappedCardGroup, TappedChangePaymentMethod, TappedClearTask, TappedCollectionGroup, TappedCompleteYourProfile, TappedConfirmSeeFewerWorks, TappedConsign, TappedConsignmentInquiry, TappedContactGallery, TappedCreateAlert, TappedExploreGroup, TappedFairCard, TappedFairGroup, TappedGlobalSearchBar, TappedImportFees, TappedInfoBubble, TappedLearnMore, TappedLink, TappedMainArtworkGrid, TappedMenuItemGroup, TappedNavigationPillsGroup, TappedNavigationTab, TappedOrderArtworkImage, TappedPartnerCard, TappedPromoSpace, TappedSeeFewerWorks, TappedSell, TappedSellArtwork, TappedShare, TappedShowMore, TappedSkip, TappedTabBar, TappedTaskGroup, TappedVerifyIdentity, TappedViewingRoomCard, TappedViewingRoomGroup, TappedViewWork, TappedVisitHelpCenter } from "./Tap";
31
- import { ToggledArtistBio, ToggledCollapsibleOrderSummary, ToggledNotification, ToggledSavedSearch } from "./Toggle";
31
+ import { ToggledArtistBio, ToggledCollapsibleOrderSummary, ToggledNotification, ToggledOfferHistory, ToggledSavedSearch } from "./Toggle";
32
32
  import { UploadSizeLimitExceeded } from "./UploadSizeLimitExceeded";
33
33
  import { ToggledAccordion } from "./UserExperienceInteractions";
34
34
  import { ViewedVideo } from "./Video";
@@ -37,13 +37,17 @@ import { ViewedVideo } from "./Video";
37
37
  *
38
38
  * Each event describes one ActionType
39
39
  */
40
- export type Event = AddCollectedArtwork | AddedArtworkToArtworkList | AddedToAlbum | AddressAutoCompletionResult | AddToCalendar | ArtworkDetailsCompleted | AuctionPageView | AuctionResultsFilterParamsChanged | AuthImpression | BannerViewed | BidPageView | CheckedAccountBalance | ClickedActiveBid | ClickedActivityPanelNotificationItem | ClickedActivityPanelTab | ClickedAddFilters | ClickedAddMissingArtworksDetails | ClickedAddNewShippingAddress | ClickedAddWorksToFair | ClickedAlertsFilters | ClickedAppDownload | ClickedArticleGroup | ClickedArtistArtworkImage | ClickedArtistGroup | ClickedArtistSeriesGroup | ClickedArtworkGroup | ClickedAskSpecialist | ClickedAuctionGroup | ClickedAuctionResultItem | ClickedBid | ClickedBuyerProtection | ClickedBuyNow | ClickedCancelExpressCheckout | ClickedChangeOfferOption | ClickedChangePage | ClickedChangePaymentMethod | ClickedChangeShippingAddress | ClickedChangeShippingMethod | ClickedCloseValidationAddressModal | ClickedCollectionGroup | ClickedCompleteYourProfile | ClickedContactGallery | ClickedConversationsFilter | ClickedCreateAlert | ClickedCV | ClickedDeliveryMethod | ClickedDismissInquiry | ClickedDownloadAppFooter | ClickedDownloadAppHeader | ClickedEditArtwork | ClickedEditAlert | ClickedEditShippingAddress | ClickedEstimateShippingCost | ClickedExpandFilterPanel | ClickedExpansionToggle | ClickedExpressCheckout | ClickedFairCard | ClickedFairGroup | ClickedFulfillmentTab | ClickedGalleryGroup | ClickedGene | ClickedHeader | ClickedHeroUnitGroup | ClickedImmersiveView | ClickedImportFees | ClickedLoadMore | ClickedMainArtworkGrid | ClickedMakeOffer | ClickedMarketingModal | ClickedMarkSold | ClickedMarkSpam | ClickedNavBar | ClickedNavigationTab | ClickedNotificationsBell | ClickedOfferActions | ClickedOfferOption | ClickedOnArtworkShippingUnitsDropdown | ClickedOnArtworkShippingWeight | ClickedOnBuyNowCheckbox | ClickedOnDuplicateArtwork | ClickedOnFramedMeasurements | ClickedOnFramedMeasurementsDropdown | ClickedOnLearnMore | ClickedOnMakeOfferCheckbox | ClickedOnPagination | ClickedOnPriceDisplayDropdown | ClickedOnReadMore | ClickedOrderArtworkImage | ClickedOrderPage | ClickedOrderProgression | ClickedOrderSummary | ClickedOpenInNewTabButton | ClickedPartnerCard | ClickedPartnerLink | ClickedPaymentDetails | ClickedPaymentMethod | ClickedPromoSpace | ClickedPublish | ClickedRegisterToBid | ClickedSaveAsTemplate | ClickedSelectShippingOption | ClickedSendPartnerOffer | ClickedShareButton | ClickedShippingAddress | ClickedShowGroup | ClickedShowMore | ClickedSnooze | ClickedStartPartnerOffer | ClickedTermsAndConditions | ClickedUpdateArtwork | ClickedUploadArtwork | ClickedValidationAddressOptions | ClickedVerifyIdentity | ClickedViewingRoomCard | ClickedViewWork | ClickedVisitHelpCenter | CommercialFilterParamsChanged | CommercialFilterSelectedAll | CompletedOfflineSync | CompletedOnboarding | ConfirmBid | ConfirmRegistrationPageview | ConsignmentArtistFailed | ConsignmentSubmitted | ContactInformationCompleted | CreatedAccount | CreateAlertReminderMessageViewed | CreatedAlbum | CreatedArtworkList | DarkModeOptionUpdated | DeleteCollectedArtwork | DeletedArtworkList | DeletedSavedSearch | EditCollectedArtwork | EditedAlert | EditedArtworkList | EditedAutocompletedAddress | EditedSavedSearch | EditedUserProfile | EditProfileModalViewed | EnterLiveAuction | ErrorMessageViewed | ExperimentViewed | ExpressCheckoutViewed | FocusedOnConversationMessageInput | FocusedOnPriceDatabaseSearchInput | FocusedOnSearchInput | FollowEvents | Impression | ImmersiveViewArtworkDisplayed | ImmersiveViewOptionViewed | ItemViewed | MaxBidSelected | MyCollectionOnboardingCompleted | NavigationDropdownViewed | NewPaymentMethodViewed | OnboardingUserInputData | OrderDetailsViewed | OrderProgressionViewed | PartnerOfferInConversationViewed | PastedIntoSearchInput | PriceDatabaseFilterParamsChanged | PromptForReview | RailViewed | RegistrationPageView | RegistrationSubmitted | ResetYourPassword | SaleScreenLoadComplete | SaveCollectedArtwork | SavedAddressViewed | SavedCookieConsentPreferences | SavedPaymentMethodViewed | SavedPriceRange | Screen | SearchedPriceDatabase | SearchedWithNoResults | SearchedWithResults | SelectedItemFromAddressAutoCompletion | SelectedItemFromPriceDatabaseSearch | SelectedItemFromSearch | SelectedItemFromSearchPage | SelectedFromDrawer | SelectedRecentPriceRange | SelectedSearchSuggestionQuickNavigationItem | SendOffersBannerViewed | SendOffersErrorMessage | SendOffersModalViewed | SentConsignmentInquiry | SentContent | SentConversationMessage | SentRequestPriceEstimate | Share | ShippingEstimateViewed | ShippingQuoteViewed | StartedOnboarding | SubmitAnotherArtwork | SubmittedOffer | SubmittedOrder | SuccessfullyLoggedIn | SwipedInfiniteDiscoveryArtwork | SwipedUp | Tapped3Dots | TappedActivityGroup | TappedAlertsGroup | TappedArticleGroup | TappedArticleShare | TappedArtistGroup | TappedArtistSeriesGroup | TappedArtworkGroup | TappedArtworkList | TappedAskSpecialist | TappedAuctionGroup | TappedAuctionResultGroup | TappedBid | TappedBrowseSimilarArtworks | TappedBuyerProtection | TappedBuyNow | TappedCardGroup | TappedChangePaymentMethod | TappedClearTask | TappedCollectedArtwork | TappedCollectedArtworkImages | TappedCollectionGroup | TappedCompleteYourProfile | TappedConfirmSeeFewerWorks | TappedConsign | TappedConsignmentInquiry | TappedContactGallery | TappedCreateAlert | TappedEditedProfile | TappedExploreGroup | TappedExploreMyCollection | TappedFairCard | TappedFairGroup | TappedFollowsGroup | TappedGlobalSearchBar | TappedImportFees | TappedInboxConversation | TappedInfoBubble | TappedLearnMore | TappedLink | TappedMainArtworkGrid | TappedMakeOffer | TappedMenuItemGroup | TappedMyCollection | TappedMyCollectionAddArtworkArtist | TappedMyCollectionInsightsMedianAuctionPriceChartCareerHighlight | TappedMyCollectionInsightsMedianAuctionPriceChartCategory | TappedMyCollectionInsightsMedianAuctionPriceChartTimeframe | TappedMyCollectionInsightsMedianAuctionRailItem | TappedNavigationPillsGroup | TappedNavigationTab | TappedNewArtworkList | TappedNotificationsBell | TappedOfferSettings | TappedOrderArtworkImage | TappedPartnerCard | TappedProductCapabilitiesGroup | TappedPromoSpace | TappedRequestPriceEstimate | TappedSeeFewerWorks | TappedSell | TappedSellArtwork | TappedShare | TappedShowMore | TappedSkip | TappedTabBar | TappedTaskGroup | TappedVerifyIdentity | TappedViewingRoomCard | TappedViewingRoomGroup | TappedViewOffer | TappedViewWork | TappedVisitHelpCenter | TimeOnPage | ToggledAccordion | ToggledArtistBio | ToggledCollapsibleOrderSummary | ToggledNotification | ToggledPresentationModeSetting | ToggledSavedSearch | TooltipViewed | ProgressiveOnboardingTooltipViewed | UploadPhotosCompleted | UploadSizeLimitExceeded | ValidationAddressViewed | ViewArtworkMyCollection | ViewedArtworkList | ViewedSharedArtworkList | ViewedVideo | ViewedToast | VisitMyCollection | VisitMyCollectionOnboardingSlide;
40
+ export type Event = AcceptedOffer | AddCollectedArtwork | AddedArtworkToArtworkList | AddedToAlbum | AddressAutoCompletionResult | AddToCalendar | ArtworkDetailsCompleted | AuctionPageView | AuctionResultsFilterParamsChanged | AuthImpression | BannerViewed | BidPageView | CheckedAccountBalance | ClickedActiveBid | ClickedActivityPanelNotificationItem | ClickedActivityPanelTab | ClickedAddFilters | ClickedAddMissingArtworksDetails | ClickedAddNewShippingAddress | ClickedAddWorksToFair | ClickedAlertsFilters | ClickedAppDownload | ClickedArticleGroup | ClickedArtistArtworkImage | ClickedArtistGroup | ClickedArtistSeriesGroup | ClickedArtworkGroup | ClickedAskSpecialist | ClickedAuctionGroup | ClickedAuctionResultItem | ClickedBid | ClickedBuyerProtection | ClickedBuyNow | ClickedCancelExpressCheckout | ClickedChangeOfferOption | ClickedChangePage | ClickedChangePaymentMethod | ClickedChangeShippingAddress | ClickedChangeShippingMethod | ClickedCloseValidationAddressModal | ClickedCollectionGroup | ClickedCompleteYourProfile | ClickedContactGallery | ClickedConversationsFilter | ClickedCounterOfferOption | ClickedCreateAlert | ClickedCV | ClickedDeliveryMethod | ClickedDismissInquiry | ClickedDownloadAppFooter | ClickedDownloadAppHeader | ClickedEditArtwork | ClickedEditAlert | ClickedEditShippingAddress | ClickedEstimateShippingCost | ClickedExpandFilterPanel | ClickedExpansionToggle | ClickedExpressCheckout | ClickedFairCard | ClickedFairGroup | ClickedFulfillmentTab | ClickedGalleryGroup | ClickedGene | ClickedHeader | ClickedHeroUnitGroup | ClickedImmersiveView | ClickedImportFees | ClickedLoadMore | ClickedMainArtworkGrid | ClickedMakeOffer | ClickedMarketingModal | ClickedMarkSold | ClickedMarkSpam | ClickedNavBar | ClickedNavigationTab | ClickedNotificationsBell | ClickedOfferActions | ClickedOfferOption | ClickedOnArtworkShippingUnitsDropdown | ClickedOnArtworkShippingWeight | ClickedOnBuyNowCheckbox | ClickedOnDuplicateArtwork | ClickedOnFramedMeasurements | ClickedOnFramedMeasurementsDropdown | ClickedOnLearnMore | ClickedOnMakeOfferCheckbox | ClickedOnPagination | ClickedOnPriceDisplayDropdown | ClickedOnReadMore | ClickedOrderArtworkImage | ClickedOrderPage | ClickedOrderProgression | ClickedOrderSummary | ClickedOpenInNewTabButton | ClickedPartnerCard | ClickedPartnerLink | ClickedPaymentDetails | ClickedPaymentMethod | ClickedPromoSpace | ClickedPublish | ClickedRegisterToBid | ClickedSaveAsTemplate | ClickedSelectShippingOption | ClickedSendPartnerOffer | ClickedShareButton | ClickedShippingAddress | ClickedShowGroup | ClickedShowMore | ClickedSnooze | ClickedStartPartnerOffer | ClickedTermsAndConditions | ClickedUpdateArtwork | ClickedUploadArtwork | ClickedValidationAddressOptions | ClickedVerifyIdentity | ClickedViewingRoomCard | ClickedViewWork | ClickedVisitHelpCenter | CommercialFilterParamsChanged | CommercialFilterSelectedAll | CompletedOfflineSync | CompletedOnboarding | ConfirmBid | ConfirmRegistrationPageview | ConsignmentArtistFailed | ConsignmentSubmitted | ContactInformationCompleted | CreatedAccount | CreateAlertReminderMessageViewed | CreatedAlbum | CreatedArtworkList | DarkModeOptionUpdated | DeclinedOffer | DeleteCollectedArtwork | DeletedArtworkList | DeletedSavedSearch | EditCollectedArtwork | EditedAlert | EditedArtworkList | EditedAutocompletedAddress | EditedSavedSearch | EditedUserProfile | EditProfileModalViewed | EnterLiveAuction | ErrorMessageViewed | ExperimentViewed | ExpressCheckoutViewed | FocusedOnConversationMessageInput | FocusedOnPriceDatabaseSearchInput | FocusedOnSearchInput | FollowEvents | Impression | ImmersiveViewArtworkDisplayed | ImmersiveViewOptionViewed | ItemViewed | MaxBidSelected | MyCollectionOnboardingCompleted | NavigationDropdownViewed | NewPaymentMethodViewed | OnboardingUserInputData | OrderDetailsViewed | OrderProgressionViewed | PartnerOfferInConversationViewed | PastedIntoSearchInput | PriceDatabaseFilterParamsChanged | PromptForReview | RailViewed | RegistrationPageView | RegistrationSubmitted | ResetYourPassword | SaleScreenLoadComplete | SaveCollectedArtwork | SavedAddressViewed | SavedCookieConsentPreferences | SavedPaymentMethodViewed | SavedPriceRange | Screen | SearchedPriceDatabase | SearchedWithNoResults | SearchedWithResults | SelectedItemFromAddressAutoCompletion | SelectedItemFromPriceDatabaseSearch | SelectedItemFromSearch | SelectedItemFromSearchPage | SelectedFromDrawer | SelectedRecentPriceRange | SelectedSearchSuggestionQuickNavigationItem | SendOffersBannerViewed | SendOffersErrorMessage | SendOffersModalViewed | SentConsignmentInquiry | SentContent | SentConversationMessage | SentRequestPriceEstimate | Share | ShippingEstimateViewed | ShippingQuoteViewed | StartedOnboarding | SubmitAnotherArtwork | SubmittedCounterOffer | SubmittedOffer | SubmittedOrder | SuccessfullyLoggedIn | SwipedInfiniteDiscoveryArtwork | SwipedUp | Tapped3Dots | TappedActivityGroup | TappedAlertsGroup | TappedArticleGroup | TappedArticleShare | TappedArtistGroup | TappedArtistSeriesGroup | TappedArtworkGroup | TappedArtworkList | TappedAskSpecialist | TappedAuctionGroup | TappedAuctionResultGroup | TappedBid | TappedBrowseSimilarArtworks | TappedBuyerProtection | TappedBuyNow | TappedCardGroup | TappedChangePaymentMethod | TappedClearTask | TappedCollectedArtwork | TappedCollectedArtworkImages | TappedCollectionGroup | TappedCompleteYourProfile | TappedConfirmSeeFewerWorks | TappedConsign | TappedConsignmentInquiry | TappedContactGallery | TappedCreateAlert | TappedEditedProfile | TappedExploreGroup | TappedExploreMyCollection | TappedFairCard | TappedFairGroup | TappedFollowsGroup | TappedGlobalSearchBar | TappedImportFees | TappedInboxConversation | TappedInfoBubble | TappedLearnMore | TappedLink | TappedMainArtworkGrid | TappedMakeOffer | TappedMenuItemGroup | TappedMyCollection | TappedMyCollectionAddArtworkArtist | TappedMyCollectionInsightsMedianAuctionPriceChartCareerHighlight | TappedMyCollectionInsightsMedianAuctionPriceChartCategory | TappedMyCollectionInsightsMedianAuctionPriceChartTimeframe | TappedMyCollectionInsightsMedianAuctionRailItem | TappedNavigationPillsGroup | TappedNavigationTab | TappedNewArtworkList | TappedNotificationsBell | TappedOfferSettings | TappedOrderArtworkImage | TappedPartnerCard | TappedProductCapabilitiesGroup | TappedPromoSpace | TappedRequestPriceEstimate | TappedSeeFewerWorks | TappedSell | TappedSellArtwork | TappedShare | TappedShowMore | TappedSkip | TappedTabBar | TappedTaskGroup | TappedVerifyIdentity | TappedViewingRoomCard | TappedViewingRoomGroup | TappedViewOffer | TappedViewWork | TappedVisitHelpCenter | TimeOnPage | ToggledAccordion | ToggledArtistBio | ToggledCollapsibleOrderSummary | ToggledNotification | ToggledOfferHistory | ToggledPresentationModeSetting | ToggledSavedSearch | TooltipViewed | ProgressiveOnboardingTooltipViewed | UploadPhotosCompleted | UploadSizeLimitExceeded | ValidationAddressViewed | ViewArtworkMyCollection | ViewedArtworkList | ViewedSharedArtworkList | ViewedVideo | ViewedToast | VisitMyCollection | VisitMyCollectionOnboardingSlide;
41
41
  /**
42
42
  * The top-level actions an Event describes.
43
43
  *
44
44
  * Each ActionType corresponds with a table in Redshift.
45
45
  */
46
46
  export declare enum ActionType {
47
+ /**
48
+ * Corresponds to {@link AcceptedOffer}
49
+ */
50
+ acceptedOffer = "acceptedOffer",
47
51
  /**
48
52
  * Corresponds to {@link AddedArtworkToArtworkList}
49
53
  */
@@ -220,6 +224,10 @@ export declare enum ActionType {
220
224
  * Corresponds to {@link ClickedContactGallery}
221
225
  */
222
226
  clickedContactGallery = "clickedContactGallery",
227
+ /**
228
+ * Corresponds to {@link ClickedCounterOfferOption}
229
+ */
230
+ clickedCounterOfferOption = "clickedCounterOfferOption",
223
231
  /**
224
232
  * Corresponds to {@link ClickedCreateAlert}
225
233
  */
@@ -616,6 +624,10 @@ export declare enum ActionType {
616
624
  * Corresponds to {@link DarkModeOptionUpdated}
617
625
  */
618
626
  darkModeOptionUpdated = "darkModeOptionUpdated",
627
+ /**
628
+ * Corresponds to {@link DeclinedOffer}
629
+ */
630
+ declinedOffer = "declinedOffer",
619
631
  /**
620
632
  * Corresponds to {@link DeleteCollectedArtwork}
621
633
  */
@@ -920,6 +932,10 @@ export declare enum ActionType {
920
932
  * Corresponds to {@link SubmitAnotherArtwork}
921
933
  */
922
934
  submitAnotherArtwork = "submitAnotherArtwork",
935
+ /**
936
+ * Corresponds to {@link SubmittedCounterOffer}
937
+ */
938
+ submittedCounterOffer = "submittedCounterOffer",
923
939
  /**
924
940
  * Corresponds to {@link SubmittedOffer}
925
941
  */
@@ -1309,6 +1325,10 @@ export declare enum ActionType {
1309
1325
  * Corresponds to {@link ToggledNotification}
1310
1326
  */
1311
1327
  toggledNotification = "toggledNotification",
1328
+ /**
1329
+ * Corresponds to {@link ToggledOfferHistory}
1330
+ */
1331
+ toggledOfferHistory = "toggledOfferHistory",
1312
1332
  /**
1313
1333
  * Corresponds to {@link ToggledPresentationModeSetting}
1314
1334
  */
@@ -20,6 +20,7 @@ var ActionType;
20
20
  exports.ActionType = ActionType;
21
21
 
22
22
  (function (ActionType) {
23
+ ActionType["acceptedOffer"] = "acceptedOffer";
23
24
  ActionType["addedArtworkToArtworkList"] = "addedArtworkToArtworkList";
24
25
  ActionType["addedToAlbum"] = "addedToAlbum";
25
26
  ActionType["addArtworkDetails"] = "addArtworkDetails";
@@ -64,6 +65,7 @@ exports.ActionType = ActionType;
64
65
  ActionType["clickedCollectionGroup"] = "clickedCollectionGroup";
65
66
  ActionType["clickedCompleteYourProfile"] = "clickedCompleteYourProfile";
66
67
  ActionType["clickedContactGallery"] = "clickedContactGallery";
68
+ ActionType["clickedCounterOfferOption"] = "clickedCounterOfferOption";
67
69
  ActionType["clickedCreateAlert"] = "clickedCreateAlert";
68
70
  ActionType["clickedDeliveryMethod"] = "clickedDeliveryMethod";
69
71
  ActionType["clickedEditArtwork"] = "clickedEditArtwork";
@@ -163,6 +165,7 @@ exports.ActionType = ActionType;
163
165
  ActionType["createAlertReminderMessageViewed"] = "createAlertReminderMessageViewed";
164
166
  ActionType["createdArtworkList"] = "createdArtworkList";
165
167
  ActionType["darkModeOptionUpdated"] = "darkModeOptionUpdated";
168
+ ActionType["declinedOffer"] = "declinedOffer";
166
169
  ActionType["deleteCollectedArtwork"] = "deleteCollectedArtwork";
167
170
  ActionType["deletedArtworkList"] = "deletedArtworkList";
168
171
  ActionType["deletedSavedSearch"] = "deletedSavedSearch";
@@ -239,6 +242,7 @@ exports.ActionType = ActionType;
239
242
  ActionType["shippingQuoteViewed"] = "shippingQuoteViewed";
240
243
  ActionType["startedOnboarding"] = "startedOnboarding";
241
244
  ActionType["submitAnotherArtwork"] = "submitAnotherArtwork";
245
+ ActionType["submittedCounterOffer"] = "submittedCounterOffer";
242
246
  ActionType["submittedOffer"] = "submittedOffer";
243
247
  ActionType["submittedOrder"] = "submittedOrder";
244
248
  ActionType["successfullyLoggedIn"] = "successfullyLoggedIn";
@@ -336,6 +340,7 @@ exports.ActionType = ActionType;
336
340
  ActionType["toggledAccordion"] = "toggledAccordion";
337
341
  ActionType["toggledCollapsibleOrderSummary"] = "toggledCollapsibleOrderSummary";
338
342
  ActionType["toggledNotification"] = "toggledNotification";
343
+ ActionType["toggledOfferHistory"] = "toggledOfferHistory";
339
344
  ActionType["toggledPresentationModeSetting"] = "toggledPresentationModeSetting";
340
345
  ActionType["toggledSavedSearch"] = "toggledSavedSearch";
341
346
  ActionType["tooltipViewed"] = "tooltipViewed";
@@ -60,6 +60,7 @@ export * from "./os/Events/InventoryTable";
60
60
  export * from "./os/Events/MailchimpEditor";
61
61
  export * from "./os/Events/MaterialsEditor";
62
62
  export * from "./os/Events/MultiAddFlow";
63
+ export * from "./os/Events/OnboardingFlow";
63
64
  export * from "./os/Events/Submit";
64
65
  export * from "./os/Events/Toggle";
65
66
  export * from "./os/Values/OsContextModule";
@@ -640,6 +640,18 @@ Object.keys(_MultiAddFlow).forEach(function (key) {
640
640
  });
641
641
  });
642
642
 
643
+ var _OnboardingFlow = require("./os/Events/OnboardingFlow");
644
+
645
+ Object.keys(_OnboardingFlow).forEach(function (key) {
646
+ if (key === "default" || key === "__esModule") return;
647
+ Object.defineProperty(exports, key, {
648
+ enumerable: true,
649
+ get: function get() {
650
+ return _OnboardingFlow[key];
651
+ }
652
+ });
653
+ });
654
+
643
655
  var _Submit = require("./os/Events/Submit");
644
656
 
645
657
  Object.keys(_Submit).forEach(function (key) {
@@ -0,0 +1,76 @@
1
+ /**
2
+ * Schemas describing Art OS Onboarding Flow events
3
+ * @packageDocumentation
4
+ */
5
+ import { OsContextModule } from "../Values/OsContextModule";
6
+ import { OsOwnerType } from "../Values/OsOwnerType";
7
+ import { OsActionType } from "./index";
8
+ /**
9
+ * A partner clicks the "Show me how" link on a Getting Started checklist step
10
+ * to open the guidance for that step.
11
+ *
12
+ * @example
13
+ * ```
14
+ * {
15
+ * action: "clickedShowMeHow",
16
+ * context_module: "onboardingFlow",
17
+ * context_page_owner_type: "inventory",
18
+ * step: "create an artwork"
19
+ * }
20
+ * ```
21
+ */
22
+ export interface ClickedShowMeHow {
23
+ action: OsActionType.clickedShowMeHow;
24
+ context_module: OsContextModule.onboardingFlow;
25
+ context_page_owner_type: OsOwnerType.collection | OsOwnerType.inventory;
26
+ step: string;
27
+ }
28
+ /**
29
+ * Fires when the partner completes the final remaining step of the Getting Started
30
+ * checklist — the "🎉 You're all set!" moment (10 of 10). If the checklist gains
31
+ * steps later, completion recomputes and this event may re-fire when the new full
32
+ * set is completed.
33
+ *
34
+ * @example
35
+ * ```
36
+ * {
37
+ * action: "completedOnboarding",
38
+ * context_module: "onboardingFlow",
39
+ * context_page_owner_type: "inventory",
40
+ * total_steps: 10
41
+ * }
42
+ * ```
43
+ */
44
+ export interface CompletedGettingStarted {
45
+ action: OsActionType.completedOnboarding;
46
+ context_module: OsContextModule.onboardingFlow;
47
+ context_page_owner_type: OsOwnerType.collection | OsOwnerType.inventory;
48
+ total_steps: number;
49
+ }
50
+ /**
51
+ * Fires each time a Getting Started checklist item is auto-ticked (step completed).
52
+ * Records which step finished and how far the partner has progressed.
53
+ * Onboarding is tracked per-user, not per-gallery.
54
+ *
55
+ * @example
56
+ * ```
57
+ * {
58
+ * action: "progressedOnboarding",
59
+ * completed_step_count: 3,
60
+ * context_module: "onboardingFlow",
61
+ * context_page_owner_type: "inventory",
62
+ * step: "create an artwork",
63
+ * total_steps: 10
64
+ * }
65
+ * ```
66
+ */
67
+ export interface ProgressedGettingStarted {
68
+ action: OsActionType.progressedOnboarding;
69
+ completed_step_count: number;
70
+ context_module: OsContextModule.onboardingFlow;
71
+ context_page_owner_type: OsOwnerType.collection | OsOwnerType.inventory;
72
+ /** Lower-case label matching UI copy (e.g. "create an artwork"). Typed as `string` because steps are backend-defined and expected to evolve. */
73
+ step: string;
74
+ total_steps: number;
75
+ }
76
+ export type OsOnboardingFlow = ClickedShowMeHow | CompletedGettingStarted | ProgressedGettingStarted;
@@ -0,0 +1 @@
1
+ "use strict";
@@ -7,6 +7,7 @@ import { OsInventoryTable } from "./InventoryTable";
7
7
  import { OsMailchimpEditor } from "./MailchimpEditor";
8
8
  import { OsMaterialsEditor } from "./MaterialsEditor";
9
9
  import { OsMultiAddFlow } from "./MultiAddFlow";
10
+ import { OsOnboardingFlow } from "./OnboardingFlow";
10
11
  import { OsSubmitEvent } from "./Submit";
11
12
  import { OsToggleEvent } from "./Toggle";
12
13
  /**
@@ -14,7 +15,7 @@ import { OsToggleEvent } from "./Toggle";
14
15
  *
15
16
  * Each event describes one ActionType
16
17
  */
17
- export type OsEvent = OsMultiAddFlow | ClickedBrandKitColor | ClickedBrandKitFont | ClickedAddBrandKitFile | ClickedSaveBrandKit | OsConnectedAppsFlow | OsClickEvent | OsFilterSortSearch | OsInstagramEditor | OsInventoryTable | OsMailchimpEditor | OsMaterialsEditor | OsSubmitEvent | OsToggleEvent;
18
+ export type OsEvent = ClickedAddBrandKitFile | ClickedBrandKitColor | ClickedBrandKitFont | ClickedSaveBrandKit | OsClickEvent | OsConnectedAppsFlow | OsFilterSortSearch | OsInstagramEditor | OsInventoryTable | OsMailchimpEditor | OsMaterialsEditor | OsMultiAddFlow | OsOnboardingFlow | OsSubmitEvent | OsToggleEvent;
18
19
  /**
19
20
  * List of all Art OS actions
20
21
  *
@@ -118,6 +119,10 @@ export declare enum OsActionType {
118
119
  * Corresponds to {@link OsInstagramEditor}
119
120
  */
120
121
  clickedPublishConfirmation = "clickedPublishConfirmation",
122
+ /**
123
+ * Corresponds to {@link ClickedShowMeHow}
124
+ */
125
+ clickedShowMeHow = "clickedShowMeHow",
121
126
  /**
122
127
  * Corresponds to {@link OsMailchimpEditor}
123
128
  */
@@ -134,6 +139,10 @@ export declare enum OsActionType {
134
139
  * Corresponds to {@link CompletedArtworkImport}
135
140
  */
136
141
  completedArtworkImport = "completedArtworkImport",
142
+ /**
143
+ * Corresponds to {@link CompletedGettingStarted}
144
+ */
145
+ completedOnboarding = "completedOnboarding",
137
146
  /**
138
147
  * Corresponds to {@link ConvertedArtworkToUnique}
139
148
  */
@@ -187,6 +196,10 @@ export declare enum OsActionType {
187
196
  * Corresponds to {@link MovedArtworksBetweenLists}
188
197
  */
189
198
  movedArtworksBetweenLists = "movedArtworksBetweenLists",
199
+ /**
200
+ * Corresponds to {@link ProgressedGettingStarted}
201
+ */
202
+ progressedOnboarding = "progressedOnboarding",
190
203
  /**
191
204
  * Corresponds to {@link OsInventoryTable}
192
205
  */
@@ -45,10 +45,12 @@ exports.OsActionType = OsActionType;
45
45
  OsActionType["clickedImagesModal"] = "clickedImagesModal";
46
46
  OsActionType["clickedOpenList"] = "clickedOpenList";
47
47
  OsActionType["clickedPublishConfirmation"] = "clickedPublishConfirmation";
48
+ OsActionType["clickedShowMeHow"] = "clickedShowMeHow";
48
49
  OsActionType["clickedSendConfirmation"] = "clickedSendConfirmation";
49
50
  OsActionType["clickedUploadImageBank"] = "clickedUploadImageBank";
50
51
  OsActionType["completedArtworkDistribution"] = "completedArtworkDistribution";
51
52
  OsActionType["completedArtworkImport"] = "completedArtworkImport";
53
+ OsActionType["completedOnboarding"] = "completedOnboarding";
52
54
  OsActionType["convertedArtworkToUnique"] = "convertedArtworkToUnique";
53
55
  OsActionType["createdEditionSet"] = "createdEditionSet";
54
56
  OsActionType["createdImportedArtworks"] = "createdImportedArtworks";
@@ -62,6 +64,7 @@ exports.OsActionType = OsActionType;
62
64
  OsActionType["editedArtworkField"] = "editedArtworkField";
63
65
  OsActionType["editedInventoryField"] = "editedInventoryField";
64
66
  OsActionType["movedArtworksBetweenLists"] = "movedArtworksBetweenLists";
67
+ OsActionType["progressedOnboarding"] = "progressedOnboarding";
65
68
  OsActionType["removedArtworkDocument"] = "removedArtworkDocument";
66
69
  OsActionType["removedFilter"] = "removedFilter";
67
70
  OsActionType["removedArtworksFromList"] = "removedArtworksFromList";
@@ -33,6 +33,7 @@ export declare enum OsContextModule {
33
33
  materialsEditor = "materialsEditor",
34
34
  multiAdd = "multiAdd",
35
35
  multiAddReview = "multiAddReview",
36
+ onboardingFlow = "onboardingFlow",
36
37
  publishConfirmationModal = "publishConfirmationModal",
37
38
  sendConfirmationModal = "sendConfirmationModal",
38
39
  tableActions = "tableActions"
@@ -43,6 +43,7 @@ exports.OsContextModule = OsContextModule;
43
43
  OsContextModule["materialsEditor"] = "materialsEditor";
44
44
  OsContextModule["multiAdd"] = "multiAdd";
45
45
  OsContextModule["multiAddReview"] = "multiAddReview";
46
+ OsContextModule["onboardingFlow"] = "onboardingFlow";
46
47
  OsContextModule["publishConfirmationModal"] = "publishConfirmationModal";
47
48
  OsContextModule["sendConfirmationModal"] = "sendConfirmationModal";
48
49
  OsContextModule["tableActions"] = "tableActions";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@artsy/cohesion",
3
- "version": "4.379.0",
3
+ "version": "4.381.0--canary.722.15553.0",
4
4
  "description": "Analytics schema",
5
5
  "main": "dist/index.js",
6
6
  "publishConfig": {