@artsy/cohesion 4.338.0 → 4.340.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.
package/CHANGELOG.md CHANGED
@@ -1,3 +1,27 @@
1
+ # v4.340.0 (Fri Jan 30 2026)
2
+
3
+ #### 🚀 Enhancement
4
+
5
+ - feat: Volt onboarding V2 migration client side events [#677](https://github.com/artsy/cohesion/pull/677) ([@jpotts244](https://github.com/jpotts244))
6
+
7
+ #### Authors: 1
8
+
9
+ - Jacqueline Potts ([@jpotts244](https://github.com/jpotts244))
10
+
11
+ ---
12
+
13
+ # v4.339.0 (Mon Jan 26 2026)
14
+
15
+ #### 🚀 Enhancement
16
+
17
+ - fix: Revert "fix examples" [#676](https://github.com/artsy/cohesion/pull/676) ([@xander-pero](https://github.com/xander-pero))
18
+
19
+ #### Authors: 1
20
+
21
+ - [@xander-pero](https://github.com/xander-pero)
22
+
23
+ ---
24
+
1
25
  # v4.338.0 (Fri Jan 23 2026)
2
26
 
3
27
  #### 🚀 Enhancement
@@ -0,0 +1,76 @@
1
+ /**
2
+ * Schemas describing CMS OnboardingFlow events
3
+ * @packageDocumentation
4
+ */
5
+ import { CmsContextModule } from "../Values/CmsContextModule";
6
+ import { CmsActionType } from ".";
7
+ /**
8
+ * Generic click event when a "start" button is clicked in the onboarding flow.
9
+ *
10
+ * @example
11
+ * {
12
+ * action: "click",
13
+ * context_module: "Onboarding",
14
+ * label: "Gallery Information",
15
+ * }
16
+ */
17
+ export type CmsOnboardingClickLabel = "start - gallery information" | "start - add primary location" | "start - add primary contact" | "start - add artists" | "start - add show or fairbooth" | "download folio" | "learn more folio";
18
+ export interface CmsOnboardingClickedEvent {
19
+ action: "click";
20
+ context_module: CmsContextModule.onboarding;
21
+ label: CmsOnboardingClickLabel;
22
+ }
23
+ /**
24
+ * Event fired after user submits gallery information form
25
+ *
26
+ * @example
27
+ * ```
28
+ * {
29
+ * action: "added profile information",
30
+ * context_module: "Onboarding",
31
+ * user_id: "some-user-id",
32
+ * }
33
+ * ```
34
+ */
35
+ export interface CmsOnboardingAddedGalleryProfileInformation {
36
+ action: CmsActionType.addedGalleryProfileInformation;
37
+ context_module: CmsContextModule.onboarding;
38
+ user_id: string;
39
+ }
40
+ /**
41
+ * Event fired after user submits add primary location form
42
+ *
43
+ * @example
44
+ * ```
45
+ * {
46
+ * action: "added new location",
47
+ * context_module: "Onboarding",
48
+ * after_address_type: "Business",
49
+ * user_id: "some-user-id",
50
+ * }
51
+ * ```
52
+ */
53
+ export interface CmsOnboardingAddNewLocation {
54
+ action: CmsActionType.addedNewLocation;
55
+ context_module: CmsContextModule.onboarding;
56
+ after_address_type: string;
57
+ user_id: string;
58
+ }
59
+ /**
60
+ * Event fired after user submits add primary contact form
61
+ *
62
+ * @example
63
+ * ```
64
+ * {
65
+ * action: "added new contact",
66
+ * context_module: "Onboarding",
67
+ * user_id: "some-user-id",
68
+ * }
69
+ * ```
70
+ */
71
+ export interface CmsOnboardingAddNewContact {
72
+ action: CmsActionType.addedNewContact;
73
+ context_module: CmsContextModule.onboarding;
74
+ user_id: string;
75
+ }
76
+ export type CmsOnboardingFlow = CmsOnboardingClickedEvent | CmsOnboardingAddedGalleryProfileInformation | CmsOnboardingAddNewLocation | CmsOnboardingAddNewContact;
@@ -0,0 +1 @@
1
+ "use strict";
@@ -3,6 +3,7 @@ import { CmsArtworkFilter } from "./ArtworkFilter";
3
3
  import { CmsBatchImportFlow } from "./BatchImportFlow";
4
4
  import { CmsBulkEditFlow } from "./BulkEditFlow";
5
5
  import { CmsCompletenessScoreFlow } from "./CompletenessScoreFlow";
6
+ import { CmsOnboardingFlow } from "./OnboardingFlow";
6
7
  import { CmsQuickReplyFlow } from "./QuickReplyFlow";
7
8
  import { CmsSettingsFlow } from "./SettingsFlow";
8
9
  import { CmsShowFlow } from "./ShowFlow";
@@ -12,7 +13,7 @@ import { CmsUploadArtworkFlow } from "./UploadArtworkFlow";
12
13
  *
13
14
  * Each event describes one ActionType
14
15
  */
15
- export type CmsEvent = CmsAnalyticsPage | CmsArtworkFilter | CmsBulkEditFlow | CmsBatchImportFlow | CmsCompletenessScoreFlow | CmsUploadArtworkFlow | CmsQuickReplyFlow | CmsSettingsFlow | CmsShowFlow;
16
+ export type CmsEvent = CmsAnalyticsPage | CmsArtworkFilter | CmsBulkEditFlow | CmsBatchImportFlow | CmsCompletenessScoreFlow | CmsOnboardingFlow | CmsUploadArtworkFlow | CmsQuickReplyFlow | CmsSettingsFlow | CmsShowFlow;
16
17
  /**
17
18
  * List of all CMS actions
18
19
  *
@@ -20,7 +21,15 @@ export type CmsEvent = CmsAnalyticsPage | CmsArtworkFilter | CmsBulkEditFlow | C
20
21
  */
21
22
  export declare enum CmsActionType {
22
23
  /**
23
- * Corresponds to {@link CmsSettingsFlow}
24
+ * Corresponds to {@link CmsOnboardingAddedGalleryProfileInformation}
25
+ */
26
+ addedGalleryProfileInformation = "addedGalleryProfileInformation",
27
+ /**
28
+ * Corresponds to {@link CmsOnboardingAddNewContact}
29
+ */
30
+ addedNewContact = "addedNewContact",
31
+ /**
32
+ * Corresponds to {@link CmsSettingsFlow} and {@link CmsOnboardingAddNewLocation}
24
33
  */
25
34
  addedNewLocation = "addedNewLocation",
26
35
  /**
@@ -20,6 +20,8 @@ var CmsActionType;
20
20
  exports.CmsActionType = CmsActionType;
21
21
 
22
22
  (function (CmsActionType) {
23
+ CmsActionType["addedGalleryProfileInformation"] = "addedGalleryProfileInformation";
24
+ CmsActionType["addedNewContact"] = "addedNewContact";
23
25
  CmsActionType["addedNewLocation"] = "addedNewLocation";
24
26
  CmsActionType["artistNeedsMatching"] = "artistNeedsMatching";
25
27
  CmsActionType["batchImportTableContentSummary"] = "batchImportTableContentSummary";
@@ -19,6 +19,7 @@ export declare enum CmsContextModule {
19
19
  bulkEditFlow = "Artworks - bulk edit",
20
20
  completenessScore = "Artworks - completeness score",
21
21
  conversations = "conversations",
22
+ onboarding = "Onboarding",
22
23
  uploads = "Uploads",
23
24
  settings = "Settings",
24
25
  showsInstallShots = "Shows - Install shots"
@@ -29,6 +29,7 @@ exports.CmsContextModule = CmsContextModule;
29
29
  CmsContextModule["bulkEditFlow"] = "Artworks - bulk edit";
30
30
  CmsContextModule["completenessScore"] = "Artworks - completeness score";
31
31
  CmsContextModule["conversations"] = "conversations";
32
+ CmsContextModule["onboarding"] = "Onboarding";
32
33
  CmsContextModule["uploads"] = "Uploads";
33
34
  CmsContextModule["settings"] = "Settings";
34
35
  CmsContextModule["showsInstallShots"] = "Shows - Install shots";
@@ -349,15 +349,15 @@ export interface ClickedMakeOffer {
349
349
  signal_label?: string;
350
350
  }
351
351
  /**
352
- * User clicks "Contact Gallery" on an artwork page (BNMO)
352
+ * User clicks "Contact Gallery" on an artwork page (BNMO) or Order Details page
353
353
  *
354
354
  * This schema describes events sent to Segment from [[clickedContactGallery]]
355
355
  * @example
356
356
  * ```
357
357
  * {
358
358
  * action: "clickedContactGallery",
359
- * context_owner_type: "Artwork"
360
- * context_owner_id: "6164889300d643000db86504",
359
+ * context_owner_type: "Artwork" | "orders-detail"
360
+ * context_owner_id: "6164889300d643000db86504" | "57e60c68-a198-431e-8a02-6ecb01e3a99b",
361
361
  * context_owner_slug: "radna-segal-pearl",
362
362
  * signal_label: "Limited-Time Offer",
363
363
  * }
@@ -1019,7 +1019,7 @@ export interface TappedBuyNow {
1019
1019
  signal_lot_watcher_count?: number;
1020
1020
  }
1021
1021
  /**
1022
- * A user taps on 'Contact Gallery' on an artwork page
1022
+ * A user taps on 'Contact Gallery' on an artwork page or in Order Details page
1023
1023
  *
1024
1024
  * This schema describes events sent to Segment from [[tappedContactGallery]]
1025
1025
  *
@@ -1027,8 +1027,8 @@ export interface TappedBuyNow {
1027
1027
  * ```
1028
1028
  * {
1029
1029
  * action: "tappedContactGallery",
1030
- * context_owner_type: "Artwork",
1031
- * context_owner_id: "6164889300d643000db86504",
1030
+ * context_owner_type: "Artwork" | "orders-detail",
1031
+ * context_owner_id: "6164889300d643000db86504" | "57e60c68-a198-431e-8a02-6ecb01e3a99b",
1032
1032
  * context_owner_slug: "radna-segal-pearl",
1033
1033
  * signal_label: "Limited-Time Offer",
1034
1034
  * }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@artsy/cohesion",
3
- "version": "4.338.0",
3
+ "version": "4.340.0",
4
4
  "description": "Analytics schema",
5
5
  "main": "dist/index.js",
6
6
  "publishConfig": {