feat(sanity): add telemetry when creating a draft

sanity-io · Sep 3, 2024 · 7041026 · 7041026
1 parent 8bc721b
commit 7041026
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/packages/sanity/src/structure/panes/document/DocumentPaneProvider.tsx b/packages/sanity/src/structure/panes/document/DocumentPaneProvider.tsx
@@ -48,7 +48,7 @@ import {usePaneRouter} from '../../components'
 import {structureLocaleNamespace} from '../../i18n'
 import {type PaneMenuItem} from '../../types'
 import {useStructureTool} from '../../useStructureTool'
-import {DocumentURLCopied} from './__telemetry__'
+import {CreatedDraft, DocumentURLCopied} from './__telemetry__'
 import {
   DEFAULT_MENU_ITEM_GROUPS,
   EMPTY_PARAMS,
@@ -294,6 +294,10 @@ export const DocumentPaneProvider = memo((props: DocumentPaneProviderProps) => {
   })
 
   patchRef.current = (event: PatchEvent) => {
+    // when creating a new draft
+    if (!editState.draft && !editState.version && !editState.published) {
+      telemetry.log(CreatedDraft)
+    }
     patch.execute(toMutationPatches(event.patches), initialValue.value)
   }
 

diff --git a/packages/sanity/src/structure/panes/document/__telemetry__/documentPanes.telemetry.ts b/packages/sanity/src/structure/panes/document/__telemetry__/documentPanes.telemetry.ts
@@ -8,3 +8,13 @@ export const DocumentURLCopied = defineEvent({
   version: 1,
   description: 'User copied document URL to clipboard',
 })
+
+/**
+ * When a draft is successfully created
+ * @internal
+ */
+export const CreatedDraft = defineEvent({
+  name: 'Create a new draft',
+  version: 1,
+  description: 'User created a new draft',
+})