@artsy/cohesion 4.364.0 → 4.365.0--canary.709.14936.0

package/dist/Schema/index.d.ts

@@ -54,5 +54,6 @@ export * from "./os/Events";
 export * from "./os/Values/OsContextModule";
 export * from "./os/Values/OsOwnerType";
 export * from "./os/Events/Click";
+export * from "./os/Events/InventoryTable";
 export * from "./os/Events/MultiAddFlow";
 export * from "./os/Events/Submit";

package/dist/Schema/index.js

@@ -568,6 +568,18 @@ Object.keys(_Click2).forEach(function (key) {
   });
 });
 
+var _InventoryTable = require("./os/Events/InventoryTable");
+
+Object.keys(_InventoryTable).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _InventoryTable[key];
+    }
+  });
+});
+
 var _MultiAddFlow = require("./os/Events/MultiAddFlow");
 
 Object.keys(_MultiAddFlow).forEach(function (key) {

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

@@ -0,0 +1,320 @@
+import { OsContextModule } from "../Values/OsContextModule";
+import { OsOwnerType } from "../Values/OsOwnerType";
+import { OsActionType } from ".";
+/**
+ * Schemas describing Art OS Inventory Table events
+ * @packageDocumentation
+ */
+/**
+ * A partner clicks a row to expand or collapse the Artsy CMS sub-row.
+ * Import rows and Inventory-Only rows (artsyListing === false) are not expandable.
+ *
+ * This schema describes events sent to Segment from [[OsClickedArtworkRow]]
+ *
+ * @example
+ * ```
+ * {
+ *   action: "clickedArtworkRow",
+ *   context_module: "artworkTable",
+ *   context_page_owner_type: "inventory",
+ *   artwork_id: "abc123"
+ * }
+ * ```
+ */
+export interface OsClickedArtworkRow {
+    action: OsActionType.clickedArtworkRow;
+    context_module: OsContextModule.artworkTable;
+    context_page_owner_type: OsOwnerType;
+    artwork_id: string;
+}
+/**
+ * A partner clicks an edition set row to expand or collapse its details sub-row.
+ *
+ * This schema describes events sent to Segment from [[OsClickedEditionSetRow]]
+ *
+ * @example
+ * ```
+ * {
+ *   action: "clickedEditionSetRow",
+ *   context_module: "artworkTable",
+ *   context_page_owner_type: "inventory",
+ *   artwork_id: "abc123",
+ *   edition_set_id: "xyz789"
+ * }
+ * ```
+ */
+export interface OsClickedEditionSetRow {
+    action: OsActionType.clickedEditionSetRow;
+    context_module: OsContextModule.artworkTable;
+    context_page_owner_type: OsOwnerType;
+    artwork_id: string;
+    edition_set_id: string;
+}
+/**
+ * A partner edits a field inline in the inventory table.
+ * Fires on mutation success (not on the toast render).
+ * All field edits share this single event; use `field` to distinguish them.
+ *
+ * This schema describes events sent to Segment from [[OsEditedArtworkField]]
+ *
+ * @example
+ * ```
+ * {
+ *   action: "editedArtworkField",
+ *   context_module: "artworkTable",
+ *   context_page_owner_type: "inventory",
+ *   artwork_id: "abc123",
+ *   field: "title",
+ *   old_value: "Untitled",
+ *   new_value: "Blue"
+ * }
+ * ```
+ *
+ * @example Medium with free-text flag
+ * ```
+ * {
+ *   action: "editedArtworkField",
+ *   context_module: "artworkTable",
+ *   context_page_owner_type: "inventory",
+ *   artwork_id: "abc123",
+ *   field: "medium",
+ *   old_value: "Oil on canvas",
+ *   new_value: "Watercolor",
+ *   is_free_text: true
+ * }
+ * ```
+ *
+ * @example Artist autocomplete match
+ * ```
+ * {
+ *   action: "editedArtworkField",
+ *   context_module: "artworkTable",
+ *   context_page_owner_type: "inventory",
+ *   artwork_id: "abc123",
+ *   field: "artist",
+ *   value: "matched",
+ *   matched_id: "artist-internal-id"
+ * }
+ * ```
+ */
+export interface OsEditedArtworkField {
+    action: OsActionType.editedArtworkField;
+    context_module: OsContextModule.artworkTable;
+    context_page_owner_type: OsOwnerType;
+    artwork_id: string;
+    /** Present only for edition-set variant rows in the Artsy CMS sub-row */
+    edition_set_id?: string;
+    field: "artist" | "availability" | "certificateOfAuthenticity" | "dimensions" | "location" | "medium" | "price" | "priceCurrency" | "privateNotes" | "title" | "year";
+    /** Omit for privateNotes (free text — don't log contents) */
+    old_value?: string;
+    /** Omit for privateNotes (free text — don't log contents) */
+    new_value?: string;
+    /** Medium only: true = free text entered, false = predefined mediumType selected */
+    is_free_text?: boolean;
+    /** Artist and location only: the action taken on the autocomplete */
+    value?: "add" | "matched" | "removed";
+    /** Artist and location only: the resolved Artsy entity ID */
+    matched_id?: string;
+}
+/**
+ * A partner successfully adds a new location via the Add Location modal (2-step flow).
+ * Fires on useCreatePartnerLocation mutation success.
+ *
+ * This schema describes events sent to Segment from [[OsAddedLocation]]
+ *
+ * @example
+ * ```
+ * {
+ *   action: "addedLocation",
+ *   context_module: "addLocationModal",
+ *   context_page_owner_type: "inventory",
+ *   artwork_id: "abc123",
+ *   location_id: "loc456"
+ * }
+ * ```
+ */
+export interface OsAddedLocation {
+    action: OsActionType.addedLocation;
+    context_module: OsContextModule.addLocationModal;
+    context_page_owner_type: OsOwnerType;
+    artwork_id: string;
+    location_id: string;
+}
+/**
+ * A partner successfully adds a new artist via the Add Artist modal.
+ * Fires on mutation success.
+ *
+ * This schema describes events sent to Segment from [[OsAddedArtist]]
+ *
+ * @example
+ * ```
+ * {
+ *   action: "addedArtist",
+ *   context_module: "addArtistModal",
+ *   context_page_owner_type: "inventory",
+ *   artwork_id: "abc123",
+ *   artist_id: "artist789"
+ * }
+ * ```
+ */
+export interface OsAddedArtist {
+    action: OsActionType.addedArtist;
+    context_module: OsContextModule.addArtistModal;
+    context_page_owner_type: OsOwnerType;
+    artwork_id: string;
+    artist_id: string;
+}
+/**
+ * A partner clicks the image cell to open the Images modal.
+ *
+ * This schema describes events sent to Segment from [[OsClickedImagesModal]]
+ *
+ * @example
+ * ```
+ * {
+ *   action: "clickedImagesModal",
+ *   context_module: "imagesModal",
+ *   context_page_owner_type: "inventory",
+ *   artwork_id: "abc123"
+ * }
+ * ```
+ */
+export interface OsClickedImagesModal {
+    action: OsActionType.clickedImagesModal;
+    context_module: OsContextModule.imagesModal;
+    context_page_owner_type: OsOwnerType;
+    artwork_id: string;
+}
+/**
+ * A partner saves changes in the Images modal (reorders, removals, and/or new uploads).
+ * Fires on save/confirm mutation success ("Images saved successfully").
+ *
+ * This schema describes events sent to Segment from [[OsSavedArtworkImages]]
+ *
+ * @example
+ * ```
+ * {
+ *   action: "savedArtworkImages",
+ *   context_module: "imagesModal",
+ *   context_page_owner_type: "inventory",
+ *   artwork_id: "abc123",
+ *   added_count: 2,
+ *   removed_count: 1,
+ *   reordered: true
+ * }
+ * ```
+ */
+export interface OsSavedArtworkImages {
+    action: OsActionType.savedArtworkImages;
+    context_module: OsContextModule.imagesModal;
+    context_page_owner_type: OsOwnerType;
+    artwork_id: string;
+    added_count: number;
+    removed_count: number;
+    reordered: boolean;
+}
+/**
+ * A partner uploads a document via the Documents modal.
+ * Fires on useCreateCatalogArtworkDocument mutation success ("Document uploaded").
+ *
+ * This schema describes events sent to Segment from [[OsAddedArtworkDocument]]
+ *
+ * @example
+ * ```
+ * {
+ *   action: "addedArtworkDocument",
+ *   context_module: "documentsModal",
+ *   context_page_owner_type: "inventory",
+ *   artwork_id: "abc123",
+ *   document_count: 3
+ * }
+ * ```
+ */
+export interface OsAddedArtworkDocument {
+    action: OsActionType.addedArtworkDocument;
+    context_module: OsContextModule.documentsModal;
+    context_page_owner_type: OsOwnerType;
+    artwork_id: string;
+    /** Document count after the upload */
+    document_count: number;
+    /** File metadata if accessible: type (e.g. "pdf") and size (e.g. "1MB") */
+    value?: {
+        type: string;
+        size: string;
+    };
+}
+/**
+ * A partner deletes a document via the Documents modal (after confirmation).
+ * Fires on useDeleteCatalogArtworkDocument mutation success ("Document deleted").
+ *
+ * This schema describes events sent to Segment from [[OsRemovedArtworkDocument]]
+ *
+ * @example
+ * ```
+ * {
+ *   action: "removedArtworkDocument",
+ *   context_module: "documentsModal",
+ *   context_page_owner_type: "inventory",
+ *   artwork_id: "abc123",
+ *   document_count: 2
+ * }
+ * ```
+ */
+export interface OsRemovedArtworkDocument {
+    action: OsActionType.removedArtworkDocument;
+    context_module: OsContextModule.documentsModal;
+    context_page_owner_type: OsOwnerType;
+    artwork_id: string;
+    /** Document count after the deletion */
+    document_count: number;
+}
+/**
+ * A partner selects an item from any inventory actions dropdown.
+ * Covers the three top-bar dropdowns ("Add to", "Open in Studio", "More") and the
+ * per-row / right-click menus. `label` identifies which specific button or trigger
+ * the partner used; `value` is the action item they selected within it.
+ *
+ * This schema describes events sent to Segment from [[OsClickedActionsDropdown]]
+ *
+ * @example Top-bar "Add to" dropdown
+ * ```
+ * {
+ *   action: "clickedActionsDropdown",
+ *   context_module: "actionsDropdown",
+ *   context_page_owner_type: "inventory",
+ *   value: "Add to Artsy",
+ *   label: "add to dropdown",
+ *   artwork_ids: ["abc123", "def456"]
+ * }
+ * ```
+ *
+ * @example Right-click context menu
+ * ```
+ * {
+ *   action: "clickedActionsDropdown",
+ *   context_module: "actionsDropdown",
+ *   context_page_owner_type: "inventory",
+ *   value: "Convert to Edition Set",
+ *   label: "context menu",
+ *   artwork_ids: ["abc123"]
+ * }
+ * ```
+ */
+export interface OsClickedActionsDropdown {
+    action: OsActionType.clickedActionsDropdown;
+    context_module: OsContextModule.actionsDropdown;
+    context_page_owner_type: OsOwnerType;
+    /**
+     * The specific action item selected within the dropdown.
+     * Top-bar "Add to": "Add to Artsy" | "Add to Collection"
+     * Top-bar "Open in Studio": "Tearsheet" | "Checklist" | "Instagram Post" | "Mailchimp Campaign"
+     * Top-bar "More": "Delete"
+     * Row/context menu only: "Remove from Artsy" | "Change Collection" | "Remove from Collection" |
+     *   "Convert to Edition Set" | "Edit Edition Set" | "Convert to Unique"
+     */
+    value: "Add to Artsy" | "Add to Collection" | "Change Collection" | "Checklist" | "Convert to Edition Set" | "Convert to Unique" | "Delete" | "Edit Edition Set" | "Instagram Post" | "Mailchimp Campaign" | "Remove from Artsy" | "Remove from Collection" | "Tearsheet";
+    /** Which button or trigger the partner used to open this dropdown */
+    label: "add to dropdown" | "context menu" | "more dropdown" | "row action" | "studio dropdown";
+    artwork_ids: string[];
+}
+export type OsInventoryTable = OsAddedArtist | OsAddedArtworkDocument | OsAddedLocation | OsClickedActionsDropdown | OsClickedArtworkRow | OsClickedEditionSetRow | OsClickedImagesModal | OsEditedArtworkField | OsRemovedArtworkDocument | OsSavedArtworkImages;

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

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

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

@@ -1,4 +1,5 @@
 import { OsClickEvent } from "./Click";
+import { OsInventoryTable } from "./InventoryTable";
 import { OsMultiAddFlow } from "./MultiAddFlow";
 import { OsSubmitEvent } from "./Submit";
 /**
@@ -6,13 +7,25 @@ import { OsSubmitEvent } from "./Submit";
  *
  * Each event describes one ActionType
  */
-export type OsEvent = OsMultiAddFlow | OsClickEvent | OsSubmitEvent;
+export type OsEvent = OsClickEvent | OsInventoryTable | OsMultiAddFlow | OsSubmitEvent;
 /**
  * List of all Art OS actions
  *
  * Each OsActionType corresponds with a table in Redshift.
  */
 export declare enum OsActionType {
+    /**
+     * Corresponds to {@link OsInventoryTable}
+     */
+    addedArtist = "addedArtist",
+    /**
+     * Corresponds to {@link OsInventoryTable}
+     */
+    addedArtworkDocument = "addedArtworkDocument",
+    /**
+     * Corresponds to {@link OsInventoryTable}
+     */
+    addedLocation = "addedLocation",
     /**
      * Corresponds to {@link BulkEditedArtworks}
      */
@@ -29,14 +42,23 @@ export declare enum OsActionType {
      * Corresponds to {@link ClickedAddFromFile}
      */
     clickedAddFromFile = "clickedAddFromFile",
+    clickedArtworkRow = "clickedArtworkRow",
     /**
      * Corresponds to {@link ClickedCancelBulkEdit}
      */
     clickedCancelBulkEdit = "clickedCancelBulkEdit",
+    /**
+     * Corresponds to {@link OsInventoryTable}
+     */
+    clickedEditionSetRow = "clickedEditionSetRow",
     /**
      * Corresponds to {@link ClickedExitDropZone}
      */
     clickedExitDropZone = "clickedExitDropZone",
+    /**
+     * Corresponds to {@link OsInventoryTable}
+     */
+    clickedImagesModal = "clickedImagesModal",
     /**
      * Corresponds to {@link CompletedArtworkImport}
      */
@@ -57,10 +79,18 @@ export declare enum OsActionType {
      * Corresponds to {@link EditedArtworkField}
      */
     editedArtworkField = "editedArtworkField",
+    /**
+     * Corresponds to {@link OsInventoryTable}
+     */
+    removedArtworkDocument = "removedArtworkDocument",
     /**
      * Corresponds to {@link ResumedArtworkImport}
      */
     resumedArtworkImport = "resumedArtworkImport",
+    /**
+     * Corresponds to {@link OsInventoryTable}
+     */
+    savedArtworkImages = "savedArtworkImages",
     /**
      * Corresponds to {@link StartedArtworkImport}
      */

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

@@ -20,17 +20,25 @@ var OsActionType;
 exports.OsActionType = OsActionType;
 
 (function (OsActionType) {
+  OsActionType["addedArtist"] = "addedArtist";
+  OsActionType["addedArtworkDocument"] = "addedArtworkDocument";
+  OsActionType["addedLocation"] = "addedLocation";
   OsActionType["bulkEditedArtworks"] = "bulkEditedArtworks";
   OsActionType["cancelledArtworkImport"] = "cancelledArtworkImport";
   OsActionType["clickedActionsDropdown"] = "clickedActionsDropdown";
   OsActionType["clickedAddFromFile"] = "clickedAddFromFile";
+  OsActionType["clickedArtworkRow"] = "clickedArtworkRow";
   OsActionType["clickedCancelBulkEdit"] = "clickedCancelBulkEdit";
+  OsActionType["clickedEditionSetRow"] = "clickedEditionSetRow";
   OsActionType["clickedExitDropZone"] = "clickedExitDropZone";
+  OsActionType["clickedImagesModal"] = "clickedImagesModal";
   OsActionType["completedArtworkImport"] = "completedArtworkImport";
   OsActionType["createdImportedArtworks"] = "createdImportedArtworks";
   OsActionType["deletedArtwork"] = "deletedArtwork";
   OsActionType["distributedArtworks"] = "distributedArtworks";
   OsActionType["editedArtworkField"] = "editedArtworkField";
+  OsActionType["removedArtworkDocument"] = "removedArtworkDocument";
   OsActionType["resumedArtworkImport"] = "resumedArtworkImport";
+  OsActionType["savedArtworkImages"] = "savedArtworkImages";
   OsActionType["startedArtworkImport"] = "startedArtworkImport";
 })(OsActionType || (exports.OsActionType = OsActionType = {}));

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

@@ -5,10 +5,15 @@
  * @packageDocumentation
  */
 export declare enum OsContextModule {
+    addArtistModal = "addArtistModal",
+    addLocationModal = "addLocationModal",
     actionsDropdown = "actionsDropdown",
+    artworkTable = "artworkTable",
     bulkEditDrawer = "bulkEditDrawer",
     deleteModal = "deleteModal",
     distributeModal = "distributeModal",
+    documentsModal = "documentsModal",
+    imagesModal = "imagesModal",
     multiAdd = "multiAdd",
     multiAddReview = "multiAddReview"
 }

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

@@ -15,10 +15,15 @@ var OsContextModule;
 exports.OsContextModule = OsContextModule;
 
 (function (OsContextModule) {
+  OsContextModule["addArtistModal"] = "addArtistModal";
+  OsContextModule["addLocationModal"] = "addLocationModal";
   OsContextModule["actionsDropdown"] = "actionsDropdown";
+  OsContextModule["artworkTable"] = "artworkTable";
   OsContextModule["bulkEditDrawer"] = "bulkEditDrawer";
   OsContextModule["deleteModal"] = "deleteModal";
   OsContextModule["distributeModal"] = "distributeModal";
+  OsContextModule["documentsModal"] = "documentsModal";
+  OsContextModule["imagesModal"] = "imagesModal";
   OsContextModule["multiAdd"] = "multiAdd";
   OsContextModule["multiAddReview"] = "multiAddReview";
 })(OsContextModule || (exports.OsContextModule = OsContextModule = {}));

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

@@ -4,6 +4,6 @@
  * @packageDocumentation
  */
 export declare enum OsOwnerType {
-    collection = "collection",
+    list = "list",
     inventory = "inventory"
 }

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

@@ -14,6 +14,6 @@ var OsOwnerType;
 exports.OsOwnerType = OsOwnerType;
 
 (function (OsOwnerType) {
-  OsOwnerType["collection"] = "collection";
+  OsOwnerType["list"] = "list";
   OsOwnerType["inventory"] = "inventory";
 })(OsOwnerType || (exports.OsOwnerType = OsOwnerType = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@artsy/cohesion",
-  "version": "4.364.0",
+  "version": "4.365.0--canary.709.14936.0",
   "description": "Analytics schema",
   "main": "dist/index.js",
   "publishConfig": {