@artsy/cohesion - npm Package Compare versions

Comparing version 1.61.0 to 1.62.0

CHANGELOG.md

@@ -0,1 +1,13 @@
+# v1.62.0 (Tue Nov 24 2020)
+
+#### 🚀  Enhancement
+
+- Add new events and contexts for auction results on iOS [#134](https://github.com/artsy/cohesion/pull/134) ([@mikehrom](https://github.com/mikehrom))
+
+#### Authors: 1
+
+- mike hromchak ([@mikehrom](https://github.com/mikehrom))
+
+---
+
 # v1.61.0 (Mon Nov 23 2020)
@@ -2,0 +14,0 @@

dist/Schema/Events/FilterAndSort.d.ts

@@ -38,4 +38,22 @@ import { ContextModule } from "../Values/ContextModule";
 /**
- * A user applies filters to a filterable/sortable module
+ * Master list of filter params available in web and iOS, specific to auction results
  *
+ * Intended action by a user that triggered an event
+ * @packageDocumentation
+ */
+export interface AuctionResultsFilterParams {
+    allowEmptyCreatedDates?: boolean;
+    categories?: string[];
+    createdAfterYear?: string;
+    createdBeforeYear?: string;
+    earliestCreatedYear?: string;
+    latestCreatedYear?: string;
+    organizations?: string[];
+    pageAndCursor?: string[];
+    sizes?: string[];
+    sort?: string;
+}
+/**
+ * A user applies filters to a filterable/sortable artworks or auction results module
+ *
  * This schema describes events sent to Segment from [[CommercialFilterParamsChanged]]
@@ -58,8 +76,8 @@ *
     action: ActionType.commercialFilterParamsChanged;
-    context_module: ContextModule.artworkGrid;
+    context_module: ContextModule.artworkGrid | ContextModule.auctionResults;
     context_owner_type: OwnerType;
     context_owner_id?: string;
     context_owner_slug?: string;
-    current: CommercialFilterParams;
-    changed: CommercialFilterParams;
+    current: CommercialFilterParams | AuctionResultsFilterParams;
+    changed: CommercialFilterParams | AuctionResultsFilterParams;
 }

dist/Schema/Events/index.d.ts

@@ -8,3 +8,3 @@ import { AddToCalendar } from "./AddToCalendar";
 import { SaleScreenLoadComplete, TimeOnPage } from "./System";
-import { TappedArticleGroup, TappedArtistGroup, TappedArtistSeriesGroup, TappedArtworkGroup, TappedAuctionGroup, 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, TappedMainArtworkGrid, TappedNavigationTab, TappedPartnerCard, TappedPromoSpace, TappedShowMore, TappedTabBar, TappedViewingRoomCard, TappedViewingRoomGroup } from "./Tap";
 import { ToggledNotification } from "./Toggle";
@@ -16,3 +16,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 | TappedCollectionGroup | TappedExploreGroup | TappedFairCard | TappedFairGroup | TappedConsign | TappedNavigationTab | TappedMainArtworkGrid | TappedPartnerCard | TappedPromoSpace | TappedShowMore | TappedTabBar | TappedViewingRoomCard | TappedViewingRoomGroup | TimeOnPage | ToggledNotification;
+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;
 /**
@@ -169,2 +169,6 @@ * The top-level actions an Event describes.
     /**
+     * Corresponds to {@link TappedAuctionResultGroup}
+     */
+    tappedAuctionResultGroup = "tappedAuctionResultGroup",
+    /**
      * Corresponds to {@link TappedCollectionGroup}
@@ -171,0 +175,0 @@ */

dist/Schema/Events/index.js

@@ -59,2 +59,3 @@ "use strict";
   ActionType["tappedAuctionGroup"] = "tappedAuctionGroup";
+  ActionType["tappedAuctionResultGroup"] = "tappedAuctionResultGroup";
   ActionType["tappedCollectionGroup"] = "tappedCollectionGroup";
@@ -61,0 +62,0 @@ ActionType["tappedExploreGroup"] = "tappedExploreGroup";

dist/Schema/Events/Tap.d.ts

@@ -135,2 +135,24 @@ import { ContextModule } from "../Values/ContextModule";
 /**
+ * A user taps a grouping of auction results on iOS
+ *
+ * This schema describes events sent to Segment from [[tappedEntityGroup]]
+ *
+ *  @example
+ *  ```
+ *  {
+ *    action: "tappedAuctionResultGroup",
+ *    context_module: "auctionResults",
+ *    context_screen_owner_type: "artistInsights",
+ *    context_screen_owner_id: "51aa03df8b3b8177260002ab",
+ *    context_screen_owner_slug: "nicolas-party",
+ *    destination_screen_owner_type: "auctionResult",
+ *    destination_screen_owner_id: "6398282",
+ *    type: "thumbnail"
+ *  }
+ * ```
+ */
+export interface TappedAuctionResultGroup extends TappedEntityGroup {
+    action: ActionType.tappedAuctionResultGroup;
+}
+/**
  * A user taps a grouping of collections on iOS
@@ -206,3 +228,3 @@ *
 export interface TappedEntityGroup {
-    action: ActionType.tappedArticleGroup | ActionType.tappedArtistGroup | ActionType.tappedArtistSeriesGroup | ActionType.tappedArtworkGroup | ActionType.tappedAuctionGroup | ActionType.tappedCollectionGroup | ActionType.tappedExploreGroup | ActionType.tappedFairGroup | ActionType.tappedViewingRoomGroup;
+    action: ActionType.tappedArticleGroup | ActionType.tappedArtistGroup | ActionType.tappedArtistSeriesGroup | ActionType.tappedArtworkGroup | ActionType.tappedAuctionGroup | ActionType.tappedAuctionResultGroup | ActionType.tappedCollectionGroup | ActionType.tappedExploreGroup | ActionType.tappedFairGroup | ActionType.tappedViewingRoomGroup;
     context_module: ContextModule;
@@ -209,0 +231,0 @@ context_screen_owner_type: ScreenOwnerType;

dist/Schema/Values/OwnerType.d.ts

@@ -12,4 +12,6 @@ /**
     artists = "artists",
+    artistInsights = "artistInsights",
     artistSeries = "artistSeries",
     artwork = "artwork",
+    auctionResult = "auctionResult",
     auctions = "auctions",
@@ -50,3 +52,3 @@ gene = "gene",
  */
-export declare type ScreenOwnerType = OwnerType.allArtistSeries | OwnerType.article | OwnerType.articles | OwnerType.artist | OwnerType.artistSeries | OwnerType.artwork | 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.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;
 /**
@@ -53,0 +55,0 @@ * Owner types available in web/mobile web

dist/Schema/Values/OwnerType.js

@@ -26,4 +26,6 @@ "use strict";
   OwnerType["artists"] = "artists";
+  OwnerType["artistInsights"] = "artistInsights";
   OwnerType["artistSeries"] = "artistSeries";
   OwnerType["artwork"] = "artwork";
+  OwnerType["auctionResult"] = "auctionResult";
   OwnerType["auctions"] = "auctions";
@@ -30,0 +32,0 @@ OwnerType["gene"] = "gene";

package.json

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

No alert changes

Improved metrics

Total package byte prevSize

198037

increased by1.08%

Lines of code

4855

increased by1.02%

No dependency changes