@artsy/cohesion 4.369.0 → 4.370.0--canary.714.15136.0

package/dist/Schema/index.d.ts

@@ -54,6 +54,7 @@ export * from "./os/Events";
 export * from "./os/Events/BrandKit";
 export * from "./os/Events/Click";
 export * from "./os/Events/ConnectedAppsFlow";
+export * from "./os/Events/FilterSortSearch";
 export * from "./os/Events/InstagramEditor";
 export * from "./os/Events/InventoryTable";
 export * from "./os/Events/MultiAddFlow";

package/dist/Schema/index.js

@@ -568,6 +568,18 @@ Object.keys(_ConnectedAppsFlow).forEach(function (key) {
   });
 });
 
+var _FilterSortSearch = require("./os/Events/FilterSortSearch");
+
+Object.keys(_FilterSortSearch).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _FilterSortSearch[key];
+    }
+  });
+});
+
 var _InstagramEditor = require("./os/Events/InstagramEditor");
 
 Object.keys(_InstagramEditor).forEach(function (key) {

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

@@ -0,0 +1,162 @@
+import { OsContextModule } from "../Values/OsContextModule";
+import { OsOwnerType } from "../Values/OsOwnerType";
+import { OsActionType } from ".";
+/**
+ * Schemas describing Art OS Filter, Sort & Search events
+ * @packageDocumentation
+ */
+/**
+ * A partner opens the filter drawer via the Filter pill in the inventory or collection view.
+ *
+ * This schema describes events sent to Segment from [[OsClickedFilterDrawer]]
+ *
+ * @example
+ * ```
+ * {
+ *   action: "clickedFilterDrawer",
+ *   context_module: "artworkFilters",
+ *   context_page_owner_type: "inventory",
+ *   value: 2
+ * }
+ * ```
+ */
+export interface OsClickedFilterDrawer {
+    action: OsActionType.clickedFilterDrawer;
+    context_module: OsContextModule.artworkFilters;
+    context_page_owner_type: OsOwnerType.inventory | OsOwnerType.collection;
+    /** Number of active filters when opening the drawer */
+    value: number;
+}
+/**
+ * A partner applies a filter in the filter drawer.
+ * One event fires per selection; `label` identifies the filter type
+ * and `value` carries the selected value.
+ *
+ * This schema describes events sent to Segment from [[OsAppliedFilter]]
+ *
+ * @example Availability filter
+ * ```
+ * {
+ *   action: "appliedFilter",
+ *   context_module: "artworkFilters",
+ *   context_page_owner_type: "inventory",
+ *   label: "availability",
+ *   value: "for sale"
+ * }
+ * ```
+ *
+ * @example Artist filter
+ * ```
+ * {
+ *   action: "appliedFilter",
+ *   context_module: "artworkFilters",
+ *   context_page_owner_type: "collection",
+ *   label: "artist",
+ *   value: "<artistId>"
+ * }
+ * ```
+ */
+export interface OsAppliedFilter {
+    action: OsActionType.appliedFilter;
+    context_module: OsContextModule.artworkFilters;
+    context_page_owner_type: OsOwnerType.inventory | OsOwnerType.collection;
+    label: "availability" | "status" | "location" | "artist" | "coa";
+    value: string;
+}
+/**
+ * A partner removes a single filter via the selected-filter pill or the per-section Clear link.
+ *
+ * This schema describes events sent to Segment from [[OsRemovedFilter]]
+ *
+ * @example
+ * ```
+ * {
+ *   action: "removedFilter",
+ *   context_module: "artworkFilters",
+ *   context_page_owner_type: "inventory",
+ *   label: "availability",
+ *   value: "for sale"
+ * }
+ * ```
+ */
+export interface OsRemovedFilter {
+    action: OsActionType.removedFilter;
+    context_module: OsContextModule.artworkFilters;
+    context_page_owner_type: OsOwnerType.inventory | OsOwnerType.collection;
+    label: "availability" | "status" | "location" | "artist" | "coa";
+    value: string;
+}
+/**
+ * A partner clears all active filters via the "Clear all" button.
+ *
+ * This schema describes events sent to Segment from [[OsClearedFilters]]
+ *
+ * @example
+ * ```
+ * {
+ *   action: "clearedFilters",
+ *   context_module: "artworkFilters",
+ *   context_page_owner_type: "inventory",
+ *   value: 3
+ * }
+ * ```
+ */
+export interface OsClearedFilters {
+    action: OsActionType.clearedFilters;
+    context_module: OsContextModule.artworkFilters;
+    context_page_owner_type: OsOwnerType.inventory | OsOwnerType.collection;
+    /** Number of filters cleared */
+    value: number;
+}
+/**
+ * A partner clicks a sortable column header to sort the artwork table.
+ * A column-header click cycles ascending → descending → default.
+ *
+ * This schema describes events sent to Segment from [[OsSortedColumn]]
+ *
+ * @example
+ * ```
+ * {
+ *   action: "sortedColumn",
+ *   context_module: "artworkTable",
+ *   context_page_owner_type: "inventory",
+ *   label: "date added",
+ *   value: "asc"
+ * }
+ * ```
+ */
+export interface OsSortedColumn {
+    action: OsActionType.sortedColumn;
+    context_module: OsContextModule.artworkTable;
+    context_page_owner_type: OsOwnerType.inventory | OsOwnerType.collection;
+    /** The column being sorted */
+    label: string;
+    value: "asc" | "desc" | "default";
+}
+/**
+ * A partner submits a keyword search in the artwork search bar.
+ * Fires on the debounced commit (not per keystroke).
+ *
+ * This schema describes events sent to Segment from [[OsSearchedArtworks]]
+ *
+ * @example
+ * ```
+ * {
+ *   action: "searchedArtworks",
+ *   context_module: "artworkSearch",
+ *   context_page_owner_type: "inventory",
+ *   query: "Kelly",
+ *   value: 42
+ * }
+ * ```
+ */
+export interface OsSearchedArtworks {
+    action: OsActionType.searchedArtworks;
+    context_module: OsContextModule.artworkSearch;
+    context_page_owner_type: OsOwnerType.inventory | OsOwnerType.collection;
+    /** The committed search string */
+    query: string;
+    /** Number of results after the search resolves */
+    value: number;
+}
+export type OsFilterSortSearch = OsAppliedFilter | OsClearedFilters | OsClickedFilterDrawer | OsRemovedFilter | OsSearchedArtworks | OsSortedColumn;

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

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

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

@@ -1,6 +1,7 @@
 import { ClickedAddBrandKitFile, ClickedBrandKitColor, ClickedBrandKitFont, ClickedSaveBrandKit } from "./BrandKit";
 import { OsClickEvent } from "./Click";
 import { OsConnectedAppsFlow } from "./ConnectedAppsFlow";
+import { OsFilterSortSearch } from "./FilterSortSearch";
 import { OsInstagramEditor } from "./InstagramEditor";
 import { OsInventoryTable } from "./InventoryTable";
 import { OsMaterialsEditor } from "./MaterialsEditor";
@@ -11,13 +12,17 @@ import { OsSubmitEvent } from "./Submit";
  *
  * Each event describes one ActionType
  */
-export type OsEvent = OsMultiAddFlow | ClickedBrandKitColor | ClickedBrandKitFont | ClickedAddBrandKitFile | ClickedSaveBrandKit | OsConnectedAppsFlow | OsClickEvent | OsInstagramEditor | OsInventoryTable | OsMaterialsEditor | OsSubmitEvent;
+export type OsEvent = OsMultiAddFlow | ClickedBrandKitColor | ClickedBrandKitFont | ClickedAddBrandKitFile | ClickedSaveBrandKit | OsConnectedAppsFlow | OsClickEvent | OsFilterSortSearch | OsInstagramEditor | OsInventoryTable | OsMaterialsEditor | OsSubmitEvent;
 /**
  * List of all Art OS actions
  *
  * Each OsActionType corresponds with a table in Redshift.
  */
 export declare enum OsActionType {
+    /**
+     * Corresponds to {@link OsFilterSortSearch}
+     */
+    appliedFilter = "appliedFilter",
     /**
      * Corresponds to {@link OsInventoryTable}
      */
@@ -59,6 +64,10 @@ export declare enum OsActionType {
      * Corresponds to {@link ClickedCancelBulkEdit}
      */
     clickedCancelBulkEdit = "clickedCancelBulkEdit",
+    /**
+     * Corresponds to {@link OsFilterSortSearch}
+     */
+    clickedFilterDrawer = "clickedFilterDrawer",
     /**
      * Corresponds to {@link ClickedConnectAccount}
      */
@@ -115,6 +124,10 @@ export declare enum OsActionType {
      * Corresponds to {@link OsMaterialsEditor} and {@link OsInstagramEditor}
      */
     createdStudioContent = "createdStudioContent",
+    /**
+     * Corresponds to {@link OsFilterSortSearch}
+     */
+    clearedFilters = "clearedFilters",
     /**
      * Corresponds to {@link DeletedArtwork}
      */
@@ -131,6 +144,10 @@ export declare enum OsActionType {
      * Corresponds to {@link OsInventoryTable}
      */
     removedArtworkDocument = "removedArtworkDocument",
+    /**
+     * Corresponds to {@link OsFilterSortSearch}
+     */
+    removedFilter = "removedFilter",
     /**
      * Corresponds to {@link ResumedArtworkImport}
      */
@@ -139,6 +156,14 @@ export declare enum OsActionType {
      * Corresponds to {@link OsInventoryTable}
      */
     savedArtworkImages = "savedArtworkImages",
+    /**
+     * Corresponds to {@link OsFilterSortSearch}
+     */
+    searchedArtworks = "searchedArtworks",
+    /**
+     * Corresponds to {@link OsFilterSortSearch}
+     */
+    sortedColumn = "sortedColumn",
     /**
      * Corresponds to {@link StartedArtworkImport}
      */

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

@@ -20,6 +20,7 @@ var OsActionType;
 exports.OsActionType = OsActionType;
 
 (function (OsActionType) {
+  OsActionType["appliedFilter"] = "appliedFilter";
   OsActionType["addedArtist"] = "addedArtist";
   OsActionType["addedArtworkDocument"] = "addedArtworkDocument";
   OsActionType["addedLocation"] = "addedLocation";
@@ -31,6 +32,7 @@ exports.OsActionType = OsActionType;
   OsActionType["clickedAspectRatio"] = "clickedAspectRatio";
   OsActionType["clickedBrandKitModal"] = "clickedBrandKitModal";
   OsActionType["clickedCancelBulkEdit"] = "clickedCancelBulkEdit";
+  OsActionType["clickedFilterDrawer"] = "clickedFilterDrawer";
   OsActionType["clickedConnectAccount"] = "clickedConnectAccount";
   OsActionType["clickedConnectAccountModal"] = "clickedConnectAccountModal";
   OsActionType["clickedConnectModal"] = "clickedConnectModal";
@@ -45,11 +47,15 @@ exports.OsActionType = OsActionType;
   OsActionType["completedArtworkImport"] = "completedArtworkImport";
   OsActionType["createdImportedArtworks"] = "createdImportedArtworks";
   OsActionType["createdStudioContent"] = "createdStudioContent";
+  OsActionType["clearedFilters"] = "clearedFilters";
   OsActionType["deletedArtwork"] = "deletedArtwork";
   OsActionType["distributedArtworks"] = "distributedArtworks";
   OsActionType["editedArtworkField"] = "editedArtworkField";
   OsActionType["removedArtworkDocument"] = "removedArtworkDocument";
+  OsActionType["removedFilter"] = "removedFilter";
   OsActionType["resumedArtworkImport"] = "resumedArtworkImport";
   OsActionType["savedArtworkImages"] = "savedArtworkImages";
+  OsActionType["searchedArtworks"] = "searchedArtworks";
+  OsActionType["sortedColumn"] = "sortedColumn";
   OsActionType["startedArtworkImport"] = "startedArtworkImport";
 })(OsActionType || (exports.OsActionType = OsActionType = {}));

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

@@ -8,6 +8,8 @@ export declare enum OsContextModule {
     actionsDropdown = "actionsDropdown",
     addArtistModal = "addArtistModal",
     addLocationModal = "addLocationModal",
+    artworkFilters = "artworkFilters",
+    artworkSearch = "artworkSearch",
     artworkTable = "artworkTable",
     brandKit = "brandKit",
     brandKitPromptModal = "brandKitPromptModal",

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

@@ -18,6 +18,8 @@ exports.OsContextModule = OsContextModule;
   OsContextModule["actionsDropdown"] = "actionsDropdown";
   OsContextModule["addArtistModal"] = "addArtistModal";
   OsContextModule["addLocationModal"] = "addLocationModal";
+  OsContextModule["artworkFilters"] = "artworkFilters";
+  OsContextModule["artworkSearch"] = "artworkSearch";
   OsContextModule["artworkTable"] = "artworkTable";
   OsContextModule["brandKit"] = "brandKit";
   OsContextModule["brandKitPromptModal"] = "brandKitPromptModal";

package/package.json

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