@artsy/cohesion 4.375.0 → 4.376.0--canary.717.15363.0

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

@@ -55,6 +55,7 @@ export declare enum ContextModule {
     artworkRecommendationsRail = "artworkRecommendationsRail",
     artworkSidebar = "artworkSidebar",
     artworksTab = "artworksTab",
+    artworkTable = "artworkTable",
     associatedViewingRoom = "associatedViewingRoom",
     auctionCard = "auctionCard",
     auctionHome = "auctionHome",

package/dist/Schema/Values/ContextModule.js

@@ -69,6 +69,7 @@ exports.ContextModule = ContextModule;
   ContextModule["artworkRecommendationsRail"] = "artworkRecommendationsRail";
   ContextModule["artworkSidebar"] = "artworkSidebar";
   ContextModule["artworksTab"] = "artworksTab";
+  ContextModule["artworkTable"] = "artworkTable";
   ContextModule["associatedViewingRoom"] = "associatedViewingRoom";
   ContextModule["auctionCard"] = "auctionCard";
   ContextModule["auctionHome"] = "auctionHome";

package/dist/Schema/index.d.ts

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

package/dist/Schema/index.js

@@ -640,6 +640,18 @@ Object.keys(_Submit).forEach(function (key) {
   });
 });
 
+var _Toggle2 = require("./os/Events/Toggle");
+
+Object.keys(_Toggle2).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _Toggle2[key];
+    }
+  });
+});
+
 var _OsContextModule = require("./os/Values/OsContextModule");
 
 Object.keys(_OsContextModule).forEach(function (key) {

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

@@ -49,6 +49,29 @@ export interface ClickedCancelBulkEdit {
     context_page_owner_type: OsOwnerType;
     artwork_ids: string[];
 }
+/**
+ * The divergence marker appears in a syncable cell when the OS value
+ * diverges from the downstream destination value (e.g. Artsy CMS). Fires as an
+ * impression when the marker first renders for a given artwork/field combination.
+ *
+ * @example
+ * ```
+ * {
+ *   action: "viewedDivergenceMarker",
+ *   context_module: "artworkTable",
+ *   context_page_owner_type: "inventory",
+ *   artwork_id: "abc123",
+ *   field: "availability"
+ * }
+ * ```
+ */
+export interface ViewedDivergenceMarker {
+    action: OsActionType.viewedDivergenceMarker;
+    context_module: OsContextModule.artworkTable;
+    context_page_owner_type: OsOwnerType;
+    artwork_id: string;
+    field: "availability" | "medium" | "price";
+}
 /**
  * A partner opens a list, either from the Lists surface (a `ListCard`) or from
  * the recent-lists shortcut on the Inventory surface. `source` distinguishes the
@@ -74,4 +97,4 @@ export interface ClickedOpenList {
     list_type: string;
     source: string;
 }
-export type OsClickEvent = ClickedActionsDropdown | ClickedCancelBulkEdit | ClickedOpenList;
+export type OsClickEvent = ClickedActionsDropdown | ClickedCancelBulkEdit | ViewedDivergenceMarker | ClickedOpenList;

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

@@ -311,10 +311,41 @@ export interface OsClickedActionsDropdown {
      * 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"
+     * Distribution: "Distribute to Artsy"
      */
-    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";
+    value: "Add to Artsy" | "Add to Collection" | "Change Collection" | "Checklist" | "Convert to Edition Set" | "Convert to Unique" | "Delete" | "Distribute to Artsy" | "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;
+/**
+ * A partner edits an availability, medium, or price cell that is configured to sync
+ * with a downstream destination (e.g. Artsy CMS). Fires on mutation success. Distinct
+ * from {@link OsEditedArtworkField} (general field edits) — this captures only the three
+ * syncable fields and whether a push to the destination actually occurred.
+ *
+ * @example
+ * ```
+ * {
+ *   action: "editedInventoryField",
+ *   context_module: "artworkTable",
+ *   context_page_owner_type: "inventory",
+ *   destination: ["artsy"],
+ *   artwork_id: "abc123",
+ *   field: "availability",
+ *   did_push_to_cms: false
+ * }
+ * ```
+ */
+export interface EditedInventoryField {
+    action: OsActionType.editedInventoryField;
+    context_module: OsContextModule.artworkTable;
+    context_page_owner_type: OsOwnerType;
+    /** Downstream destinations the value was pushed to (e.g. ["artsy"]) */
+    destination: string[];
+    artwork_id: string;
+    field: "availability" | "medium" | "price";
+    /** false e.g. for "Not For Sale" (OS-only value that does not push to the destination) */
+    did_push_to_cms: boolean;
+}
+export type OsInventoryTable = EditedInventoryField | OsAddedArtist | OsAddedArtworkDocument | OsAddedLocation | OsClickedActionsDropdown | OsClickedArtworkRow | OsClickedEditionSetRow | OsClickedImagesModal | OsEditedArtworkField | OsRemovedArtworkDocument | OsSavedArtworkImages;

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

@@ -78,6 +78,36 @@ export interface DistributedArtworks {
     artwork_ids: string[];
     selected_count: number;
 }
+/**
+ * The websocket-driven distribute job reaches a terminal state (complete or failed).
+ * Driven by `useDistributeWebsocket` (`PartnersChannel`, `metadata_update`).
+ * Fire on the final websocket message to capture success/skip rates.
+ *
+ * @example
+ * ```
+ * {
+ *   action: "completedArtworkDistribution",
+ *   context_module: "artworkTable",
+ *   context_page_owner_type: "inventory",
+ *   destination: ["artsy"],
+ *   total_artworks: 12,
+ *   success_count: 10,
+ *   skipped_count: 2,
+ *   value: "partial"
+ * }
+ * ```
+ */
+export interface CompletedArtworkDistribution {
+    action: OsActionType.completedArtworkDistribution;
+    context_module: OsContextModule.artworkTable;
+    context_page_owner_type: OsOwnerType.inventory;
+    /** Destination marketplaces (currently Artsy only; extensible) */
+    destination: string[];
+    total_artworks: number;
+    success_count: number;
+    skipped_count: number;
+    value: "success" | "partial" | "error";
+}
 /**
  * A partner creates a new list in the Add-to-list modal and bulk-adds the current
  * selection to it. `start_date` / `end_date` are null when unset; `fair_id` is
@@ -343,4 +373,4 @@ export interface ConvertedArtworkToUnique {
     context_page_owner_type: OsOwnerType;
     value: "confirm" | "cancel";
 }
-export type OsSubmitEvent = AddedArtworksToList | BulkEditedArtworks | ConvertedArtworkToUnique | CreatedEditionSet | CreatedList | DeletedArtwork | DeletedList | DistributedArtworks | DistributedList | MovedArtworksBetweenLists | RemovedArtworksFromList | UpdatedEditionSet | UpdatedList;
+export type OsSubmitEvent = AddedArtworksToList | BulkEditedArtworks | BulkEditedArtworks | CompletedArtworkDistribution | ConvertedArtworkToUnique | CreatedEditionSet | CreatedList | CreatedList | DeletedArtwork | DeletedArtwork | DeletedList | DistributedArtworks | DistributedArtworks | DistributedList | MovedArtworksBetweenLists | RemovedArtworksFromList | UpdatedEditionSet | UpdatedList;

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

@@ -0,0 +1,28 @@
+/**
+ * Schemas describing Art OS toggle events
+ * @packageDocumentation
+ */
+import { OsContextModule } from "../Values/OsContextModule";
+import { OsOwnerType } from "../Values/OsOwnerType";
+import { OsActionType } from "./index";
+/**
+ * A partner toggles account-wide Auto-sync on or off via the InventoryTableActions bar.
+ * Flips `distributionSyncEnabled` for the whole partner account.
+ *
+ * @example
+ * ```
+ * {
+ *   action: "toggledDistributionSync",
+ *   context_module: "tableActions",
+ *   context_page_owner_type: "inventory",
+ *   value: "on"
+ * }
+ * ```
+ */
+export interface ToggledDistributionSync {
+    action: OsActionType.toggledDistributionSync;
+    context_module: OsContextModule.tableActions;
+    context_page_owner_type: OsOwnerType.inventory;
+    value: "on" | "off";
+}
+export type OsToggleEvent = ToggledDistributionSync;

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

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

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

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

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

@@ -7,12 +7,13 @@ import { OsInventoryTable } from "./InventoryTable";
 import { OsMaterialsEditor } from "./MaterialsEditor";
 import { OsMultiAddFlow } from "./MultiAddFlow";
 import { OsSubmitEvent } from "./Submit";
+import { OsToggleEvent } from "./Toggle";
 /**
  * List of valid schemas for Art OS analytics actions
  *
  * Each event describes one ActionType
  */
-export type OsEvent = OsMultiAddFlow | ClickedBrandKitColor | ClickedBrandKitFont | ClickedAddBrandKitFile | ClickedSaveBrandKit | OsConnectedAppsFlow | OsClickEvent | OsFilterSortSearch | OsInstagramEditor | OsInventoryTable | OsMaterialsEditor | OsSubmitEvent;
+export type OsEvent = OsMultiAddFlow | ClickedBrandKitColor | ClickedBrandKitFont | ClickedAddBrandKitFile | ClickedSaveBrandKit | OsConnectedAppsFlow | OsClickEvent | OsFilterSortSearch | OsInstagramEditor | OsInventoryTable | OsMaterialsEditor | OsSubmitEvent | OsToggleEvent;
 /**
  * List of all Art OS actions
  *
@@ -120,6 +121,10 @@ export declare enum OsActionType {
      * Corresponds to {@link OsInstagramEditor}
      */
     clickedUploadImageBank = "clickedUploadImageBank",
+    /**
+     * Corresponds to {@link CompletedArtworkDistribution}
+     */
+    completedArtworkDistribution = "completedArtworkDistribution",
     /**
      * Corresponds to {@link CompletedArtworkImport}
      */
@@ -168,6 +173,10 @@ export declare enum OsActionType {
      * Corresponds to {@link EditedArtworkField}
      */
     editedArtworkField = "editedArtworkField",
+    /**
+     * Corresponds to {@link EditedInventoryField}
+     */
+    editedInventoryField = "editedInventoryField",
     /**
      * Corresponds to {@link MovedArtworksBetweenLists}
      */
@@ -204,6 +213,10 @@ export declare enum OsActionType {
      * Corresponds to {@link StartedArtworkImport}
      */
     startedArtworkImport = "startedArtworkImport",
+    /**
+     * Corresponds to {@link ToggledDistributionSync}
+     */
+    toggledDistributionSync = "toggledDistributionSync",
     /**
      * Corresponds to {@link UpdatedEditionSet}
      */
@@ -211,5 +224,9 @@ export declare enum OsActionType {
     /**
      * Corresponds to {@link UpdatedList}
      */
-    updatedList = "updatedList"
+    updatedList = "updatedList",
+    /**
+     * Corresponds to {@link ViewedDivergenceMarker}
+     */
+    viewedDivergenceMarker = "viewedDivergenceMarker"
 }

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

@@ -46,6 +46,7 @@ exports.OsActionType = OsActionType;
   OsActionType["clickedOpenList"] = "clickedOpenList";
   OsActionType["clickedPublishConfirmation"] = "clickedPublishConfirmation";
   OsActionType["clickedUploadImageBank"] = "clickedUploadImageBank";
+  OsActionType["completedArtworkDistribution"] = "completedArtworkDistribution";
   OsActionType["completedArtworkImport"] = "completedArtworkImport";
   OsActionType["convertedArtworkToUnique"] = "convertedArtworkToUnique";
   OsActionType["createdEditionSet"] = "createdEditionSet";
@@ -58,6 +59,7 @@ exports.OsActionType = OsActionType;
   OsActionType["distributedArtworks"] = "distributedArtworks";
   OsActionType["distributedList"] = "distributedList";
   OsActionType["editedArtworkField"] = "editedArtworkField";
+  OsActionType["editedInventoryField"] = "editedInventoryField";
   OsActionType["movedArtworksBetweenLists"] = "movedArtworksBetweenLists";
   OsActionType["removedArtworkDocument"] = "removedArtworkDocument";
   OsActionType["removedFilter"] = "removedFilter";
@@ -67,6 +69,8 @@ exports.OsActionType = OsActionType;
   OsActionType["searchedArtworks"] = "searchedArtworks";
   OsActionType["sortedColumn"] = "sortedColumn";
   OsActionType["startedArtworkImport"] = "startedArtworkImport";
+  OsActionType["toggledDistributionSync"] = "toggledDistributionSync";
   OsActionType["updatedEditionSet"] = "updatedEditionSet";
   OsActionType["updatedList"] = "updatedList";
+  OsActionType["viewedDivergenceMarker"] = "viewedDivergenceMarker";
 })(OsActionType || (exports.OsActionType = OsActionType = {}));

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

@@ -32,5 +32,6 @@ export declare enum OsContextModule {
     materialsEditor = "materialsEditor",
     multiAdd = "multiAdd",
     multiAddReview = "multiAddReview",
-    publishConfirmationModal = "publishConfirmationModal"
+    publishConfirmationModal = "publishConfirmationModal",
+    tableActions = "tableActions"
 }

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

@@ -43,4 +43,5 @@ exports.OsContextModule = OsContextModule;
   OsContextModule["multiAdd"] = "multiAdd";
   OsContextModule["multiAddReview"] = "multiAddReview";
   OsContextModule["publishConfirmationModal"] = "publishConfirmationModal";
+  OsContextModule["tableActions"] = "tableActions";
 })(OsContextModule || (exports.OsContextModule = OsContextModule = {}));

package/package.json

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