wip

Author: silesky

packages/signals/signals-runtime/editor/web-editor.d.ts

@@ -18,9 +18,10 @@ type JSONObject = {
 };
 type JSONArray = JSONValue[];
 interface SegmentEvent {
-	type: string;
+	type: EventType;
 	[key: string]: any;
 }
+type EventType = "track" | "page" | "screen" | "identify" | "group" | "alias";
 type WebSignalTypes = WebSignal["type"];
 interface WebAppSignal<T extends WebSignalTypes, Data> extends BaseSignal {
 	type: T;

packages/signals/signals-runtime/src/mobile/mobile-signal-types.ts

@@ -1,7 +1,26 @@
 import { BaseSignal } from '../shared/shared-types'
-
 export type MobileSignalTypes = MobileSignal['type']
 
+export type MobileSignalType = MobileSignal['type']
+
+export type MobileNavigationAction =
+  | 'forward'
+  | 'backward'
+  | 'modal'
+  | 'entering'
+  | 'leaving'
+  | 'page'
+  | 'popup'
+
+export type NetworkAction = 'request' | 'response'
+
+export type LocalDataAction =
+  | 'loaded'
+  | 'updated'
+  | 'saved'
+  | 'deleted'
+  | 'undefined'
+
 export type MobileSignal =
   | MobileInteractionSignal
   | MobileNavigationSignal
@@ -10,20 +29,20 @@ export type MobileSignal =
   | MobileInstrumentationSignal
   | MobileUserDefinedSignal
 
-interface MobileRawSignal extends BaseSignal {
+interface MobileRawSignal<SignalType extends string> extends BaseSignal {
+  type: SignalType
   anonymousId: string
-  type: string
   data: any
   timestamp: string
   index: any
 }
 
 interface MobileNavigationData {
-  action: string
+  action: MobileNavigationAction
   screen: string
 }
 
-interface MobileNavigationSignal extends MobileRawSignal {
+interface MobileNavigationSignal extends MobileRawSignal<'navigation'> {
   data: MobileNavigationData
 }
 
@@ -33,35 +52,32 @@ interface MobileInteractionData {
   data: any
 }
 
-interface MobileInteractionSignal extends MobileRawSignal {
+interface MobileInteractionSignal extends MobileRawSignal<'interaction'> {
   type: 'interaction'
   data: MobileInteractionData
 }
 
 interface MobileNetworkData {
-  action: string
+  action: NetworkAction
   url: string
   data: any
 }
 
-interface MobileNetworkSignal extends MobileRawSignal {
-  static: 'network'
+interface MobileNetworkSignal extends MobileRawSignal<'network'> {
   data: MobileNetworkData
 }
 
 interface MobileLocalData {
-  action: string
+  action: LocalDataAction
   identifier: string
   data: string
 }
 
-interface MobileLocalDataSignal extends MobileRawSignal {
-  type: 'localData'
+interface MobileLocalDataSignal extends MobileRawSignal<'localData'> {
   data: MobileLocalData
 }
 
-interface MobileUserDefinedSignal extends MobileRawSignal {
-  type: 'userDefined'
+interface MobileUserDefinedSignal extends MobileRawSignal<'userDefined'> {
   data: any
 }
 
@@ -70,6 +86,7 @@ interface MobileInstrumentationData {
   rawEvent: any
 }
 
-interface MobileInstrumentationSignal extends MobileRawSignal {
+interface MobileInstrumentationSignal
+  extends MobileRawSignal<'instrumentation'> {
   data: MobileInstrumentationData
 }

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

@@ -21,6 +21,14 @@ export type JSONObject = { [member: string]: JSONValue }
 export type JSONArray = JSONValue[]
 
 export interface SegmentEvent {
-  type: string // e.g 'track'
+  type: EventType // e.g 'track'
   [key: string]: any
 }
+
+export type EventType =
+  | 'track'
+  | 'page'
+  | 'screen'
+  | 'identify'
+  | 'group'
+  | 'alias'