@artsy/cohesion 4.70.0 → 4.71.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/dist/Schema/Events/Video.d.ts +27 -0
  3. package/dist/Schema/Events/Video.js +1 -0
  4. package/dist/Schema/Events/index.d.ts +7 -2
  5. package/dist/Schema/Events/index.js +1 -0
  6. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,3 +1,15 @@
1
+ # v4.71.0 (Thu Nov 03 2022)
2
+
3
+ #### 🚀 Enhancement
4
+
5
+ - Adds viewedVideo event [#360](https://github.com/artsy/cohesion/pull/360) ([@abhitip](https://github.com/abhitip))
6
+
7
+ #### Authors: 1
8
+
9
+ - Abhiti Prabahar ([@abhitip](https://github.com/abhitip))
10
+
11
+ ---
12
+
1
13
  # v4.70.0 (Thu Oct 27 2022)
2
14
 
3
15
  #### 🚀 Enhancement
package/dist/Schema/Events/Video.d.ts ADDED
@@ -0,0 +1,27 @@
1
+ import { OwnerType } from "../Values/OwnerType";
2
+ import { ActionType } from ".";
3
+ /**
4
+ * Schema describing Video events
5
+ * @packageDocumentation
6
+ */
7
+ /**
8
+ * A user views a video.
9
+ *
10
+ * This schema describes events sent to Segment from [[viewedVideo]]
11
+ *
12
+ * @example
13
+ * ```
14
+ * {
15
+ * action: "viewedVideo",
16
+ * context_screen_owner_id: "5df3e3fa485efe0012c37055"
17
+ * context_screen_owner_slug: "anoushka-mirchandani-bloom-1"
18
+ * context_screen_owner_type: "artwork"
19
+ * }
20
+ * ```
21
+ */
22
+ export interface ViewedVideo {
23
+ action: ActionType.viewedVideo;
24
+ context_screen_owner_id: string;
25
+ context_screen_owner_slug: string;
26
+ context_screen_owner_type: OwnerType;
27
+ }
package/dist/Schema/Events/Video.js ADDED
@@ -0,0 +1 @@
1
+ "use strict";
package/dist/Schema/Events/index.d.ts CHANGED
@@ -20,12 +20,13 @@ import { SaleScreenLoadComplete, Screen, TimeOnPage } from "./System";
20
20
  import { TappedArticleGroup, TappedArtistGroup, TappedArtistSeriesGroup, TappedArtworkGroup, TappedAuctionGroup, TappedAuctionResultGroup, TappedBid, TappedBuyNow, TappedCollectionGroup, TappedConsign, TappedContactGallery, TappedCreateAlert, TappedExploreGroup, TappedFairCard, TappedFairGroup, TappedInfoBubble, TappedLearnMore, TappedLink, TappedMainArtworkGrid, TappedNavigationTab, TappedPartnerCard, TappedPromoSpace, TappedSell, TappedSellArtwork, TappedShowMore, TappedSkip, TappedTabBar, TappedVerifyIdentity, TappedViewingRoomCard, TappedViewingRoomGroup } from "./Tap";
21
21
  import { ToggledNotification, ToggledSavedSearch } from "./Toggle";
22
22
  import { ToggledAccordion } from "./UserExperienceInteractions";
23
+ import { ViewedVideo } from "./Video";
23
24
  /**
24
25
  * Master list of valid schemas for analytics actions
25
26
  *
26
27
  * Each event describes one ActionType
27
28
  */
28
- export declare type Event = AddToCalendar | AddCollectedArtwork | ArtworkDetailsCompleted | AuctionPageView | AuctionResultsFilterParamsChanged | AuthImpression | BidPageView | CreatedAccount | ClickedActiveBid | ClickedActivityPanelNotificationItem | ClickedActivityPanelTab | ClickedAddNewShippingAddress | ClickedAddWorksToFair | ClickedAppDownload | ClickedArticleGroup | ClickedArtistGroup | ClickedArtistSeriesGroup | ClickedArtworkGroup | ClickedAuctionGroup | ClickedBuyerProtection | ClickedChangePage | ClickedChangePaymentMethod | ClickedChangeShippingAddress | ClickedChangeShippingMethod | ClickedCollectionGroup | ClickedCreateAlert | ClickedDeliveryMethod | ClickedEditArtwork | ClickedExpansionToggle | ClickedFairCard | ClickedFairGroup | ClickedGalleryGroup | ClickedLoadMore | ClickedMainArtworkGrid | ClickedNavigationTab | ClickedNotificationsBell | ClickedOfferOption | ClickedOnArtworkShippingWeight | ClickedOnArtworkShippingUnitsDropdown | ClickedOnFramedMeasurements | ClickedOnFramedMeasurementsDropdown | ClickedOnSubmitOrder | ClickedSnooze | ClickedPartnerCard | ClickedPartnerLink | ClickedPaymentMethod | ClickedPaymentDetails | CheckedAccountBalance | ClickedPromoSpace | ClickedRegisterToBid | ClickedSelectShippingOption | ClickedShippingAddress | ClickedShowGroup | ClickedShowMore | ClickedVerifyIdentity | ClickedViewingRoomCard | ClickedOfferActions | ClickedOrderPage | CommercialFilterParamsChanged | CompletedOnboarding | ConfirmBid | ConfirmRegistrationPageview | ConsignmentArtistFailed | ConsignmentSubmitted | DeleteCollectedArtwork | DeletedSavedSearch | EditCollectedArtwork | EditedSavedSearch | EnterLiveAuction | ExperimentViewed | FocusedOnConversationMessageInput | FocusedOnSearchInput | FocusedOnPriceDatabaseSearchInput | FollowEvents | Impression | MaxBidSelected | OnboardingUserInputData | PriceDatabaseFilterParamsChanged | PromptForReview | RegistrationPageView | RegistrationSubmitted | ResetYourPassword | SaleScreenLoadComplete | SaveCollectedArtwork | Screen | SearchedPriceDatabase | SearchedReverseImageWithNoResults | SearchedReverseImageWithResults | SearchedWithNoResults | SelectedArtworkFromReverseImageSearch | SelectedItemFromSearch | SelectedItemFromPriceDatabaseSearch | SentConversationMessage | SentRequestPriceEstimate | Share | StartedOnboarding | SubmitAnotherArtwork | SuccessfullyLoggedIn | TappedArticleGroup | TappedArtistGroup | TappedArtistSeriesGroup | TappedArtworkGroup | TappedAuctionGroup | TappedAuctionResultGroup | TappedBid | TappedBuyNow | TappedCollectedArtwork | TappedCollectedArtworkImages | TappedCollectionGroup | TappedConsign | TappedContactGallery | TappedCreateAlert | TappedExploreGroup | TappedFairCard | TappedFairGroup | TappedInboxConversation | TappedInfoBubble | TappedLink | TappedNavigationTab | TappedMainArtworkGrid | TappedMakeOffer | TappedMyCollectionInsightsMedianAuctionRailItem | TappedMyCollectionInsightsMedianAuctionPriceChartCareerHighlight | TappedMyCollectionInsightsMedianAuctionPriceChartCategory | TappedMyCollectionInsightsMedianAuctionPriceChartTimeframe | TappedPartnerCard | TappedPickImageFromLibrary | TappedPromoSpace | TappedRequestPriceEstimate | TappedReverseImageSearch | TappedSell | TappedSellArtwork | TappedShowMore | TappedLearnMore | TappedSkip | TappedTabBar | TappedToggleCameraFlash | TappedVerifyIdentity | TappedViewingRoomCard | TappedViewingRoomGroup | TappedViewOffer | TimeOnPage | ToggledAccordion | ToggledNotification | ToggledSavedSearch | UploadPhotosCompleted | ViewArtworkMyCollection;
29
+ export declare type Event = AddToCalendar | AddCollectedArtwork | ArtworkDetailsCompleted | AuctionPageView | AuctionResultsFilterParamsChanged | AuthImpression | BidPageView | CreatedAccount | ClickedActiveBid | ClickedActivityPanelNotificationItem | ClickedActivityPanelTab | ClickedAddNewShippingAddress | ClickedAddWorksToFair | ClickedAppDownload | ClickedArticleGroup | ClickedArtistGroup | ClickedArtistSeriesGroup | ClickedArtworkGroup | ClickedAuctionGroup | ClickedBuyerProtection | ClickedChangePage | ClickedChangePaymentMethod | ClickedChangeShippingAddress | ClickedChangeShippingMethod | ClickedCollectionGroup | ClickedCreateAlert | ClickedDeliveryMethod | ClickedEditArtwork | ClickedExpansionToggle | ClickedFairCard | ClickedFairGroup | ClickedGalleryGroup | ClickedLoadMore | ClickedMainArtworkGrid | ClickedNavigationTab | ClickedNotificationsBell | ClickedOfferOption | ClickedOnArtworkShippingWeight | ClickedOnArtworkShippingUnitsDropdown | ClickedOnFramedMeasurements | ClickedOnFramedMeasurementsDropdown | ClickedOnSubmitOrder | ClickedSnooze | ClickedPartnerCard | ClickedPartnerLink | ClickedPaymentMethod | ClickedPaymentDetails | CheckedAccountBalance | ClickedPromoSpace | ClickedRegisterToBid | ClickedSelectShippingOption | ClickedShippingAddress | ClickedShowGroup | ClickedShowMore | ClickedVerifyIdentity | ClickedViewingRoomCard | ClickedOfferActions | ClickedOrderPage | CommercialFilterParamsChanged | CompletedOnboarding | ConfirmBid | ConfirmRegistrationPageview | ConsignmentArtistFailed | ConsignmentSubmitted | DeleteCollectedArtwork | DeletedSavedSearch | EditCollectedArtwork | EditedSavedSearch | EnterLiveAuction | ExperimentViewed | FocusedOnConversationMessageInput | FocusedOnSearchInput | FocusedOnPriceDatabaseSearchInput | FollowEvents | Impression | MaxBidSelected | OnboardingUserInputData | PriceDatabaseFilterParamsChanged | PromptForReview | RegistrationPageView | RegistrationSubmitted | ResetYourPassword | SaleScreenLoadComplete | SaveCollectedArtwork | Screen | SearchedPriceDatabase | SearchedReverseImageWithNoResults | SearchedReverseImageWithResults | SearchedWithNoResults | SelectedArtworkFromReverseImageSearch | SelectedItemFromSearch | SelectedItemFromPriceDatabaseSearch | SentConversationMessage | SentRequestPriceEstimate | Share | StartedOnboarding | SubmitAnotherArtwork | SuccessfullyLoggedIn | TappedArticleGroup | TappedArtistGroup | TappedArtistSeriesGroup | TappedArtworkGroup | TappedAuctionGroup | TappedAuctionResultGroup | TappedBid | TappedBuyNow | TappedCollectedArtwork | TappedCollectedArtworkImages | TappedCollectionGroup | TappedConsign | TappedContactGallery | TappedCreateAlert | TappedExploreGroup | TappedFairCard | TappedFairGroup | TappedInboxConversation | TappedInfoBubble | TappedLink | TappedNavigationTab | TappedMainArtworkGrid | TappedMakeOffer | TappedMyCollectionInsightsMedianAuctionRailItem | TappedMyCollectionInsightsMedianAuctionPriceChartCareerHighlight | TappedMyCollectionInsightsMedianAuctionPriceChartCategory | TappedMyCollectionInsightsMedianAuctionPriceChartTimeframe | TappedPartnerCard | TappedPickImageFromLibrary | TappedPromoSpace | TappedRequestPriceEstimate | TappedReverseImageSearch | TappedSell | TappedSellArtwork | TappedShowMore | TappedLearnMore | TappedSkip | TappedTabBar | TappedToggleCameraFlash | TappedVerifyIdentity | TappedViewingRoomCard | TappedViewingRoomGroup | TappedViewOffer | TimeOnPage | ToggledAccordion | ToggledNotification | ToggledSavedSearch | UploadPhotosCompleted | ViewArtworkMyCollection | ViewedVideo;
29
30
  /**
30
31
  * The top-level actions an Event describes.
31
32
  *
@@ -699,5 +700,9 @@ export declare enum ActionType {
699
700
  /**
700
701
  * Corresponds to {@link ViewArtworkMyCollection}
701
702
  */
702
- viewArtworkMyCollection = "viewArtworkMyCollection"
703
+ viewArtworkMyCollection = "viewArtworkMyCollection",
704
+ /**
705
+ * Corresponds to {@link ViewedVideo}
706
+ */
707
+ viewedVideo = "viewedVideo"
703
708
  }
package/dist/Schema/Events/index.js CHANGED
@@ -187,4 +187,5 @@ exports.ActionType = ActionType;
187
187
  ActionType["unfollowedPartner"] = "unfollowedPartner";
188
188
  ActionType["uploadPhotosCompleted"] = "uploadPhotosCompleted";
189
189
  ActionType["viewArtworkMyCollection"] = "viewArtworkMyCollection";
190
+ ActionType["viewedVideo"] = "viewedVideo";
190
191
  })(ActionType || (exports.ActionType = ActionType = {}));
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@artsy/cohesion",
3
- "version": "4.70.0",
3
+ "version": "4.71.0",
4
4
  "description": "Analytics schema",
5
5
  "main": "dist/index.js",
6
6
  "publishConfig": {