fix(tiktokPixel): missing types (#773)

Author: harlan-zw

packages/script/src/runtime/registry/tiktok-pixel.ts

@@ -13,11 +13,13 @@ type StandardEvents
 |'AddPaymentInfo'
 |'CompletePayment'
 |'PlaceAnOrder'
+|'Purchase'
 |'Contact'
 |'Download'
 |'SubmitForm'
 |'CompleteRegistration'
 |'Subscribe'
+|'StartTrial'
 
 interfaceEventProperties{
 content_id?: string
@@ -37,8 +39,14 @@ interface IdentifyProperties {
 external_id?: string
 }
 
+interfaceTrackOptions{
+/** Used to deduplicate events sent from both the browser Pixel and the server-side Events API. */
+event_id?: string
+[key: string]: any
+}
+
 typeTtqFns
-=((cmd: 'track',event: StandardEvents|(string&{}),properties?: EventProperties)=>void)
+=((cmd: 'track',event: StandardEvents|(string&{}),properties?: EventProperties,options?: TrackOptions)=>void)
 &((cmd: 'page')=>void)
 &((cmd: 'identify',properties: IdentifyProperties)=>void)
 &((cmd: (string&{}), ...args: any[])=>void)

test/types/types.test-d.ts

@@ -1,6 +1,7 @@
 importtype{ModuleOptions}from'../../packages/script/src/module'
 importtype{CrispApi}from'../../packages/script/src/runtime/registry/crisp'
 importtype{DefaultEventName}from'../../packages/script/src/runtime/registry/google-analytics'
+importtype{TikTokPixelApi}from'../../packages/script/src/runtime/registry/tiktok-pixel'
 importtype{NuxtConfigScriptRegistry,NuxtConfigScriptRegistryEntry,NuxtUseScriptOptions,RegistryScriptInput,ScriptRegistry,UseScriptContext}from'../../packages/script/src/runtime/types'
 import{describe,expectTypeOf,it}from'vitest'
 
@@ -157,3 +158,20 @@ describe('#nuxt-scripts/types exports', () => {
 expectTypeOf<ScriptRegistry>().toHaveProperty('clarity')
 })
 })
+
+describe('tiktok pixel ttq',()=>{
+typeTtq=TikTokPixelApi['ttq']
+
+it('track accepts the 4th options arg with event_id',()=>{
+expectTypeOf<Ttq>().toBeCallableWith('track','Purchase',{value: 10},{event_id: 'abc'})
+})
+
+it('track accepts standard events including Purchase and StartTrial',()=>{
+expectTypeOf<Ttq>().toBeCallableWith('track','Purchase')
+expectTypeOf<Ttq>().toBeCallableWith('track','StartTrial')
+})
+
+it('track still accepts arbitrary custom event names',()=>{
+expectTypeOf<Ttq>().toBeCallableWith('track','CustomEvent')
+})
+})