Generate Events from Signals

1
interface RawSignal<T> {
2
  var anonymousId: String    // 
3
  var type: SignalType       // Specifies the signal category.
4
  var timestamp: String      // The exact time when the signal was generated.
5
  var index: Int             // An integer representing the signal's position.
6
  var data: T                // The specific data of type `T` associated with the signal.
7
}

1
enum SignalType {
2
  Interaction,      // User interactions like clicks or touches.
3
  Navigation,       // Navigation events.
4
  Network,          // Network requests and responses.
5
  LocalData,        // Data loaded from local or other external sources.
6
  Instrumentation,  // Events generated from Segment Track/Screen/... events.
7
  UserDefined       // Custom events defined by the user.
8
}

1
class InteractionData {
2
  var component: String // The type of UI component interacted with, like "Button" or "Image".
3
  var title: String?    // Optional title of the component, if applicable.
4
  var data: Object?     // Additional data related to the interaction, if any.
5
}
6

7
class InteractionSignal extends RawSignal<InteractionData> {
8
  type = SignalType.UIInteraction // Sets the signal type to UI Interaction.
9
}

1
enum NavigationAction {
2
  Forward,    // Navigation to the next item or page
3
  Backward,   // Navigation to the previous item or page
4
  Modal,      // Opening a modal window
5
  Entering,   // Entering a new screen 
6
  Leaving,    // Leaving a screen 
7
  Page,       // Navigation involving a full page
8
  Popup       // Interaction with a popup
9
}
10

11
class NavigationData {
12
  var action: NavigationAction // The type of navigation action performed.
13
  var screen: String           // The screen or component name involved in the navigation.
14
}
15

16
class NavigationSignal extends RawSignal<NavigationData> {
17
  type = SignalType.Navigation // Sets the signal type to Navigation.
18
}

1
enum NetworkAction {
2
  Request,  // A network request is made.
3
  Response  // A response is received.
4
}
5

6
class NetworkData {
7
  var action: NetworkAction // The type of network action, either Request or Response.
8
  var url: String           // The URL involved in the network action.
9
  var statusCode: Int?      // The HTTP status code of the response, if applicable.
10
  var data: Object?         // Additional data associated with the network action.
11
}
12

13
class NetworkSignal extends RawSignal<NetworkData> {
14
  type = SignalType.Network // Sets the signal type to Network.
15
}

1
enum LocalDataAction {
2
  Loaded,    // Data was loaded from a local source.
3
  Updated,   // Existing data was updated.
4
  Saved,     // New data was saved locally.
5
  Deleted,   // Data was deleted from a local source.
6
  Undefined  // Any other unspecified local data action.
7
}
8

9
class LocalData {
10
  var action: LocalDataAction // The type of action performed on the local data.
11
  var identifier: String      // A unique identifier for the data, like "Loaded User Info".
12
  var data: Object?           // Additional details or data associated with the action.
13
}
14

15
class LocalDataSignal extends RawSignal<LocalData> {
16
  type = SignalType.LocalData // Sets the signal type to LocalData.
17
}

1
enum EventType {
2
  Track,    // 
3
  Screen,   // 
4
  Identify, // 
5
  Group,    // 
6
  Alias,    // 
7
  Unknown   // Any other unspecified event type.
8
}
9

10
class InstrumentationData {
11
  type: EventType      // The type of Segment event.
12
  rawEvent: Object?    // Additional details of the event.
13
}
14

15
class InstrumentationSignal extends RawSignal<InstrumentationData> {
16
  type = SignalType.Instrumentation // Sets the signal type to Instrumentation.
17
}

1
interface MyCustomData {
2
  var event: String  // A custom event description or identifier.
3
}
4

5
class MyCustomSignal extends RawSignal<MyCustomData> {
6
  type = SignalType.UserDefined // Sets the signal type to User Defined.
7
}

1
function screenCall(currentSignal) {
2
  if (currentSignal.type == SignalType.Navigation && currentSignal.data.action == NavigationAction.Entering) {
3
    analytics.screen(currentSignal.data.screen, null, null)
4
  }
5
}
6

7
function processSignal(signal) {
8
  screenCall(signal)
9
}

1
function detectIdentify(currentSignal) {
2
  var loginType;
3
  
4
  // Check if the signal is related to network activity on a login URL
5
  if (currentSignal.type == SignalType.Network && currentSignal.data.url.includes("login")) {
6
      loginType = "login";
7
  }
8
  
9
  // If a login type was detected, identify the user
10
  if (loginType) {
11
      var traits = new Object();
12
      traits.loggedIn = true; // Set user status to logged in
13
      let loginData = currentSignal.data.data.content; // Extract login data from the signal
14
      traits.userName = loginData.userName; // Capture the user's name
15

16
      if (loginType === "login") {
17
          var userId = loginData.userId; // Get userID from login data
18
          analytics.identify(userId, traits); // Identify the user with the Identify call
19
      } 
20
  }
21
}
22

23
//...other functions
24

25
function processSignal(signal) {
26
  //...other functions
27
  detectIdentify(signal); // Process the Identify call based on incoming signals
28
}

1
function trackAddToCart(currentSignal) {
2
  // Check if the signal is an interaction with the "Add To Cart" button
3
  if (currentSignal.type == SignalType.Interaction && currentSignal.data.title == "Add To Cart") {
4
      var properties = new Object(); // Initialize an object to store event properties
5
      
6
      // Find the network response signal for additional data
7
      let network = signals.find(currentSignal, SignalType.Network, (signal) => {
8
          return signal.data.action === NetworkAction.Response;
9
      });
10

11
      if (network) {
12
          // Extract and assign product details from the network response
13
          properties.price = network.data.data.content.price; // Product price
14
          properties.currency = network.data.data.content.currency ?? "USD"; // Currency, defaulting to USD if undefined
15
          properties.productId = network.data.data.content.id; // Product ID
16
          properties.productName = network.data.data.content.title; // Product name
17
      }
18
      
19
      // Track the "Add To Cart" event with the defined properties
20
      analytics.track(currentSignal.data.title, properties);
21
  }
22
}
23

24
//...other functions
25

26
function ProcessSignals(signal) {
27
  //...other functions
28
  trackAddToCart(signal); // Process the "Add To Cart" tracking based on incoming signals
29
}