@artsy/cohesion - npm Package Compare versions

Comparing version 1.63.0 to 1.64.0

CHANGELOG.md

@@ -0,1 +1,13 @@
+# v1.64.0 (Tue Dec 01 2020)
+
+#### 🚀  Enhancement
+
+- Track critical myCollection events and contexts [#139](https://github.com/artsy/cohesion/pull/139) ([@mikehrom](https://github.com/mikehrom))
+
+#### Authors: 1
+
+- mike hromchak ([@mikehrom](https://github.com/mikehrom))
+
+---
+
 # v1.63.0 (Mon Nov 30 2020)
@@ -2,0 +14,0 @@

dist/Schema/Events/index.d.ts

@@ -6,5 +6,6 @@ import { AddToCalendar } from "./AddToCalendar";
 import { CommercialFilterParamsChanged } from "./FilterAndSort";
+import { AddCollectedArtwork, DeleteCollectedArtwork, EditCollectedArtwork, TappedCollectedArtwork } from "./MyCollection";
 import { FollowEvents } from "./SavesAndFollows";
 import { SaleScreenLoadComplete, TimeOnPage } from "./System";
-import { TappedArticleGroup, TappedArtistGroup, TappedArtistSeriesGroup, TappedArtworkGroup, TappedAuctionGroup, TappedAuctionResultGroup, TappedCollectionGroup, TappedConsign, TappedExploreGroup, TappedFairCard, TappedFairGroup, TappedMainArtworkGrid, TappedNavigationTab, TappedPartnerCard, TappedPromoSpace, TappedShowMore, TappedTabBar, TappedViewingRoomCard, TappedViewingRoomGroup } from "./Tap";
+import { TappedArticleGroup, TappedArtistGroup, TappedArtistSeriesGroup, TappedArtworkGroup, TappedAuctionGroup, TappedAuctionResultGroup, TappedCollectionGroup, TappedConsign, TappedExploreGroup, TappedFairCard, TappedFairGroup, TappedInfoBubble, TappedMainArtworkGrid, TappedNavigationTab, TappedPartnerCard, TappedPromoSpace, TappedSell, TappedShowMore, TappedTabBar, TappedViewingRoomCard, TappedViewingRoomGroup } from "./Tap";
 import { ToggledNotification } from "./Toggle";
@@ -16,3 +17,3 @@ /**
  */
-export declare type Event = AddToCalendar | AuthImpression | CreatedAccount | ClickedAppDownload | ClickedArticleGroup | ClickedArtistGroup | ClickedArtistSeriesGroup | ClickedArtworkGroup | ClickedAuctionGroup | ClickedCollectionGroup | ClickedFairCard | ClickedFairGroup | ClickedMainArtworkGrid | ClickedNavigationTab | ClickedPartnerCard | ClickedShowMore | ClickedViewingRoomCard | CommercialFilterParamsChanged | FocusedOnConversationMessageInput | FollowEvents | OnboardingUserInputData | ResetYourPassword | SaleScreenLoadComplete | SentConversationMessage | SuccessfullyLoggedIn | TappedArticleGroup | TappedArtistGroup | TappedArtistSeriesGroup | TappedArtworkGroup | TappedAuctionGroup | TappedAuctionResultGroup | TappedCollectionGroup | TappedExploreGroup | TappedFairCard | TappedFairGroup | TappedConsign | TappedNavigationTab | TappedMainArtworkGrid | TappedPartnerCard | TappedPromoSpace | TappedShowMore | TappedTabBar | TappedViewingRoomCard | TappedViewingRoomGroup | TimeOnPage | ToggledNotification;
+export declare type Event = AddToCalendar | AddCollectedArtwork | AuthImpression | CreatedAccount | ClickedAppDownload | ClickedArticleGroup | ClickedArtistGroup | ClickedArtistSeriesGroup | ClickedArtworkGroup | ClickedAuctionGroup | ClickedCollectionGroup | ClickedFairCard | ClickedFairGroup | ClickedMainArtworkGrid | ClickedNavigationTab | ClickedPartnerCard | ClickedShowMore | ClickedViewingRoomCard | CommercialFilterParamsChanged | DeleteCollectedArtwork | EditCollectedArtwork | FocusedOnConversationMessageInput | FollowEvents | OnboardingUserInputData | ResetYourPassword | SaleScreenLoadComplete | SentConversationMessage | SuccessfullyLoggedIn | TappedArticleGroup | TappedArtistGroup | TappedArtistSeriesGroup | TappedArtworkGroup | TappedAuctionGroup | TappedAuctionResultGroup | TappedCollectedArtwork | TappedCollectionGroup | TappedConsign | TappedExploreGroup | TappedFairCard | TappedFairGroup | TappedInfoBubble | TappedNavigationTab | TappedMainArtworkGrid | TappedPartnerCard | TappedPromoSpace | TappedSell | TappedShowMore | TappedTabBar | TappedViewingRoomCard | TappedViewingRoomGroup | TimeOnPage | ToggledNotification;
 /**
@@ -33,2 +34,6 @@ * The top-level actions an Event describes.
     /**
+     * Corresponds to {@link AddCollectedArtwork}
+     */
+    addCollectedArtwork = "addCollectedArtwork",
+    /**
      * Corresponds to {@link ClickedAppDownload}
@@ -98,2 +103,10 @@ */
     /**
+     * Corresponds to {@link DeleteCollectedArtwork}
+     */
+    deleteCollectedArtwork = "deleteCollectedArtwork",
+    /**
+     * Corresponds to {@link EditCollectedArtwork}
+     */
+    editCollectedArtwork = "editCollectedArtwork",
+    /**
      * Corresponds to {@link FocusedOnConversationMessageInput}
@@ -175,2 +188,6 @@ */
     /**
+     * Corresponds to {@link TappedCollectedArtwork}
+     */
+    tappedCollectedArtwork = "tappedCollectedArtwork",
+    /**
      * Corresponds to {@link TappedCollectionGroup}
@@ -180,2 +197,6 @@ */
     /**
+     * Corresponds to {@link TappedConsign}
+     */
+    tappedConsign = "tappedConsign",
+    /**
      * Corresponds to {@link TappedExploreGroup}
@@ -189,6 +210,2 @@ */
     /**
-     * Corresponds to {@link TappedConsign}
-     */
-    tappedConsign = "tappedConsign",
-    /**
      * Corresponds to {@link TappedFairCard}
@@ -198,2 +215,6 @@ */
     /**
+     * Corresponds to {@link TappedInfoBubble}
+     */
+    tappedInfoBubble = "tappedInfoBubble",
+    /**
      * Corresponds to {@link TappedMainArtworkGrid}
@@ -203,2 +224,6 @@ */
     /**
+     * Corresponds to {@link TappedNavigationTab}
+     */
+    tappedNavigationTab = "tappedNavigationTab",
+    /**
      * Corresponds to {@link TappedPartnerCard}
@@ -216,2 +241,10 @@ */
     /**
+     * Corresponds to {@link TappedSell}
+     */
+    tappedSell = "tappedSell",
+    /**
+     * Corresponds to {@link TappedShowMore}
+     */
+    tappedShowMore = "tappedShowMore",
+    /**
      * Corresponds to {@link TappedTabBar}
@@ -229,10 +262,2 @@ */
     /**
-     * Corresponds to {@link TappedShowMore}
-     */
-    tappedShowMore = "tappedShowMore",
-    /**
-     * Corresponds to {@link TappedNavigationTab}
-     */
-    tappedNavigationTab = "tappedNavigationTab",
-    /**
      * Corresponds to {@link TimeOnPage}
@@ -239,0 +264,0 @@ */

dist/Schema/Events/index.js

@@ -25,2 +25,3 @@ "use strict";
   ActionType["addToCalendar"] = "addToCalendar";
+  ActionType["addCollectedArtwork"] = "addCollectedArtwork";
   ActionType["clickedAppDownload"] = "clickedAppDownload";
@@ -42,2 +43,4 @@ ActionType["clickedArticleGroup"] = "clickedArticleGroup";
   ActionType["createdAccount"] = "createdAccount";
+  ActionType["deleteCollectedArtwork"] = "deleteCollectedArtwork";
+  ActionType["editCollectedArtwork"] = "editCollectedArtwork";
   ActionType["focusedOnConversationMessageInput"] = "focusedOnConversationMessageInput";
@@ -62,16 +65,19 @@ ActionType["focusedOnSearchInput"] = "focusedOnSearchInput";
   ActionType["tappedAuctionResultGroup"] = "tappedAuctionResultGroup";
+  ActionType["tappedCollectedArtwork"] = "tappedCollectedArtwork";
   ActionType["tappedCollectionGroup"] = "tappedCollectionGroup";
+  ActionType["tappedConsign"] = "tappedConsign";
   ActionType["tappedExploreGroup"] = "tappedExploreGroup";
   ActionType["tappedFairGroup"] = "tappedFairGroup";
-  ActionType["tappedConsign"] = "tappedConsign";
   ActionType["tappedFairCard"] = "tappedFairCard";
+  ActionType["tappedInfoBubble"] = "tappedInfoBubble";
   ActionType["tappedMainArtworkGrid"] = "tappedMainArtworkGrid";
+  ActionType["tappedNavigationTab"] = "tappedNavigationTab";
   ActionType["tappedPartnerCard"] = "tappedPartnerCard";
   ActionType["tappedPromoSpace"] = "tappedPromoSpace";
   ActionType["tappedRegisterToBid"] = "tappedRegisterToBid";
+  ActionType["tappedSell"] = "tappedSell";
+  ActionType["tappedShowMore"] = "tappedShowMore";
   ActionType["tappedTabBar"] = "tappedTabBar";
   ActionType["tappedViewingRoomCard"] = "tappedViewingRoomCard";
   ActionType["tappedViewingRoomGroup"] = "tappedViewingRoomGroup";
-  ActionType["tappedShowMore"] = "tappedShowMore";
-  ActionType["tappedNavigationTab"] = "tappedNavigationTab";
   ActionType["timeOnPage"] = "timeOnPage";
@@ -78,0 +84,0 @@ ActionType["toggledNotification"] = "toggledNotification";

dist/Schema/Events/Tap.d.ts

@@ -250,3 +250,3 @@ import { ContextModule } from "../Values/ContextModule";
  *    action: "tappedConsign",
- *    context_module : "sellHeader",
+ *    context_module: "sellHeader",
  *    context_screen_owner_type: "sell",
@@ -298,2 +298,25 @@ *    destination_screen_owner_type: "consignmentSubmission",
 /**
+ * A user taps an information bubble
+ *
+ * This schema describes events sent to Segment from [[TappedInfoBubble]]
+ *
+ *  @example
+ *  ```
+ *  {
+ *    action: "tappedInfoBubble",
+ *    context_module: "myCollectionArtwork",
+ *    context_screen_owner_type: "myCollectionArtwork",
+ *    subject: "auctionResults"
+ *  }
+ * ```
+ */
+export interface TappedInfoBubble {
+    action: ActionType.tappedInfoBubble;
+    context_module: ContextModule;
+    context_screen_owner_type: ScreenOwnerType;
+    context_screen_owner_id?: string;
+    context_screen_owner_slug?: string;
+    subject: "auctionResults" | "demandIndex";
+}
+/**
  * A user taps on an artwork in the main artwork grid, which is the main product feed we can find on our core merchandising surfaces.
@@ -382,2 +405,27 @@ * Note: This event is separate from [[tappedArtworkGroup]] because it is an important and frequent event. Separating it out will make it easier for analysts to access.
 /**
+ * A user taps a button that navigates to the Sell With Artsy home screen (not the 'sell' icon in the tab bar)
+ *
+ * This schema describes events sent to Segment from [[tappedSell]]
+ *
+ *  @example
+ *  ```
+ *  {
+ *    action: "tappedSell",
+ *    context_module: "myCollectionArtwork",
+ *    context_screen_owner_type: "myCollectionArtwork",
+ *    destination_screen_owner_type: "sell"
+ *    subject: "Learn more"
+ *  }
+ * ```
+ */
+export interface TappedSell {
+    action: ActionType.tappedSell;
+    context_module: ContextModule;
+    context_screen_owner_type: ScreenOwnerType;
+    context_screen_owner_id?: string;
+    context_screen_owner_slug?: string;
+    destination_screen_owner_type: OwnerType.sell;
+    subject: string;
+}
+/**
  * A user taps an icon on the tab bar
@@ -445,4 +493,4 @@ *
     context_screen_owner_type: ScreenOwnerType;
-    context_screen_owner_id: string;
-    context_screen_owner_slug: string;
+    context_screen_owner_id?: string;
+    context_screen_owner_slug?: string;
     /** The text of the tapped button */
@@ -449,0 +497,0 @@ subject: string;

dist/Schema/Values/ContextModule.d.ts

@@ -63,2 +63,4 @@ /**
     moreSeriesByThisArtist = "moreSeriesByThisArtist",
+    myCollectionArtwork = "myCollectionArtwork",
+    myCollectionHome = "myCollectionHome",
     newWorksByArtistsYouFollowRail = "newWorksByArtistsYouFollowRail",
@@ -65,0 +67,0 @@ newWorksByGalleriesYouFollowRail = "newWorksByGalleriesYouFollowRail",

dist/Schema/Values/ContextModule.js

@@ -77,2 +77,4 @@ "use strict";
   ContextModule["moreSeriesByThisArtist"] = "moreSeriesByThisArtist";
+  ContextModule["myCollectionArtwork"] = "myCollectionArtwork";
+  ContextModule["myCollectionHome"] = "myCollectionHome";
   ContextModule["newWorksByArtistsYouFollowRail"] = "newWorksByArtistsYouFollowRail";
@@ -79,0 +81,0 @@ ContextModule["newWorksByGalleriesYouFollowRail"] = "newWorksByGalleriesYouFollowRail";

dist/Schema/Values/OwnerType.d.ts

@@ -33,2 +33,4 @@ /**
     inbox = "inbox",
+    myCollection = "myCollection",
+    myCollectionArtwork = "myCollectionArtwork",
     partner = "partner",
@@ -53,3 +55,3 @@ profile = "profile",
  */
-export declare type ScreenOwnerType = OwnerType.allArtistSeries | OwnerType.article | OwnerType.articles | OwnerType.artist | OwnerType.artistInsights | OwnerType.artistSeries | OwnerType.artwork | OwnerType.auctionResult | OwnerType.auctions | OwnerType.gene | OwnerType.cityGuideGuide | OwnerType.cityGuideMap | OwnerType.cityPicker | OwnerType.collection | OwnerType.consignmentSubmission | OwnerType.consign | OwnerType.explore | OwnerType.fair | OwnerType.fairArtworks | OwnerType.home | OwnerType.inbox | OwnerType.partner | OwnerType.profile | OwnerType.sale | OwnerType.saleInformation | OwnerType.search | OwnerType.savesAndFollows | OwnerType.sell | OwnerType.show | OwnerType.viewingRoom | OwnerType.viewingRoomArtworks | OwnerType.viewingRoomList | OwnerType.viewingRoomArtworkPage | OwnerType.worksForYou;
+export declare type ScreenOwnerType = OwnerType.allArtistSeries | OwnerType.article | OwnerType.articles | OwnerType.artist | OwnerType.artistInsights | OwnerType.artistSeries | OwnerType.artwork | OwnerType.auctionResult | OwnerType.auctions | OwnerType.gene | OwnerType.cityGuideGuide | OwnerType.cityGuideMap | OwnerType.cityPicker | OwnerType.collection | OwnerType.consignmentSubmission | OwnerType.consign | OwnerType.explore | OwnerType.fair | OwnerType.fairArtworks | OwnerType.home | OwnerType.inbox | OwnerType.myCollection | OwnerType.myCollectionArtwork | OwnerType.partner | OwnerType.profile | OwnerType.sale | OwnerType.saleInformation | OwnerType.search | OwnerType.savesAndFollows | OwnerType.sell | OwnerType.show | OwnerType.viewingRoom | OwnerType.viewingRoomArtworks | OwnerType.viewingRoomList | OwnerType.viewingRoomArtworkPage | OwnerType.worksForYou;
 /**
@@ -56,0 +58,0 @@ * Owner types available in web/mobile web

dist/Schema/Values/OwnerType.js

@@ -47,2 +47,4 @@ "use strict";
   OwnerType["inbox"] = "inbox";
+  OwnerType["myCollection"] = "myCollection";
+  OwnerType["myCollectionArtwork"] = "myCollectionArtwork";
   OwnerType["partner"] = "partner";
@@ -49,0 +51,0 @@ OwnerType["profile"] = "profile";

package.json

 {
   "name": "@artsy/cohesion",
-  "version": "1.63.0",
+  "version": "1.64.0",
   "description": "Analytics schema and library helpers",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

No alert changes

Improved metrics

Total package byte prevSize

204692

increased by3.19%

Number of package files

124

increased by1.64%

Lines of code

5049

increased by3.95%

No dependency changes