@artsy/cohesion 4.390.0 → 4.391.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# v4.391.0 (Mon Aug 17 2026)
+
+#### 🚀  Enhancement
+
+- feat: add private vr events [#738](https://github.com/artsy/cohesion/pull/738) ([@dariakoko](https://github.com/dariakoko))
+
+#### Authors: 1
+
+- Daria Kozlova ([@dariakoko](https://github.com/dariakoko))
+
+---
+
 # v4.390.0 (Fri Aug 14 2026)
 
 #### 🚀  Enhancement

package/dist/Schema/os/Events/InstagramEditor.d.ts

@@ -160,7 +160,11 @@ export interface OsClickedAspectRatio {
     label: "image aspect ratio" | "image zoom";
 }
 /**
- * A partner clicks "Cancel" or "Continue" in the Instagram post publish confirmation modal.
+ * A partner clicks "Cancel" or "Continue" in a publish confirmation modal.
+ *
+ * Shared across surfaces rather than Instagram-only: the Private Viewing Room
+ * editor sends it from its "Share without a passcode?" confirmation, which is
+ * why `context_page_owner_type` accepts any {@link OsOwnerType}.
  *
  * This schema describes events sent to Segment from [[OsClickedPublishConfirmation]]
  *
@@ -187,7 +191,7 @@ export interface OsClickedAspectRatio {
 export interface OsClickedPublishConfirmation {
     action: OsActionType.clickedPublishConfirmation;
     context_module: OsContextModule.publishConfirmationModal;
-    context_page_owner_type: OsOwnerType.studioInstagram;
+    context_page_owner_type: OsOwnerType;
     value: "cancel" | "continue";
 }
 /**

package/dist/Schema/os/Events/PrivateViewingRoom.d.ts

@@ -0,0 +1,139 @@
+import { OsContextModule } from "../Values/OsContextModule";
+import { OsOwnerType } from "../Values/OsOwnerType";
+import { OsActionType } from ".";
+/**
+ * Schemas describing Art OS Private Viewing Room events
+ *
+ * A Private Viewing Room is a password-protected web page a gallery generates
+ * from a collection and shares with a client by link. It is a `PartnerList`
+ * with `listType: "PRIVATE_VIEWING_ROOM"`, so the generic list events
+ * (`createdList`, `addedArtworksToList`, …) also fire for it — these schemas
+ * cover only what is specific to sharing a room.
+ *
+ * Note the `privateViewingRoom` prefix throughout: `OwnerType.viewingRoom` and
+ * `ContextModule.viewingRoom` already exist for the consumer-facing viewing
+ * rooms on artsy.net, and both feed the same `context_page_owner_type` /
+ * `context_module` columns. Reusing the bare name would merge two unrelated
+ * products downstream.
+ *
+ * @packageDocumentation
+ */
+/**
+ * A partner opens the Private Viewing Room editor, either to share a room for
+ * the first time or to update one already shared.
+ *
+ * `trigger` separates the three entry points: the Share button on an unshared
+ * room, the Manage panel on a shared one, and the banner shown when a shared
+ * room's artworks have drifted from the snapshot viewers currently see. Pairing
+ * the banner trigger with its `bannerViewed` impression is the only way to tell
+ * whether that nudge gets acted on.
+ *
+ * Fires on open, not on the first edit, so it is the denominator for
+ * share-completion rate when paired with {@link SharedPrivateViewingRoom}.
+ *
+ * This schema describes events sent to Segment from
+ * [[ClickedSharePrivateViewingRoom]]
+ *
+ * @example
+ * ```
+ * {
+ *   action: "clickedSharePrivateViewingRoom",
+ *   context_module: "listDetail",
+ *   context_page_owner_type: "privateViewingRoom",
+ *   list_id: "5d2b5b5d5e5b5d000e1b5b5d",
+ *   value: "share",
+ *   trigger: "shareButton"
+ * }
+ * ```
+ */
+export interface ClickedSharePrivateViewingRoom {
+    action: OsActionType.clickedSharePrivateViewingRoom;
+    context_module: OsContextModule.listDetail;
+    context_page_owner_type: OsOwnerType.privateViewingRoom;
+    list_id: string;
+    value: "share" | "update";
+    trigger: "shareButton" | "manageMenu" | "updateBanner";
+}
+/**
+ * A partner successfully shares a Private Viewing Room — past this point the
+ * link works and the client can open the room. Fires from the publish
+ * mutation's success callback, so it means the room is live rather than that
+ * the gallery intended to share it.
+ *
+ * `value` distinguishes a first share from an update to an already-shared room.
+ * Every share goes through the editor: the stale-room banner opens the editor
+ * rather than republishing in one click, so the gallery always reviews the
+ * preview before viewers see a change.
+ *
+ * `has_passcode` is a boolean by design. The passcode itself is a shared access
+ * credential and is never sent.
+ *
+ * `content` is a generic catch-all holding the header choices and the artwork
+ * detail fields the gallery chose to expose — field names only, never their
+ * values. Kept generic on purpose, matching {@link OsCreatedStudioContent}, so
+ * it is parsed ad-hoc downstream rather than maintained as a rigid set of
+ * top-level fields.
+ *
+ * This schema describes events sent to Segment from
+ * [[SharedPrivateViewingRoom]]
+ *
+ * @example
+ * ```
+ * {
+ *   action: "sharedPrivateViewingRoom",
+ *   context_module: "privateViewingRoomEditor",
+ *   context_page_owner_type: "privateViewingRoom",
+ *   value: "shared",
+ *   list_id: "5d2b5b5d5e5b5d000e1b5b5d",
+ *   artwork_count: 12,
+ *   has_passcode: true,
+ *   brand_kit: true,
+ *   content: {
+ *     showGalleryName: true,
+ *     hasHeading: true,
+ *     hasDescription: false,
+ *     artworkFields: ["artistName", "artworkTitle", "year", "medium"]
+ *   }
+ * }
+ * ```
+ */
+export interface SharedPrivateViewingRoom {
+    action: OsActionType.sharedPrivateViewingRoom;
+    context_module: OsContextModule.privateViewingRoomEditor;
+    context_page_owner_type: OsOwnerType.privateViewingRoom;
+    value: "shared" | "updated";
+    list_id: string;
+    artwork_count: number;
+    /** Whether a passcode is set. The passcode itself is never sent */
+    has_passcode: boolean;
+    brand_kit: boolean;
+    /** Generic catch-all for the header choices and exposed artwork detail fields */
+    content: Record<string, unknown>;
+}
+/**
+ * A partner stops sharing a Private Viewing Room, which immediately breaks the
+ * link the client was given. `trigger` distinguishes the Manage panel on the
+ * collection page from the editor's own footer.
+ *
+ * This schema describes events sent to Segment from
+ * [[StoppedSharingPrivateViewingRoom]]
+ *
+ * @example
+ * ```
+ * {
+ *   action: "stoppedSharingPrivateViewingRoom",
+ *   context_module: "listDetail",
+ *   context_page_owner_type: "privateViewingRoom",
+ *   list_id: "5d2b5b5d5e5b5d000e1b5b5d",
+ *   trigger: "manageMenu"
+ * }
+ * ```
+ */
+export interface StoppedSharingPrivateViewingRoom {
+    action: OsActionType.stoppedSharingPrivateViewingRoom;
+    context_module: OsContextModule.listDetail;
+    context_page_owner_type: OsOwnerType.privateViewingRoom;
+    list_id: string;
+    trigger: "manageMenu" | "editor";
+}
+export type OsPrivateViewingRoom = ClickedSharePrivateViewingRoom | SharedPrivateViewingRoom | StoppedSharingPrivateViewingRoom;

package/dist/Schema/os/Events/PrivateViewingRoom.js

@@ -0,0 +1 @@
+"use strict";

package/dist/Schema/os/Events/__tests__/PrivateViewingRoom.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -8,6 +8,7 @@ import { OsMailchimpEditor } from "./MailchimpEditor";
 import { OsMaterialsEditor } from "./MaterialsEditor";
 import { OsMultiAddFlow } from "./MultiAddFlow";
 import { OsOnboardingFlow } from "./OnboardingFlow";
+import { OsPrivateViewingRoom } from "./PrivateViewingRoom";
 import { OsSubmitEvent } from "./Submit";
 import { OsToggleEvent } from "./Toggle";
 /**
@@ -15,7 +16,7 @@ import { OsToggleEvent } from "./Toggle";
  *
  * Each event describes one ActionType
  */
-export type OsEvent = ClickedAddBrandKitFile | ClickedBrandKitColor | ClickedBrandKitFont | ClickedSaveBrandKit | OsClickEvent | OsConnectedAppsFlow | OsFilterSortSearch | OsInstagramEditor | OsInventoryTable | OsMailchimpEditor | OsMaterialsEditor | OsMultiAddFlow | OsOnboardingFlow | OsSubmitEvent | OsToggleEvent;
+export type OsEvent = ClickedAddBrandKitFile | ClickedBrandKitColor | ClickedBrandKitFont | ClickedSaveBrandKit | OsClickEvent | OsConnectedAppsFlow | OsFilterSortSearch | OsInstagramEditor | OsInventoryTable | OsMailchimpEditor | OsMaterialsEditor | OsMultiAddFlow | OsOnboardingFlow | OsPrivateViewingRoom | OsSubmitEvent | OsToggleEvent;
 /**
  * List of all Art OS actions
  *
@@ -131,6 +132,10 @@ export declare enum OsActionType {
      * Corresponds to {@link OsInstagramEditor}
      */
     clickedPublishConfirmation = "clickedPublishConfirmation",
+    /**
+     * Corresponds to {@link ClickedSharePrivateViewingRoom}
+     */
+    clickedSharePrivateViewingRoom = "clickedSharePrivateViewingRoom",
     /**
      * Corresponds to {@link ClickedShowMeHow}
      */
@@ -240,6 +245,10 @@ export declare enum OsActionType {
      * Corresponds to {@link OsFilterSortSearch}
      */
     searchedArtworks = "searchedArtworks",
+    /**
+     * Corresponds to {@link SharedPrivateViewingRoom}
+     */
+    sharedPrivateViewingRoom = "sharedPrivateViewingRoom",
     /**
      * Corresponds to {@link OsFilterSortSearch}
      */
@@ -248,6 +257,10 @@ export declare enum OsActionType {
      * Corresponds to {@link StartedArtworkImport}
      */
     startedArtworkImport = "startedArtworkImport",
+    /**
+     * Corresponds to {@link StoppedSharingPrivateViewingRoom}
+     */
+    stoppedSharingPrivateViewingRoom = "stoppedSharingPrivateViewingRoom",
     /**
      * Corresponds to {@link ToggledDistributionSync}
      */

package/dist/Schema/os/Events/index.js

@@ -48,6 +48,7 @@ exports.OsActionType = OsActionType;
   OsActionType["clickedImagesModal"] = "clickedImagesModal";
   OsActionType["clickedOpenList"] = "clickedOpenList";
   OsActionType["clickedPublishConfirmation"] = "clickedPublishConfirmation";
+  OsActionType["clickedSharePrivateViewingRoom"] = "clickedSharePrivateViewingRoom";
   OsActionType["clickedShowMeHow"] = "clickedShowMeHow";
   OsActionType["clickedSendConfirmation"] = "clickedSendConfirmation";
   OsActionType["clickedUploadImageBank"] = "clickedUploadImageBank";
@@ -75,8 +76,10 @@ exports.OsActionType = OsActionType;
   OsActionType["resumedArtworkImport"] = "resumedArtworkImport";
   OsActionType["savedArtworkImages"] = "savedArtworkImages";
   OsActionType["searchedArtworks"] = "searchedArtworks";
+  OsActionType["sharedPrivateViewingRoom"] = "sharedPrivateViewingRoom";
   OsActionType["sortedColumn"] = "sortedColumn";
   OsActionType["startedArtworkImport"] = "startedArtworkImport";
+  OsActionType["stoppedSharingPrivateViewingRoom"] = "stoppedSharingPrivateViewingRoom";
   OsActionType["toggledDistributionSync"] = "toggledDistributionSync";
   OsActionType["updatedEditionSet"] = "updatedEditionSet";
   OsActionType["updatedList"] = "updatedList";

package/dist/Schema/os/Values/OsContextModule.d.ts

@@ -35,6 +35,7 @@ export declare enum OsContextModule {
     multiAdd = "multiAdd",
     multiAddReview = "multiAddReview",
     onboardingFlow = "onboardingFlow",
+    privateViewingRoomEditor = "privateViewingRoomEditor",
     publishConfirmationModal = "publishConfirmationModal",
     sendConfirmationModal = "sendConfirmationModal",
     tableActions = "tableActions"

package/dist/Schema/os/Values/OsContextModule.js

@@ -45,6 +45,7 @@ exports.OsContextModule = OsContextModule;
   OsContextModule["multiAdd"] = "multiAdd";
   OsContextModule["multiAddReview"] = "multiAddReview";
   OsContextModule["onboardingFlow"] = "onboardingFlow";
+  OsContextModule["privateViewingRoomEditor"] = "privateViewingRoomEditor";
   OsContextModule["publishConfirmationModal"] = "publishConfirmationModal";
   OsContextModule["sendConfirmationModal"] = "sendConfirmationModal";
   OsContextModule["tableActions"] = "tableActions";

package/dist/Schema/os/Values/OsOwnerType.d.ts

@@ -7,6 +7,7 @@ export declare enum OsOwnerType {
     collection = "collection",
     connectedApps = "connectedApps",
     inventory = "inventory",
+    privateViewingRoom = "privateViewingRoom",
     studio = "studio",
     studioInstagram = "studioInstagram",
     studioMailchimp = "studioMailchimp",

package/dist/Schema/os/Values/OsOwnerType.js

@@ -17,6 +17,7 @@ exports.OsOwnerType = OsOwnerType;
   OsOwnerType["collection"] = "collection";
   OsOwnerType["connectedApps"] = "connectedApps";
   OsOwnerType["inventory"] = "inventory";
+  OsOwnerType["privateViewingRoom"] = "privateViewingRoom";
   OsOwnerType["studio"] = "studio";
   OsOwnerType["studioInstagram"] = "studioInstagram";
   OsOwnerType["studioMailchimp"] = "studioMailchimp";

package/package.json

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