@artsy/cohesion 4.66.0 → 4.68.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 (8) hide show
  1. package/CHANGELOG.md +39 -0
  2. package/dist/Schema/Events/ActivityPanel.d.ts +60 -0
  3. package/dist/Schema/Events/ActivityPanel.js +1 -0
  4. package/dist/Schema/Events/MyCollectionInsights.d.ts +25 -0
  5. package/dist/Schema/Events/index.d.ts +18 -1
  6. package/dist/Schema/Events/index.js +4 -0
  7. package/package.json +3 -3
  8. package/pull_request_template.md +1 -1
package/CHANGELOG.md CHANGED
@@ -1,3 +1,42 @@
1
+ # v4.68.0 (Wed Oct 19 2022)
2
+
3
+ #### 🚀 Enhancement
4
+
5
+ - feat(FX-4379): Activity Panel tracking events [#356](https://github.com/artsy/cohesion/pull/356) ([@nickskalkin](https://github.com/nickskalkin))
6
+
7
+ #### Authors: 1
8
+
9
+ - Nikita Skalkin ([@nickskalkin](https://github.com/nickskalkin))
10
+
11
+ ---
12
+
13
+ # v4.67.0 (Tue Oct 18 2022)
14
+
15
+ #### 🚀 Enhancement
16
+
17
+ - feat(CX-3066): Add MyC Insights web tracking events [#357](https://github.com/artsy/cohesion/pull/357) ([@MrSltun](https://github.com/MrSltun))
18
+
19
+ #### 🐛 Bug Fix
20
+
21
+ - Update pull_request_template.md [#305](https://github.com/artsy/cohesion/pull/305) ([@pvinis](https://github.com/pvinis))
22
+
23
+ #### 🏠 Internal
24
+
25
+ - chore(deps): update dep typescript from 4.8.3 to v4.8.4 [#355](https://github.com/artsy/cohesion/pull/355) ([@renovate[bot]](https://github.com/renovate[bot]))
26
+ - Bump ajv from 6.12.0 to 6.12.6 [#300](https://github.com/artsy/cohesion/pull/300) ([@dependabot[bot]](https://github.com/dependabot[bot]))
27
+ - Bump shelljs from 0.8.4 to 0.8.5 [#295](https://github.com/artsy/cohesion/pull/295) ([@dependabot[bot]](https://github.com/dependabot[bot]))
28
+ - chore(deps): update dep @artsy/auto-config from 1.1.0 to v1.2.0 [#308](https://github.com/artsy/cohesion/pull/308) ([@renovate-bot](https://github.com/renovate-bot) [@renovate[bot]](https://github.com/renovate[bot]))
29
+
30
+ #### Authors: 5
31
+
32
+ - [@dependabot[bot]](https://github.com/dependabot[bot])
33
+ - [@renovate[bot]](https://github.com/renovate[bot])
34
+ - Pavlos Vinieratos ([@pvinis](https://github.com/pvinis))
35
+ - Sultan Al-Maari ([@MrSltun](https://github.com/MrSltun))
36
+ - WhiteSource Renovate ([@renovate-bot](https://github.com/renovate-bot))
37
+
38
+ ---
39
+
1
40
  # v4.66.0 (Mon Sep 19 2022)
2
41
 
3
42
  #### 🚀 Enhancement
package/dist/Schema/Events/ActivityPanel.d.ts ADDED
@@ -0,0 +1,60 @@
1
+ /**
2
+ * Schema describing Activity Panel related events
3
+ * @packageDocumentation
4
+ */
5
+ import { ActionType } from ".";
6
+ /**
7
+ * A user clicked on a notifications bell.
8
+ *
9
+ * This schema describes events sent to Segment from [[clickedNotificationsBell]]
10
+ *
11
+ * @example
12
+ * ```
13
+ * {
14
+ * action: "clickedNotificationsBell",
15
+ * user_id: "5bd8b675776bd6002c86526c"
16
+ * }
17
+ * ```
18
+ */
19
+ export interface ClickedNotificationsBell {
20
+ action: ActionType.clickedNotificationsBell;
21
+ user_id: string;
22
+ }
23
+ /**
24
+ * A user clicked on a notification in Activity Panel.
25
+ *
26
+ * This schema describes events sent to Segment from [[clickedActivityPanelNotificationItem]]
27
+ *
28
+ * @example
29
+ * ```
30
+ * {
31
+ * action: "clickedActivityPanelNotificationItem",
32
+ * user_id: "5bd8b675776bd6002c86526c",
33
+ * notification_type: "ARTWORK_ALERT"
34
+ * }
35
+ * ```
36
+ */
37
+ export interface ClickedActivityPanelNotificationItem {
38
+ action: ActionType.clickedActivityPanelNotificationItem;
39
+ user_id: string;
40
+ notification_type: string;
41
+ }
42
+ /**
43
+ * A user clicked on a tab in Activity Panel.
44
+ *
45
+ * This schema describes events sent to Segment from [[clickedActivityPanelTab]]
46
+ *
47
+ * @example
48
+ * ```
49
+ * {
50
+ * action: "clickedActivityPanelTab",
51
+ * user_id: "5bd8b675776bd6002c86526c",
52
+ * tab_name: "Alerts"
53
+ * }
54
+ * ```
55
+ */
56
+ export interface ClickedActivityPanelTab {
57
+ action: ActionType.clickedActivityPanelTab;
58
+ user_id: string;
59
+ tab_name: string;
60
+ }
package/dist/Schema/Events/ActivityPanel.js ADDED
@@ -0,0 +1 @@
1
+ "use strict";
package/dist/Schema/Events/MyCollectionInsights.d.ts CHANGED
@@ -5,6 +5,31 @@ import { ActionType } from ".";
5
5
  * Schema describing 'MyCollectionInsightsRails' events
6
6
  * @packageDocumentation
7
7
  */
8
+ /**
9
+ * A user clicks on My Collection Insights Median Auction Rail item.
10
+ *
11
+ * This schema describes events sent to Segment from [[clickedMyCollectionInsightsMedianAuctionRailItem]]
12
+ *
13
+ * @example
14
+ * ```
15
+ * {
16
+ * action: "clickedMyCollectionInsightsMedianAuctionRailItem",
17
+ * context_module: "myCollectionInsightsMedianAuctionRail",
18
+ * context_screen: "myCollectionInsights",
19
+ * context_screen_owner_type: "myCollectionInsights",
20
+ * artist_id: "4212691337420",
21
+ * category: "Print"
22
+ * }
23
+ * ```
24
+ */
25
+ export interface ClickedMyCollectionInsightsMedianAuctionRailItem {
26
+ action: ActionType.clickedMyCollectionInsightsMedianAuctionRailItem;
27
+ context_module: ContextModule.myCollectionInsightsMedianAuctionRail;
28
+ context_screen: OwnerType.myCollectionInsights;
29
+ context_screen_owner_type: OwnerType.myCollectionInsights;
30
+ artist_id: string;
31
+ category: string;
32
+ }
8
33
  /**
9
34
  * A user taps on the MyCollectionInsightsMedianAuctionRailItem
10
35
  *
package/dist/Schema/Events/index.d.ts CHANGED
@@ -1,4 +1,5 @@
1
1
  import { AddToCalendar } from "./AddToCalendar";
2
+ import { ClickedActivityPanelNotificationItem, ClickedActivityPanelTab, ClickedNotificationsBell } from "./ActivityPanel";
2
3
  import { AuctionPageView, BidPageView, ClickedActiveBid, ClickedRegisterToBid, ConfirmBid, ConfirmRegistrationPageview, EnterLiveAuction, MaxBidSelected, RegistrationPageView, RegistrationSubmitted } from "./Auction";
3
4
  import { AuthImpression, CompletedOnboarding, CreatedAccount, OnboardingUserInputData, ResetYourPassword, StartedOnboarding, SuccessfullyLoggedIn } from "./Authentication";
4
5
  import { CheckedAccountBalance, 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";
@@ -24,7 +25,7 @@ import { ToggledAccordion } from "./UserExperienceInteractions";
24
25
  *
25
26
  * Each event describes one ActionType
26
27
  */
27
- 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 | SaveCollectedArtwork | Screen | SearchedPriceDatabase | SearchedReverseImageWithNoResults | SearchedReverseImageWithResults | SearchedWithNoResults | SelectedArtworkFromReverseImageSearch | 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 | TappedMyCollectionInsightsMedianAuctionRailItem | TappedMyCollectionInsightsMedianAuctionPriceChartCareerHighlight | TappedMyCollectionInsightsMedianAuctionPriceChartCategory | TappedMyCollectionInsightsMedianAuctionPriceChartTimeframe | TappedPartnerCard | TappedPickImageFromLibrary | TappedPromoSpace | TappedRequestPriceEstimate | TappedReverseImageSearch | TappedSell | TappedSellArtwork | TappedShowMore | TappedLearnMore | TappedSkip | TappedTabBar | TappedToggleCameraFlash | TappedVerifyIdentity | TappedViewingRoomCard | TappedViewingRoomGroup | TappedViewOffer | TimeOnPage | ToggledAccordion | ToggledNotification | ToggledSavedSearch | UploadPhotosCompleted | ViewArtworkMyCollection;
28
+ export declare type Event = AddToCalendar | AddCollectedArtwork | ArtworkDetailsCompleted | AuctionPageView | AuctionResultsFilterParamsChanged | AuthImpression | BidPageView | CreatedAccount | ClickedActiveBid | ClickedActivityPanelNotificationItem | ClickedActivityPanelTab | ClickedAddNewShippingAddress | ClickedAddWorksToFair | ClickedAppDownload | ClickedArticleGroup | ClickedArtistGroup | ClickedArtistSeriesGroup | ClickedArtworkGroup | ClickedAuctionGroup | ClickedBuyerProtection | ClickedChangePage | ClickedChangePaymentMethod | ClickedChangeShippingAddress | ClickedChangeShippingMethod | ClickedCollectionGroup | ClickedCreateAlert | ClickedDeliveryMethod | ClickedEditArtwork | ClickedExpansionToggle | ClickedFairCard | ClickedFairGroup | ClickedGalleryGroup | ClickedLoadMore | ClickedMainArtworkGrid | ClickedNavigationTab | ClickedNotificationsBell | 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 | SaveCollectedArtwork | Screen | SearchedPriceDatabase | SearchedReverseImageWithNoResults | SearchedReverseImageWithResults | SearchedWithNoResults | SelectedArtworkFromReverseImageSearch | 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 | TappedMyCollectionInsightsMedianAuctionRailItem | TappedMyCollectionInsightsMedianAuctionPriceChartCareerHighlight | TappedMyCollectionInsightsMedianAuctionPriceChartCategory | TappedMyCollectionInsightsMedianAuctionPriceChartTimeframe | TappedPartnerCard | TappedPickImageFromLibrary | TappedPromoSpace | TappedRequestPriceEstimate | TappedReverseImageSearch | TappedSell | TappedSellArtwork | TappedShowMore | TappedLearnMore | TappedSkip | TappedTabBar | TappedToggleCameraFlash | TappedVerifyIdentity | TappedViewingRoomCard | TappedViewingRoomGroup | TappedViewOffer | TimeOnPage | ToggledAccordion | ToggledNotification | ToggledSavedSearch | UploadPhotosCompleted | ViewArtworkMyCollection;
28
29
  /**
29
30
  * The top-level actions an Event describes.
30
31
  *
@@ -67,6 +68,14 @@ export declare enum ActionType {
67
68
  * Corresponds to {@link ClickedActiveBid}
68
69
  */
69
70
  clickedActiveBid = "clickedActiveBid",
71
+ /**
72
+ * Corresponds to {@link ClickedActivityPanelNotificationItem}
73
+ */
74
+ clickedActivityPanelNotificationItem = "clickedActivityPanelNotificationItem",
75
+ /**
76
+ * Corresponds to {@link ClickedActivityPanelTab}
77
+ */
78
+ clickedActivityPanelTab = "clickedActivityPanelTab",
70
79
  /**
71
80
  * Corresponds to {@link ClickedAddNewShippingAddress}
72
81
  */
@@ -167,10 +176,18 @@ export declare enum ActionType {
167
176
  * Corresponds to {@link ClickedMainArtworkGrid}
168
177
  */
169
178
  clickedMainArtworkGrid = "clickedMainArtworkGrid",
179
+ /**
180
+ * Corresponds to {@link ClickedMyCollectionInsightsMedianAuctionRailItem}
181
+ */
182
+ clickedMyCollectionInsightsMedianAuctionRailItem = "clickedMyCollectionInsightsMedianAuctionRailItem",
170
183
  /**
171
184
  * Corresponds to {@link ClickedNavigationTab}
172
185
  */
173
186
  clickedNavigationTab = "clickedNavigationTab",
187
+ /**
188
+ * Corresponds to {@link ClickedNotificationsBell}
189
+ */
190
+ clickedNotificationsBell = "clickedNotificationsBell",
174
191
  /**
175
192
  * Corresponds to {@link ClickedOfferActions}
176
193
  */
package/dist/Schema/Events/index.js CHANGED
@@ -29,6 +29,8 @@ exports.ActionType = ActionType;
29
29
  ActionType["bidPageView"] = "bidPageView";
30
30
  ActionType["checkedAccountBalance"] = "checkedAccountBalance";
31
31
  ActionType["clickedActiveBid"] = "clickedActiveBid";
32
+ ActionType["clickedActivityPanelNotificationItem"] = "clickedActivityPanelNotificationItem";
33
+ ActionType["clickedActivityPanelTab"] = "clickedActivityPanelTab";
32
34
  ActionType["clickedAddNewShippingAddress"] = "clickedAddNewShippingAddress";
33
35
  ActionType["clickedAddWorksToFair"] = "clickedAddWorksToFair";
34
36
  ActionType["clickedAppDownload"] = "clickedAppDownload";
@@ -54,7 +56,9 @@ exports.ActionType = ActionType;
54
56
  ActionType["clickedGalleryGroup"] = "clickedGalleryGroup";
55
57
  ActionType["clickedLoadMore"] = "clickedLoadMore";
56
58
  ActionType["clickedMainArtworkGrid"] = "clickedMainArtworkGrid";
59
+ ActionType["clickedMyCollectionInsightsMedianAuctionRailItem"] = "clickedMyCollectionInsightsMedianAuctionRailItem";
57
60
  ActionType["clickedNavigationTab"] = "clickedNavigationTab";
61
+ ActionType["clickedNotificationsBell"] = "clickedNotificationsBell";
58
62
  ActionType["clickedOfferActions"] = "clickedOfferActions";
59
63
  ActionType["clickedOfferOption"] = "clickedOfferOption";
60
64
  ActionType["clickedOnArtworkShippingUnitsDropdown"] = "clickedOnArtworkShippingUnitsDropdown";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@artsy/cohesion",
3
- "version": "4.66.0",
3
+ "version": "4.68.0",
4
4
  "description": "Analytics schema",
5
5
  "main": "dist/index.js",
6
6
  "publishConfig": {
@@ -25,7 +25,7 @@
25
25
  "watch": "concurrently --raw --kill-others 'yarn compile -w' 'yarn emit-types -w'"
26
26
  },
27
27
  "devDependencies": {
28
- "@artsy/auto-config": "1.1.0",
28
+ "@artsy/auto-config": "1.2.0",
29
29
  "@babel/cli": "7.8.4",
30
30
  "@babel/core": "7.9.0",
31
31
  "@babel/preset-env": "7.9.5",
@@ -47,7 +47,7 @@
47
47
  "lint-staged": "10.1.7",
48
48
  "prettier": "2.0.5",
49
49
  "typedoc": "0.17.7",
50
- "typescript": "4.8.3"
50
+ "typescript": "4.8.4"
51
51
  },
52
52
  "dependencies": {
53
53
  "core-js": "3"
package/pull_request_template.md CHANGED
@@ -15,6 +15,6 @@ This PR resolves [CO-]
15
15
 
16
16
  <!-- 💡 This checklist is experimental. #cohesion warmly welcomes any feedback about the list or how it impacts your workflow -->
17
17
 
18
- - [ ] If I've added a new file to the tree I've exported it from the common `index.ts`
18
+ - [ ] If I've added a new file to the tree I've exported it from the common [`index.ts`](https://github.com/artsy/cohesion/blob/main/src/Schema/Events/index.ts)
19
19
  - [ ] I've added comments with examples for any new interfaces and ensured that they're in the docs
20
20
  - [ ] No platform-specific terminology has been used outside of `click` and `tap` (platform is inferred by the DB storing events)