import { DateTime, HashMap, Option, Utc } from "./_commons";
import { EventType } from "./EventType";
import { PageVisitEventError } from "./PageVisitEventError";
import { PageVisitUserStep } from "./PageVisitUserStep";
import { PageVisitEventHTTP } from "./PageVisitEventHTTP";
import { PageVisitEventLoc } from "./PageVisitEventLoc";
import { PageVisitEventPage } from "./PageVisitEventPage";
import { PageVisitEventWebVitals } from "./PageVisitEventWebVitals";
import { PageVisitEventECommerce } from "./PageVisitEventECommerce";
import { PageVisitEventNetworkStats } from "./PageVisitEventNetworkStats";
import { PageVisitEventSampleEntry } from "./PageVisitEventSampleEntry";
import { PageVisitEventApplicationNavigation } from "./PageVisitEventApplicationNavigation";
import { PageVisitEventVisualError } from "./PageVisitEventVisualError";
import { PageVisitEventPageType } from "./PageVisitEventPageType";
import { PageVisitEventPageGroups } from "./PageVisitEventPageGroups";

/**
 * PageVisitEvent represents one event that occurred on a page visit
 * Since it has OccurredAt which is in browser time it can be time ordered later
 */
export interface PageVisitEvent {
  /**
   * The type of event this is for and which of the optional members will have data
   * Renamed to event_type in metroplex
   */
  type: EventType;

  /**
   * The time that the event occurred at. Browser time
   * Renamed to occurred_at in metroplex
   */
  occ_at: DateTime<Utc>;

  /**
   * The remaining fields are used to capture the data for each respective type of event
   * Renamed to event_error in metroplex
   */
  err?: Option<PageVisitEventError>;

  /** Renamed to event_user_step in metroplex */
  userstep?: Option<PageVisitUserStep>;

  /** Renamed to event_http in metroplex */
  http?: Option<PageVisitEventHTTP>;

  /** Renamed to event_loc in metroplex */
  loc?: Option<PageVisitEventLoc>;

  /** Renamed to event_page in metroplex */
  page?: Option<PageVisitEventPage>;

  /** Renamed to event_web_vitals in metroplex */
  wv?: Option<PageVisitEventWebVitals>;

  /** Renamed to event_ecommerce in metroplex */
  ecommerce?: Option<PageVisitEventECommerce>;

  /** Renamed to event_network_stats in metroplex */
  network?: Option<PageVisitEventNetworkStats>;

  /** Renamed to event_sample in metroplex */
  sample?: Option<HashMap<string, PageVisitEventSampleEntry>>;

  /** Renamed to event_application_navigation in metroplex */
  app_nav?: Option<PageVisitEventApplicationNavigation>;

  /** Renamed to event_visual_error in metroplex */
  visual_error?: Option<PageVisitEventVisualError>;

  /**
   * page title was updated
   * Renamed to event_title in metroplex
   */
  title?: Option<PageVisitEventLoc>;

  /** Renamed to current_location in metroplex */
  cur_loc?: Option<PageVisitEventLoc>;

  /** Renamed to event_page_type in metroplex */
  page_type?: Option<PageVisitEventPageType>;

  /** Renamed to event_page_groups in metroplex */
  page_groups?: Option<PageVisitEventPageGroups>;
}