glean/src/core/pings/ping_payload.ts

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

import type { Metrics } from "../metrics/index.js";
import type { JSONObject, JSONArray } from "../utils.js";

export interface PingInfo extends JSONObject {
  seq: number,
  start_time: string,
  end_time: string,
  reason?: string,
}

export interface ClientInfo extends JSONObject {
  client_id?: string,
  locale?: string,
  device_model?: string,
  device_manufacturer?: string,
  app_channel?: string,
  // Even though all the next fields are required by the schema
  // we can't guarantee that they will be present.
  // Active discussion about this is happening on Bug 1685705.
  app_build?: string,
  app_display_version?: string,
  architecture?: string,
  first_run_date?: string,
  os?: string,
  os_version?: string,
  telemetry_sdk_build: string,
  session_id?: string,
  session_count?: number
}

/**
 * This definition must be in sync with
 * the Glean ping [schema](https://github.com/mozilla-services/mozilla-pipeline-schemas/blob/master/schemas/glean/glean/glean.1.schema.json)
 */
export interface PingPayload extends JSONObject {
  ping_info: PingInfo,
  client_info: ClientInfo,
  metrics?: Metrics,
  events?: JSONArray,
}