@artsy/cohesion 4.160.0 → 4.161.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# v4.161.0 (Thu Dec 21 2023)
+
+#### 🚀  Enhancement
+
+- Folio tracking [#477](https://github.com/artsy/cohesion/pull/477) ([@louislecluse](https://github.com/louislecluse))
+
+#### Authors: 1
+
+- [@louislecluse](https://github.com/louislecluse)
+
+---
+
 # v4.160.0 (Wed Dec 20 2023)
 
 #### 🚀  Enhancement

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

@@ -0,0 +1,105 @@
+import { ScreenOwnerType } from "../Values/OwnerType";
+import { ActionType } from ".";
+/**
+ * Schema describing Folio related events
+ * @packageDocumentation
+ */
+/**
+ * A user sends an artwork/show/album from Folio via email
+ *
+ * This schema describes events sent to Segment from [[SentContent]]
+ *
+ *  @example
+ *  ```
+ *  {
+ *    action: "SentContent",
+ *    context_screen_owner_type: "artwork",
+ *    context_screen_owner_id: "id"
+ *    context_screen_owner_slug: "slug"
+ *  }
+ * ```
+ */
+export interface SentContent {
+    action: ActionType.sentContent;
+    context_screen_owner_type: ScreenOwnerType;
+    context_screen_owner_id?: string;
+    context_screen_owner_slug?: string;
+}
+/**
+ * A user creates an Album in Folio
+ *
+ * This schema describes events sent to Segment from [[createdAlbum]]
+ *
+ *  @example
+ *  ```
+ *  {
+ *    action: "createdAlbum",
+ *    context_screen_owner_type: "artwork",
+ *    context_screen_owner_id: "id"
+ *    context_screen_owner_slug: "slug"
+ *  }
+ * ```
+ */
+export interface CreatedAlbum {
+    action: ActionType.createdAlbum;
+    context_screen_owner_type: ScreenOwnerType;
+    context_screen_owner_id?: string;
+    context_screen_owner_slug?: string;
+}
+/**
+ * A user adds content to an Album
+ *
+ * This schema describes events sent to Segment from [[addedToAlbum]]
+ *
+ *  @example
+ *  ```
+ *  {
+ *    action: "addedToAlbum",
+ *    context_screen_owner_type: "artwork",
+ *    context_screen_owner_id: "id"
+ *    context_screen_owner_slug: "slug"
+ *    album_name: "My Album"
+ *  }
+ * ```
+ */
+export interface AddedToAlbum {
+    action: ActionType.addedToAlbum;
+    context_screen_owner_type: ScreenOwnerType;
+    context_screen_owner_id?: string;
+    context_screen_owner_slug?: string;
+    album_name: string;
+}
+/**
+ * A user changes a setting in presentation mode
+ *
+ * This schema describes events sent to Segment from [[toggledPresentationModeSetting]]
+ *
+ *  @example
+ *  ```
+ *  {
+ *    action: "toggledPresentationModeSetting",
+ *    label: "Hide Prices"
+ *    enabled: True
+ *  }
+ * ```
+ */
+export interface ToggledPresentationModeSetting {
+    action: ActionType.toggledPresentationModeSetting;
+    label: string;
+    enabled: boolean;
+}
+/**
+ * A user completes Folio offline sync
+ *
+ * This schema describes events sent to Segment from [[completedOfflineSync]]
+ *
+ *  @example
+ *  ```
+ *  {
+ *    action: "completedOfflineSync"
+ *  }
+ * ```
+ */
+export interface CompletedOfflineSync {
+    action: ActionType.completedOfflineSync;
+}

package/dist/Schema/Events/Folio.js

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

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

@@ -10,6 +10,7 @@ import { FocusedOnConversationMessageInput, SentConversationMessage, TappedInbox
 import { SavedCookieConsentPreferences } from "./CookieConsent";
 import { ExperimentViewed } from "./ExperimentViewed";
 import { AuctionResultsFilterParamsChanged, CommercialFilterParamsChanged, PriceDatabaseFilterParamsChanged, SelectedRecentPriceRange } from "./FilterAndSort";
+import { AddedToAlbum, CompletedOfflineSync, CreatedAlbum, SentContent, ToggledPresentationModeSetting } from "./Folio";
 import { TappedProductCapabilitiesGroup } from "./HomeFeedArtsyOnboarding";
 import { MyCollectionOnboardingCompleted, TappedExploreMyCollection, VisitMyCollection, VisitMyCollectionOnboardingSlide } from "./HomeFeedMyCollectionOnboarding";
 import { Impression } from "./Impression";
@@ -33,7 +34,7 @@ import { ViewedVideo } from "./Video";
  *
  * Each event describes one ActionType
  */
-export type Event = AddedArtworkToArtworkList | AddToCalendar | AddCollectedArtwork | AddressAutoCompletionResult | ArtworkDetailsCompleted | AuctionPageView | AuctionResultsFilterParamsChanged | AuthImpression | BidPageView | CreatedAccount | CreatedArtworkList | ClickedActiveBid | ClickedActivityPanelNotificationItem | ClickedActivityPanelTab | ClickedAddFilters | ClickedAddNewShippingAddress | ClickedAddWorksToFair | ClickedAlertsFilters | ClickedAppDownload | ClickedArticleGroup | ClickedArtistGroup | ClickedArtistSeriesGroup | ClickedArtworkGroup | ClickedAuctionGroup | ClickedAuctionResultItem | ClickedBuyerProtection | ClickedChangePage | ClickedChangePaymentMethod | ClickedChangeShippingAddress | ClickedChangeShippingMethod | ClickedCollectionGroup | ClickedCreateAlert | ClickedDeliveryMethod | ClickedEditArtwork | ClickedExpandFilterPanel | ClickedExpansionToggle | ClickedFairCard | ClickedFairGroup | ClickedGalleryGroup | ClickedLoadMore | ClickedMainArtworkGrid | ClickedNavigationTab | ClickedNavBar | ClickedNotificationsBell | ClickedOfferOption | ClickedOnArtworkShippingWeight | ClickedOnArtworkShippingUnitsDropdown | ClickedOnBuyNowCheckbox | ClickedOnFramedMeasurements | ClickedOnFramedMeasurementsDropdown | ClickedOnMakeOfferCheckbox | ClickedOnDuplicateArtwork | ClickedOnPriceDisplayDropdown | ClickedPublish | ClickedOnSubmitOrder | ClickedSnooze | ClickedUploadArtwork | ClickedPartnerCard | ClickedPartnerLink | ClickedPaymentMethod | ClickedPaymentDetails | CheckedAccountBalance | ClickedPromoSpace | ClickedRegisterToBid | ClickedSelectShippingOption | ClickedShippingAddress | ClickedShowGroup | ClickedShowMore | ClickedVerifyIdentity | ClickedViewingRoomCard | ClickedOfferActions | ClickedOrderPage | ClickedOrderSummary | ClickedDismissInquiry | ClickedMarkSpam | ClickedMarkSold | ClickedConversationsFilter | ClickedValidationAddressOptions | ClickedCloseValidationAddressModal | CommercialFilterParamsChanged | CompletedOnboarding | ConfirmBid | ConfirmRegistrationPageview | ConsignmentArtistFailed | ConsignmentSubmitted | ContactInformationCompleted | DeleteCollectedArtwork | EditedAlert | DeletedArtworkList | DeletedSavedSearch | EditCollectedArtwork | EditedArtworkList | EditedAutocompletedAddress | EditedSavedSearch | EditedUserProfile | EnterLiveAuction | ErrorMessageViewed | ExperimentViewed | ItemViewed | UploadSizeLimitExceeded | FocusedOnConversationMessageInput | FocusedOnSearchInput | FocusedOnPriceDatabaseSearchInput | FollowEvents | Impression | MaxBidSelected | MyCollectionOnboardingCompleted | OnboardingUserInputData | PriceDatabaseFilterParamsChanged | PromptForReview | RailViewed | ValidationAddressViewed | RegistrationPageView | RegistrationSubmitted | ResetYourPassword | SaleScreenLoadComplete | SaveCollectedArtwork | SavedCookieConsentPreferences | Screen | SearchedPriceDatabase | SearchedReverseImageWithNoResults | SearchedReverseImageWithResults | SearchedWithNoResults | SearchedWithResults | SelectedArtworkFromReverseImageSearch | SelectedItemFromSearch | SelectedItemFromPriceDatabaseSearch | SelectedItemFromAddressAutoCompletion | SelectedRecentPriceRange | SelectedSearchSuggestionQuickNavigationItem | SentConsignmentInquiry | SentConversationMessage | SentRequestPriceEstimate | Share | StartedOnboarding | SubmitAnotherArtwork | SuccessfullyLoggedIn | TappedActivityGroup | TappedArticleGroup | TappedArticleShare | TappedArtistGroup | TappedArtistSeriesGroup | TappedArtworkGroup | TappedAuctionGroup | TappedAuctionResultGroup | TappedBid | TappedBrowseSimilarArtworks | TappedBuyNow | TappedCollectedArtwork | TappedCollectedArtworkImages | TappedCollectionGroup | TappedConsign | TappedContactGallery | TappedConsignmentInquiry | TappedCreateAlert | TappedExploreGroup | TappedExploreMyCollection | TappedFairCard | TappedFairGroup | TappedInboxConversation | TappedInfoBubble | TappedLink | TappedNavigationTab | TappedMainArtworkGrid | TappedMakeOffer | TappedMyCollectionInsightsMedianAuctionRailItem | TappedMyCollectionInsightsMedianAuctionPriceChartCareerHighlight | TappedMyCollectionInsightsMedianAuctionPriceChartCategory | TappedMyCollectionInsightsMedianAuctionPriceChartTimeframe | TappedPartnerCard | TappedPickImageFromLibrary | TappedProductCapabilitiesGroup | TappedPromoSpace | TappedRequestPriceEstimate | TappedReverseImageSearch | TappedSell | TappedSellArtwork | TappedShowMore | TappedLearnMore | TappedSkip | TappedTabBar | TappedToggleCameraFlash | TappedVerifyIdentity | TappedViewingRoomCard | TappedViewingRoomGroup | TappedViewOffer | TimeOnPage | ToggledAccordion | ToggledNotification | ToggledSavedSearch | TooltipViewed | UploadPhotosCompleted | ViewArtworkMyCollection | ViewedArtworkList | ViewedVideo | VisitMyCollection | VisitMyCollectionOnboardingSlide;
+export type Event = AddedArtworkToArtworkList | AddedToAlbum | AddToCalendar | AddCollectedArtwork | AddressAutoCompletionResult | ArtworkDetailsCompleted | AuctionPageView | AuctionResultsFilterParamsChanged | AuthImpression | BidPageView | CreatedAccount | CreatedArtworkList | ClickedActiveBid | ClickedActivityPanelNotificationItem | ClickedActivityPanelTab | ClickedAddFilters | ClickedAddNewShippingAddress | ClickedAddWorksToFair | ClickedAlertsFilters | ClickedAppDownload | ClickedArticleGroup | ClickedArtistGroup | ClickedArtistSeriesGroup | ClickedArtworkGroup | ClickedAuctionGroup | ClickedAuctionResultItem | ClickedBuyerProtection | ClickedChangePage | ClickedChangePaymentMethod | ClickedChangeShippingAddress | ClickedChangeShippingMethod | ClickedCollectionGroup | ClickedCreateAlert | ClickedDeliveryMethod | ClickedEditArtwork | ClickedExpandFilterPanel | ClickedExpansionToggle | ClickedFairCard | ClickedFairGroup | ClickedGalleryGroup | ClickedLoadMore | ClickedMainArtworkGrid | ClickedNavigationTab | ClickedNavBar | ClickedNotificationsBell | ClickedOfferOption | ClickedOnArtworkShippingWeight | ClickedOnArtworkShippingUnitsDropdown | ClickedOnBuyNowCheckbox | ClickedOnFramedMeasurements | ClickedOnFramedMeasurementsDropdown | ClickedOnMakeOfferCheckbox | ClickedOnDuplicateArtwork | ClickedOnPriceDisplayDropdown | ClickedPublish | ClickedOnSubmitOrder | ClickedSnooze | ClickedUploadArtwork | ClickedPartnerCard | ClickedPartnerLink | ClickedPaymentMethod | ClickedPaymentDetails | CheckedAccountBalance | ClickedPromoSpace | ClickedRegisterToBid | ClickedSelectShippingOption | ClickedShippingAddress | ClickedShowGroup | ClickedShowMore | ClickedVerifyIdentity | ClickedViewingRoomCard | ClickedOfferActions | ClickedOrderPage | ClickedOrderSummary | ClickedDismissInquiry | ClickedMarkSpam | ClickedMarkSold | ClickedConversationsFilter | ClickedValidationAddressOptions | ClickedCloseValidationAddressModal | CommercialFilterParamsChanged | CompletedOfflineSync | CompletedOnboarding | ConfirmBid | ConfirmRegistrationPageview | ConsignmentArtistFailed | ConsignmentSubmitted | ContactInformationCompleted | CreatedAlbum | DeleteCollectedArtwork | EditedAlert | DeletedArtworkList | DeletedSavedSearch | EditCollectedArtwork | EditedArtworkList | EditedAutocompletedAddress | EditedSavedSearch | EditedUserProfile | EnterLiveAuction | ErrorMessageViewed | ExperimentViewed | ItemViewed | UploadSizeLimitExceeded | FocusedOnConversationMessageInput | FocusedOnSearchInput | FocusedOnPriceDatabaseSearchInput | FollowEvents | Impression | MaxBidSelected | MyCollectionOnboardingCompleted | OnboardingUserInputData | PriceDatabaseFilterParamsChanged | PromptForReview | RailViewed | ValidationAddressViewed | RegistrationPageView | RegistrationSubmitted | ResetYourPassword | SaleScreenLoadComplete | SaveCollectedArtwork | SavedCookieConsentPreferences | Screen | SearchedPriceDatabase | SearchedReverseImageWithNoResults | SearchedReverseImageWithResults | SearchedWithNoResults | SearchedWithResults | SelectedArtworkFromReverseImageSearch | SelectedItemFromSearch | SelectedItemFromPriceDatabaseSearch | SelectedItemFromAddressAutoCompletion | SelectedRecentPriceRange | SelectedSearchSuggestionQuickNavigationItem | SentContent | SentConsignmentInquiry | SentConversationMessage | SentRequestPriceEstimate | Share | StartedOnboarding | SubmitAnotherArtwork | SuccessfullyLoggedIn | TappedActivityGroup | TappedArticleGroup | TappedArticleShare | TappedArtistGroup | TappedArtistSeriesGroup | TappedArtworkGroup | TappedAuctionGroup | TappedAuctionResultGroup | TappedBid | TappedBrowseSimilarArtworks | TappedBuyNow | TappedCollectedArtwork | TappedCollectedArtworkImages | TappedCollectionGroup | TappedConsign | TappedContactGallery | TappedConsignmentInquiry | TappedCreateAlert | TappedExploreGroup | TappedExploreMyCollection | TappedFairCard | TappedFairGroup | TappedInboxConversation | TappedInfoBubble | TappedLink | TappedNavigationTab | TappedMainArtworkGrid | TappedMakeOffer | TappedMyCollectionInsightsMedianAuctionRailItem | TappedMyCollectionInsightsMedianAuctionPriceChartCareerHighlight | TappedMyCollectionInsightsMedianAuctionPriceChartCategory | TappedMyCollectionInsightsMedianAuctionPriceChartTimeframe | TappedPartnerCard | TappedPickImageFromLibrary | TappedProductCapabilitiesGroup | TappedPromoSpace | TappedRequestPriceEstimate | TappedReverseImageSearch | TappedSell | TappedSellArtwork | TappedShowMore | TappedLearnMore | TappedSkip | TappedTabBar | TappedToggleCameraFlash | TappedVerifyIdentity | TappedViewingRoomCard | TappedViewingRoomGroup | TappedViewOffer | TimeOnPage | ToggledAccordion | ToggledNotification | ToggledPresentationModeSetting | ToggledSavedSearch | TooltipViewed | UploadPhotosCompleted | ViewArtworkMyCollection | ViewedArtworkList | ViewedVideo | VisitMyCollection | VisitMyCollectionOnboardingSlide;
 /**
  * The top-level actions an Event describes.
  *
@@ -44,6 +45,10 @@ export declare enum ActionType {
      * Corresponds to {@link AddedArtworkToArtworkList}
      */
     addedArtworkToArtworkList = "addedArtworkToArtworkList",
+    /**
+     * Corresponds to {@link AddedToAlbum}
+     */
+    addedToAlbum = "addedToAlbum",
     /**
      * Corresponds to {@link AddArtworkDetails}
      */
@@ -392,6 +397,10 @@ export declare enum ActionType {
      * Corresponds to {@link CommercialFilterParamsChanged}
      */
     commercialFilterParamsChanged = "commercialFilterParamsChanged",
+    /**
+     * Corresponds to {@link CompletedOfflineSync}
+     */
+    completedOfflineSync = "completedOfflineSync",
     /**
      * Corresponds to {@link CompletedOnboarding}
      */
@@ -420,6 +429,10 @@ export declare enum ActionType {
      * Corresponds to {@link ContactInformationCompleted}
      */
     contactInformationCompleted = "contactInformationCompleted",
+    /**
+     * Corresponds to {@link CreatedAlbum}
+     */
+    createdAlbum = "createdAlbum",
     /**
      * Corresponds to {@link CreatedAccount}
      */
@@ -580,6 +593,10 @@ export declare enum ActionType {
      * Corresponds to {@link SelectedSearchSuggestionQuickNavigationItem}
      */
     selectedSearchSuggestionQuickNavigationItem = "selectedSearchSuggestionQuickNavigationItem",
+    /**
+     * Corresponds to {@link SentContent}
+     */
+    sentContent = "sentContent",
     /**
      * Corresponds to {@link SearchedPriceDatabase}
      */
@@ -908,6 +925,10 @@ export declare enum ActionType {
      * Corresponds to {@link ToggledNotification}
      */
     toggledNotification = "toggledNotification",
+    /**
+     * Corresponds to {@link ToggledPresentationModeSetting}
+     */
+    toggledPresentationModeSetting = "toggledPresentationModeSetting",
     /**
      * Corresponds to {@link ToggledSavedSearch}
      */

package/dist/Schema/Events/index.js

@@ -21,6 +21,7 @@ exports.ActionType = ActionType;
 
 (function (ActionType) {
   ActionType["addedArtworkToArtworkList"] = "addedArtworkToArtworkList";
+  ActionType["addedToAlbum"] = "addedToAlbum";
   ActionType["addArtworkDetails"] = "addArtworkDetails";
   ActionType["addCollectedArtwork"] = "addCollectedArtwork";
   ActionType["addressAutoCompletionResult"] = "addressAutoCompletionResult";
@@ -108,6 +109,7 @@ exports.ActionType = ActionType;
   ActionType["clickedGene"] = "clickedGene";
   ActionType["clickedHighlightAchievement"] = "clickedHighlightAchievement";
   ActionType["commercialFilterParamsChanged"] = "commercialFilterParamsChanged";
+  ActionType["completedOfflineSync"] = "completedOfflineSync";
   ActionType["completedOnboarding"] = "completedOnboarding";
   ActionType["confirmBid"] = "confirmBid";
   ActionType["confirmRegistrationPageview"] = "confirmRegistrationPageview";
@@ -115,6 +117,7 @@ exports.ActionType = ActionType;
   ActionType["consignmentSubmitted"] = "consignmentSubmitted";
   ActionType["contactGallery"] = "contactGallery";
   ActionType["contactInformationCompleted"] = "contactInformationCompleted";
+  ActionType["createdAlbum"] = "createdAlbum";
   ActionType["createdAccount"] = "createdAccount";
   ActionType["createdArtworkList"] = "createdArtworkList";
   ActionType["deleteCollectedArtwork"] = "deleteCollectedArtwork";
@@ -155,6 +158,7 @@ exports.ActionType = ActionType;
   ActionType["savedCookieConsentPreferences"] = "savedCookieConsentPreferences";
   ActionType["screen"] = "screen";
   ActionType["selectedSearchSuggestionQuickNavigationItem"] = "selectedSearchSuggestionQuickNavigationItem";
+  ActionType["sentContent"] = "sentContent";
   ActionType["searchedPriceDatabase"] = "searchedPriceDatabase";
   ActionType["searchedReverseImageWithNoResults"] = "searchedReverseImageWithNoResults";
   ActionType["searchedReverseImageWithResults"] = "searchedReverseImageWithResults";
@@ -237,6 +241,7 @@ exports.ActionType = ActionType;
   ActionType["timeOnPage"] = "timeOnPage";
   ActionType["toggledAccordion"] = "toggledAccordion";
   ActionType["toggledNotification"] = "toggledNotification";
+  ActionType["toggledPresentationModeSetting"] = "toggledPresentationModeSetting";
   ActionType["toggledSavedSearch"] = "toggledSavedSearch";
   ActionType["tooltipViewed"] = "tooltipViewed";
   ActionType["unfollowedArtist"] = "unfollowedArtist";

package/dist/Schema/index.d.ts

@@ -7,6 +7,7 @@ export * from "./Events/CollectorProfile";
 export * from "./Events/Conversations";
 export * from "./Events/ExperimentViewed";
 export * from "./Events/FilterAndSort";
+export * from "./Events/Folio";
 export * from "./Events/HomeFeedArtsyOnboarding";
 export * from "./Events/Impression";
 export * from "./Events/ImpressionTracking";

package/dist/Schema/index.js

@@ -112,6 +112,18 @@ Object.keys(_FilterAndSort).forEach(function (key) {
   });
 });
 
+var _Folio = require("./Events/Folio");
+
+Object.keys(_Folio).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _Folio[key];
+    }
+  });
+});
+
 var _HomeFeedArtsyOnboarding = require("./Events/HomeFeedArtsyOnboarding");
 
 Object.keys(_HomeFeedArtsyOnboarding).forEach(function (key) {

package/package.json

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