Skip to content

Commit 928d5f4

Browse files
authored
fix: cmdk event naming and description (supabase#39860)
1 parent 312259b commit 928d5f4

File tree

6 files changed

+17
-17
lines changed

6 files changed

+17
-17
lines changed

apps/docs/hooks/useDocsCommandMenuTelemetry.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import { useCallback } from 'react'
44

55
import type {
66
CommandMenuOpenedEvent,
7-
CommandMenuCommandSelectedEvent,
7+
CommandMenuCommandClickedEvent,
88
CommandMenuSearchSubmittedEvent,
99
} from 'common/telemetry-constants'
1010
import { useSendTelemetryEvent } from 'lib/telemetry'
@@ -16,7 +16,7 @@ export function useDocsCommandMenuTelemetry() {
1616
(
1717
event:
1818
| CommandMenuOpenedEvent
19-
| CommandMenuCommandSelectedEvent
19+
| CommandMenuCommandClickedEvent
2020
| CommandMenuSearchSubmittedEvent
2121
) => {
2222
sendTelemetryEvent(event)

apps/studio/hooks/misc/useStudioCommandMenuTelemetry.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { useSelectedOrganizationQuery } from 'hooks/misc/useSelectedOrganization
55
import { useSendEventMutation } from 'data/telemetry/send-event-mutation'
66
import type {
77
CommandMenuOpenedEvent,
8-
CommandMenuCommandSelectedEvent,
8+
CommandMenuCommandClickedEvent,
99
CommandMenuSearchSubmittedEvent,
1010
} from 'common/telemetry-constants'
1111

@@ -18,7 +18,7 @@ export function useStudioCommandMenuTelemetry() {
1818
(
1919
event:
2020
| CommandMenuOpenedEvent
21-
| CommandMenuCommandSelectedEvent
21+
| CommandMenuCommandClickedEvent
2222
| CommandMenuSearchSubmittedEvent
2323
) => {
2424
// Add studio-specific groups (project and organization)

apps/www/hooks/useWwwCommandMenuTelemetry.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { useCallback } from 'react'
22

33
import type {
44
CommandMenuOpenedEvent,
5-
CommandMenuCommandSelectedEvent,
5+
CommandMenuCommandClickedEvent,
66
CommandMenuSearchSubmittedEvent,
77
} from 'common/telemetry-constants'
88
import { useSendTelemetryEvent } from 'lib/telemetry'
@@ -14,7 +14,7 @@ export function useWwwCommandMenuTelemetry() {
1414
(
1515
event:
1616
| CommandMenuOpenedEvent
17-
| CommandMenuCommandSelectedEvent
17+
| CommandMenuCommandClickedEvent
1818
| CommandMenuSearchSubmittedEvent
1919
) => {
2020
sendTelemetryEvent(event)

packages/common/telemetry-constants.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1953,7 +1953,7 @@ export interface AuthUsersSearchSubmittedEvent {
19531953
* User opened the command menu.
19541954
*
19551955
* @group Events
1956-
* @source ui-patterns
1956+
* @source studio, docs, www
19571957
* @page any
19581958
*/
19591959
export interface CommandMenuOpenedEvent {
@@ -1979,7 +1979,7 @@ export interface CommandMenuOpenedEvent {
19791979
* User typed a search term in the command menu input.
19801980
*
19811981
* @group Events
1982-
* @source ui-patterns
1982+
* @source studio, docs, www
19831983
* @page any
19841984
*/
19851985
export interface CommandMenuSearchSubmittedEvent {
@@ -1998,17 +1998,17 @@ export interface CommandMenuSearchSubmittedEvent {
19981998
}
19991999

20002000
/**
2001-
* User selected a command from the command menu.
2001+
* User clicked a command from the command menu.
20022002
*
20032003
* @group Events
2004-
* @source ui-patterns
2004+
* @source studio, docs, www
20052005
* @page any
20062006
*/
2007-
export interface CommandMenuCommandSelectedEvent {
2008-
action: 'command_menu_command_selected'
2007+
export interface CommandMenuCommandClickedEvent {
2008+
action: 'command_menu_command_clicked'
20092009
properties: {
20102010
/**
2011-
* The selected command
2011+
* The clicked command
20122012
*/
20132013
command_name: string
20142014
command_value?: string
@@ -2137,4 +2137,4 @@ export type TelemetryEvent =
21372137
| AuthUsersSearchSubmittedEvent
21382138
| CommandMenuOpenedEvent
21392139
| CommandMenuSearchSubmittedEvent
2140-
| CommandMenuCommandSelectedEvent
2140+
| CommandMenuCommandClickedEvent

packages/ui-patterns/src/CommandMenu/api/hooks/useCommandMenuTelemetry.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ import { useCommandMenuOpen } from './viewHooks'
66

77
import type {
88
CommandMenuOpenedEvent,
9-
CommandMenuCommandSelectedEvent,
9+
CommandMenuCommandClickedEvent,
1010
CommandMenuSearchSubmittedEvent,
1111
} from 'common/telemetry-constants'
1212

1313
export type CommandMenuTelemetryCallback = (
14-
event: CommandMenuOpenedEvent | CommandMenuCommandSelectedEvent | CommandMenuSearchSubmittedEvent
14+
event: CommandMenuOpenedEvent | CommandMenuCommandClickedEvent | CommandMenuSearchSubmittedEvent
1515
) => void
1616

1717
export interface UseCommandMenuTelemetryOptions {

packages/ui-patterns/src/CommandMenu/internal/Command.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ const CommandItem = forwardRef<
6161
// Send telemetry event
6262
if (telemetryContext?.onTelemetry) {
6363
const event = {
64-
action: 'command_menu_command_selected' as const,
64+
action: 'command_menu_command_clicked' as const,
6565
properties: {
6666
command_name: command.name,
6767
command_value: command.value,

0 commit comments

Comments
 (0)