@artsy/cohesion 4.58.0 → 4.59.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.59.0 (Thu Jul 28 2022)
2
+
3
+ #### 🚀 Enhancement
4
+
5
+ - [GRO-1153] Updates onboarding data [#344](https://github.com/artsy/cohesion/pull/344) ([@abhitip](https://github.com/abhitip))
6
+
7
+ #### Authors: 1
8
+
9
+ - Abhiti Prabahar ([@abhitip](https://github.com/abhitip))
10
+
11
+ ---
12
+
1
13
  # v4.58.0 (Tue Jul 26 2022)
2
14
 
3
15
  #### 🚀 Enhancement
@@ -1,6 +1,5 @@
1
1
  import { AuthContextModule, ContextModule } from "../Values/ContextModule";
2
2
  import { AuthIntent } from "../Values/Intent";
3
- import { PageOwnerType } from "../Values/OwnerType";
4
3
  import { ActionType } from ".";
5
4
  /**
6
5
  * Schemas describing authentication events
@@ -163,14 +162,42 @@ export declare type AuthService = "apple" | "email" | "facebook" | "google";
163
162
  * {
164
163
  * action: "onboardingUserInputData",
165
164
  * context_module: "onboardingInterests",
166
- * context_owner_type: "onboarding",
167
- * data_input: "[learnAboutArt]"
165
+ * data_input: "[developingArtTastes]"
168
166
  * }
169
167
  * ```
170
168
  */
171
169
  export interface OnboardingUserInputData {
172
170
  action: ActionType.onboardingUserInputData;
173
171
  context_module: ContextModule;
174
- context_owner_type: PageOwnerType;
175
172
  data_input: string;
176
173
  }
174
+ /**
175
+ * A user starts the onboarding flow
176
+ *
177
+ * This schema describes events sent to Segment from [[startedOnboarding]]
178
+ *
179
+ * @example
180
+ * ```
181
+ * {
182
+ * action: "startedOnboarding",
183
+ * }
184
+ * ```
185
+ */
186
+ export interface StartedOnboarding {
187
+ action: ActionType.startedOnboarding;
188
+ }
189
+ /**
190
+ * A user completes the onboarding flow
191
+ *
192
+ * This schema describes events sent to Segment from [[completedOnboarding]]
193
+ *
194
+ * @example
195
+ * ```
196
+ * {
197
+ * action: "completedOnboarding",
198
+ * }
199
+ * ```
200
+ */
201
+ export interface CompletedOnboarding {
202
+ action: ActionType.completedOnboarding;
203
+ }
@@ -1,6 +1,6 @@
1
1
  import { AddToCalendar } from "./AddToCalendar";
2
2
  import { AuctionPageView, BidPageView, ClickedActiveBid, ClickedRegisterToBid, ConfirmBid, ConfirmRegistrationPageview, EnterLiveAuction, MaxBidSelected, RegistrationPageView, RegistrationSubmitted } from "./Auction";
3
- import { AuthImpression, CreatedAccount, OnboardingUserInputData, ResetYourPassword, SuccessfullyLoggedIn } from "./Authentication";
3
+ import { AuthImpression, CompletedOnboarding, CreatedAccount, OnboardingUserInputData, ResetYourPassword, StartedOnboarding, SuccessfullyLoggedIn } from "./Authentication";
4
4
  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, ClickedOfferActions, ClickedOfferOption, ClickedOnArtworkShippingUnitsDropdown, ClickedOnArtworkShippingWeight, ClickedOnFramedMeasurements, ClickedOnFramedMeasurementsDropdown, ClickedOnSubmitOrder, ClickedOrderPage, ClickedPartnerCard, ClickedPartnerLink, ClickedPaymentDetails, ClickedPaymentMethod, ClickedPromoSpace, ClickedSelectShippingOption, ClickedShippingAddress, ClickedShowGroup, ClickedShowMore, ClickedSnooze, ClickedVerifyIdentity, ClickedViewingRoomCard } from "./Click";
5
5
  import { ArtworkDetailsCompleted, ConsignmentSubmitted, SubmitAnotherArtwork, UploadPhotosCompleted, ViewArtworkMyCollection } from "./Consignments";
6
6
  import { FocusedOnConversationMessageInput, SentConversationMessage, TappedInboxConversation, TappedMakeOffer, TappedViewOffer } from "./Conversations";
@@ -22,7 +22,7 @@ import { ToggledAccordion } from "./UserExperienceInteractions";
22
22
  *
23
23
  * Each event describes one ActionType
24
24
  */
25
- 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;
25
+ 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 | CompletedOnboarding | 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 | StartedOnboarding | 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;
26
26
  /**
27
27
  * The top-level actions an Event describes.
28
28
  *
@@ -266,6 +266,10 @@ export declare enum ActionType {
266
266
  * Corresponds to {@link CommercialFilterParamsChanged}
267
267
  */
268
268
  commercialFilterParamsChanged = "commercialFilterParamsChanged",
269
+ /**
270
+ * Corresponds to {@link CompletedOnboarding}
271
+ */
272
+ completedOnboarding = "completedOnboarding",
269
273
  /**
270
274
  * Corresponds to {@link ConfirmBid}
271
275
  */
@@ -418,6 +422,10 @@ export declare enum ActionType {
418
422
  * Corresponds to {@link ExperimentViewed}
419
423
  */
420
424
  experimentViewed = "experimentViewed",
425
+ /**
426
+ * Corresponds to {@link SuccessfullyLoggedIn}
427
+ */
428
+ startedOnboarding = "startedOnboarding",
421
429
  /**
422
430
  * Corresponds to {@link SubmitAnotherArtwork}
423
431
  */
@@ -79,6 +79,7 @@ exports.ActionType = ActionType;
79
79
  ActionType["clickedOfferActions"] = "clickedOfferActions";
80
80
  ActionType["clickedOrderPage"] = "clickedOrderPage";
81
81
  ActionType["commercialFilterParamsChanged"] = "commercialFilterParamsChanged";
82
+ ActionType["completedOnboarding"] = "completedOnboarding";
82
83
  ActionType["confirmBid"] = "confirmBid";
83
84
  ActionType["confirmRegistrationPageview"] = "confirmRegistrationPageview";
84
85
  ActionType["consignmentArtistFailed"] = "consignmentArtistFailed";
@@ -117,6 +118,7 @@ exports.ActionType = ActionType;
117
118
  ActionType["sentRequestPriceEstimate"] = "sentRequestPriceEstimate";
118
119
  ActionType["share"] = "share";
119
120
  ActionType["experimentViewed"] = "experimentViewed";
121
+ ActionType["startedOnboarding"] = "startedOnboarding";
120
122
  ActionType["submitAnotherArtwork"] = "submitAnotherArtwork";
121
123
  ActionType["successfullyLoggedIn"] = "successfullyLoggedIn";
122
124
  ActionType["tappedArticleGroup"] = "tappedArticleGroup";
@@ -104,9 +104,8 @@ export declare enum ContextModule {
104
104
  newWorksByArtistsYouFollowRail = "newWorksByArtistsYouFollowRail",
105
105
  newWorksForYouRail = "newWorksForYouRail",
106
106
  newWorksByGalleriesYouFollowRail = "newWorksByGalleriesYouFollowRail",
107
- onboardingArtists = "onboardingArtists",
108
- onboardingBudget = "onboardingBudget",
109
- onboardingGenes = "onboardingGenes",
107
+ onboardingActivity = "onboardingActivity",
108
+ onboardingCollectorLevel = "onboardingCollectorLevel",
110
109
  onboardingInterests = "onboardingInterests",
111
110
  ordersAccept = "ordersAccept",
112
111
  ordersCounter = "ordersCounter",
@@ -174,4 +173,4 @@ export declare enum ContextModule {
174
173
  /**
175
174
  * Limited ContextModules available for web authentication events
176
175
  */
177
- export declare type AuthContextModule = ContextModule.aboutTheWork | ContextModule.artistHeader | ContextModule.artistRecentlySold | ContextModule.artistSeriesRail | ContextModule.artistSeriesTab | ContextModule.artistsTab | ContextModule.artistsToFollowRail | ContextModule.artworkGrid | ContextModule.artworkImage | ContextModule.artworkSidebar | ContextModule.artworksTab | ContextModule.associatedViewingRoom | ContextModule.auctionHome | ContextModule.auctionLots | ContextModule.auctionRail | ContextModule.auctionResult | ContextModule.auctionResults | ContextModule.auctionResultComparableWorks | ContextModule.auctionSidebar | ContextModule.auctionsInfo | ContextModule.auctionTab | ContextModule.bannerPopUp | ContextModule.boothsTab | ContextModule.browseFair | ContextModule.categoryRail | ContextModule.collectionDescription | ContextModule.consignSubmissionFlow | ContextModule.currentShowsRail | ContextModule.fairInfo | ContextModule.fairOrganizerHeader | ContextModule.fairRail | ContextModule.fairsHeader | ContextModule.fairTab | ContextModule.featuredArtists | ContextModule.featuredArtistsRail | ContextModule.featuredGalleriesRail | ContextModule.footer | ContextModule.galleryTab | ContextModule.geneHeader | ContextModule.header | ContextModule.inquiry | ContextModule.intextTooltip | ContextModule.liveAuctionRoom | ContextModule.liveAuctionsRail | ContextModule.mainCarousel | ContextModule.minimalCTABanner | ContextModule.myCollectionAddArtworkAddArtist | 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.recommendedArtistsRail | ContextModule.relatedArtistsRail | ContextModule.relatedWorksRail | ContextModule.saveWorksCTA | ContextModule.showHeader | ContextModule.showInfo | ContextModule.showTab | ContextModule.standoutLots | ContextModule.tagHeader | ContextModule.topWorksRail | ContextModule.topTab | ContextModule.trendingArtistsRail | ContextModule.trendingLots | ContextModule.viewingRoom | ContextModule.worksByArtistsYouFollowRail | ContextModule.worksByPopularArtistsRail | ContextModule.worksForSaleRail;
176
+ export declare type AuthContextModule = ContextModule.aboutTheWork | ContextModule.artistHeader | ContextModule.artistRecentlySold | ContextModule.artistSeriesRail | ContextModule.artistSeriesTab | ContextModule.artistsTab | ContextModule.artistsToFollowRail | ContextModule.artworkGrid | ContextModule.artworkImage | ContextModule.artworkSidebar | ContextModule.artworksTab | ContextModule.associatedViewingRoom | ContextModule.auctionHome | ContextModule.auctionLots | ContextModule.auctionRail | ContextModule.auctionResult | ContextModule.auctionResults | ContextModule.auctionResultComparableWorks | ContextModule.auctionSidebar | ContextModule.auctionsInfo | ContextModule.auctionTab | ContextModule.bannerPopUp | ContextModule.boothsTab | ContextModule.browseFair | ContextModule.categoryRail | ContextModule.collectionDescription | ContextModule.consignSubmissionFlow | ContextModule.currentShowsRail | ContextModule.fairInfo | ContextModule.fairOrganizerHeader | ContextModule.fairRail | ContextModule.fairsHeader | ContextModule.fairTab | ContextModule.featuredArtists | ContextModule.featuredArtistsRail | ContextModule.featuredGalleriesRail | ContextModule.footer | ContextModule.galleryTab | ContextModule.geneHeader | ContextModule.header | ContextModule.inquiry | ContextModule.intextTooltip | ContextModule.liveAuctionRoom | ContextModule.liveAuctionsRail | ContextModule.mainCarousel | ContextModule.minimalCTABanner | ContextModule.myCollectionAddArtworkAddArtist | ContextModule.onboardingActivity | ContextModule.onboardingCollectorLevel | 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.recommendedArtistsRail | ContextModule.relatedArtistsRail | ContextModule.relatedWorksRail | ContextModule.saveWorksCTA | ContextModule.showHeader | ContextModule.showInfo | ContextModule.showTab | ContextModule.standoutLots | ContextModule.tagHeader | ContextModule.topWorksRail | ContextModule.topTab | ContextModule.trendingArtistsRail | ContextModule.trendingLots | ContextModule.viewingRoom | ContextModule.worksByArtistsYouFollowRail | ContextModule.worksByPopularArtistsRail | ContextModule.worksForSaleRail;
@@ -118,9 +118,8 @@ exports.ContextModule = ContextModule;
118
118
  ContextModule["newWorksByArtistsYouFollowRail"] = "newWorksByArtistsYouFollowRail";
119
119
  ContextModule["newWorksForYouRail"] = "newWorksForYouRail";
120
120
  ContextModule["newWorksByGalleriesYouFollowRail"] = "newWorksByGalleriesYouFollowRail";
121
- ContextModule["onboardingArtists"] = "onboardingArtists";
122
- ContextModule["onboardingBudget"] = "onboardingBudget";
123
- ContextModule["onboardingGenes"] = "onboardingGenes";
121
+ ContextModule["onboardingActivity"] = "onboardingActivity";
122
+ ContextModule["onboardingCollectorLevel"] = "onboardingCollectorLevel";
124
123
  ContextModule["onboardingInterests"] = "onboardingInterests";
125
124
  ContextModule["ordersAccept"] = "ordersAccept";
126
125
  ContextModule["ordersCounter"] = "ordersCounter";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@artsy/cohesion",
3
- "version": "4.58.0",
3
+ "version": "4.59.0",
4
4
  "description": "Analytics schema",
5
5
  "main": "dist/index.js",
6
6
  "publishConfig": {