Skip to content

Commit c9004ab

Browse files
committed
feat: add SelectedItemFromSearchPage and enhance SelectedItemFromSearch
- Add SelectedItemFromSearchPage interface with item tracking fields - Update SelectedItemFromSearch to include destination_path and item tracking (item_id, item_number, item_type) - Remove deprecated helper (confirmed unused)
1 parent 0745f1c commit c9004ab

File tree

4 files changed

+42
-37
lines changed

4 files changed

+42
-37
lines changed

src/DeprecatedHelpers/Search/SelectedItemFromSearch.ts

Lines changed: 0 additions & 21 deletions
This file was deleted.

src/DeprecatedHelpers/index.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ export * from "./MyCollection/TappedCollectedArtworkImages"
1313
export * from "./SavesAndFollows/Follow"
1414
export * from "./Search/FocusedOnSearchInput"
1515
export * from "./Search/SearchedWithNoResults"
16-
export * from "./Search/SelectedItemFromSearch"
1716
export * from "./System/TimeOnPage"
1817
export * from "./Tap/TappedConsign"
1918
export * from "./Tap/TappedEntityGroup"

src/Schema/Events/Search.ts

Lines changed: 36 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -38,28 +38,49 @@ export interface FocusedOnSearchInput {
3838
* ```
3939
* {
4040
* action: "selectedItemFromSearch",
41-
* context_module: "priceEstimate",
42-
* context_owner_type: "consign",
43-
* owner_type: "artist",
44-
* owner_id: "5df3e3fa485efe0012c37055",
45-
* owner_slug: "andy-warhol",
46-
* query: "andy warhol"
41+
* context_module: "header",
42+
* destination_path: "/artist/andy-warhol",
43+
* query: "andy warhol",
44+
* item_id: "4d8b92b34eb68a1b2c0003f4",
45+
* item_number: 2,
46+
* item_type: "Artist"
4747
* }
4848
* ```
4949
*/
5050
export interface SelectedItemFromSearch {
5151
action: ActionType.selectedItemFromSearch
5252
context_module: ContextModule
53-
context_owner_type: PageOwnerType
54-
context_owner_id?: string
55-
context_owner_slug?: string
56-
destination_owner_type?: PageOwnerType
57-
destination_owner_id?: string
58-
destination_owner_slug?: string
59-
owner_type: OwnerType
60-
owner_id: string
61-
owner_slug: string
53+
destination_path: string
6254
query: string
55+
item_id: string
56+
item_number: number
57+
item_type: string
58+
}
59+
60+
/**
61+
* A user selects an item from the search results page
62+
*
63+
* This schema describes events sent to Segment from [[selectedItemFromSearchPage]]
64+
*
65+
* @example
66+
* ```
67+
* {
68+
* action: "selectedItemFromSearchPage",
69+
* query: "andy warhol",
70+
* item_number: 2,
71+
* item_type: "Artist",
72+
* item_id: "4d8b92b34eb68a1b2c0003f4",
73+
* destination_path: "/artist/andy-warhol"
74+
* }
75+
* ```
76+
*/
77+
export interface SelectedItemFromSearchPage {
78+
action: ActionType.selectedItemFromSearchPage
79+
query: string
80+
item_number: number
81+
item_type: string
82+
item_id: string
83+
destination_path: string
6384
}
6485

6586
/**

src/Schema/Events/index.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -240,6 +240,7 @@ import {
240240
SelectedItemFromAddressAutoCompletion,
241241
SelectedItemFromPriceDatabaseSearch,
242242
SelectedItemFromSearch,
243+
SelectedItemFromSearchPage,
243244
SelectedSearchSuggestionQuickNavigationItem,
244245
} from "./Search"
245246
import { DarkModeOptionUpdated } from "./Settings"
@@ -484,6 +485,7 @@ export type Event =
484485
| SelectedItemFromAddressAutoCompletion
485486
| SelectedItemFromPriceDatabaseSearch
486487
| SelectedItemFromSearch
488+
| SelectedItemFromSearchPage
487489
| SelectedFromDrawer
488490
| SelectedRecentPriceRange
489491
| SelectedSearchSuggestionQuickNavigationItem
@@ -1377,6 +1379,10 @@ export enum ActionType {
13771379
* Corresponds to {@link SelectedItemFromSearch}
13781380
*/
13791381
selectedItemFromSearch = "selectedItemFromSearch",
1382+
/**
1383+
* Corresponds to {@link SelectedItemFromSearchPage}
1384+
*/
1385+
selectedItemFromSearchPage = "selectedItemFromSearchPage",
13801386
/**
13811387
* Corresponds to {@link SelectedItemFromAddressAutoCompletion}
13821388
*/

0 commit comments

Comments
 (0)