@artsy/cohesion 4.21.0 → 4.25.0

package/CHANGELOG.md

@@ -1,3 +1,52 @@
+# v4.25.0 (Mon Nov 29 2021)
+
+#### 🚀  Enhancement
+
+- [FX-3343] Remove deprecated clickedAppDownload helper [#261](https://github.com/artsy/cohesion/pull/261) ([@lidimayra](https://github.com/lidimayra) [@mdole](https://github.com/mdole))
+
+#### Authors: 2
+
+- Lidiane Taquehara ([@lidimayra](https://github.com/lidimayra))
+- Matt Dole ([@mdole](https://github.com/mdole))
+
+---
+
+# v4.24.0 (Mon Nov 29 2021)
+
+#### 🚀  Enhancement
+
+- [FX-3344] Remove deprecated clickedArticleGroup helper [#267](https://github.com/artsy/cohesion/pull/267) ([@lidimayra](https://github.com/lidimayra))
+
+#### Authors: 1
+
+- Lidiane Taquehara ([@lidimayra](https://github.com/lidimayra))
+
+---
+
+# v4.23.0 (Tue Nov 23 2021)
+
+#### 🚀  Enhancement
+
+- [AS-2774] Creating new event for the new offer submission flow [#266](https://github.com/artsy/cohesion/pull/266) (dayanetavares@Dayanes-MBP.fritz.box)
+
+#### Authors: 1
+
+- Dayane Tavares ([@daytavares](https://github.com/daytavares))
+
+---
+
+# v4.22.0 (Tue Nov 23 2021)
+
+#### 🚀  Enhancement
+
+- Web Alert events [#262](https://github.com/artsy/cohesion/pull/262) ([@louislecluse](https://github.com/louislecluse))
+
+#### Authors: 1
+
+- [@louislecluse](https://github.com/louislecluse)
+
+---
+
 # v4.21.0 (Thu Nov 18 2021)
 
 #### 🚀  Enhancement

package/dist/DeprecatedHelpers/index.d.ts

@@ -1,7 +1,5 @@
 export * from "./AddToCalendar";
 export * from "./Share";
-export * from "./Click/ClickedAppDownload";
-export * from "./Click/ClickedArticleGroup";
 export * from "./Click/ClickedArtistSeriesGroup";
 export * from "./Click/ClickedCollectionGroup";
 export * from "./Click/ClickedEntityGroup";

package/dist/DeprecatedHelpers/index.js

@@ -28,30 +28,6 @@ Object.keys(_Share).forEach(function (key) {
   });
 });
 
-var _ClickedAppDownload = require("./Click/ClickedAppDownload");
-
-Object.keys(_ClickedAppDownload).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function get() {
-      return _ClickedAppDownload[key];
-    }
-  });
-});
-
-var _ClickedArticleGroup = require("./Click/ClickedArticleGroup");
-
-Object.keys(_ClickedArticleGroup).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function get() {
-      return _ClickedArticleGroup[key];
-    }
-  });
-});
-
 var _ClickedArtistSeriesGroup = require("./Click/ClickedArtistSeriesGroup");
 
 Object.keys(_ClickedArtistSeriesGroup).forEach(function (key) {

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

@@ -491,6 +491,35 @@ export interface ClickedNavigationTab {
     destination_path: string;
     subject: string;
 }
+/**
+ *  User clicks in one of the price options on the offer page
+ *
+ *  This schema describes events sent to Segment from [[clickedOfferOption]]
+ *
+ *  @example
+ *  ```
+ *  {
+ *    action: "clickedOfferOption",
+ *    flow: "Make Offer",
+ *    context_page_owner_type: "orders-offer",
+ *    context_page_owner_id: "dd0cbbb5-300b-4c49-92a1-fed55b077fa9",
+ *    order_id: "407dd09f-4afd-4aad-a6cc-1d6704dc2b11",
+ *    offer: "20% below the list price",
+ *    amount: 2000,
+ *    currency: "USD"
+ *  }
+ * ```
+ */
+export interface ClickedOfferOption {
+    action: ActionType.clickedOfferOption;
+    flow: string;
+    context_page_owner_type: string;
+    context_page_owner_id: string;
+    order_id: string;
+    offer: string;
+    amount: number;
+    currency: string;
+}
 /**
  * A Partner clicks on Artwork weight (without packaging) bar in the artwork edit page
  * in CMS.
@@ -928,3 +957,24 @@ export interface ClickedPromoSpace {
     destination_path: string;
     subject: string;
 }
+/**
+ * A user clicks create alert button
+ *
+ * This schema describes events sent to Segment from [[clickedCreateAlert]]
+ *
+ *  @example
+ *  ```
+ *  {
+ *    action: "clickedCreateAlert",
+ *    context_page_owner_type: "artist",
+ *    context_page_owner_id: "5359794d1a1e86c3740001f7",
+ *    context_page_owner_slug: "anthony-hunter",
+ *  }
+ * ```
+ */
+export interface ClickedCreateAlert {
+    action: ActionType.clickedCreateAlert;
+    context_page_owner_type: PageOwnerType;
+    context_page_owner_id?: string;
+    context_page_owner_slug?: string;
+}

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

@@ -34,7 +34,7 @@ export interface ToggledNotification {
     subject: PushNotificationType;
 }
 /**
- * A user toggles a saved search on/off on iOS
+ * A user toggles a saved search on/off on an app or web
  *
  *  This schema describes events sent to Segment from [[toggledNotification]]
  *
@@ -56,7 +56,7 @@ export interface ToggledSavedSearch {
     context_screen_owner_type: ScreenOwnerType;
     context_screen_owner_id?: string;
     context_screen_owner_slug?: string;
-    modified: boolean;
-    original: boolean;
+    modified?: boolean;
+    original?: boolean;
     search_criteria_id: string;
 }

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

@@ -1,6 +1,6 @@
 import { AddToCalendar } from "./AddToCalendar";
 import { AuthImpression, CreatedAccount, OnboardingUserInputData, ResetYourPassword, SuccessfullyLoggedIn } from "./Authentication";
-import { ClickedAddNewShippingAddress, ClickedAddWorksToFair, ClickedAppDownload, ClickedArticleGroup, ClickedArtistGroup, ClickedArtistSeriesGroup, ClickedArtworkGroup, ClickedAuctionGroup, ClickedBuyerProtection, ClickedChangePage, ClickedChangePaymentMethod, ClickedChangeShippingAddress, ClickedChangeShippingMethod, ClickedCollectionGroup, ClickedDeliveryMethod, ClickedEditArtwork, ClickedExpansionToggle, ClickedFairCard, ClickedFairGroup, ClickedGalleryGroup, ClickedLoadMore, ClickedMainArtworkGrid, ClickedNavigationTab, ClickedOnArtworkShippingUnitsDropdown, ClickedOnArtworkShippingWeight, ClickedOnFramedMeasurements, ClickedOnFramedMeasurementsDropdown, ClickedOnSubmitOrder, ClickedPartnerCard, 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, ClickedPromoSpace, ClickedSelectShippingOption, ClickedShippingAddress, ClickedShowGroup, ClickedShowMore, ClickedSnooze, ClickedVerifyIdentity, ClickedViewingRoomCard } from "./Click";
 import { ConsignmentSubmitted } from "./Consignments";
 import { FocusedOnConversationMessageInput, SentConversationMessage, TappedInboxConversation, TappedMakeOffer, TappedViewOffer } from "./Conversations";
 import { AuctionResultsFilterParamsChanged, CommercialFilterParamsChanged, PriceDatabaseFilterParamsChanged } from "./FilterAndSort";
@@ -18,7 +18,7 @@ import { ToggledNotification, ToggledSavedSearch } from "./Toggle";
  *
  * Each event describes one ActionType
  */
-export declare type Event = AddToCalendar | AddCollectedArtwork | AuctionResultsFilterParamsChanged | AuthImpression | CreatedAccount | ClickedAddNewShippingAddress | ClickedAddWorksToFair | ClickedAppDownload | ClickedArticleGroup | ClickedArtistGroup | ClickedArtistSeriesGroup | ClickedArtworkGroup | ClickedAuctionGroup | ClickedBuyerProtection | ClickedChangePage | ClickedChangePaymentMethod | ClickedChangeShippingAddress | ClickedChangeShippingMethod | ClickedCollectionGroup | ClickedDeliveryMethod | ClickedEditArtwork | ClickedExpansionToggle | ClickedFairCard | ClickedFairGroup | ClickedGalleryGroup | ClickedLoadMore | ClickedMainArtworkGrid | ClickedNavigationTab | ClickedOnArtworkShippingWeight | ClickedOnArtworkShippingUnitsDropdown | ClickedOnFramedMeasurements | ClickedOnFramedMeasurementsDropdown | ClickedOnSubmitOrder | ClickedSnooze | ClickedPartnerCard | ClickedPromoSpace | ClickedSelectShippingOption | ClickedShippingAddress | ClickedShowGroup | ClickedShowMore | ClickedVerifyIdentity | ClickedViewingRoomCard | CommercialFilterParamsChanged | ConsignmentArtistFailed | ConsignmentSubmitted | DeleteCollectedArtwork | DeletedSavedSearch | EditCollectedArtwork | EditedSavedSearch | FocusedOnConversationMessageInput | FocusedOnSearchInput | FocusedOnPriceDatabaseSearchInput | FollowEvents | OnboardingUserInputData | PriceDatabaseFilterParamsChanged | PromptForReview | ResetYourPassword | SaleScreenLoadComplete | Screen | SearchedPriceDatabase | SearchedWithNoResults | SelectedItemFromSearch | SelectedItemFromPriceDatabaseSearch | SentConversationMessage | Share | 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 | TappedSell | TappedShowMore | TappedTabBar | TappedVerifyIdentity | TappedViewingRoomCard | TappedViewingRoomGroup | TappedViewOffer | TimeOnPage | ToggledNotification | ToggledSavedSearch;
+export declare type Event = AddToCalendar | AddCollectedArtwork | AuctionResultsFilterParamsChanged | AuthImpression | CreatedAccount | 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 | ClickedPromoSpace | ClickedSelectShippingOption | ClickedShippingAddress | ClickedShowGroup | ClickedShowMore | ClickedVerifyIdentity | ClickedViewingRoomCard | CommercialFilterParamsChanged | ConsignmentArtistFailed | ConsignmentSubmitted | DeleteCollectedArtwork | DeletedSavedSearch | EditCollectedArtwork | EditedSavedSearch | FocusedOnConversationMessageInput | FocusedOnSearchInput | FocusedOnPriceDatabaseSearchInput | FollowEvents | OnboardingUserInputData | PriceDatabaseFilterParamsChanged | PromptForReview | ResetYourPassword | SaleScreenLoadComplete | Screen | SearchedPriceDatabase | SearchedWithNoResults | SelectedItemFromSearch | SelectedItemFromPriceDatabaseSearch | SentConversationMessage | Share | 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 | TappedSell | TappedShowMore | TappedTabBar | TappedVerifyIdentity | TappedViewingRoomCard | TappedViewingRoomGroup | TappedViewOffer | TimeOnPage | ToggledNotification | ToggledSavedSearch;
 /**
  * The top-level actions an Event describes.
  *
@@ -97,6 +97,10 @@ export declare enum ActionType {
      * Corresponds to {@link ClickedCollectionGroup}
      */
     clickedCollectionGroup = "clickedCollectionGroup",
+    /**
+     * Corresponds to {@link ClickedCreateAlert}
+     */
+    clickedCreateAlert = "clickedCreateAlert",
     /**
      * Corresponds to {@link ClickedDeliveryMethod}
      */
@@ -137,6 +141,10 @@ export declare enum ActionType {
     /**
      * Corresponds to {@link ClickedOnArtworkShippingUnitsDropdown}
      */
+    clickedOfferOption = "clickedOfferOption",
+    /**
+     * Corresponds to {@link ClickedOfferOption}
+     */
     clickedOnArtworkShippingUnitsDropdown = "clickedOnArtworkShippingUnitsDropdown",
     /**
      * Corresponds to {@link ClickedOnArtworkShippingWeight}

package/dist/Schema/Events/index.js

@@ -38,6 +38,7 @@ exports.ActionType = ActionType;
   ActionType["clickedChangeShippingMethod"] = "clickedChangeShippingMethod";
   ActionType["clickedChangePaymentMethod"] = "clickedChangePaymentMethod";
   ActionType["clickedCollectionGroup"] = "clickedCollectionGroup";
+  ActionType["clickedCreateAlert"] = "clickedCreateAlert";
   ActionType["clickedDeliveryMethod"] = "clickedDeliveryMethod";
   ActionType["clickedEditArtwork"] = "clickedEditArtwork";
   ActionType["clickedExpansionToggle"] = "clickedExpansionToggle";
@@ -47,6 +48,7 @@ exports.ActionType = ActionType;
   ActionType["clickedLoadMore"] = "clickedLoadMore";
   ActionType["clickedMainArtworkGrid"] = "clickedMainArtworkGrid";
   ActionType["clickedNavigationTab"] = "clickedNavigationTab";
+  ActionType["clickedOfferOption"] = "clickedOfferOption";
   ActionType["clickedOnArtworkShippingUnitsDropdown"] = "clickedOnArtworkShippingUnitsDropdown";
   ActionType["clickedOnArtworkShippingWeight"] = "clickedOnArtworkShippingWeight";
   ActionType["clickedOnFramedMeasurements"] = "clickedOnFramedMeasurements";

package/package.json

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

package/dist/DeprecatedHelpers/Click/ClickedAppDownload.d.ts

@@ -1,2 +0,0 @@
-import { ClickedAppDownload } from "../../Schema";
-export declare const clickedAppDownload: (props: Omit<ClickedAppDownload, "action">) => ClickedAppDownload;

package/dist/DeprecatedHelpers/Click/ClickedAppDownload.js

@@ -1,22 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.clickedAppDownload = void 0;
-
-var _Schema = require("../../Schema");
-
-var clickedAppDownload = function clickedAppDownload(props) {
-  return {
-    action: _Schema.ActionType.clickedAppDownload,
-    context_module: props.context_module,
-    context_page_owner_id: props.context_page_owner_id,
-    context_page_owner_slug: props.context_page_owner_slug,
-    context_page_owner_type: props.context_page_owner_type,
-    destination_path: props.destination_path,
-    subject: props.subject
-  };
-};
-
-exports.clickedAppDownload = clickedAppDownload;

package/dist/DeprecatedHelpers/Click/ClickedArticleGroup.d.ts

@@ -1,2 +0,0 @@
-import { ClickedArticleGroup } from "../../Schema";
-export declare const clickedArticleGroup: (props: Omit<ClickedArticleGroup, "action" | "type">) => ClickedArticleGroup;

package/dist/DeprecatedHelpers/Click/ClickedArticleGroup.js

@@ -1,22 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.clickedArticleGroup = void 0;
-
-var _Schema = require("../../Schema");
-
-var clickedArticleGroup = function clickedArticleGroup(props) {
-  return {
-    action: _Schema.ActionType.clickedArticleGroup,
-    context_module: _Schema.ContextModule.relatedArticles,
-    context_page_owner_type: props.context_page_owner_type,
-    destination_page_owner_id: props.destination_page_owner_id,
-    destination_page_owner_slug: props.destination_page_owner_slug,
-    destination_page_owner_type: props.destination_page_owner_type,
-    type: "thumbnail"
-  };
-};
-
-exports.clickedArticleGroup = clickedArticleGroup;