@artsy/cohesion 4.148.0 → 4.149.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# v4.149.0 (Mon Sep 25 2023)
+
+#### 🚀  Enhancement
+
+- [AS-4137] Address auto completion tracking [#457](https://github.com/artsy/cohesion/pull/457) ([@daytavares](https://github.com/daytavares))
+
+#### Authors: 1
+
+- Dayane Tavares ([@daytavares](https://github.com/daytavares))
+
+---
+
 # v4.148.0 (Thu Sep 21 2023)
 
 #### 🚀  Enhancement

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

@@ -225,3 +225,76 @@ export interface SelectedSearchSuggestionQuickNavigationItem {
     destination_path: string;
     label: "Artworks" | "Auction Results";
 }
+/**
+ * User fills address and has/or not auto completion with results
+ *
+ * This schema describes events sent to Segment from [[addressAutoCompletionResult]]
+ *
+ *  @example
+ *  ```
+ *  {
+ *    action: "addressAutoCompletionResult",
+ *    context_module:"OrdersShipping",
+ *    context_page_owner_type: "orders-shipping",
+ *    context_page_owner_id: "57e60c68-a198-431e-8a02-6ecb01e3a99b",
+ *    input: "Weserstr."
+ *    suggested_addresses_results: 3
+ *  }
+ * ```
+ */
+export interface AddressAutoCompletionResult {
+    action: ActionType.addressAutoCompletionResult;
+    context_module: ContextModule;
+    context_owner_type: PageOwnerType;
+    context_owner_id?: string;
+    input: string;
+    suggested_addresses_results: number;
+}
+/**
+ * A User selects one address from the address auto completion options
+ *
+ * This schema describes events sent to Segment from [[selectedItemFromAddressAutoCompletion]]
+ *
+ *  @example
+ *  ```
+ *  {
+ *    action: "selectedItemFromAddressAutoCompletion",
+ *    context_module:"OrdersShipping",
+ *    context_page_owner_type: "orders-shipping",
+ *    context_page_owner_id: "57e60c68-a198-431e-8a02-6ecb01e3a99b",
+ *    input: "Wes"
+ *    item: "Weserstr."
+ *  }
+ * ```
+ */
+export interface SelectedItemFromAddressAutoCompletion {
+    action: ActionType.selectedItemFromAddressAutoCompletion;
+    context_module: ContextModule;
+    context_owner_type: PageOwnerType;
+    context_owner_id?: string;
+    input: string;
+    item: string;
+}
+/**
+ * User edits a suggested address
+ *
+ * This schema describes events sent to Segment from [[editedAutocompletedAddress]]
+ *
+ *  @example
+ *  ```
+ *  {
+ *    action: "editedAutocompletedAddress",
+ *    context_module:"OrdersShipping",
+ *    context_page_owner_type: "orders-shipping",
+ *    context_page_owner_id: "57e60c68-a198-431e-8a02-6ecb01e3a99b",
+ *    field: "Address line 2"
+ *  }
+ * ```
+ */
+export interface EditedAutocompletedAddress {
+    action: ActionType.editedAutocompletedAddress;
+    context_module: ContextModule;
+    context_owner_type: PageOwnerType;
+    context_owner_id?: string;
+    field: string;
+}

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

@@ -20,7 +20,7 @@ import { PromptForReview } from "./PromptForReview";
 import { SearchedReverseImageWithNoResults, SearchedReverseImageWithResults, SelectedArtworkFromReverseImageSearch, TappedPickImageFromLibrary, TappedReverseImageSearch, TappedToggleCameraFlash } from "./ReverseImageSearch";
 import { DeletedSavedSearch, EditedSavedSearch } from "./SavedSearch";
 import { FollowEvents } from "./SavesAndFollows";
-import { ConsignmentArtistFailed, FocusedOnPriceDatabaseSearchInput, FocusedOnSearchInput, SearchedPriceDatabase, SearchedWithNoResults, SearchedWithResults, SelectedItemFromPriceDatabaseSearch, SelectedItemFromSearch, SelectedSearchSuggestionQuickNavigationItem } from "./Search";
+import { AddressAutoCompletionResult, ConsignmentArtistFailed, EditedAutocompletedAddress, FocusedOnPriceDatabaseSearchInput, FocusedOnSearchInput, SearchedPriceDatabase, SearchedWithNoResults, SearchedWithResults, SelectedItemFromPriceDatabaseSearch, SelectedItemFromSearch, SelectedSearchSuggestionQuickNavigationItem, SelectedItemFromAddressAutoCompletion } from "./Search";
 import { Share } from "./Share";
 import { SaleScreenLoadComplete, Screen, TimeOnPage } from "./System";
 import { TappedActivityGroup, TappedArticleGroup, TappedArticleShare, TappedArtistGroup, TappedArtistSeriesGroup, TappedArtworkGroup, TappedAuctionGroup, TappedAuctionResultGroup, TappedBid, TappedBrowseSimilarArtworks, TappedBuyNow, TappedCollectionGroup, TappedConsign, TappedConsignmentInquiry, TappedContactGallery, TappedCreateAlert, TappedExploreGroup, TappedFairCard, TappedFairGroup, TappedInfoBubble, TappedLearnMore, TappedLink, TappedMainArtworkGrid, TappedNavigationTab, TappedPartnerCard, TappedPromoSpace, TappedSell, TappedSellArtwork, TappedShowMore, TappedSkip, TappedTabBar, TappedVerifyIdentity, TappedViewingRoomCard, TappedViewingRoomGroup } from "./Tap";
@@ -33,7 +33,7 @@ import { ViewedVideo } from "./Video";
  *
  * Each event describes one ActionType
  */
-export type Event = AddedArtworkToArtworkList | AddToCalendar | AddCollectedArtwork | ArtworkDetailsCompleted | AuctionPageView | AuctionResultsFilterParamsChanged | AuthImpression | BidPageView | CreatedAccount | CreatedArtworkList | ClickedActiveBid | ClickedActivityPanelNotificationItem | ClickedActivityPanelTab | ClickedAddNewShippingAddress | ClickedAddWorksToFair | ClickedAppDownload | ClickedArticleGroup | ClickedArtistGroup | ClickedArtistSeriesGroup | ClickedArtworkGroup | ClickedAuctionGroup | ClickedAuctionResultItem | ClickedBuyerProtection | ClickedChangePage | ClickedChangePaymentMethod | ClickedChangeShippingAddress | ClickedChangeShippingMethod | ClickedCollectionGroup | ClickedCreateAlert | ClickedDeliveryMethod | ClickedEditArtwork | 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 | DeletedArtworkList | DeletedSavedSearch | EditCollectedArtwork | EditedArtworkList | 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 | 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 | AddToCalendar | AddCollectedArtwork | AddressAutoCompletionResult | ArtworkDetailsCompleted | AuctionPageView | AuctionResultsFilterParamsChanged | AuthImpression | BidPageView | CreatedAccount | CreatedArtworkList | ClickedActiveBid | ClickedActivityPanelNotificationItem | ClickedActivityPanelTab | ClickedAddNewShippingAddress | ClickedAddWorksToFair | ClickedAppDownload | ClickedArticleGroup | ClickedArtistGroup | ClickedArtistSeriesGroup | ClickedArtworkGroup | ClickedAuctionGroup | ClickedAuctionResultItem | ClickedBuyerProtection | ClickedChangePage | ClickedChangePaymentMethod | ClickedChangeShippingAddress | ClickedChangeShippingMethod | ClickedCollectionGroup | ClickedCreateAlert | ClickedDeliveryMethod | ClickedEditArtwork | 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 | 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;
 /**
  * The top-level actions an Event describes.
  *
@@ -52,6 +52,10 @@ export declare enum ActionType {
      * Corresponds to {@link AddCollectedArtwork}
      */
     addCollectedArtwork = "addCollectedArtwork",
+    /**
+     * Corresponds to {@link AddressAutoCompletionResult}
+     */
+    addressAutoCompletionResult = "addressAutoCompletionResult",
     /**
      * Corresponds to {@link AddNewArtistName}
      */
@@ -420,6 +424,10 @@ export declare enum ActionType {
      * Corresponds to {@link EditCollectedArtwork}
      */
     editCollectedArtwork = "editCollectedArtwork",
+    /**
+     * Corresponds to {@link EditedAutocompletedAddress}
+     */
+    editedAutocompletedAddress = "editedAutocompletedAddress",
     /**
      * Corresponds to {@link EditedArtworkList}
      */
@@ -592,6 +600,10 @@ export declare enum ActionType {
      * Corresponds to {@link SelectedItemFromSearch}
      */
     selectedItemFromSearch = "selectedItemFromSearch",
+    /**
+     * Corresponds to {@link SelectedItemFromAddressAutoCompletion}
+     */
+    selectedItemFromAddressAutoCompletion = "selectedItemFromAddressAutoCompletion",
     /**
      * Corresponds to {@link SelectedRecentPriceRange}
      */

package/dist/Schema/Events/index.js

@@ -23,6 +23,7 @@ exports.ActionType = ActionType;
   ActionType["addedArtworkToArtworkList"] = "addedArtworkToArtworkList";
   ActionType["addArtworkDetails"] = "addArtworkDetails";
   ActionType["addCollectedArtwork"] = "addCollectedArtwork";
+  ActionType["addressAutoCompletionResult"] = "addressAutoCompletionResult";
   ActionType["addNewArtistName"] = "addNewArtistName";
   ActionType["addToCalendar"] = "addToCalendar";
   ActionType["artworkDetailsCompleted"] = "artworkDetailsCompleted";
@@ -115,6 +116,7 @@ exports.ActionType = ActionType;
   ActionType["deletedArtworkList"] = "deletedArtworkList";
   ActionType["deletedSavedSearch"] = "deletedSavedSearch";
   ActionType["editCollectedArtwork"] = "editCollectedArtwork";
+  ActionType["editedAutocompletedAddress"] = "editedAutocompletedAddress";
   ActionType["editedArtworkList"] = "editedArtworkList";
   ActionType["editedSavedSearch"] = "editedSavedSearch";
   ActionType["editedUserProfile"] = "editedUserProfile";
@@ -158,6 +160,7 @@ exports.ActionType = ActionType;
   ActionType["clickedConversationsFilter"] = "clickedConversationsFilter";
   ActionType["selectedItemFromPriceDatabaseSearch"] = "selectedItemFromPriceDatabaseSearch";
   ActionType["selectedItemFromSearch"] = "selectedItemFromSearch";
+  ActionType["selectedItemFromAddressAutoCompletion"] = "selectedItemFromAddressAutoCompletion";
   ActionType["selectedRecentPriceRange"] = "selectedRecentPriceRange";
   ActionType["sentArtworkInquiry"] = "sentArtworkInquiry";
   ActionType["sentConsignmentInquiry"] = "sentConsignmentInquiry";

package/package.json

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