feat: Add artwork template tracking schema (#663)

* feat: Add artwork template tracking events

* export CMS events in Schema/index.ts

Author: MrSltun

src/Schema/CMS/Events/SettingsFlow.ts

@@ -45,6 +45,27 @@ export interface SettingsFlowEditLocation {
   user_id: string
 }
 
+/**
+ * Event fired after user deletes an artwork template
+ *
+ * @example
+ * ```
+ * {
+ *   action: "deletedArtworkTemplate",
+ *   context_module: "Settings",
+ *   template_id: "template-id",
+ *   user_id: "some-user-id",
+ * }
+ * ```
+ */
+export interface SettingsFlowDeleteArtworkTemplate {
+  action: CmsActionType.deletedArtworkTemplate
+  context_module: CmsContextModule.settings
+  template_id: string
+  user_id: string
+}
+
 export type CmsSettingsFlow =
   | SettingsFlowAddNewLocation
   | SettingsFlowEditLocation
+  | SettingsFlowDeleteArtworkTemplate

src/Schema/CMS/Events/UploadArtworkFlow.ts

@@ -1,6 +1,24 @@
 import { CmsContextModule } from "../Values/CmsContextModule"
 import { CmsActionType } from "."
 
+/**
+ * Click "Create from template" in upload artwork flow
+ *
+ * @example
+ * ```
+ * {
+ *   action: "click",
+ *   context_module: "Uploads",
+ *   label: "Create from template",
+ * }
+ * ```
+ */
+export interface UploadArtworkFlowClickedCreateFromTemplate {
+  action: "click"
+  context_module: CmsContextModule.uploads
+  label: "Create from template"
+}
+
 /**
  * Click "Next" after selecting an existing artist
  *
@@ -39,6 +57,26 @@ export interface UploadArtworkFlowClickFinishUploadingImages {
   artwork_ids: string[]
 }
 
+/**
+ * Click "Add Another Artwork" in Review page
+ *
+ * @example
+ * ```
+ * {
+ *   action: "click",
+ *   context_module: "Uploads",
+ *   label: "Add another artwork",
+ *   template_id: "template-123",
+ * }
+ * ```
+ */
+export interface UploadArtworkFlowClickedAddAnotherArtwork {
+  action: "click"
+  context_module: CmsContextModule.uploads
+  label: "Add another artwork"
+  template_id: string
+}
+
 /**
  * Click "View my artworks" after creating artworks
  *
@@ -79,8 +117,33 @@ export interface UploadArtworkFlowCreateArtworks {
   user_id: string
 }
 
+/**
+ * Event fired after user created artworks from template
+ *
+ * @example
+ * ```
+ * {
+ *   action: "createdArtworkFromTemplate",
+ *   context_module: "Uploads",
+ *   template_id: "template-123",
+ *   artwork_ids: ['some-artwork-id'],
+ *   user_id: "some-user-id",
+ * }
+ * ```
+ */
+export interface UploadArtworkFlowCreateArtworksFromTemplate {
+  action: CmsActionType.createdArtworkFromTemplate
+  context_module: CmsContextModule.uploads
+  template_id: string
+  artwork_ids: string[]
+  user_id: string
+}
+
 export type CmsUploadArtworkFlow =
+  | UploadArtworkFlowClickedCreateFromTemplate
   | UploadArtworkFlowClickSelectExistingArtist
   | UploadArtworkFlowClickFinishUploadingImages
+  | UploadArtworkFlowClickedAddAnotherArtwork
   | UploadArtworkFlowClickViewMyArtworks
   | UploadArtworkFlowCreateArtworks
+  | UploadArtworkFlowCreateArtworksFromTemplate

src/Schema/CMS/Events/index.ts

@@ -31,7 +31,7 @@ export type CmsEvent =
  */
 export enum CmsActionType {
   /**
-   * Corresponds to {@link SettingsFlow}
+   * Corresponds to {@link CmsSettingsFlow}
    */
   addedNewLocation = "addedNewLocation",
 
@@ -75,6 +75,11 @@ export enum CmsActionType {
    */
   createdArtwork = "created artwork",
 
+  /**
+   * Corresponds to {@link CmsUploadArtworkFlow}
+   */
+  createdArtworkFromTemplate = "createdArtworkFromTemplate",
+
   /**
    * Corresponds to {@link CmsBatchImportFlow}
    */
@@ -86,7 +91,7 @@ export enum CmsActionType {
   editedBatchImportField = "editedBatchImportField",
 
   /**
-   * Corresponds to {@link SettingsFlow}
+   * Corresponds to {@link CmsSettingsFlow}
    */
   editedLocation = "editedLocation",
 
@@ -210,6 +215,11 @@ export enum CmsActionType {
    */
   deletedTemplate = "deletedTemplate",
 
+  /**
+   * Corresponds to {@link CmsSettingsFlow}
+   */
+  deletedArtworkTemplate = "deletedArtworkTemplate",
+
   /**
    * Corresponds to {@link CmsQuickReplyFlow}
    */

src/Schema/Events/Click.ts

@@ -1654,6 +1654,30 @@ export interface ClickedSave {
   shipping_preset_id?: string
 }
 
+/**
+ * A partner clicks on Save as Template button on an artwork in the CMS.
+ *
+ * This schema describes events sent to Segment from [[ClickedSaveAsTemplate]]
+ *
+ *  @example
+ *  ```
+ *  {
+ *    action: "clickedSaveAsTemplate",
+ *    context_module: "voltArtworksEdit" | "artworkForm",
+ *    artwork_id: "60de173a47476c000fd5c4cc"
+ *    label: "Save as template"
+ *    flow: "artworksList" | "artworkForm"
+ *  }
+ * ```
+ */
+export interface ClickedSaveAsTemplate {
+  action: ActionType.clickedSaveAsTemplate
+  context_module: ContextModule
+  artwork_id: string
+  label: string
+  flow: string
+}
+
 /**
  * A Partner selects a filter on the conversations page in CMS.
  *

src/Schema/Events/index.ts

@@ -111,6 +111,7 @@ import {
   ClickedPaymentMethod,
   ClickedPromoSpace,
   ClickedPublish,
+  ClickedSaveAsTemplate,
   ClickedSelectShippingOption,
   ClickedSendPartnerOffer,
   ClickedShippingAddress,
@@ -405,6 +406,7 @@ export type Event =
   | ClickedPromoSpace
   | ClickedPublish
   | ClickedRegisterToBid
+  | ClickedSaveAsTemplate
   | ClickedSelectShippingOption
   | ClickedSendPartnerOffer
   | ClickedShareButton
@@ -916,6 +918,10 @@ export enum ActionType {
    * Corresponds to {@link ClickedSave}
    */
   clickedSave = "clickedSave",
+  /**
+   * Corresponds to {@link ClickedSaveAsTemplate}
+   */
+  clickedSaveAsTemplate = "clickedSaveAsTemplate",
   /**
    * Corresponds to {@link ClickedShareButton}
    */

src/Schema/index.ts

@@ -41,3 +41,12 @@ export * from "./Values/Tab"
 export * from "./CMS/Events"
 export * from "./CMS/Values/CmsContextModule"
 export * from "./CMS/Values/CmsOwnerType"
+export * from "./CMS/Events/AnalyticsPage"
+export * from "./CMS/Events/ArtworkFilter"
+export * from "./CMS/Events/BatchImportFlow"
+export * from "./CMS/Events/BulkEditFlow"
+export * from "./CMS/Events/CompletenessScoreFlow"
+export * from "./CMS/Events/QuickReplyFlow"
+export * from "./CMS/Events/SettingsFlow"
+export * from "./CMS/Events/ShowFlow"
+export * from "./CMS/Events/UploadArtworkFlow"