@artsy/cohesion 4.57.0 → 4.60.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.
Files changed (28) hide show
  1. package/CHANGELOG.md +36 -0
  2. package/dist/DeprecatedSchema/DeprecatedAuctionInfo.d.ts +33 -0
  3. package/dist/DeprecatedSchema/DeprecatedAuctionInfo.js +1 -0
  4. package/dist/DeprecatedSchema/DeprecatedContextModule.d.ts +9 -0
  5. package/dist/DeprecatedSchema/DeprecatedContextModule.js +1 -0
  6. package/dist/DeprecatedSchema/DeprecatedContextPage.d.ts +20 -0
  7. package/dist/DeprecatedSchema/DeprecatedContextPage.js +1 -0
  8. package/dist/DeprecatedSchema/DeprecatedFlow.d.ts +7 -0
  9. package/dist/DeprecatedSchema/DeprecatedFlow.js +1 -0
  10. package/dist/DeprecatedSchema/DeprecatedInteraction.d.ts +38 -0
  11. package/dist/DeprecatedSchema/DeprecatedInteraction.js +1 -0
  12. package/dist/DeprecatedSchema/DeprecatedLabel.d.ts +11 -0
  13. package/dist/DeprecatedSchema/DeprecatedLabel.js +1 -0
  14. package/dist/DeprecatedSchema/DeprecatedResult.d.ts +46 -0
  15. package/dist/DeprecatedSchema/DeprecatedResult.js +1 -0
  16. package/dist/DeprecatedSchema/DeprecatedType.d.ts +7 -0
  17. package/dist/DeprecatedSchema/DeprecatedType.js +1 -0
  18. package/dist/DeprecatedSchema/DeprecatedValues.d.ts +409 -0
  19. package/dist/DeprecatedSchema/DeprecatedValues.js +311 -0
  20. package/dist/DeprecatedSchema/index.d.ts +46 -0
  21. package/dist/DeprecatedSchema/index.js +17 -0
  22. package/dist/Schema/Events/Authentication.d.ts +31 -4
  23. package/dist/Schema/Events/Click.d.ts +33 -0
  24. package/dist/Schema/Events/index.d.ts +17 -5
  25. package/dist/Schema/Events/index.js +3 -0
  26. package/dist/Schema/Values/ContextModule.d.ts +3 -4
  27. package/dist/Schema/Values/ContextModule.js +2 -3
  28. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,3 +1,39 @@
1
+ # v4.60.0 (Tue Aug 09 2022)
2
+
3
+ #### 🚀 Enhancement
4
+
5
+ - [AS-3324] Adding event for balance account check [#345](https://github.com/artsy/cohesion/pull/345) ([@daytavares](https://github.com/daytavares))
6
+
7
+ #### Authors: 1
8
+
9
+ - Dayane Tavares ([@daytavares](https://github.com/daytavares))
10
+
11
+ ---
12
+
13
+ # v4.59.0 (Thu Jul 28 2022)
14
+
15
+ #### 🚀 Enhancement
16
+
17
+ - [GRO-1153] Updates onboarding data [#344](https://github.com/artsy/cohesion/pull/344) ([@abhitip](https://github.com/abhitip))
18
+
19
+ #### Authors: 1
20
+
21
+ - Abhiti Prabahar ([@abhitip](https://github.com/abhitip))
22
+
23
+ ---
24
+
25
+ # v4.58.0 (Tue Jul 26 2022)
26
+
27
+ #### 🚀 Enhancement
28
+
29
+ - chore(deprecated-schema): Move deprecated schema from force [#343](https://github.com/artsy/cohesion/pull/343) ([@damassi](https://github.com/damassi))
30
+
31
+ #### Authors: 1
32
+
33
+ - Christopher Pappas ([@damassi](https://github.com/damassi))
34
+
35
+ ---
36
+
1
37
  # v4.57.0 (Thu Jul 07 2022)
2
38
 
3
39
  #### 🚀 Enhancement
@@ -0,0 +1,33 @@
1
+ export interface AuctionInfo {
2
+ /**
3
+ * database id of a Bidder record (instance of user registered for an auction)
4
+ */
5
+ bidder_id: string;
6
+ /**
7
+ * database id of a Bidder Position record
8
+ *
9
+ * Bidder position is the term used in Gravity to track the intent of a Bidder
10
+ * to bid on a lot. Typically this is a "max bid" (they could win at a lower value),
11
+ * but occasionally it is a fixed bid amount.
12
+ */
13
+ bidder_position_id: string;
14
+ /**
15
+ * List of reasons why there's a failure event
16
+ *
17
+ * Used by the auction registration flow.
18
+ */
19
+ error_messages: string[];
20
+ /**
21
+ * The amount of max bid the user selected in cents. For example, if the user
22
+ * selected $5,000.00, it will be reported as 500000.
23
+ *
24
+ * Used by the auction confirm bid flow.
25
+ */
26
+ selected_max_bid_minor: string;
27
+ /**
28
+ * Internal ID of the SaleArtwork.
29
+ *
30
+ * Used by the request condition report flow.
31
+ */
32
+ sale_artwork_id: string;
33
+ }
@@ -0,0 +1 @@
1
+ "use strict";
@@ -0,0 +1,9 @@
1
+ import { ContextModule as _ContextModule } from "./DeprecatedValues";
2
+ export interface ContextModule {
3
+ /**
4
+ * A conceptual module on the page. While this may be a React component name,
5
+ * it does not need to be, as long as given the name it should be clear what
6
+ * part of the page is being referred to.
7
+ */
8
+ context_module: _ContextModule;
9
+ }
@@ -0,0 +1 @@
1
+ "use strict";
@@ -0,0 +1,20 @@
1
+ import { OwnerType, PageName } from "./DeprecatedValues";
2
+ /**
3
+ * The current page.
4
+ */
5
+ export interface ContextPage {
6
+ context_page: PageName;
7
+ /**
8
+ * The type of the entity that this page represents.
9
+ */
10
+ context_page_owner_type?: OwnerType;
11
+ /**
12
+ * The database ID of the owner. E.g. in the case of an entity that comes out
13
+ * of Gravity this should be its Mongo ID.
14
+ */
15
+ context_page_owner_id?: string;
16
+ /**
17
+ * The slug of the entity, if it has one.
18
+ */
19
+ context_page_owner_slug?: string;
20
+ }
@@ -0,0 +1 @@
1
+ "use strict";
@@ -0,0 +1,7 @@
1
+ import { Flow as _Flow } from "./DeprecatedValues";
2
+ export interface Flow {
3
+ /**
4
+ * TODO: Descriptor
5
+ */
6
+ flow: _Flow;
7
+ }
@@ -0,0 +1 @@
1
+ "use strict";
@@ -0,0 +1,38 @@
1
+ import { ActionName, ActionType } from "./DeprecatedValues";
2
+ /**
3
+ * An interaction event is one that is triggered by a user in _some_ way. This
4
+ * could be either an active action, such as a click, or a passive action, such
5
+ * as hovering over a UI element.
6
+ *
7
+ * Some actions lead to results, such as following an artist, in which case the
8
+ * action name is used to tie the interaction and result events together.
9
+ */
10
+ export interface Interaction {
11
+ /**
12
+ * The type of interaction that this event represents. E.g. `Click`.
13
+ *
14
+ * NOTE: In the old Force schema, this was the event’s name.
15
+ */
16
+ action_type: ActionType;
17
+ /**
18
+ * In case the interaction will lead to a result, this should be the action
19
+ * name that will be used to associate the interaction to the result.
20
+ */
21
+ action_name?: ActionName;
22
+ /**
23
+ * A description of the UI element that describes it inside the page/module.
24
+ * This is e.g. the label of the UI element.
25
+ */
26
+ subject?: string;
27
+ /**
28
+ * In case of a link, the location that it points to.
29
+ *
30
+ * NOTE: This is old Force schema.
31
+ */
32
+ destination_path?: string;
33
+ flow?: string;
34
+ }
35
+ export interface AuthenticationInteraction extends Interaction {
36
+ intent?: string;
37
+ trigger?: string;
38
+ }
@@ -0,0 +1 @@
1
+ "use strict";
@@ -0,0 +1,11 @@
1
+ import { Label as _Label } from "./DeprecatedValues";
2
+ export interface Label {
3
+ /**
4
+ * The label of element being iteracted with
5
+ */
6
+ label: _Label;
7
+ /**
8
+ * The notification count as seen in the NavBar
9
+ */
10
+ new_notification_count: string | number;
11
+ }
@@ -0,0 +1 @@
1
+ "use strict";
@@ -0,0 +1,46 @@
1
+ import { ActionName, OwnerType } from "./DeprecatedValues";
2
+ /**
3
+ * The base interface for either a successful or failure event.
4
+ */
5
+ interface Result {
6
+ /**
7
+ * The action name that will be used to tie this back to an interaction.
8
+ */
9
+ action_name: ActionName;
10
+ /**
11
+ * The type of the entity that owns this result.
12
+ */
13
+ owner_type: OwnerType;
14
+ /**
15
+ * The database ID of the entity. E.g. in the case of an entity that comes out
16
+ * of Gravity this should be its Mongo ID.
17
+ */
18
+ owner_id: string;
19
+ /**
20
+ * The slug of the entity, if it has one.
21
+ */
22
+ owner_slug?: string;
23
+ }
24
+ /**
25
+ * A successful result.
26
+ */
27
+ export interface Success extends Result {
28
+ /**
29
+ * Used to identify the event as a success one.
30
+ */
31
+ result: "Success";
32
+ }
33
+ /**
34
+ * A failure result.
35
+ */
36
+ export interface Failure extends Result {
37
+ /**
38
+ * Used to identify the event as a failure one.
39
+ */
40
+ result: "Failure";
41
+ /**
42
+ * The reason for the failure.
43
+ */
44
+ error: string;
45
+ }
46
+ export {};
@@ -0,0 +1 @@
1
+ "use strict";
@@ -0,0 +1,7 @@
1
+ import { Type as _Type } from "./DeprecatedValues";
2
+ export interface Type {
3
+ /**
4
+ * Identifier of the type of element being clicked
5
+ */
6
+ type: _Type;
7
+ }
@@ -0,0 +1 @@
1
+ "use strict";
@@ -0,0 +1,409 @@
1
+ /**
2
+ * Pages that the user can view.
3
+ */
4
+ export declare enum PageName {
5
+ ArticlePage = "Article",
6
+ ArtistPage = "Artist",
7
+ ArtistAuctionResults = "Artist Auction Results",
8
+ ArtworkPage = "Artwork page",
9
+ AuctionRegistrationPage = "Auction Registration page",
10
+ AuctionConfirmBidPage = "Auction Confirm Bid page",
11
+ CollectPage = "Collect page",
12
+ CollectionPage = "Collection",
13
+ SearchPage = "Search page",
14
+ HomePage = "Home",
15
+ IdentityVerificationPage = "Identity Verification page"
16
+ }
17
+ /**
18
+ * An entity in the data model that has an ownership relationship to the entity
19
+ * being described, be it a straightforward model such as ‘Artist’ or a more
20
+ * conceptual one like a ‘Consignment Submission’
21
+ *
22
+ * @see {Result.owner}
23
+ * @see {PageView.owner}
24
+ */
25
+ export declare enum OwnerType {
26
+ Article = "Article",
27
+ Artist = "Artist",
28
+ Artwork = "Artwork",
29
+ Collection = "Collection",
30
+ Consignment = "ConsignmentSubmission",
31
+ Conversation = "Conversation",
32
+ Gene = "Gene",
33
+ Invoice = "Invoice",
34
+ Partner = "Partner",
35
+ Show = "Show"
36
+ }
37
+ /**
38
+ * User actions, which can be active or passive ones.
39
+ *
40
+ * TODO: Distinguishing between Click and Tap is a little confusing. Do we always
41
+ * use Click on Force or do we use Tap when browsing from a mobile device?
42
+ */
43
+ export declare enum ActionType {
44
+ /**
45
+ * A click on a UI element using a mouse-like input device.
46
+ *
47
+ * TODO: Check if ‘Tap’ and this can be combined.
48
+ */
49
+ Click = "Click",
50
+ ClickedBid = "Clicked \"Bid\"",
51
+ /**
52
+ * A click on 'Buy Now' or 'Make offer' buttons.
53
+ */
54
+ ClickedBuyNow = "Clicked buy now",
55
+ ClickedConsign = "Clicked consign",
56
+ ClickedContactGallery = "Clicked \"Contact Gallery\"",
57
+ ClickedMakeOffer = "Clicked make offer",
58
+ /**
59
+ * Triggers a pageview in force, skips segment
60
+ */
61
+ ClickedReadMore = "Clicked read more",
62
+ AuctionResultFilterParamChanged = "Auction results filter params changed",
63
+ AuctionResultItemClicked = "Auction result item clicked",
64
+ /**
65
+ * A/B Test Experiments
66
+ */
67
+ ExperimentViewed = "Experiment Viewed",
68
+ /**
69
+ * Moving the mouse pointer over a UI element or, when browsing on a mobile
70
+ * device, by first tapping the UI element once making it switch into
71
+ * continuous hover mode.
72
+ */
73
+ Hover = "Hover",
74
+ /**
75
+ * A UI element was rendered in the viewport
76
+ */
77
+ Impression = "Impression",
78
+ AuthImpression = "Auth impression",
79
+ /**
80
+ * A UI element that links out to another location
81
+ */
82
+ Link = "Link",
83
+ /**
84
+ * Auctions
85
+ */
86
+ ClickedRequestConditionReport = "Clicked request condition report",
87
+ ConfirmBidSubmitted = "Confirmed bid on bid page",
88
+ ConfirmBidFailed = "Confirm bid failed",
89
+ PlacedMaxBid = "Placed Max Bid",
90
+ RegisteredToBid = "Registered To Bid",
91
+ SelectedMaxBid = "Selected max bid",
92
+ ViewedLot = "Lot Viewed",
93
+ /**
94
+ * A tap on a UI element using a finger-like input device.
95
+ *
96
+ * TODO: Check if ‘Click’ and this can be combined.
97
+ */
98
+ Tap = "Tap",
99
+ /**
100
+ * BNMO
101
+ */
102
+ SubmittedOrder = "submitted_order",
103
+ SubmittedOffer = "submitted_offer",
104
+ SubmittedCounterOffer = "submitted_counter_offer",
105
+ FocusedOnOfferInput = "Focused on offer input",
106
+ /**
107
+ * Paid Marketing - Retargeting
108
+ */
109
+ ViewedProduct = "Product Viewed",
110
+ ViewedOfferTooLow = "Viewed offer too low",
111
+ ViewedOfferHigherThanListPrice = "Viewed offer higher than listed price",
112
+ FocusedOnAutosuggestInput = "Focused on search input",
113
+ SelectedItemFromSearch = "Selected item from search",
114
+ SelectedItemFromSearchPage = "Selected item from search page",
115
+ SearchedAutosuggestWithResults = "Searched from header with results",
116
+ SearchedAutosuggestWithoutResults = "Searched from header with no results",
117
+ /**
118
+ * Auction Registration flow
119
+ */
120
+ RegistrationSubmitFailed = "Registration failed to submit",
121
+ RegistrationSubmitted = "Registration submitted",
122
+ /**
123
+ * Identity Verification
124
+ */
125
+ ClickedContinueToIdVerification = "ClickedContinueToIdVerification",
126
+ /**
127
+ * Viewing Room
128
+ */
129
+ ClickedArtworkGroup = "clickedArtworkGroup",
130
+ ClickedBuyViewingGroup = "clickedBuyViewingRoom",
131
+ /**
132
+ * Artwork Submission
133
+ */
134
+ SubmitAnotherArtwork = "submitAnotherArtwork",
135
+ ClickedFAQ = "clickedFAQ"
136
+ }
137
+ /**
138
+ * The identifier that ties an interaction to a result.
139
+ */
140
+ export declare enum ActionName {
141
+ /**
142
+ * Artist Page
143
+ */
144
+ ArtistFollow = "artistFollow",
145
+ ArtistUnfollow = "artistUnfollow",
146
+ ArtworkAboutTheWork = "Artwork about the work",
147
+ /**
148
+ * Authentication
149
+ */
150
+ ViewEditorial = "viewed editorial",
151
+ Dismiss = "dismiss",
152
+ EmailNextButton = "emailNextButton",
153
+ PasswordNextButton = "passwordNextButton",
154
+ /**
155
+ * Gene Page
156
+ */
157
+ GeneFollow = "geneFollow",
158
+ GeneUnfollow = "geneUnfollow",
159
+ /**
160
+ * Home page events
161
+ */
162
+ HomeArtistRailFollow = "homeArtistRailFollow",
163
+ HomeArtistArtworksBlockFollow = "homeArtistArtworksBlockFollow",
164
+ /**
165
+ * Conversations / Inbox / Messaging
166
+ */
167
+ ConversationSendReply = "conversationSendReply",
168
+ ConversationLink = "conversationLinkUsed",
169
+ InquiryCancel = "inquiryCancel",
170
+ InquirySend = "inquirySend",
171
+ /**
172
+ * Saves And Follows Events
173
+ */
174
+ SavesAndFollowsWorks = "savesAndFollowsWorks",
175
+ SavesAndFollowsArtists = "savesAndFollowsArtists",
176
+ SavesAndFollowsCategories = "savesAndFollowsCategories",
177
+ /**
178
+ * Consignment flow
179
+ */
180
+ ConsignmentDraftCreated = "consignmentDraftCreated",
181
+ ConsignmentSubmitted = "consignmentSubmitted",
182
+ ConsignmentInterest = "Interested in selling a work learn more",
183
+ /**
184
+ * Bid flow
185
+ */
186
+ BidFlowAddBillingAddress = "addBillingAddress",
187
+ BidFlowPlaceBid = "placeBid",
188
+ BidFlowSaveBillingAddress = "saveBillingAddress",
189
+ /**
190
+ * Generic
191
+ */
192
+ ReadMoreExpanded = "readMoreExpanded",
193
+ InSale = "In current auction",
194
+ InShow = "In featured show"
195
+ }
196
+ /**
197
+ * Identifier of content that was interacted with
198
+ */
199
+ export declare enum Subject {
200
+ /**
201
+ * Generic events
202
+ */
203
+ ClickedNextButton = "clicked next button",
204
+ FurtherReading = "Further reading",
205
+ ReadMore = "Read more",
206
+ RelatedArticles = "Related articles",
207
+ /**
208
+ * Buy now checkout flow
209
+ */
210
+ BNMOAskSpecialist = "ask a specialist",
211
+ BNMOReadFAQ = "Visit our help center",
212
+ BNMOProvideShipping = "provide shipping address",
213
+ BNMOArrangePickup = "arrange for pickup",
214
+ BNMOUseShippingAddress = "use shipping address",
215
+ BNMOAddBankAccount = "addBankAccount",
216
+ BNMOHelpEmail = "orders@artsy.net",
217
+ BNMOBankTransferNotifcationCheckbox = "notifyCheckboxChecked",
218
+ BNMOBankTransferModalDismissed = "modalDismissed",
219
+ AuctionConditionsOfSale = "conditions of sale",
220
+ AuctionFAQ = "auction faq",
221
+ AuctionAskSpecialist = "ask a specialist",
222
+ AuctionBuyerPremium = "Buyer premium",
223
+ CollectorFAQ = "Visit our help center",
224
+ ConsignLearnMore = "learn more",
225
+ /**
226
+ * Artist Page
227
+ */
228
+ GetStarted = "Get Started",
229
+ /**
230
+ * Artwork Page
231
+ */
232
+ Classification = "Classification info",
233
+ ContactGallery = "Contact Gallery",
234
+ EnterLiveAuction = "Enter live auction",
235
+ ShowArtistInsights = "Show artist insights",
236
+ HistogramBar = "Histogram Bar",
237
+ BrowseWorks = "Browse works in this category",
238
+ QuestionMarkIcon = "Question Mark Informational Icon",
239
+ RequestConditionReport = "Request condition report",
240
+ /**
241
+ * Header
242
+ */
243
+ NotificationBell = "Notification Bell",
244
+ Notification = "Notification",
245
+ ViewAll = "View All",
246
+ Login = "Log In",
247
+ Signup = "Sign Up",
248
+ SmallScreenMenuSandwichIcon = "Small Screen Menu Sandwich Icon",
249
+ EmailConfirmationCTA = "Email Confirmation CTA",
250
+ EmailConfirmationLinkExpired = "Email Confirmation Link Expired",
251
+ /**
252
+ * CollectionHub
253
+ */
254
+ FeaturedCategories = "Featured Categories",
255
+ /**
256
+ * Consignments
257
+ */
258
+ ExploreAuctionResults = "Explore Auction Results",
259
+ Here = "here",
260
+ RequestPriceEstimate = "Request a price estimate",
261
+ SubmitForReview = "Submit for review",
262
+ SubmitWorksInterestedInSelling = "submit works you\u2019re interested in selling here",
263
+ /**
264
+ * Viewing Room
265
+ */
266
+ Rail = "Rail",
267
+ ViewWorks = "View works",
268
+ ArtworkThumbnail = "ArtworkThumbnail",
269
+ ViewingRoomArtworkDetail = "ViewingRoomArtworkDetail"
270
+ }
271
+ /**
272
+ * Identifier of a conceptual module on the page.
273
+ */
274
+ export declare enum ContextModule {
275
+ Header = "Header",
276
+ NavigationTabs = "NavigationTabs",
277
+ FlashBanner = "FlashBanner",
278
+ RecentlyViewedArtworks = "recently_viewed_artworks",
279
+ HeaderMoreDropdown = "HeaderMoreDropdown",
280
+ HeaderUserDropdown = "HeaderUserDropdown",
281
+ HeaderActivityDropdown = "HeaderActivityDropdown",
282
+ HeaderArtworksDropdown = "HeaderArtworksDropdown",
283
+ HeaderArtistsDropdown = "HeaderArtistsDropdown",
284
+ /**
285
+ * Artist page
286
+ */
287
+ ArtistConsignment = "ArtistConsignment",
288
+ ArtistPage = "Artist page",
289
+ AboutTheWork = "About the work",
290
+ AboutTheWorkPartner = "About the Work (Partner)",
291
+ ArtworkFilter = "ArtworkFilter",
292
+ ArtistOverview = "ArtistOverview",
293
+ ArtistBio = "ArtistBio",
294
+ ArtistInsights = "ArtistInsights",
295
+ Biography = "Biography",
296
+ Sidebar = "Sidebar",
297
+ WorksForSale = "Works For Sale",
298
+ /**
299
+ * Artwork page
300
+ */
301
+ AboutTheWorkCondition = "About the work condition",
302
+ ArtworkPage = "Artwork page",
303
+ ArtworkTabs = "Artwork tabs",
304
+ OtherWorksByArtist = "Other works by artist",
305
+ OtherWorksInAuction = "Other works in auction",
306
+ OtherWorksInFair = "Other works in fair",
307
+ OtherWorksFromGallery = "Other works from gallery",
308
+ OtherWorksFromShow = "Other works from show",
309
+ RecommendedArtists = "Recommended Artists",
310
+ RelatedArtists = "RelatedArtists",
311
+ RelatedWorks = "RelatedWorks",
312
+ ShareButton = "Share button",
313
+ Zoom = "Zoom",
314
+ ViewInRoom = "View in room",
315
+ PriceContext = "Price Context",
316
+ FurtherReading = "Further reading",
317
+ ReadMore = "Read more",
318
+ RelatedArticles = "Related articles",
319
+ /**
320
+ * Buy Now Make Offer ("Works For You")
321
+ */
322
+ BNMOBanner = "BNMO Banner",
323
+ /**
324
+ * Collection page
325
+ */
326
+ CollectionDescription = "CollectionDescription",
327
+ ArtworkBanner = "ArtworkBanner",
328
+ /**
329
+ * Collections Rails
330
+ */
331
+ CollectionsRail = "CollectionsRail",
332
+ /**
333
+ * CollectionHub Entry Point in home page
334
+ */
335
+ CollectionHubEntryPoint = "HubEntrypoint",
336
+ /**
337
+ * Consignments
338
+ */
339
+ FAQ = "FAQ",
340
+ HowToSellYourCollection = "How to sell your collection with Artsy",
341
+ SellArtFromYourCollection = "Sell Art From Your Collection",
342
+ SellWorksBy = "Sell Works by",
343
+ /**
344
+ * Other Collections Rail
345
+ */
346
+ OtherCollectionsRail = "OtherCollectionsRail",
347
+ /**
348
+ * Featured Collections Rail
349
+ */
350
+ FeaturedCollectionsRail = "FeaturedCollectionsRail",
351
+ /**
352
+ * Artist Series rail in the collection hub
353
+ */
354
+ ArtistCollectionsRail = "ArtistCollectionsRail",
355
+ /**
356
+ * Ad Server
357
+ */
358
+ AdServer = "AdServer",
359
+ /**
360
+ * Art Keeps Going Campaign
361
+ */
362
+ FeaturedThisWeek = "FeaturedThisWeek",
363
+ Editorial = "Editorial",
364
+ SelectedWorks = "SelectedWorks",
365
+ FeaturedArtists = "FeaturedArtists",
366
+ BrowseCollections = "BrowseCollections",
367
+ BrowseAuctions = "BrowseAuctions",
368
+ BrowseFairs = "BrowseFairs",
369
+ /**
370
+ * Viewing Room
371
+ */
372
+ ViewingRoomArtworkRail = "viewingRoomArtworkRail",
373
+ /**
374
+ * Artwork Submission
375
+ */
376
+ ConsignSubmissionFlow = "consignSubmissionFlow"
377
+ }
378
+ export declare enum Flow {
379
+ ArtworkAboutTheWork = "Artwork about the work",
380
+ ArtworkAboutTheArtist = "Artwork about the artist",
381
+ ArtworkShare = "Artwork share",
382
+ ArtworkZoom = "Artwork zoom",
383
+ ArtworkViewInRoom = "Artwork view in room",
384
+ ArtworkPriceContext = "Artwork Price Context",
385
+ Auctions = "Auctions",
386
+ BuyNow = "Buy now",
387
+ Consignments = "Consignments",
388
+ MakeOffer = "Make offer",
389
+ Header = "Header"
390
+ }
391
+ export declare enum Label {
392
+ AboutTheWork = "about_the_work",
393
+ Articles = "articles",
394
+ Biography = "biography",
395
+ ExhibitionHighlights = "exhibition_highlights",
396
+ ReadMore = "ReadMore"
397
+ }
398
+ export declare enum Type {
399
+ ArtistCard = "Artist card",
400
+ ArtworkBrick = "Artwork brick",
401
+ Button = "Button",
402
+ Link = "Link",
403
+ Tab = "Tab",
404
+ Thumbnail = "thumbnail",
405
+ Chart = "Chart",
406
+ RadioButton = "radio button",
407
+ EmailLink = "email link",
408
+ ModalDismissal = "modal dismissal"
409
+ }
@@ -0,0 +1,311 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.Type = exports.Label = exports.Flow = exports.ContextModule = exports.Subject = exports.ActionName = exports.ActionType = exports.OwnerType = exports.PageName = void 0;
7
+
8
+ /**
9
+ * Pages that the user can view.
10
+ */
11
+ var PageName;
12
+ /**
13
+ * An entity in the data model that has an ownership relationship to the entity
14
+ * being described, be it a straightforward model such as ‘Artist’ or a more
15
+ * conceptual one like a ‘Consignment Submission’
16
+ *
17
+ * @see {Result.owner}
18
+ * @see {PageView.owner}
19
+ */
20
+
21
+ exports.PageName = PageName;
22
+
23
+ (function (PageName) {
24
+ PageName["ArticlePage"] = "Article";
25
+ PageName["ArtistPage"] = "Artist";
26
+ PageName["ArtistAuctionResults"] = "Artist Auction Results";
27
+ PageName["ArtworkPage"] = "Artwork page";
28
+ PageName["AuctionRegistrationPage"] = "Auction Registration page";
29
+ PageName["AuctionConfirmBidPage"] = "Auction Confirm Bid page";
30
+ PageName["CollectPage"] = "Collect page";
31
+ PageName["CollectionPage"] = "Collection";
32
+ PageName["SearchPage"] = "Search page";
33
+ PageName["HomePage"] = "Home";
34
+ PageName["IdentityVerificationPage"] = "Identity Verification page";
35
+ })(PageName || (exports.PageName = PageName = {}));
36
+
37
+ var OwnerType;
38
+ /**
39
+ * User actions, which can be active or passive ones.
40
+ *
41
+ * TODO: Distinguishing between Click and Tap is a little confusing. Do we always
42
+ * use Click on Force or do we use Tap when browsing from a mobile device?
43
+ */
44
+
45
+ exports.OwnerType = OwnerType;
46
+
47
+ (function (OwnerType) {
48
+ OwnerType["Article"] = "Article";
49
+ OwnerType["Artist"] = "Artist";
50
+ OwnerType["Artwork"] = "Artwork";
51
+ OwnerType["Collection"] = "Collection";
52
+ OwnerType["Consignment"] = "ConsignmentSubmission";
53
+ OwnerType["Conversation"] = "Conversation";
54
+ OwnerType["Gene"] = "Gene";
55
+ OwnerType["Invoice"] = "Invoice";
56
+ OwnerType["Partner"] = "Partner";
57
+ OwnerType["Show"] = "Show";
58
+ })(OwnerType || (exports.OwnerType = OwnerType = {}));
59
+
60
+ var ActionType;
61
+ /**
62
+ * The identifier that ties an interaction to a result.
63
+ */
64
+
65
+ exports.ActionType = ActionType;
66
+
67
+ (function (ActionType) {
68
+ ActionType["Click"] = "Click";
69
+ ActionType["ClickedBid"] = "Clicked \"Bid\"";
70
+ ActionType["ClickedBuyNow"] = "Clicked buy now";
71
+ ActionType["ClickedConsign"] = "Clicked consign";
72
+ ActionType["ClickedContactGallery"] = "Clicked \"Contact Gallery\"";
73
+ ActionType["ClickedMakeOffer"] = "Clicked make offer";
74
+ ActionType["ClickedReadMore"] = "Clicked read more";
75
+ ActionType["AuctionResultFilterParamChanged"] = "Auction results filter params changed";
76
+ ActionType["AuctionResultItemClicked"] = "Auction result item clicked";
77
+ ActionType["ExperimentViewed"] = "Experiment Viewed";
78
+ ActionType["Hover"] = "Hover";
79
+ ActionType["Impression"] = "Impression";
80
+ ActionType["AuthImpression"] = "Auth impression";
81
+ ActionType["Link"] = "Link";
82
+ ActionType["ClickedRequestConditionReport"] = "Clicked request condition report";
83
+ ActionType["ConfirmBidSubmitted"] = "Confirmed bid on bid page";
84
+ ActionType["ConfirmBidFailed"] = "Confirm bid failed";
85
+ ActionType["PlacedMaxBid"] = "Placed Max Bid";
86
+ ActionType["RegisteredToBid"] = "Registered To Bid";
87
+ ActionType["SelectedMaxBid"] = "Selected max bid";
88
+ ActionType["ViewedLot"] = "Lot Viewed";
89
+ ActionType["Tap"] = "Tap";
90
+ ActionType["SubmittedOrder"] = "submitted_order";
91
+ ActionType["SubmittedOffer"] = "submitted_offer";
92
+ ActionType["SubmittedCounterOffer"] = "submitted_counter_offer";
93
+ ActionType["FocusedOnOfferInput"] = "Focused on offer input";
94
+ ActionType["ViewedProduct"] = "Product Viewed";
95
+ ActionType["ViewedOfferTooLow"] = "Viewed offer too low";
96
+ ActionType["ViewedOfferHigherThanListPrice"] = "Viewed offer higher than listed price";
97
+ ActionType["FocusedOnAutosuggestInput"] = "Focused on search input";
98
+ ActionType["SelectedItemFromSearch"] = "Selected item from search";
99
+ ActionType["SelectedItemFromSearchPage"] = "Selected item from search page";
100
+ ActionType["SearchedAutosuggestWithResults"] = "Searched from header with results";
101
+ ActionType["SearchedAutosuggestWithoutResults"] = "Searched from header with no results";
102
+ ActionType["RegistrationSubmitFailed"] = "Registration failed to submit";
103
+ ActionType["RegistrationSubmitted"] = "Registration submitted";
104
+ ActionType["ClickedContinueToIdVerification"] = "ClickedContinueToIdVerification";
105
+ ActionType["ClickedArtworkGroup"] = "clickedArtworkGroup";
106
+ ActionType["ClickedBuyViewingGroup"] = "clickedBuyViewingRoom";
107
+ ActionType["SubmitAnotherArtwork"] = "submitAnotherArtwork";
108
+ ActionType["ClickedFAQ"] = "clickedFAQ";
109
+ })(ActionType || (exports.ActionType = ActionType = {}));
110
+
111
+ var ActionName;
112
+ exports.ActionName = ActionName;
113
+
114
+ (function (ActionName) {
115
+ ActionName["ArtistFollow"] = "artistFollow";
116
+ ActionName["ArtistUnfollow"] = "artistUnfollow";
117
+ ActionName["ArtworkAboutTheWork"] = "Artwork about the work";
118
+ ActionName["ViewEditorial"] = "viewed editorial";
119
+ ActionName["Dismiss"] = "dismiss";
120
+ ActionName["EmailNextButton"] = "emailNextButton";
121
+ ActionName["PasswordNextButton"] = "passwordNextButton";
122
+ ActionName["GeneFollow"] = "geneFollow";
123
+ ActionName["GeneUnfollow"] = "geneUnfollow";
124
+ ActionName["HomeArtistRailFollow"] = "homeArtistRailFollow";
125
+ ActionName["HomeArtistArtworksBlockFollow"] = "homeArtistArtworksBlockFollow";
126
+ ActionName["ConversationSendReply"] = "conversationSendReply";
127
+ ActionName["ConversationLink"] = "conversationLinkUsed";
128
+ ActionName["InquiryCancel"] = "inquiryCancel";
129
+ ActionName["InquirySend"] = "inquirySend";
130
+ ActionName["SavesAndFollowsWorks"] = "savesAndFollowsWorks";
131
+ ActionName["SavesAndFollowsArtists"] = "savesAndFollowsArtists";
132
+ ActionName["SavesAndFollowsCategories"] = "savesAndFollowsCategories";
133
+ ActionName["ConsignmentDraftCreated"] = "consignmentDraftCreated";
134
+ ActionName["ConsignmentSubmitted"] = "consignmentSubmitted";
135
+ ActionName["ConsignmentInterest"] = "Interested in selling a work learn more";
136
+ ActionName["BidFlowAddBillingAddress"] = "addBillingAddress";
137
+ ActionName["BidFlowPlaceBid"] = "placeBid";
138
+ ActionName["BidFlowSaveBillingAddress"] = "saveBillingAddress";
139
+ ActionName["ReadMoreExpanded"] = "readMoreExpanded";
140
+ ActionName["InSale"] = "In current auction";
141
+ ActionName["InShow"] = "In featured show";
142
+ })(ActionName || (exports.ActionName = ActionName = {}));
143
+
144
+ /**
145
+ * Identifier of content that was interacted with
146
+ */
147
+ var Subject;
148
+ /**
149
+ * Identifier of a conceptual module on the page.
150
+ */
151
+
152
+ exports.Subject = Subject;
153
+
154
+ (function (Subject) {
155
+ Subject["ClickedNextButton"] = "clicked next button";
156
+ Subject["FurtherReading"] = "Further reading";
157
+ Subject["ReadMore"] = "Read more";
158
+ Subject["RelatedArticles"] = "Related articles";
159
+ Subject["BNMOAskSpecialist"] = "ask a specialist";
160
+ Subject["BNMOReadFAQ"] = "Visit our help center";
161
+ Subject["BNMOProvideShipping"] = "provide shipping address";
162
+ Subject["BNMOArrangePickup"] = "arrange for pickup";
163
+ Subject["BNMOUseShippingAddress"] = "use shipping address";
164
+ Subject["BNMOAddBankAccount"] = "addBankAccount";
165
+ Subject["BNMOHelpEmail"] = "orders@artsy.net";
166
+ Subject["BNMOBankTransferNotifcationCheckbox"] = "notifyCheckboxChecked";
167
+ Subject["BNMOBankTransferModalDismissed"] = "modalDismissed";
168
+ Subject["AuctionConditionsOfSale"] = "conditions of sale";
169
+ Subject["AuctionFAQ"] = "auction faq";
170
+ Subject["AuctionAskSpecialist"] = "ask a specialist";
171
+ Subject["AuctionBuyerPremium"] = "Buyer premium";
172
+ Subject["CollectorFAQ"] = "Visit our help center";
173
+ Subject["ConsignLearnMore"] = "learn more";
174
+ Subject["GetStarted"] = "Get Started";
175
+ Subject["Classification"] = "Classification info";
176
+ Subject["ContactGallery"] = "Contact Gallery";
177
+ Subject["EnterLiveAuction"] = "Enter live auction";
178
+ Subject["ShowArtistInsights"] = "Show artist insights";
179
+ Subject["HistogramBar"] = "Histogram Bar";
180
+ Subject["BrowseWorks"] = "Browse works in this category";
181
+ Subject["QuestionMarkIcon"] = "Question Mark Informational Icon";
182
+ Subject["RequestConditionReport"] = "Request condition report";
183
+ Subject["NotificationBell"] = "Notification Bell";
184
+ Subject["Notification"] = "Notification";
185
+ Subject["ViewAll"] = "View All";
186
+ Subject["Login"] = "Log In";
187
+ Subject["Signup"] = "Sign Up";
188
+ Subject["SmallScreenMenuSandwichIcon"] = "Small Screen Menu Sandwich Icon";
189
+ Subject["EmailConfirmationCTA"] = "Email Confirmation CTA";
190
+ Subject["EmailConfirmationLinkExpired"] = "Email Confirmation Link Expired";
191
+ Subject["FeaturedCategories"] = "Featured Categories";
192
+ Subject["ExploreAuctionResults"] = "Explore Auction Results";
193
+ Subject["Here"] = "here";
194
+ Subject["RequestPriceEstimate"] = "Request a price estimate";
195
+ Subject["SubmitForReview"] = "Submit for review";
196
+ Subject["SubmitWorksInterestedInSelling"] = "submit works you\u2019re interested in selling here";
197
+ Subject["Rail"] = "Rail";
198
+ Subject["ViewWorks"] = "View works";
199
+ Subject["ArtworkThumbnail"] = "ArtworkThumbnail";
200
+ Subject["ViewingRoomArtworkDetail"] = "ViewingRoomArtworkDetail";
201
+ })(Subject || (exports.Subject = Subject = {}));
202
+
203
+ var ContextModule;
204
+ exports.ContextModule = ContextModule;
205
+
206
+ (function (ContextModule) {
207
+ ContextModule["Header"] = "Header";
208
+ ContextModule["NavigationTabs"] = "NavigationTabs";
209
+ ContextModule["FlashBanner"] = "FlashBanner";
210
+ ContextModule["RecentlyViewedArtworks"] = "recently_viewed_artworks";
211
+ ContextModule["HeaderMoreDropdown"] = "HeaderMoreDropdown";
212
+ ContextModule["HeaderUserDropdown"] = "HeaderUserDropdown";
213
+ ContextModule["HeaderActivityDropdown"] = "HeaderActivityDropdown";
214
+ ContextModule["HeaderArtworksDropdown"] = "HeaderArtworksDropdown";
215
+ ContextModule["HeaderArtistsDropdown"] = "HeaderArtistsDropdown";
216
+ ContextModule["ArtistConsignment"] = "ArtistConsignment";
217
+ ContextModule["ArtistPage"] = "Artist page";
218
+ ContextModule["AboutTheWork"] = "About the work";
219
+ ContextModule["AboutTheWorkPartner"] = "About the Work (Partner)";
220
+ ContextModule["ArtworkFilter"] = "ArtworkFilter";
221
+ ContextModule["ArtistOverview"] = "ArtistOverview";
222
+ ContextModule["ArtistBio"] = "ArtistBio";
223
+ ContextModule["ArtistInsights"] = "ArtistInsights";
224
+ ContextModule["Biography"] = "Biography";
225
+ ContextModule["Sidebar"] = "Sidebar";
226
+ ContextModule["WorksForSale"] = "Works For Sale";
227
+ ContextModule["AboutTheWorkCondition"] = "About the work condition";
228
+ ContextModule["ArtworkPage"] = "Artwork page";
229
+ ContextModule["ArtworkTabs"] = "Artwork tabs";
230
+ ContextModule["OtherWorksByArtist"] = "Other works by artist";
231
+ ContextModule["OtherWorksInAuction"] = "Other works in auction";
232
+ ContextModule["OtherWorksInFair"] = "Other works in fair";
233
+ ContextModule["OtherWorksFromGallery"] = "Other works from gallery";
234
+ ContextModule["OtherWorksFromShow"] = "Other works from show";
235
+ ContextModule["RecommendedArtists"] = "Recommended Artists";
236
+ ContextModule["RelatedArtists"] = "RelatedArtists";
237
+ ContextModule["RelatedWorks"] = "RelatedWorks";
238
+ ContextModule["ShareButton"] = "Share button";
239
+ ContextModule["Zoom"] = "Zoom";
240
+ ContextModule["ViewInRoom"] = "View in room";
241
+ ContextModule["PriceContext"] = "Price Context";
242
+ ContextModule["FurtherReading"] = "Further reading";
243
+ ContextModule["ReadMore"] = "Read more";
244
+ ContextModule["RelatedArticles"] = "Related articles";
245
+ ContextModule["BNMOBanner"] = "BNMO Banner";
246
+ ContextModule["CollectionDescription"] = "CollectionDescription";
247
+ ContextModule["ArtworkBanner"] = "ArtworkBanner";
248
+ ContextModule["CollectionsRail"] = "CollectionsRail";
249
+ ContextModule["CollectionHubEntryPoint"] = "HubEntrypoint";
250
+ ContextModule["FAQ"] = "FAQ";
251
+ ContextModule["HowToSellYourCollection"] = "How to sell your collection with Artsy";
252
+ ContextModule["SellArtFromYourCollection"] = "Sell Art From Your Collection";
253
+ ContextModule["SellWorksBy"] = "Sell Works by";
254
+ ContextModule["OtherCollectionsRail"] = "OtherCollectionsRail";
255
+ ContextModule["FeaturedCollectionsRail"] = "FeaturedCollectionsRail";
256
+ ContextModule["ArtistCollectionsRail"] = "ArtistCollectionsRail";
257
+ ContextModule["AdServer"] = "AdServer";
258
+ ContextModule["FeaturedThisWeek"] = "FeaturedThisWeek";
259
+ ContextModule["Editorial"] = "Editorial";
260
+ ContextModule["SelectedWorks"] = "SelectedWorks";
261
+ ContextModule["FeaturedArtists"] = "FeaturedArtists";
262
+ ContextModule["BrowseCollections"] = "BrowseCollections";
263
+ ContextModule["BrowseAuctions"] = "BrowseAuctions";
264
+ ContextModule["BrowseFairs"] = "BrowseFairs";
265
+ ContextModule["ViewingRoomArtworkRail"] = "viewingRoomArtworkRail";
266
+ ContextModule["ConsignSubmissionFlow"] = "consignSubmissionFlow";
267
+ })(ContextModule || (exports.ContextModule = ContextModule = {}));
268
+
269
+ var Flow;
270
+ exports.Flow = Flow;
271
+
272
+ (function (Flow) {
273
+ Flow["ArtworkAboutTheWork"] = "Artwork about the work";
274
+ Flow["ArtworkAboutTheArtist"] = "Artwork about the artist";
275
+ Flow["ArtworkShare"] = "Artwork share";
276
+ Flow["ArtworkZoom"] = "Artwork zoom";
277
+ Flow["ArtworkViewInRoom"] = "Artwork view in room";
278
+ Flow["ArtworkPriceContext"] = "Artwork Price Context";
279
+ Flow["Auctions"] = "Auctions";
280
+ Flow["BuyNow"] = "Buy now";
281
+ Flow["Consignments"] = "Consignments";
282
+ Flow["MakeOffer"] = "Make offer";
283
+ Flow["Header"] = "Header";
284
+ })(Flow || (exports.Flow = Flow = {}));
285
+
286
+ var Label;
287
+ exports.Label = Label;
288
+
289
+ (function (Label) {
290
+ Label["AboutTheWork"] = "about_the_work";
291
+ Label["Articles"] = "articles";
292
+ Label["Biography"] = "biography";
293
+ Label["ExhibitionHighlights"] = "exhibition_highlights";
294
+ Label["ReadMore"] = "ReadMore";
295
+ })(Label || (exports.Label = Label = {}));
296
+
297
+ var Type;
298
+ exports.Type = Type;
299
+
300
+ (function (Type) {
301
+ Type["ArtistCard"] = "Artist card";
302
+ Type["ArtworkBrick"] = "Artwork brick";
303
+ Type["Button"] = "Button";
304
+ Type["Link"] = "Link";
305
+ Type["Tab"] = "Tab";
306
+ Type["Thumbnail"] = "thumbnail";
307
+ Type["Chart"] = "Chart";
308
+ Type["RadioButton"] = "radio button";
309
+ Type["EmailLink"] = "email link";
310
+ Type["ModalDismissal"] = "modal dismissal";
311
+ })(Type || (exports.Type = Type = {}));
@@ -0,0 +1,46 @@
1
+ /**
2
+ * TODO:
3
+ * - See if we can get rid of all the namespacing and transform before sending.
4
+ * E.g. inside the `ContextPage` interface have just a `page` field that
5
+ * transforms to `context_page`.
6
+ * - If the above gets done, we could also dry up the ‘owner’ in both
7
+ * `ContextPage` and `Result`.
8
+ */
9
+ export * from "./DeprecatedValues";
10
+ import { Event } from "../Schema";
11
+ import { AuctionInfo } from "./DeprecatedAuctionInfo";
12
+ import { ContextModule } from "./DeprecatedContextModule";
13
+ import { ContextPage } from "./DeprecatedContextPage";
14
+ import { Flow } from "./DeprecatedFlow";
15
+ import { AuthenticationInteraction, Interaction } from "./DeprecatedInteraction";
16
+ import { Label } from "./DeprecatedLabel";
17
+ import { Failure, Success } from "./DeprecatedResult";
18
+ import { Type } from "./DeprecatedType";
19
+ import { ActionType } from "./DeprecatedValues";
20
+ interface Uncategorized {
21
+ changed: any;
22
+ current: any;
23
+ item_type: any;
24
+ item_id: any;
25
+ query: any;
26
+ item_number: number;
27
+ experiment_id: string;
28
+ experiment_name: string;
29
+ variation_id: string;
30
+ variation_name: string;
31
+ nonInteraction: number;
32
+ action_type: ActionType | string;
33
+ }
34
+ export declare type Trackables = AuthenticationInteraction | ContextModule | ContextPage | Flow | Interaction | Label | Success | Failure | Type | Uncategorized | AuctionInfo | Event;
35
+ /**
36
+ * A sentinel type used to signal that anything goes in order to be able to
37
+ * support old Force schema.
38
+ *
39
+ * @example
40
+ *
41
+ * ```ts
42
+ * import * as Schema from "@artsy/cohesion"
43
+ *
44
+ * @track({ … } as Schema.Old)
45
+ */
46
+ export declare type Old = any;
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+
7
+ var _DeprecatedValues = require("./DeprecatedValues");
8
+
9
+ Object.keys(_DeprecatedValues).forEach(function (key) {
10
+ if (key === "default" || key === "__esModule") return;
11
+ Object.defineProperty(exports, key, {
12
+ enumerable: true,
13
+ get: function get() {
14
+ return _DeprecatedValues[key];
15
+ }
16
+ });
17
+ });
@@ -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
+ }
@@ -781,6 +781,39 @@ export interface ClickedPaymentDetails {
781
781
  order_id: string;
782
782
  subject: string;
783
783
  }
784
+ /**
785
+ * After choosing Bank Transfer, when user clicks on save & continue
786
+ * on the payment page, the balance account is checked
787
+ *
788
+ * This schema describes events sent
789
+ * to Segment from [[clickedBalanceAccountCheck]]
790
+ *
791
+ * @example
792
+ * ```
793
+ * {
794
+ * action: "checkedAccountBalance",
795
+ * flow: "Make Offer",
796
+ * context_page_owner_type: "orders-payment",
797
+ * order_id: "407dd09f-4afd-4aad-a6cc-1d6704dc2b11"
798
+ * amount: 2000,
799
+ * currency: "USD"
800
+ * payment_method: "bank transfer"
801
+ * subject: "balance account check"
802
+ * outcome: "sucess"
803
+ * }
804
+ * ```
805
+ */
806
+ export interface CheckedAccountBalance {
807
+ action: ActionType.checkedAccountBalance;
808
+ flow: string;
809
+ context_page_owner_type: string;
810
+ order_id: string;
811
+ amount: number;
812
+ currency: string;
813
+ payment_method: string;
814
+ subject: string;
815
+ outcome: string;
816
+ }
784
817
  /**
785
818
  * User selects existing shipping address when entering the orders
786
819
  * checkout flow.
@@ -1,7 +1,7 @@
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";
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, ClickedOfferOption, ClickedOnArtworkShippingUnitsDropdown, ClickedOnArtworkShippingWeight, ClickedOnFramedMeasurements, ClickedOnFramedMeasurementsDropdown, ClickedOnSubmitOrder, ClickedPartnerCard, ClickedPartnerLink, ClickedPaymentDetails, ClickedPaymentMethod, ClickedPromoSpace, ClickedSelectShippingOption, ClickedShippingAddress, ClickedShowGroup, ClickedShowMore, ClickedSnooze, ClickedVerifyIdentity, ClickedViewingRoomCard, ClickedOfferActions, ClickedOrderPage } from "./Click";
3
+ import { AuthImpression, CompletedOnboarding, CreatedAccount, OnboardingUserInputData, ResetYourPassword, StartedOnboarding, SuccessfullyLoggedIn } from "./Authentication";
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, CheckedAccountBalance, 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";
7
7
  import { ExperimentViewed } from "./ExperimentViewed";
@@ -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 | CheckedAccountBalance | 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
  *
@@ -217,6 +217,10 @@ export declare enum ActionType {
217
217
  /**
218
218
  * Corresponds to {@link ClickedPaymentDetails}
219
219
  */
220
+ checkedAccountBalance = "checkedAccountBalance",
221
+ /**
222
+ * Corresponds to {@link CheckedAccountBalance}
223
+ */
220
224
  clickedPromoSpace = "clickedPromoSpace",
221
225
  /**
222
226
  * Corresponds to {@link ClickedRegisterToBid}
@@ -259,13 +263,17 @@ export declare enum ActionType {
259
263
  */
260
264
  clickedOfferActions = "clickedOfferActions",
261
265
  /**
262
- * Corresponds to {@link ClickedOrderPage}
263
- */
266
+ * Corresponds to {@link ClickedOrderPage}
267
+ */
264
268
  clickedOrderPage = "clickedOrderPage",
265
269
  /**
266
270
  * Corresponds to {@link CommercialFilterParamsChanged}
267
271
  */
268
272
  commercialFilterParamsChanged = "commercialFilterParamsChanged",
273
+ /**
274
+ * Corresponds to {@link CompletedOnboarding}
275
+ */
276
+ completedOnboarding = "completedOnboarding",
269
277
  /**
270
278
  * Corresponds to {@link ConfirmBid}
271
279
  */
@@ -418,6 +426,10 @@ export declare enum ActionType {
418
426
  * Corresponds to {@link ExperimentViewed}
419
427
  */
420
428
  experimentViewed = "experimentViewed",
429
+ /**
430
+ * Corresponds to {@link SuccessfullyLoggedIn}
431
+ */
432
+ startedOnboarding = "startedOnboarding",
421
433
  /**
422
434
  * Corresponds to {@link SubmitAnotherArtwork}
423
435
  */
@@ -66,6 +66,7 @@ exports.ActionType = ActionType;
66
66
  ActionType["clickedPlayVideo"] = "clickedPlayVideo";
67
67
  ActionType["clickedPaymentMethod"] = "clickedPaymentMethod";
68
68
  ActionType["clickedPaymentDetails"] = "clickedPaymentDetails";
69
+ ActionType["checkedAccountBalance"] = "checkedAccountBalance";
69
70
  ActionType["clickedPromoSpace"] = "clickedPromoSpace";
70
71
  ActionType["clickedRegisterToBid"] = "clickedRegisterToBid";
71
72
  ActionType["clickedSelectShippingOption"] = "clickedSelectShippingOption";
@@ -79,6 +80,7 @@ exports.ActionType = ActionType;
79
80
  ActionType["clickedOfferActions"] = "clickedOfferActions";
80
81
  ActionType["clickedOrderPage"] = "clickedOrderPage";
81
82
  ActionType["commercialFilterParamsChanged"] = "commercialFilterParamsChanged";
83
+ ActionType["completedOnboarding"] = "completedOnboarding";
82
84
  ActionType["confirmBid"] = "confirmBid";
83
85
  ActionType["confirmRegistrationPageview"] = "confirmRegistrationPageview";
84
86
  ActionType["consignmentArtistFailed"] = "consignmentArtistFailed";
@@ -117,6 +119,7 @@ exports.ActionType = ActionType;
117
119
  ActionType["sentRequestPriceEstimate"] = "sentRequestPriceEstimate";
118
120
  ActionType["share"] = "share";
119
121
  ActionType["experimentViewed"] = "experimentViewed";
122
+ ActionType["startedOnboarding"] = "startedOnboarding";
120
123
  ActionType["submitAnotherArtwork"] = "submitAnotherArtwork";
121
124
  ActionType["successfullyLoggedIn"] = "successfullyLoggedIn";
122
125
  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.57.0",
3
+ "version": "4.60.0",
4
4
  "description": "Analytics schema",
5
5
  "main": "dist/index.js",
6
6
  "publishConfig": {