@artsy/cohesion 4.367.0 → 4.368.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# v4.368.0 (Thu Jun 25 2026)
+
+#### 🚀  Enhancement
+
+- chore: Add tracking schema for OS Materials Editor [#710](https://github.com/artsy/cohesion/pull/710) ([@olerichter00](https://github.com/olerichter00))
+
+#### Authors: 1
+
+- Ole ([@olerichter00](https://github.com/olerichter00))
+
+---
+
 # v4.367.0 (Thu Jun 25 2026)
 
 #### 🚀  Enhancement

package/dist/Schema/Values/ContextModule.d.ts

@@ -78,6 +78,7 @@ export declare enum ContextModule {
     basedOnYourRecentSavesRail = "basedOnYourRecentSavesRail",
     boothsTab = "boothsTab",
     bottomTabs = "bottomTabs",
+    brandKitPromptModal = "brandKitPromptModal",
     browseFair = "browseFair",
     bulkEditDrawer = "bulkEditDrawer",
     categoryRail = "categoryRail",

package/dist/Schema/Values/ContextModule.js

@@ -92,6 +92,7 @@ exports.ContextModule = ContextModule;
   ContextModule["basedOnYourRecentSavesRail"] = "basedOnYourRecentSavesRail";
   ContextModule["boothsTab"] = "boothsTab";
   ContextModule["bottomTabs"] = "bottomTabs";
+  ContextModule["brandKitPromptModal"] = "brandKitPromptModal";
   ContextModule["browseFair"] = "browseFair";
   ContextModule["bulkEditDrawer"] = "bulkEditDrawer";
   ContextModule["categoryRail"] = "categoryRail";

package/dist/Schema/Values/OwnerType.d.ts

@@ -148,6 +148,7 @@ export declare enum OwnerType {
     shows = "shows",
     signup = "signup",
     similarToRecentlyViewed = "similarToRecentlyViewed",
+    studioMaterials = "studioMaterials",
     submitArtworkStepAddDetails = "submitArtworkStepAddDetails",
     submitArtworkStepAddDimensions = "submitArtworkStepAddDimensions",
     submitArtworkStepAddPhoneNumber = "submitArtworkStepAddPhoneNumber",

package/dist/Schema/Values/OwnerType.js

@@ -166,6 +166,7 @@ exports.OwnerType = OwnerType;
   OwnerType["shows"] = "shows";
   OwnerType["signup"] = "signup";
   OwnerType["similarToRecentlyViewed"] = "similarToRecentlyViewed";
+  OwnerType["studioMaterials"] = "studioMaterials";
   OwnerType["submitArtworkStepAddDetails"] = "submitArtworkStepAddDetails";
   OwnerType["submitArtworkStepAddDimensions"] = "submitArtworkStepAddDimensions";
   OwnerType["submitArtworkStepAddPhoneNumber"] = "submitArtworkStepAddPhoneNumber";

package/dist/Schema/index.d.ts

@@ -53,9 +53,10 @@ export * from "./CMS/Events/UploadArtworkFlow";
 export * from "./os/Events";
 export * from "./os/Values/OsContextModule";
 export * from "./os/Values/OsOwnerType";
-export * from "./os/Events/ConnectedAppsFlow";
+export * from "./os/Events/BrandKit";
 export * from "./os/Events/Click";
+export * from "./os/Events/ConnectedAppsFlow";
 export * from "./os/Events/InventoryTable";
+export * from "./os/Events/MaterialsEditor";
 export * from "./os/Events/MultiAddFlow";
-export * from "./os/Events/BrandKit";
 export * from "./os/Events/Submit";

package/dist/Schema/index.js

@@ -556,14 +556,14 @@ Object.keys(_OsOwnerType).forEach(function (key) {
   });
 });
 
-var _ConnectedAppsFlow = require("./os/Events/ConnectedAppsFlow");
+var _BrandKit = require("./os/Events/BrandKit");
 
-Object.keys(_ConnectedAppsFlow).forEach(function (key) {
+Object.keys(_BrandKit).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
   Object.defineProperty(exports, key, {
     enumerable: true,
     get: function get() {
-      return _ConnectedAppsFlow[key];
+      return _BrandKit[key];
     }
   });
 });
@@ -580,6 +580,18 @@ Object.keys(_Click2).forEach(function (key) {
   });
 });
 
+var _ConnectedAppsFlow = require("./os/Events/ConnectedAppsFlow");
+
+Object.keys(_ConnectedAppsFlow).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _ConnectedAppsFlow[key];
+    }
+  });
+});
+
 var _InventoryTable = require("./os/Events/InventoryTable");
 
 Object.keys(_InventoryTable).forEach(function (key) {
@@ -592,26 +604,26 @@ Object.keys(_InventoryTable).forEach(function (key) {
   });
 });
 
-var _MultiAddFlow = require("./os/Events/MultiAddFlow");
+var _MaterialsEditor = require("./os/Events/MaterialsEditor");
 
-Object.keys(_MultiAddFlow).forEach(function (key) {
+Object.keys(_MaterialsEditor).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
   Object.defineProperty(exports, key, {
     enumerable: true,
     get: function get() {
-      return _MultiAddFlow[key];
+      return _MaterialsEditor[key];
     }
   });
 });
 
-var _BrandKit = require("./os/Events/BrandKit");
+var _MultiAddFlow = require("./os/Events/MultiAddFlow");
 
-Object.keys(_BrandKit).forEach(function (key) {
+Object.keys(_MultiAddFlow).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
   Object.defineProperty(exports, key, {
     enumerable: true,
     get: function get() {
-      return _BrandKit[key];
+      return _MultiAddFlow[key];
     }
   });
 });

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

@@ -0,0 +1,88 @@
+import { OsContextModule } from "../Values/OsContextModule";
+import { OsOwnerType } from "../Values/OsOwnerType";
+import { OsActionType } from ".";
+/**
+ * Schemas describing Art OS Materials (Tearsheet / Checklist) events
+ * @packageDocumentation
+ */
+/**
+ * A partner clicks "Exit" in the Materials editor header to leave the editor.
+ *
+ * This schema describes events sent to Segment from [[OsClickedExitEditor]]
+ *
+ * @example
+ * ```
+ * {
+ *   action: "clickedExitEditor",
+ *   context_module: "editorHeader",
+ *   context_page_owner_type: "studioMaterials",
+ *   label: "materials editor"
+ * }
+ * ```
+ */
+export interface OsClickedExitEditor {
+    action: OsActionType.clickedExitEditor;
+    context_module: OsContextModule.editorHeader;
+    context_page_owner_type: OsOwnerType.studioMaterials;
+    label: string;
+}
+/**
+ * A partner clicks a button in the Brand Kit prompt modal (the modal suggesting they
+ * create a Brand Kit). `value` distinguishes the dismiss action from the create action.
+ *
+ * This schema describes events sent to Segment from [[OsClickedBrandKitModal]]
+ *
+ * @example
+ * ```
+ * {
+ *   action: "clickedBrandKitModal",
+ *   context_module: "brandKitPromptModal",
+ *   context_page_owner_type: "studioMaterials",
+ *   label: "materials brand kit modal",
+ *   value: "create"
+ * }
+ * ```
+ */
+export interface OsClickedBrandKitModal {
+    action: OsActionType.clickedBrandKitModal;
+    context_module: OsContextModule.brandKitPromptModal;
+    context_page_owner_type: OsOwnerType.studioMaterials;
+    label: string;
+    value: "cancel" | "create";
+}
+/**
+ * A partner creates a material (Tearsheet or Checklist PDF) from the Materials editor.
+ *
+ * `content` is a generic catch-all holding the artwork detail fields included in the
+ * generated material (e.g. only the fields whose checkboxes are selected). It is kept
+ * generic on purpose — parsed ad-hoc downstream rather than maintained as a rigid set
+ * of top-level fields — so the same event can serve Materials, Mailchimp, Instagram, etc.
+ *
+ * This schema describes events sent to Segment from [[OsCreatedStudioContent]]
+ *
+ * @example
+ * ```
+ * {
+ *   action: "createdStudioContent",
+ *   context_module: "materialsEditor",
+ *   context_page_owner_type: "studioMaterials",
+ *   value: "tearsheet",
+ *   brand_kit: true,
+ *   content: {
+ *     artworkTitle: "Xpto",
+ *     artistNames: ["Jane Doe", "John Doe"],
+ *     date: "2025"
+ *   }
+ * }
+ * ```
+ */
+export interface OsCreatedStudioContent {
+    action: OsActionType.createdStudioContent;
+    context_module: OsContextModule.materialsEditor;
+    context_page_owner_type: OsOwnerType.studioMaterials;
+    value: "tearsheet" | "checklist";
+    brand_kit: boolean;
+    /** Generic catch-all for the artwork detail fields included in the generated material */
+    content: Record<string, unknown>;
+}
+export type OsMaterialsEditor = OsClickedBrandKitModal | OsClickedExitEditor | OsCreatedStudioContent;

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

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

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

@@ -2,6 +2,7 @@ import { ClickedAddBrandKitFile, ClickedBrandKitColor, ClickedBrandKitFont, Clic
 import { OsClickEvent } from "./Click";
 import { OsConnectedAppsFlow } from "./ConnectedAppsFlow";
 import { OsInventoryTable } from "./InventoryTable";
+import { OsMaterialsEditor } from "./MaterialsEditor";
 import { OsMultiAddFlow } from "./MultiAddFlow";
 import { OsSubmitEvent } from "./Submit";
 /**
@@ -9,7 +10,7 @@ import { OsSubmitEvent } from "./Submit";
  *
  * Each event describes one ActionType
  */
-export type OsEvent = OsMultiAddFlow | ClickedBrandKitColor | ClickedBrandKitFont | ClickedAddBrandKitFile | ClickedSaveBrandKit | OsConnectedAppsFlow | OsClickEvent | OsInventoryTable | OsMultiAddFlow | OsSubmitEvent;
+export type OsEvent = OsMultiAddFlow | ClickedBrandKitColor | ClickedBrandKitFont | ClickedAddBrandKitFile | ClickedSaveBrandKit | OsConnectedAppsFlow | OsClickEvent | OsInventoryTable | OsMaterialsEditor | OsSubmitEvent;
 /**
  * List of all Art OS actions
  *
@@ -37,7 +38,7 @@ export declare enum OsActionType {
      */
     cancelledArtworkImport = "cancelledArtworkImport",
     /**
-     * Corresponds to {@link ClickedActionsDropdown}
+     * Corresponds to {@link OsClickedActionsDropdown}
      */
     clickedActionsDropdown = "clickedActionsDropdown",
     /**
@@ -61,10 +62,18 @@ export declare enum OsActionType {
      * Corresponds to {@link ClickedConnectAccountModal}
      */
     clickedConnectAccountModal = "clickedConnectAccountModal",
+    /**
+     * Corresponds to {@link OsClickedBrandKitModal}
+     */
+    clickedBrandKitModal = "clickedBrandKitModal",
     /**
      * Corresponds to {@link ClickedExitDropZone}
      */
     clickedExitDropZone = "clickedExitDropZone",
+    /**
+     * Corresponds to {@link OsClickedExitEditor}
+     */
+    clickedExitEditor = "clickedExitEditor",
     /**
      * Corresponds to {@link OsInventoryTable}
      */
@@ -77,6 +86,10 @@ export declare enum OsActionType {
      * Corresponds to {@link CreatedImportedArtworks}
      */
     createdImportedArtworks = "createdImportedArtworks",
+    /**
+     * Corresponds to {@link OsCreatedStudioContent}
+     */
+    createdStudioContent = "createdStudioContent",
     /**
      * Corresponds to {@link DeletedArtwork}
      */

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

@@ -32,10 +32,13 @@ exports.OsActionType = OsActionType;
   OsActionType["clickedEditionSetRow"] = "clickedEditionSetRow";
   OsActionType["clickedConnectAccount"] = "clickedConnectAccount";
   OsActionType["clickedConnectAccountModal"] = "clickedConnectAccountModal";
+  OsActionType["clickedBrandKitModal"] = "clickedBrandKitModal";
   OsActionType["clickedExitDropZone"] = "clickedExitDropZone";
+  OsActionType["clickedExitEditor"] = "clickedExitEditor";
   OsActionType["clickedImagesModal"] = "clickedImagesModal";
   OsActionType["completedArtworkImport"] = "completedArtworkImport";
   OsActionType["createdImportedArtworks"] = "createdImportedArtworks";
+  OsActionType["createdStudioContent"] = "createdStudioContent";
   OsActionType["deletedArtwork"] = "deletedArtwork";
   OsActionType["distributedArtworks"] = "distributedArtworks";
   OsActionType["editedArtworkField"] = "editedArtworkField";

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

@@ -5,18 +5,21 @@
  * @packageDocumentation
  */
 export declare enum OsContextModule {
+    actionsDropdown = "actionsDropdown",
     addArtistModal = "addArtistModal",
     addLocationModal = "addLocationModal",
-    actionsDropdown = "actionsDropdown",
     artworkTable = "artworkTable",
+    brandKit = "brandKit",
+    brandKitPromptModal = "brandKitPromptModal",
     bulkEditDrawer = "bulkEditDrawer",
     connectedAppsList = "connectedAppsList",
     connectModal = "connectModal",
     deleteModal = "deleteModal",
     distributeModal = "distributeModal",
     documentsModal = "documentsModal",
+    editorHeader = "editorHeader",
     imagesModal = "imagesModal",
+    materialsEditor = "materialsEditor",
     multiAdd = "multiAdd",
-    multiAddReview = "multiAddReview",
-    brandKit = "brandKit"
+    multiAddReview = "multiAddReview"
 }

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

@@ -15,18 +15,21 @@ var OsContextModule;
 exports.OsContextModule = OsContextModule;
 
 (function (OsContextModule) {
+  OsContextModule["actionsDropdown"] = "actionsDropdown";
   OsContextModule["addArtistModal"] = "addArtistModal";
   OsContextModule["addLocationModal"] = "addLocationModal";
-  OsContextModule["actionsDropdown"] = "actionsDropdown";
   OsContextModule["artworkTable"] = "artworkTable";
+  OsContextModule["brandKit"] = "brandKit";
+  OsContextModule["brandKitPromptModal"] = "brandKitPromptModal";
   OsContextModule["bulkEditDrawer"] = "bulkEditDrawer";
   OsContextModule["connectedAppsList"] = "connectedAppsList";
   OsContextModule["connectModal"] = "connectModal";
   OsContextModule["deleteModal"] = "deleteModal";
   OsContextModule["distributeModal"] = "distributeModal";
   OsContextModule["documentsModal"] = "documentsModal";
+  OsContextModule["editorHeader"] = "editorHeader";
   OsContextModule["imagesModal"] = "imagesModal";
+  OsContextModule["materialsEditor"] = "materialsEditor";
   OsContextModule["multiAdd"] = "multiAdd";
   OsContextModule["multiAddReview"] = "multiAddReview";
-  OsContextModule["brandKit"] = "brandKit";
 })(OsContextModule || (exports.OsContextModule = OsContextModule = {}));

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

@@ -5,7 +5,8 @@
  */
 export declare enum OsOwnerType {
     connectedApps = "connectedApps",
-    list = "list",
     inventory = "inventory",
-    studio = "studio"
+    list = "list",
+    studio = "studio",
+    studioMaterials = "studioMaterials"
 }

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

@@ -15,7 +15,8 @@ exports.OsOwnerType = OsOwnerType;
 
 (function (OsOwnerType) {
   OsOwnerType["connectedApps"] = "connectedApps";
-  OsOwnerType["list"] = "list";
   OsOwnerType["inventory"] = "inventory";
+  OsOwnerType["list"] = "list";
   OsOwnerType["studio"] = "studio";
+  OsOwnerType["studioMaterials"] = "studioMaterials";
 })(OsOwnerType || (exports.OsOwnerType = OsOwnerType = {}));

package/package.json

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