wip

Author: silesky

packages/signals/signals-integration-tests/src/tests/signals-vanilla/index-page.ts

@@ -27,12 +27,8 @@ export class IndexPage extends BasePage {
     return this.page.evaluate(
       (args) => {
         window.signalsPlugin.addSignal({
-          type: 'userDefined',
-          // @ts-ignore
-          data: {
-            foo: 'bar',
-            ...args.data,
-          },
+          foo: 'bar',
+          ...args.data,
         })
       },
       { data }
@@ -43,9 +39,7 @@ export class IndexPage extends BasePage {
     return this.page.click('#some-button')
   }
 
-  async clickComplexButton() {
-    return this.page.click('#complex-button')
-  }
+  async clickComplexButton() {}
 
   async clickInsideComplexButton() {
     return this.page.click('#complex-button h1')

packages/signals/signals-runtime/src/web/web-signals-types.ts

@@ -44,13 +44,13 @@ export interface PageData {
 /**
  * The base data that all web signal data must have
  */
-interface BaseWebData {
+export interface BaseWebData {
   page: PageData
 }
 
 export interface RawSignal<T extends SignalTypes, Data> extends BaseSignal {
   type: T
-  data: Data & BaseWebData
+  data: BaseWebData & Data
   metadata?: Record<string, any>
 }
 export type InteractionData = ClickData | SubmitData | ChangeData

packages/signals/signals/src/plugin/__tests__/signals-plugin.test.ts

@@ -42,10 +42,12 @@ describe(SignalsPlugin, () => {
 
   test('addSignal method emits signal', async () => {
     const plugin = new SignalsPlugin()
-    const signal = createUserDefinedSignal({ foo: 'bar' })
     const emitterSpy = jest.spyOn(plugin.signals.signalEmitter, 'emit')
-    plugin.addSignal(signal)
+    const userDefinedData = { foo: 'bar' }
+    plugin.addSignal(userDefinedData)
     expect(emitterSpy).toHaveBeenCalledTimes(1)
-    expect(emitterSpy.mock.calls[0][0]).toEqual(signal)
+    expect(emitterSpy.mock.calls[0][0]).toEqual(
+      createUserDefinedSignal(userDefinedData)
+    )
   })
 })

packages/signals/signals/src/plugin/signals-plugin.ts

@@ -5,7 +5,7 @@ import { AnyAnalytics, SignalsPluginSettingsConfig } from '../types'
 import { Signal } from '@segment/analytics-signals-runtime'
 import { assertBrowserEnv } from '../lib/assert-browser-env'
 import { version } from '../generated/version'
-import { getPageData } from '../lib/page-data'
+import { createUserDefinedSignal } from '../types/factories'
 
 export type OnSignalCb = (signal: Signal) => void
 
@@ -17,9 +17,9 @@ interface SignalsAugmentedFunctionality {
   onSignal: (fn: OnSignalCb) => this
 
   /**
-   * Emit/add a custom signal
+   * Emit/add a custom signal of type 'userDefined'
    */
-  addSignal(data: Signal): this
+  addSignal(userDefinedData: Record<string, unknown>): this
 }
 
 export class SignalsPlugin implements Plugin, SignalsAugmentedFunctionality {
@@ -83,9 +83,8 @@ export class SignalsPlugin implements Plugin, SignalsAugmentedFunctionality {
     return this
   }
 
-  addSignal(signal: Signal): this {
-    signal.data.page ??= getPageData()
-    this.signals.signalEmitter.emit(signal)
+  addSignal(data: Record<string, unknown>): this {
+    this.signals.signalEmitter.emit(createUserDefinedSignal(data))
     return this
   }
 

packages/signals/signals/src/types/signal-init.ts

@@ -0,0 +1 @@
+import { PageData, Signal } from '@segment/analytics-signals-runtime'