chore: Add Completeness Score events (#657)

Author: olerichter00

src/Schema/CMS/Events/CompletenessScoreFlow.ts

@@ -0,0 +1,62 @@
+/**
+ * Schemas describing CMS CompletenessScore events
+ * @packageDocumentation
+ */
+
+import { CmsContextModule } from "../Values/CmsContextModule"
+import { CmsActionType } from "."
+
+/**
+ * Generic click event in the completeness score flow.
+ *
+ * @example
+ * {
+ *   action: "click",
+ *   context_module: "Artworks - completeness score",
+ *   label: "view details",
+ *   artwork_ids: ["artwork1", "artwork2", "artwork3"]
+ * }
+ */
+export type CmsCompletenessScoreClickLabel =
+  | "view details"
+  | "improve score"
+  | "dismiss"
+
+export interface CmsCompletenessScoreClickedEvent {
+  action: "click"
+  context_module: CmsContextModule.completenessScore
+  label: CmsCompletenessScoreClickLabel
+  value?: string | number
+  artwork_ids?: string[]
+}
+
+/**
+ * Completeness score modal has been shown to a partner.
+ *
+ * @example
+ * ```
+ * {
+ *   action: "shownCompletenessScoreModal",
+ *   context_module: "Artworks - completeness score",
+ *   artwork_id: "artwork123",
+ *   completeness_score: 75,
+ *   completeness_tier: "good",
+ *   checklist: [
+ *     { completed: true, key: "title" },
+ *     { completed: false, key: "description" }
+ *   ]
+ * }
+ * ```
+ */
+export interface CmsCompletenessScoreModalShown {
+  action: CmsActionType.shownCompletenessScoreModal
+  context_module: CmsContextModule.completenessScore
+  artwork_id: string
+  completeness_score: number
+  completeness_tier: string
+  checklist: Array<{ completed: boolean; key: string }>
+}
+
+export type CmsCompletenessScoreFlow =
+  | CmsCompletenessScoreClickedEvent
+  | CmsCompletenessScoreModalShown

src/Schema/CMS/Events/index.ts

@@ -2,6 +2,7 @@ import { CmsAnalyticsPage } from "./AnalyticsPage"
 import { CmsArtworkFilter } from "./ArtworkFilter"
 import { CmsBatchImportFlow } from "./BatchImportFlow"
 import { CmsBulkEditFlow } from "./BulkEditFlow"
+import { CmsCompletenessScoreFlow } from "./CompletenessScoreFlow"
 import { CmsQuickReplyFlow } from "./QuickReplyFlow"
 import { CmsSettingsFlow } from "./SettingsFlow"
 import { CmsShowFlow } from "./ShowFlow"
@@ -17,6 +18,7 @@ export type CmsEvent =
   | CmsArtworkFilter
   | CmsBulkEditFlow
   | CmsBatchImportFlow
+  | CmsCompletenessScoreFlow
   | CmsUploadArtworkFlow
   | CmsQuickReplyFlow
   | CmsSettingsFlow
@@ -133,6 +135,11 @@ export enum CmsActionType {
    */
   shownMissingInformation = "shownMissingInformation",
 
+  /**
+   * Corresponds to {@link CmsCompletenessScoreFlow}
+   */
+  shownCompletenessScoreModal = "shownCompletenessScoreModal",
+
   /**
    * Corresponds to {@link CmsAnalytics}
    */

src/Schema/CMS/Values/CmsContextModule.ts

@@ -17,6 +17,7 @@ export enum CmsContextModule {
   artworkFilterQuickEdit = "Artworks - quick edit",
   batchImportFlow = "batchImportFlow",
   bulkEditFlow = "Artworks - bulk edit",
+  completenessScore = "Artworks - completeness score",
   conversations = "conversations",
   uploads = "Uploads",
   settings = "Settings",