@artsy/cohesion 4.46.0 → 4.47.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# v4.47.0 (Mon May 16 2022)
+
+#### 🚀  Enhancement
+
+- feat: adds schema for article events [#318](https://github.com/artsy/cohesion/pull/318) ([@dzucconi](https://github.com/dzucconi))
+
+#### Authors: 1
+
+- Damon ([@dzucconi](https://github.com/dzucconi))
+
+---
+
 # v4.46.0 (Tue May 10 2022)
 
 #### 🚀  Enhancement

package/dist/Schema/Events/Click.d.ts

@@ -1030,3 +1030,115 @@ export interface ClickedCreateAlert {
     context_page_owner_id?: string;
     context_page_owner_slug?: string;
 }
+/**
+ * A user clicks the external news source of an article
+ *
+ * This schema describes events sent to Segment from [[clickedExternalNewsSource]]
+ *
+ *  @example
+ *  ```
+ *  {
+ *    action: "clickedExternalNewsSource",
+ *    context_page_owner_type: "article",
+ *    context_page_owner_id: "62389c0a0b01c80022eb82a1",
+ *    context_page_owner_slug: "artsy-editorial-making-generative-art-changed-understanding",
+ *  }
+ * ```
+ */
+export interface ClickedExternalNewsSource {
+    action: ActionType.clickedExternalNewsSource;
+    context_owner_id: string;
+    context_owner_slug: string;
+    context_owner_type: PageOwnerType;
+    destination_path: string;
+}
+/**
+ * A user clicks on the sponsor of an article
+ *
+ * This schema describes events sent to Segment from [[clickedSponsorLink]]
+ *
+ *  @example
+ *  ```
+ *  {
+ *    action: "clickedSponsorLink",
+ *    context_page_owner_type: "article",
+ *    context_page_owner_id: "62389c0a0b01c80022eb82a1",
+ *    context_page_owner_slug: "artsy-editorial-making-generative-art-changed-understanding",
+ *    destination_path: "https://www.bmw.com/",
+ *  }
+ * ```
+ */
+export interface ClickedSponsorLink {
+    action: ActionType.clickedSponsorLink;
+    context_owner_id: string;
+    context_owner_slug: string;
+    context_owner_type: PageOwnerType;
+    destination_path: string;
+}
+/**
+ * A user clicks to share an article
+ *
+ * This schema describes events sent to Segment from [[clickedArticleShare]]
+ *
+ *  @example
+ *  ```
+ *  {
+ *    action: "clickedArticleShare",
+ *    context_page_owner_type: "article",
+ *    context_page_owner_id: "62389c0a0b01c80022eb82a1",
+ *    context_page_owner_slug: "artsy-editorial-making-generative-art-changed-understanding",
+ *  }
+ * ```
+ */
+export interface ClickedArticleShare {
+    action: ActionType.clickedArticleShare;
+    context_owner_id: string;
+    context_owner_slug: string;
+    context_owner_type: PageOwnerType;
+}
+/**
+ * A user clicks to play a video
+ *
+ * This schema describes events sent to Segment from [[clickedPlayVideo]]
+ *
+ *  @example
+ *  ```
+ *  {
+ *    action: "clickedPlayVideo",
+ *    context_page_owner_type: "article",
+ *    context_page_owner_id: "62389c0a0b01c80022eb82a1",
+ *    context_page_owner_slug: "artsy-editorial-making-generative-art-changed-understanding",
+ *  }
+ * ```
+ */
+export interface ClickedPlayVideo {
+    action: ActionType.clickedPlayVideo;
+    context_owner_id: string;
+    context_owner_slug: string;
+    context_owner_type: PageOwnerType;
+}
+/**
+ * A user an entity within a tooltip. `type` will be an artist, gene, or partner.
+ *
+ * This schema describes events sent to Segment from [[clickedTooltip]]
+ *
+ *  @example
+ *  ```
+ *  {
+ *    action: "clickedTooltip",
+ *    context_page_owner_type: "artist",
+ *    context_page_owner_id: "4d8b926a4eb68a1b2c0000ae",
+ *    context_page_owner_slug: "damien-hirst",
+ *    destination_path: "/artist/damien-hirst",
+ *    type: "artist",
+ *  }
+ * ```
+ */
+export interface ClickedTooltip {
+    action: ActionType.clickedTooltip;
+    context_owner_id: string;
+    context_owner_slug: string;
+    context_owner_type: PageOwnerType;
+    destination_path: string;
+    type: string;
+}

package/dist/Schema/Events/Impression.d.ts

@@ -0,0 +1,10 @@
+import { ContextModule } from "../Values/ContextModule";
+import { OwnerType } from "../Values/OwnerType";
+import { ActionType } from ".";
+export interface Impression {
+    action: ActionType.impression;
+    context_module: ContextModule;
+    context_owner_id: string;
+    context_owner_slug: string;
+    context_owner_type: OwnerType;
+}

package/dist/Schema/Events/Impression.js

@@ -0,0 +1 @@
+"use strict";

package/dist/Schema/Events/index.d.ts

@@ -1,7 +1,7 @@
 import { AddToCalendar } from "./AddToCalendar";
 import { AuctionPageView, BidPageView, ClickedActiveBid, ClickedRegisterToBid, ConfirmBid, ConfirmRegistrationPageview, EnterLiveAuction, MaxBidSelected, RegistrationPageView, RegistrationSubmitted } from "./Auction";
 import { AuthImpression, CreatedAccount, OnboardingUserInputData, ResetYourPassword, SuccessfullyLoggedIn } from "./Authentication";
-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, ClickedPaymentMethod, ClickedPaymentDetails, ClickedPromoSpace, ClickedSelectShippingOption, ClickedShippingAddress, ClickedShowGroup, ClickedShowMore, ClickedSnooze, ClickedVerifyIdentity, ClickedViewingRoomCard } from "./Click";
+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, ClickedPaymentDetails, ClickedPaymentMethod, ClickedPromoSpace, ClickedSelectShippingOption, ClickedShippingAddress, ClickedShowGroup, ClickedShowMore, ClickedSnooze, ClickedVerifyIdentity, ClickedViewingRoomCard } from "./Click";
 import { ArtworkDetailsCompleted, ConsignmentSubmitted, SubmitAnotherArtwork, UploadPhotosCompleted, ViewArtworkMyCollection } from "./Consignments";
 import { FocusedOnConversationMessageInput, SentConversationMessage, TappedInboxConversation, TappedMakeOffer, TappedViewOffer } from "./Conversations";
 import { ExperimentViewed } from "./ExperimentViewed";
@@ -76,6 +76,10 @@ export declare enum ActionType {
      * Corresponds to {@link ClickedArticleGroup}
      */
     clickedArticleGroup = "clickedArticleGroup",
+    /**
+     * Corresponds to {@link ClickedArticleShare}
+     */
+    clickedArticleShare = "clickedArticleShare",
     /**
      * Corresponds to {@link ClickedArtistGroup}
      */
@@ -132,6 +136,10 @@ export declare enum ActionType {
      * Corresponds to {@link ClickedExpansionToggle}
      */
     clickedExpansionToggle = "clickedExpansionToggle",
+    /**
+     * Corresponds to {@link ClickedExternalNewsSource}
+     */
+    clickedExternalNewsSource = "clickedExternalNewsSource",
     /**
      * Corresponds to {@link ClickedFairCard}
      */
@@ -189,6 +197,10 @@ export declare enum ActionType {
      * Corresponds to {@link ClickedPartnerCard}
      */
     clickedPartnerCard = "clickedPartnerCard",
+    /**
+     * Corresponds to {@link ClickedPlayVideo}
+     */
+    clickedPlayVideo = "clickedPlayVideo",
     /**
      * Corresponds to {@link ClickedPromoSpace}
      */
@@ -221,6 +233,14 @@ export declare enum ActionType {
      * Corresponds to {@link ClickedShowMore}
      */
     clickedShowMore = "clickedShowMore",
+    /**
+     * Corresponds to {@link ClickedSponsorLink}
+     */
+    clickedSponsorLink = "clickedSponsorLink",
+    /**
+     * Corresponds to {@link ClickedTooltip}
+     */
+    clickedTooltip = "clickedTooltip",
     /**
      * Corresponds to {@link ClickedVerifyIdentiity}
      */
@@ -309,6 +329,10 @@ export declare enum ActionType {
      * Corresponds to {@link FollowedPartner}
      */
     followedPartner = "followedPartner",
+    /**
+     * Corresponds to {@link Impression}
+     */
+    impression = "impression",
     /**
      * Corresponds to {@link MaxBidSelected}
      */

package/dist/Schema/Events/index.js

@@ -32,6 +32,7 @@ exports.ActionType = ActionType;
   ActionType["clickedAddWorksToFair"] = "clickedAddWorksToFair";
   ActionType["clickedAppDownload"] = "clickedAppDownload";
   ActionType["clickedArticleGroup"] = "clickedArticleGroup";
+  ActionType["clickedArticleShare"] = "clickedArticleShare";
   ActionType["clickedArtistGroup"] = "clickedArtistGroup";
   ActionType["clickedArtistSeriesGroup"] = "clickedArtistSeriesGroup";
   ActionType["clickedArtworkGroup"] = "clickedArtworkGroup";
@@ -46,6 +47,7 @@ exports.ActionType = ActionType;
   ActionType["clickedDeliveryMethod"] = "clickedDeliveryMethod";
   ActionType["clickedEditArtwork"] = "clickedEditArtwork";
   ActionType["clickedExpansionToggle"] = "clickedExpansionToggle";
+  ActionType["clickedExternalNewsSource"] = "clickedExternalNewsSource";
   ActionType["clickedFairCard"] = "clickedFairCard";
   ActionType["clickedFairGroup"] = "clickedFairGroup";
   ActionType["clickedGalleryGroup"] = "clickedGalleryGroup";
@@ -60,6 +62,7 @@ exports.ActionType = ActionType;
   ActionType["clickedOnSubmitOrder"] = "clickedOnSubmitOrder";
   ActionType["clickedSnooze"] = "clickedSnooze";
   ActionType["clickedPartnerCard"] = "clickedPartnerCard";
+  ActionType["clickedPlayVideo"] = "clickedPlayVideo";
   ActionType["clickedPaymentMethod"] = "clickedPaymentMethod";
   ActionType["clickedPaymentDetails"] = "clickedPaymentDetails";
   ActionType["clickedPromoSpace"] = "clickedPromoSpace";
@@ -68,6 +71,8 @@ exports.ActionType = ActionType;
   ActionType["clickedShippingAddress"] = "clickedShippingAddress";
   ActionType["clickedShowGroup"] = "clickedShowGroup";
   ActionType["clickedShowMore"] = "clickedShowMore";
+  ActionType["clickedSponsorLink"] = "clickedSponsorLink";
+  ActionType["clickedTooltip"] = "clickedTooltip";
   ActionType["clickedVerifyIdentity"] = "clickedVerifyIdentity";
   ActionType["clickedViewingRoomCard"] = "clickedViewingRoomCard";
   ActionType["commercialFilterParamsChanged"] = "commercialFilterParamsChanged";
@@ -90,6 +95,7 @@ exports.ActionType = ActionType;
   ActionType["followedFair"] = "followedFair";
   ActionType["followedGene"] = "followedGene";
   ActionType["followedPartner"] = "followedPartner";
+  ActionType["impression"] = "impression";
   ActionType["maxBidSelected"] = "maxBidSelected";
   ActionType["onboardingUserInputData"] = "onboardingUserInputData";
   ActionType["priceDatabaseFilterParamsChanged"] = "priceDatabaseFilterParamsChanged";

package/dist/Schema/Values/ContextModule.d.ts

@@ -7,6 +7,7 @@
 export declare enum ContextModule {
     aboutTheWork = "aboutTheWork",
     aboutThisAuction = "aboutThisAuction",
+    adServer = "adServer",
     articleArtist = "articleArtist",
     articleRail = "articleRail",
     articles = "articles",

package/dist/Schema/Values/ContextModule.js

@@ -21,6 +21,7 @@ exports.ContextModule = ContextModule;
 (function (ContextModule) {
   ContextModule["aboutTheWork"] = "aboutTheWork";
   ContextModule["aboutThisAuction"] = "aboutThisAuction";
+  ContextModule["adServer"] = "adServer";
   ContextModule["articleArtist"] = "articleArtist";
   ContextModule["articleRail"] = "articleRail";
   ContextModule["articles"] = "articles";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@artsy/cohesion",
-  "version": "4.46.0",
+  "version": "4.47.0",
   "description": "Analytics schema",
   "main": "dist/index.js",
   "publishConfig": {