@artsy/cohesion 4.243.0 → 4.244.0

package/CHANGELOG.md

@@ -1,3 +1,16 @@
+# v4.244.0 (Sun Mar 16 2025)
+
+#### 🚀  Enhancement
+
+- feat(imports): Add CmsBatchImport events [#562](https://github.com/artsy/cohesion/pull/562) ([@damassi](https://github.com/damassi) [@leodmz](https://github.com/leodmz))
+
+#### Authors: 2
+
+- Christopher Pappas ([@damassi](https://github.com/damassi))
+- Leo Demazeau ([@leodmz](https://github.com/leodmz))
+
+---
+
 # v4.243.0 (Fri Mar 14 2025)
 
 #### 🚀  Enhancement

package/dist/Schema/CMS/Events/BatchImportFlow.d.ts

@@ -0,0 +1,126 @@
+/**
+ * Schemas describing CMS BatchImportFlow events
+ * @packageDocumentation
+ */
+import { CmsContextModule } from "../Values/CmsContextModule";
+import { CmsOwnerType } from "../Values/CmsOwnerType";
+import { CmsActionType } from "./index";
+/**
+ * A partner has clicked the import button and started the flow.
+ *
+ * @example
+ * ```
+ * {
+ *   context_module: "batchImportFlow",
+ *   context_page_owner_type: "batchImport",
+ *   context_page_owner_id: "67b646ecbe87376bfeb3f962",
+ *   label: "click import",
+ *   referrer: ""
+ * }
+ * ```
+ */
+export interface CmsBatchImportFlowClickImport {
+    context_module: CmsContextModule.batchImportFlow;
+    context_page_owner_type: CmsOwnerType.batchImport;
+    context_page_owner_id: string;
+    label: "click import works";
+    referrer: "";
+}
+/**
+ * A partner has clicked to add a CSV file.
+ *
+ * @example
+ * ```
+ * {
+ *   context_module: "batchImportFlow",
+ *   context_page_owner_type: "batchImport",
+ *   context_page_owner_id: "67b646ecbe87376bfeb3f962",
+ *   label: "click add CSV"
+ * }
+ * ```
+ */
+export interface CmsBatchImportFlowClickAddCSV {
+    context_module: CmsContextModule.batchImportFlow;
+    context_page_owner_type: CmsOwnerType.batchImport;
+    context_page_owner_id: string;
+    label: "click add CSV";
+}
+/**
+ * A partner has clicked to download the template.
+ *
+ * @example
+ * ```
+ * {
+ *   context_module: "batchImportFlow",
+ *   context_page_owner_type: "batchImport",
+ *   context_page_owner_id: "67b646ecbe87376bfeb3f962",
+ *   label: "click download template"
+ * }
+ * ```
+ */
+export interface CmsBatchImportFlowClickDownloadTemplate {
+    context_module: CmsContextModule.batchImportFlow;
+    context_page_owner_type: CmsOwnerType.batchImport;
+    context_page_owner_id: string;
+    label: "click download template";
+}
+/**
+ * Some artworks have missing information warnings.
+ *
+ * @example
+ * ```
+ * {
+ *   event: "shownMissingInformation",
+ *   context_page_owner_type: "batchImport",
+ *   context_page_owner_id: "67b646ecbe87376bfeb3f962",
+ *   // number of artworks with warnings
+ *   value: 5
+ * }
+ * ```
+ */
+export interface CmsBatchImportFlowShownMissingInformation {
+    event: CmsActionType.shownMissingInformation;
+    context_page_owner_type: CmsOwnerType.batchImport;
+    context_page_owner_id: string;
+    value: number;
+}
+/**
+ * Artists need matching during the batch import.
+ *
+ * @example
+ * ```
+ * {
+ *   event: "artistNeedsMatching",
+ *   context_page_owner_type: "batchImportArtistMatching",
+ *   context_page_owner_id: "67b646ecbe87376bfeb3f962",
+ *   // number of artists with missing matching
+ *   value: 3
+ * }
+ * ```
+ */
+export interface CmsBatchImportFlowArtistNeedsMatching {
+    event: CmsActionType.artistNeedsMatching;
+    context_page_owner_type: CmsOwnerType.batchImportArtistMatching;
+    context_page_owner_id: string;
+    value: number;
+}
+/**
+ * Partners click to exit the batch import flow
+ *
+ * @example
+ * ```
+ * {
+*   context_module: "batchImportFlow",
+ *   context_page_owner_type: "batchImport",
+ *   context_page_owner_id: "67b646ecbe87376bfeb3f962",
+ *   label: "click import"
+ * }
+ * ```
+ */
+export interface CmsBatchImportClickExit {
+    context_module: CmsContextModule.batchImportFlow;
+    context_page_owner_type: CmsOwnerType.batchImport;
+    context_page_owner_id: string;
+    label: "click exit";
+}
+export type CmsBatchImportFlow = CmsBatchImportFlowClickImport | CmsBatchImportFlowClickAddCSV | CmsBatchImportFlowClickDownloadTemplate | CmsBatchImportFlowShownMissingInformation | CmsBatchImportFlowArtistNeedsMatching | CmsBatchImportClickExit;

package/dist/Schema/CMS/Events/BatchImportFlow.js

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

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

@@ -0,0 +1,22 @@
+import { CmsBatchImportFlow } from "./BatchImportFlow";
+/**
+ * List of valid schemas for CMS analytics actions
+ *
+ * Each event describes one ActionType
+ */
+export type CmsEvent = CmsBatchImportFlow;
+/**
+ * List of all CMS actions
+ *
+ * Each CmsActionType corresponds with a table in Redshift.
+ */
+export declare enum CmsActionType {
+    /**
+     * Corresponds to {@link CmsBatchImportFlow}
+     */
+    artistNeedsMatching = "artistNeedsMatching",
+    /**
+     * Corresponds to {@link BatchImportFlow}
+     */
+    shownMissingInformation = "shownMissingInformation"
+}

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

@@ -0,0 +1,25 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.CmsActionType = void 0;
+
+/**
+ * List of valid schemas for CMS analytics actions
+ *
+ * Each event describes one ActionType
+ */
+
+/**
+ * List of all CMS actions
+ *
+ * Each CmsActionType corresponds with a table in Redshift.
+ */
+var CmsActionType;
+exports.CmsActionType = CmsActionType;
+
+(function (CmsActionType) {
+  CmsActionType["artistNeedsMatching"] = "artistNeedsMatching";
+  CmsActionType["shownMissingInformation"] = "shownMissingInformation";
+})(CmsActionType || (exports.CmsActionType = CmsActionType = {}));

package/dist/Schema/CMS/Values/CmsContextModule.d.ts

@@ -0,0 +1,9 @@
+/**
+ * All context modules available for CMS
+ *
+ * A component where an action is triggered
+ * @packageDocumentation
+ */
+export declare enum CmsContextModule {
+    batchImportFlow = "batchImportFlow"
+}

package/dist/Schema/CMS/Values/CmsContextModule.js

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.CmsContextModule = void 0;
+
+/**
+ * All context modules available for CMS
+ *
+ * A component where an action is triggered
+ * @packageDocumentation
+ */
+var CmsContextModule;
+exports.CmsContextModule = CmsContextModule;
+
+(function (CmsContextModule) {
+  CmsContextModule["batchImportFlow"] = "batchImportFlow";
+})(CmsContextModule || (exports.CmsContextModule = CmsContextModule = {}));

package/dist/Schema/CMS/Values/CmsOwnerType.d.ts

@@ -0,0 +1,9 @@
+/**
+ * All owner types available for CMS
+ *
+ * @packageDocumentation
+ */
+export declare enum CmsOwnerType {
+    batchImport = "batchImport",
+    batchImportArtistMatching = "batchImportArtistMatching"
+}

package/dist/Schema/CMS/Values/CmsOwnerType.js

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.CmsOwnerType = void 0;
+
+/**
+ * All owner types available for CMS
+ *
+ * @packageDocumentation
+ */
+var CmsOwnerType;
+exports.CmsOwnerType = CmsOwnerType;
+
+(function (CmsOwnerType) {
+  CmsOwnerType["batchImport"] = "batchImport";
+  CmsOwnerType["batchImportArtistMatching"] = "batchImportArtistMatching";
+})(CmsOwnerType || (exports.CmsOwnerType = CmsOwnerType = {}));

package/dist/Schema/index.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Web and iOS exports
+ */
 export * from "./Events";
 export * from "./Events/ActivityPanel";
 export * from "./Events/AddToCalendar";
@@ -29,3 +32,9 @@ export * from "./Values/Intent";
 export * from "./Values/OwnerType";
 export * from "./Values/PushNotificationType";
 export * from "./Values/Tab";
+/**
+ * CMS-specific exports
+ */
+export * from "./CMS/Events";
+export * from "./CMS/Values/CmsContextModule";
+export * from "./CMS/Values/CmsOwnerType";

package/dist/Schema/index.js

@@ -374,4 +374,40 @@ Object.keys(_Tab).forEach(function (key) {
       return _Tab[key];
     }
   });
+});
+
+var _Events2 = require("./CMS/Events");
+
+Object.keys(_Events2).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _Events2[key];
+    }
+  });
+});
+
+var _CmsContextModule = require("./CMS/Values/CmsContextModule");
+
+Object.keys(_CmsContextModule).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _CmsContextModule[key];
+    }
+  });
+});
+
+var _CmsOwnerType = require("./CMS/Values/CmsOwnerType");
+
+Object.keys(_CmsOwnerType).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _CmsOwnerType[key];
+    }
+  });
 });

package/package.json

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