@artsy/cohesion 4.369.0 → 4.370.0--canary.716.15151.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.
@@ -14,6 +14,7 @@ export declare enum ContextModule {
14
14
  activity = "activity",
15
15
  activityRail = "activityRail",
16
16
  actNow = "actNow",
17
+ addToListModal = "addToListModal",
17
18
  adServer = "adServer",
18
19
  alertConfirmation = "alertConfirmation",
19
20
  alertDetails = "alertDetails",
@@ -155,6 +156,8 @@ export declare enum ContextModule {
155
156
  intextTooltip = "intextTooltip",
156
157
  invoice = "invoice",
157
158
  latestViewingRoomsRail = "latestViewingRoomsRail",
159
+ listCard = "listCard",
160
+ listDetail = "listDetail",
158
161
  liveAuctionRoom = "liveAuctionRoom",
159
162
  liveAuctionsRail = "liveAuctionsRail",
160
163
  lotsForYouCard = "lotsForYouCard",
@@ -28,6 +28,7 @@ exports.ContextModule = ContextModule;
28
28
  ContextModule["activity"] = "activity";
29
29
  ContextModule["activityRail"] = "activityRail";
30
30
  ContextModule["actNow"] = "actNow";
31
+ ContextModule["addToListModal"] = "addToListModal";
31
32
  ContextModule["adServer"] = "adServer";
32
33
  ContextModule["alertConfirmation"] = "alertConfirmation";
33
34
  ContextModule["alertDetails"] = "alertDetails";
@@ -169,6 +170,8 @@ exports.ContextModule = ContextModule;
169
170
  ContextModule["intextTooltip"] = "intextTooltip";
170
171
  ContextModule["invoice"] = "invoice";
171
172
  ContextModule["latestViewingRoomsRail"] = "latestViewingRoomsRail";
173
+ ContextModule["listCard"] = "listCard";
174
+ ContextModule["listDetail"] = "listDetail";
172
175
  ContextModule["liveAuctionRoom"] = "liveAuctionRoom";
173
176
  ContextModule["liveAuctionsRail"] = "liveAuctionsRail";
174
177
  ContextModule["lotsForYouCard"] = "lotsForYouCard";
@@ -49,4 +49,29 @@ export interface ClickedCancelBulkEdit {
49
49
  context_page_owner_type: OsOwnerType;
50
50
  artwork_ids: string[];
51
51
  }
52
- export type OsClickEvent = ClickedActionsDropdown | ClickedCancelBulkEdit;
52
+ /**
53
+ * A partner opens a list, either from the Lists surface (a `ListCard`) or from
54
+ * the recent-lists shortcut on the Inventory surface. `source` distinguishes the
55
+ * two entry points so they can be compared.
56
+ *
57
+ * @example
58
+ * ```
59
+ * {
60
+ * action: "clickedOpenList",
61
+ * context_module: "listCard",
62
+ * context_page_owner_type: "collection",
63
+ * list_id: "5d2b5b5d5e5b5d000e1b5b5d",
64
+ * list_type: "SHOW",
65
+ * source: "listsPage"
66
+ * }
67
+ * ```
68
+ */
69
+ export interface ClickedOpenList {
70
+ action: OsActionType.clickedOpenList;
71
+ context_module: OsContextModule.listCard;
72
+ context_page_owner_type: OsOwnerType;
73
+ list_id: string;
74
+ list_type: string;
75
+ source: string;
76
+ }
77
+ export type OsClickEvent = ClickedActionsDropdown | ClickedCancelBulkEdit | ClickedOpenList;
@@ -78,4 +78,184 @@ export interface DistributedArtworks {
78
78
  artwork_ids: string[];
79
79
  selected_count: number;
80
80
  }
81
- export type OsSubmitEvent = BulkEditedArtworks | DeletedArtwork | DistributedArtworks;
81
+ /**
82
+ * A partner creates a new list in the Add-to-list modal and bulk-adds the current
83
+ * selection to it. `start_date` / `end_date` are null when unset; `fair_id` is
84
+ * present only when `list_type` is FAIR.
85
+ *
86
+ * @example
87
+ * ```
88
+ * {
89
+ * action: "createdList",
90
+ * context_module: "addToListModal",
91
+ * context_page_owner_type: "inventory",
92
+ * list_type: "SHOW",
93
+ * artwork_ids: ["5d2b5b5d5e5b5d000e1b5b5d"],
94
+ * artwork_count: 12,
95
+ * start_date: "2026-09-01",
96
+ * end_date: "2026-09-30"
97
+ * }
98
+ * ```
99
+ */
100
+ export interface CreatedList {
101
+ action: OsActionType.createdList;
102
+ context_module: OsContextModule.addToListModal;
103
+ context_page_owner_type: OsOwnerType;
104
+ list_type: string;
105
+ artwork_ids: string[];
106
+ artwork_count: number;
107
+ start_date: string | null;
108
+ end_date: string | null;
109
+ fair_id?: string;
110
+ }
111
+ /**
112
+ * A partner bulk-adds the current selection to an existing list in the
113
+ * Add-to-list modal.
114
+ *
115
+ * @example
116
+ * ```
117
+ * {
118
+ * action: "addedArtworksToList",
119
+ * context_module: "addToListModal",
120
+ * context_page_owner_type: "inventory",
121
+ * list_id: "5d2b5b5d5e5b5d000e1b5b5d",
122
+ * artwork_ids: ["5d2b5b5d5e5b5d000e1b5b5e"],
123
+ * artwork_count: 12
124
+ * }
125
+ * ```
126
+ */
127
+ export interface AddedArtworksToList {
128
+ action: OsActionType.addedArtworksToList;
129
+ context_module: OsContextModule.addToListModal;
130
+ context_page_owner_type: OsOwnerType;
131
+ list_id: string;
132
+ artwork_ids: string[];
133
+ artwork_count: number;
134
+ }
135
+ /**
136
+ * A partner commits an inline edit of a list's name, dates, or fair on the
137
+ * List detail view. Fires only on a committed change.
138
+ *
139
+ * @example
140
+ * ```
141
+ * {
142
+ * action: "updatedList",
143
+ * context_module: "listDetail",
144
+ * context_page_owner_type: "collection",
145
+ * list_id: "5d2b5b5d5e5b5d000e1b5b5d",
146
+ * field: "name",
147
+ * old_value: "Summer Show",
148
+ * new_value: "Summer Show 2026"
149
+ * }
150
+ * ```
151
+ */
152
+ export interface UpdatedList {
153
+ action: OsActionType.updatedList;
154
+ context_module: OsContextModule.listDetail;
155
+ context_page_owner_type: OsOwnerType;
156
+ list_id: string;
157
+ field: string;
158
+ old_value: string;
159
+ new_value: string;
160
+ }
161
+ /**
162
+ * A partner deletes a list. `trigger` distinguishes the List detail action
163
+ * (listPage), the Lists surface card control (listsPage), and the implicit
164
+ * auto-delete when removing the last artwork(s) empties the list (autoEmptied).
165
+ *
166
+ * @example
167
+ * ```
168
+ * {
169
+ * action: "deletedList",
170
+ * context_module: "listCard",
171
+ * context_page_owner_type: "collection",
172
+ * list_id: "5d2b5b5d5e5b5d000e1b5b5d",
173
+ * trigger: "listPage"
174
+ * }
175
+ * ```
176
+ */
177
+ export interface DeletedList {
178
+ action: OsActionType.deletedList;
179
+ context_module: OsContextModule.listCard;
180
+ context_page_owner_type: OsOwnerType;
181
+ list_id: string;
182
+ trigger: string;
183
+ }
184
+ /**
185
+ * A partner removes artworks from a list (bulk or single row) from the
186
+ * List detail view.
187
+ *
188
+ * @example
189
+ * ```
190
+ * {
191
+ * action: "removedArtworksFromList",
192
+ * context_module: "listDetail",
193
+ * context_page_owner_type: "collection",
194
+ * list_id: "5d2b5b5d5e5b5d000e1b5b5d",
195
+ * artwork_ids: ["5d2b5b5d5e5b5d000e1b5b5e"],
196
+ * artwork_count: 5
197
+ * }
198
+ * ```
199
+ */
200
+ export interface RemovedArtworksFromList {
201
+ action: OsActionType.removedArtworksFromList;
202
+ context_module: OsContextModule.listDetail;
203
+ context_page_owner_type: OsOwnerType;
204
+ list_id: string;
205
+ artwork_ids: string[];
206
+ artwork_count: number;
207
+ }
208
+ /**
209
+ * A partner moves artworks from one list to another from the List detail view.
210
+ *
211
+ * @example
212
+ * ```
213
+ * {
214
+ * action: "movedArtworksBetweenLists",
215
+ * context_module: "listDetail",
216
+ * context_page_owner_type: "collection",
217
+ * source_list_id: "5d2b5b5d5e5b5d000e1b5b5d",
218
+ * destination_list_id: "5d2b5b5d5e5b5d000e1b5b5e",
219
+ * artwork_ids: ["5d2b5b5d5e5b5d000e1b5b5f"],
220
+ * artwork_count: 5
221
+ * }
222
+ * ```
223
+ */
224
+ export interface MovedArtworksBetweenLists {
225
+ action: OsActionType.movedArtworksBetweenLists;
226
+ context_module: OsContextModule.listDetail;
227
+ context_page_owner_type: OsOwnerType;
228
+ source_list_id: string;
229
+ destination_list_id: string;
230
+ artwork_ids: string[];
231
+ artwork_count: number;
232
+ }
233
+ /**
234
+ * A partner distributes a list to Artsy as a draft Show (or Fair booth). One-time
235
+ * push; `partner_show_id` comes from the success response. `fair_id` is present
236
+ * only when `list_type` is FAIR.
237
+ *
238
+ * @example
239
+ * ```
240
+ * {
241
+ * action: "distributedList",
242
+ * context_module: "listDetail",
243
+ * context_page_owner_type: "collection",
244
+ * destination: ["artsy"],
245
+ * list_id: "5d2b5b5d5e5b5d000e1b5b5d",
246
+ * list_type: "SHOW",
247
+ * partner_show_id: "5d2b5b5d5e5b5d000e1b5b5e"
248
+ * }
249
+ * ```
250
+ */
251
+ export interface DistributedList {
252
+ action: OsActionType.distributedList;
253
+ context_module: OsContextModule.listDetail;
254
+ context_page_owner_type: OsOwnerType;
255
+ destination: string[];
256
+ list_id: string;
257
+ list_type: string;
258
+ fair_id?: string;
259
+ partner_show_id: string;
260
+ }
261
+ export type OsSubmitEvent = BulkEditedArtworks | DeletedArtwork | DistributedArtworks | CreatedList | AddedArtworksToList | UpdatedList | DeletedList | RemovedArtworksFromList | MovedArtworksBetweenLists | DistributedList;
@@ -26,6 +26,10 @@ export declare enum OsActionType {
26
26
  * Corresponds to {@link OsInventoryTable}
27
27
  */
28
28
  addedArtworkDocument = "addedArtworkDocument",
29
+ /**
30
+ * Corresponds to {@link AddedArtworksToList}
31
+ */
32
+ addedArtworksToList = "addedArtworksToList",
29
33
  /**
30
34
  * Corresponds to {@link OsInventoryTable}
31
35
  */
@@ -95,6 +99,10 @@ export declare enum OsActionType {
95
99
  * Corresponds to {@link OsInventoryTable}
96
100
  */
97
101
  clickedImagesModal = "clickedImagesModal",
102
+ /**
103
+ * Corresponds to {@link ClickedOpenList}
104
+ */
105
+ clickedOpenList = "clickedOpenList",
98
106
  /**
99
107
  * Corresponds to {@link OsInstagramEditor}
100
108
  */
@@ -111,6 +119,10 @@ export declare enum OsActionType {
111
119
  * Corresponds to {@link CreatedImportedArtworks}
112
120
  */
113
121
  createdImportedArtworks = "createdImportedArtworks",
122
+ /**
123
+ * Corresponds to {@link CreatedList}
124
+ */
125
+ createdList = "createdList",
114
126
  /**
115
127
  * Corresponds to {@link OsMaterialsEditor} and {@link OsInstagramEditor}
116
128
  */
@@ -119,18 +131,34 @@ export declare enum OsActionType {
119
131
  * Corresponds to {@link DeletedArtwork}
120
132
  */
121
133
  deletedArtwork = "deletedArtwork",
134
+ /**
135
+ * Corresponds to {@link DeletedList}
136
+ */
137
+ deletedList = "deletedList",
122
138
  /**
123
139
  * Corresponds to {@link DistributedArtworks}
124
140
  */
125
141
  distributedArtworks = "distributedArtworks",
142
+ /**
143
+ * Corresponds to {@link DistributedList}
144
+ */
145
+ distributedList = "distributedList",
126
146
  /**
127
147
  * Corresponds to {@link EditedArtworkField}
128
148
  */
129
149
  editedArtworkField = "editedArtworkField",
150
+ /**
151
+ * Corresponds to {@link MovedArtworksBetweenLists}
152
+ */
153
+ movedArtworksBetweenLists = "movedArtworksBetweenLists",
130
154
  /**
131
155
  * Corresponds to {@link OsInventoryTable}
132
156
  */
133
157
  removedArtworkDocument = "removedArtworkDocument",
158
+ /**
159
+ * Corresponds to {@link RemovedArtworksFromList}
160
+ */
161
+ removedArtworksFromList = "removedArtworksFromList",
134
162
  /**
135
163
  * Corresponds to {@link ResumedArtworkImport}
136
164
  */
@@ -142,5 +170,9 @@ export declare enum OsActionType {
142
170
  /**
143
171
  * Corresponds to {@link StartedArtworkImport}
144
172
  */
145
- startedArtworkImport = "startedArtworkImport"
173
+ startedArtworkImport = "startedArtworkImport",
174
+ /**
175
+ * Corresponds to {@link UpdatedList}
176
+ */
177
+ updatedList = "updatedList"
146
178
  }
@@ -22,6 +22,7 @@ exports.OsActionType = OsActionType;
22
22
  (function (OsActionType) {
23
23
  OsActionType["addedArtist"] = "addedArtist";
24
24
  OsActionType["addedArtworkDocument"] = "addedArtworkDocument";
25
+ OsActionType["addedArtworksToList"] = "addedArtworksToList";
25
26
  OsActionType["addedLocation"] = "addedLocation";
26
27
  OsActionType["bulkEditedArtworks"] = "bulkEditedArtworks";
27
28
  OsActionType["cancelledArtworkImport"] = "cancelledArtworkImport";
@@ -40,16 +41,23 @@ exports.OsActionType = OsActionType;
40
41
  OsActionType["clickedImageBankImage"] = "clickedImageBankImage";
41
42
  OsActionType["clickedImageBankManagement"] = "clickedImageBankManagement";
42
43
  OsActionType["clickedImagesModal"] = "clickedImagesModal";
44
+ OsActionType["clickedOpenList"] = "clickedOpenList";
43
45
  OsActionType["clickedPublishConfirmation"] = "clickedPublishConfirmation";
44
46
  OsActionType["clickedUploadImageBank"] = "clickedUploadImageBank";
45
47
  OsActionType["completedArtworkImport"] = "completedArtworkImport";
46
48
  OsActionType["createdImportedArtworks"] = "createdImportedArtworks";
49
+ OsActionType["createdList"] = "createdList";
47
50
  OsActionType["createdStudioContent"] = "createdStudioContent";
48
51
  OsActionType["deletedArtwork"] = "deletedArtwork";
52
+ OsActionType["deletedList"] = "deletedList";
49
53
  OsActionType["distributedArtworks"] = "distributedArtworks";
54
+ OsActionType["distributedList"] = "distributedList";
50
55
  OsActionType["editedArtworkField"] = "editedArtworkField";
56
+ OsActionType["movedArtworksBetweenLists"] = "movedArtworksBetweenLists";
51
57
  OsActionType["removedArtworkDocument"] = "removedArtworkDocument";
58
+ OsActionType["removedArtworksFromList"] = "removedArtworksFromList";
52
59
  OsActionType["resumedArtworkImport"] = "resumedArtworkImport";
53
60
  OsActionType["savedArtworkImages"] = "savedArtworkImages";
54
61
  OsActionType["startedArtworkImport"] = "startedArtworkImport";
62
+ OsActionType["updatedList"] = "updatedList";
55
63
  })(OsActionType || (exports.OsActionType = OsActionType = {}));
@@ -8,6 +8,7 @@ export declare enum OsContextModule {
8
8
  actionsDropdown = "actionsDropdown",
9
9
  addArtistModal = "addArtistModal",
10
10
  addLocationModal = "addLocationModal",
11
+ addToListModal = "addToListModal",
11
12
  artworkTable = "artworkTable",
12
13
  brandKit = "brandKit",
13
14
  brandKitPromptModal = "brandKitPromptModal",
@@ -22,6 +23,8 @@ export declare enum OsContextModule {
22
23
  imageEditor = "imageEditor",
23
24
  imagesModal = "imagesModal",
24
25
  instagramEditor = "instagramEditor",
26
+ listCard = "listCard",
27
+ listDetail = "listDetail",
25
28
  materialsEditor = "materialsEditor",
26
29
  multiAdd = "multiAdd",
27
30
  multiAddReview = "multiAddReview",
@@ -18,6 +18,7 @@ exports.OsContextModule = OsContextModule;
18
18
  OsContextModule["actionsDropdown"] = "actionsDropdown";
19
19
  OsContextModule["addArtistModal"] = "addArtistModal";
20
20
  OsContextModule["addLocationModal"] = "addLocationModal";
21
+ OsContextModule["addToListModal"] = "addToListModal";
21
22
  OsContextModule["artworkTable"] = "artworkTable";
22
23
  OsContextModule["brandKit"] = "brandKit";
23
24
  OsContextModule["brandKitPromptModal"] = "brandKitPromptModal";
@@ -32,6 +33,8 @@ exports.OsContextModule = OsContextModule;
32
33
  OsContextModule["imageEditor"] = "imageEditor";
33
34
  OsContextModule["imagesModal"] = "imagesModal";
34
35
  OsContextModule["instagramEditor"] = "instagramEditor";
36
+ OsContextModule["listCard"] = "listCard";
37
+ OsContextModule["listDetail"] = "listDetail";
35
38
  OsContextModule["materialsEditor"] = "materialsEditor";
36
39
  OsContextModule["multiAdd"] = "multiAdd";
37
40
  OsContextModule["multiAddReview"] = "multiAddReview";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@artsy/cohesion",
3
- "version": "4.369.0",
3
+ "version": "4.370.0--canary.716.15151.0",
4
4
  "description": "Analytics schema",
5
5
  "main": "dist/index.js",
6
6
  "publishConfig": {