@artsy/cohesion 4.255.0 → 4.256.1

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.
package/CHANGELOG.md CHANGED
@@ -1,3 +1,27 @@
1
+ # v4.256.1 (Sun Apr 20 2025)
2
+
3
+ #### 🐛 Bug Fix
4
+
5
+ - fix(artwork-filter): fix prop [#585](https://github.com/artsy/cohesion/pull/585) ([@damassi](https://github.com/damassi))
6
+
7
+ #### Authors: 1
8
+
9
+ - Christopher Pappas ([@damassi](https://github.com/damassi))
10
+
11
+ ---
12
+
13
+ # v4.256.0 (Sun Apr 20 2025)
14
+
15
+ #### 🚀 Enhancement
16
+
17
+ - feat(artwork-filter): Add CmsArtworkFilter events [#584](https://github.com/artsy/cohesion/pull/584) ([@damassi](https://github.com/damassi))
18
+
19
+ #### Authors: 1
20
+
21
+ - Christopher Pappas ([@damassi](https://github.com/damassi))
22
+
23
+ ---
24
+
1
25
  # v4.255.0 (Mon Apr 14 2025)
2
26
 
3
27
  #### 🚀 Enhancement
@@ -0,0 +1,151 @@
1
+ /**
2
+ * Schemas describing CMS ArtworkFilter events
3
+ * @packageDocumentation
4
+ */
5
+ import { CmsContextModule } from "../Values/CmsContextModule";
6
+ import { CmsActionType } from ".";
7
+ /**
8
+ * Click on the duplicate artwork button
9
+ *
10
+ * @example
11
+ * ```
12
+ * {
13
+ * action: "clickedonduplicateartwork",
14
+ * }
15
+ * ```
16
+ */
17
+ export interface CmsArtworkFilterClickDuplicateArtwork {
18
+ action: CmsActionType.clickedOnDuplicateArtwork;
19
+ }
20
+ /**
21
+ * Click on the sort at the top right of the sreen
22
+ *
23
+ * @example
24
+ * ```
25
+ * {
26
+ * action: "click",
27
+ * context_module: "Artworks - filter artworks",
28
+ * label: "change sorting method",
29
+ * title: "Sort by",
30
+ * }
31
+ * ```
32
+ */
33
+ export interface CmsArtworkFilterClickSort {
34
+ action: "click";
35
+ context_module: CmsContextModule.artworkFilterFilterArtworks;
36
+ label: "change sorting method";
37
+ title: string;
38
+ }
39
+ /**
40
+ * Filter through one of the filters at the top
41
+ *
42
+ * @example
43
+ * ```
44
+ * {
45
+ * action: "click",
46
+ * context_module: "Artworks - filter artworks",
47
+ * label: Filter by <some filter>",
48
+ * value: "true",
49
+ * }
50
+ * ```
51
+ */
52
+ export interface CmsArtworkFilterQuickEditClickFilter {
53
+ action: "click";
54
+ context_module: CmsContextModule.artworkFilterFilterArtworks;
55
+ label: string;
56
+ value: string;
57
+ }
58
+ /**
59
+ * Quick edit - change price
60
+ *
61
+ * @example
62
+ * ```
63
+ * {
64
+ * action: "click",
65
+ * context_module: "Artworks - quick edit",
66
+ * label: "save price",
67
+ * artwork_id: "artwork_id",
68
+ * }
69
+ * ```
70
+ */
71
+ export interface CmsArtworkFilterQuickEditSavePrice {
72
+ action: "click";
73
+ context_module: CmsContextModule.artworkFilterQuickEdit;
74
+ label: "save price";
75
+ artwork_id: string;
76
+ }
77
+ /**
78
+ * Quick edit - change availability
79
+ *
80
+ * @example
81
+ * ```
82
+ * {
83
+ * action: "click",
84
+ * context_module: "Artworks - quick edit",
85
+ * label: "change availability",
86
+ * artwork_id: "artwork_id",
87
+ * value: "for sale"
88
+ * }
89
+ * ```
90
+ */
91
+ export interface CmsArtworkFilterQuickEditChangeAvailability {
92
+ action: "click";
93
+ context_module: CmsContextModule.artworkFilterQuickEdit;
94
+ label: "change availability";
95
+ artwork_id: string;
96
+ value: string;
97
+ }
98
+ /**
99
+ * Quick edit - publish
100
+ *
101
+ * @example
102
+ * ```
103
+ * {
104
+ * action: "click",
105
+ * context_module: "Artworks - quick edit",
106
+ * label: "publish",
107
+ * artwork_id: "artwork_id",
108
+ * }
109
+ * ```
110
+ */
111
+ export interface CmsArtworkFilterQuickEditPublish {
112
+ action: "click";
113
+ context_module: CmsContextModule.artworkFilterQuickEdit;
114
+ label: "publish";
115
+ artwork_id: string;
116
+ }
117
+ /**
118
+ * Click "import work " to enter the batch import flow
119
+ *
120
+ * @example
121
+ * ```
122
+ * {
123
+ * action: "click",
124
+ * context_module: 'batchImportFlow',
125
+ * label: "click import works",
126
+ * }
127
+ * ```
128
+ */
129
+ export interface CmsArtworkFilterQuickEditClickImport {
130
+ action: "click";
131
+ context_module: CmsContextModule.batchImportFlow;
132
+ label: "click import works";
133
+ }
134
+ /**
135
+ * Search something using the search bar
136
+ *
137
+ * @example
138
+ * ```
139
+ * {
140
+ * action: "searched artwork",
141
+ * context_module: 'Artworks - search',
142
+ * value: "search input",
143
+ * }
144
+ * ```
145
+ */
146
+ export interface CmsArtworkFilterSearch {
147
+ action: CmsActionType.searchedArtwork;
148
+ context_module: CmsContextModule.artworkFilterSearch;
149
+ value: string;
150
+ }
151
+ export type CmsArtworkFilter = CmsArtworkFilterClickDuplicateArtwork | CmsArtworkFilterClickSort | CmsArtworkFilterQuickEditClickFilter | CmsArtworkFilterQuickEditSavePrice | CmsArtworkFilterQuickEditChangeAvailability | CmsArtworkFilterQuickEditPublish | CmsArtworkFilterQuickEditClickImport | CmsArtworkFilterSearch;
@@ -0,0 +1 @@
1
+ "use strict";
@@ -1,10 +1,11 @@
1
+ import { CmsArtworkFilter } from "./ArtworkFilter";
1
2
  import { CmsBatchImportFlow } from "./BatchImportFlow";
2
3
  /**
3
4
  * List of valid schemas for CMS analytics actions
4
5
  *
5
6
  * Each event describes one ActionType
6
7
  */
7
- export type CmsEvent = CmsBatchImportFlow;
8
+ export type CmsEvent = CmsBatchImportFlow | CmsArtworkFilter;
8
9
  /**
9
10
  * List of all CMS actions
10
11
  *
@@ -15,10 +16,18 @@ export declare enum CmsActionType {
15
16
  * Corresponds to {@link CmsBatchImportFlow}
16
17
  */
17
18
  artistNeedsMatching = "artistNeedsMatching",
19
+ /**
20
+ * Corresponds to {@link CmsArtworkFilter}
21
+ */
22
+ clickedOnDuplicateArtwork = "clickedonduplicateartwork",
18
23
  /**
19
24
  * Corresponds to {@link CmsBatchImportFlow}
20
25
  */
21
26
  csvImportError = "csvImportError",
27
+ /**
28
+ * Corresponds to {@link CmsArtworkFilter}
29
+ */
30
+ searchedArtwork = "searched artwork",
22
31
  /**
23
32
  * Corresponds to {@link BatchImportFlow}
24
33
  */
@@ -21,6 +21,8 @@ exports.CmsActionType = CmsActionType;
21
21
 
22
22
  (function (CmsActionType) {
23
23
  CmsActionType["artistNeedsMatching"] = "artistNeedsMatching";
24
+ CmsActionType["clickedOnDuplicateArtwork"] = "clickedonduplicateartwork";
24
25
  CmsActionType["csvImportError"] = "csvImportError";
26
+ CmsActionType["searchedArtwork"] = "searched artwork";
25
27
  CmsActionType["shownMissingInformation"] = "shownMissingInformation";
26
28
  })(CmsActionType || (exports.CmsActionType = CmsActionType = {}));
@@ -5,5 +5,8 @@
5
5
  * @packageDocumentation
6
6
  */
7
7
  export declare enum CmsContextModule {
8
+ artworkFilterFilterArtworks = "Artworks - filter artworks",
9
+ artworkFilterSearch = "Artworks - search",
10
+ artworkFilterQuickEdit = "Artworks - quick edit",
8
11
  batchImportFlow = "batchImportFlow"
9
12
  }
@@ -15,5 +15,8 @@ var CmsContextModule;
15
15
  exports.CmsContextModule = CmsContextModule;
16
16
 
17
17
  (function (CmsContextModule) {
18
+ CmsContextModule["artworkFilterFilterArtworks"] = "Artworks - filter artworks";
19
+ CmsContextModule["artworkFilterSearch"] = "Artworks - search";
20
+ CmsContextModule["artworkFilterQuickEdit"] = "Artworks - quick edit";
18
21
  CmsContextModule["batchImportFlow"] = "batchImportFlow";
19
22
  })(CmsContextModule || (exports.CmsContextModule = CmsContextModule = {}));
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@artsy/cohesion",
3
- "version": "4.255.0",
3
+ "version": "4.256.1",
4
4
  "description": "Analytics schema",
5
5
  "main": "dist/index.js",
6
6
  "publishConfig": {