global.d.ts

declare module 'simple-vdf';

declare namespace Express {
  interface Locals {
    queryObj: QueryObj;
  }
  interface User {
    account_id: string;
  }
}

type QueryObj = {
  project: (keyof ParsedPlayerMatch)[];
  projectAll?: boolean;
  filter?: Map<string, (string | number)[]>;
  sort?: keyof ParsedPlayerMatch;
  // Number of results to return after client filter/sort
  limit?: number;
  offset?: number;
  having?: number;
  // Number of results to fetch from the database (before filter/sort)
  dbLimit?: number;
  isPrivate?: boolean;
  cacheSeconds?: number;
};

type AnyDict = Record<string, any>;
type NumberDict = Record<string, number>;
type ErrorCb = (
  err?: Error | null | undefined | string | unknown,
  result?: any,
) => void;

type Match = {
  match_id: number;
  players: Player[];
  start_time: number;
  duration: number;
  leagueid?: number;
  radiant_win: boolean;
  lobby_type: number;
  game_mode: number;
  cluster: number;
  patch?: number;
  region?: number;
  radiant_team_id?: number;
  dire_team_id?: number;
  picks_bans?: any[];
  human_players: number;

  // Computed if we have data
  replay_url?: string;
  replay_salt?: number;

  // Added at insert
  average_rank?: number;

  // Parsed match metadata from .meta file
  metadata?: any;

  od_data?: GetMatchDataMetadata | null;
};

type GetMatchDataMetadata = {
  has_api: boolean;
  has_gcdata: boolean;
  has_parsed: boolean;
  backfill_api?: boolean;
  backfill_gc?: boolean;
  has_archive: boolean;
};

interface LiveMatch extends Match {
  lobby_id: string;
}

interface ParsedMatch extends Match {
  players: ParsedPlayer[];
  version: number;
  chat: any[];
  cosmetics: any;
  objectives: any[];
  radiant_gold_adv: number[];
  teamfights: any[];
  draft_timings: any[];
}

type Player = {
  player_slot: number;
  account_id?: number;
  hero_id: number;
  kills: number;
  deaths: number;
  assists: number;
  denies: number;
  level: number;
  gold_per_min: number;
  xp_per_min: number;
  last_hits: number;
  hero_damage: number;
  hero_healing: number;
  tower_damage: number;
  leaver_status: number;
  hero_variant?: number;
  ability_upgrades?: any[];
  ability_upgrades_arr: number[];

  // Computed fields
  match_id?: number;
  radiant_win?: boolean;
  is_radiant: boolean;
  isRadiant?: boolean;
  win: number;
  lose: number;
  total_gold: number;
  total_xp: number;
  kills_per_min: number;
  kda: number;
  abandons: number;
  heroes: PGroup;
  benchmarks: AnyDict;

  // In Steam API that we're manually removing
  scaled_hero_damage?: number;
  scaled_tower_damage?: number;
  scaled_hero_healing?: number;
  aghanims_shard?: number;
  aghanims_scepter?: number;
  moonshard?: number;

  // Added in buildMatch for display
  is_subscriber: boolean;

  // For storing in player_caches
  average_rank?: number;
};

interface ParsedPlayer extends Player {
  kills_log: any[];
  obs_log: any[];
  purchase_log: any[];
  pings: any;
  purchase: NumberDict;
  lane_pos: Record<string, NumberDict>;
  gold_t: number[];
  xp_t: number[];
  lh_t: number[];
  item_uses: NumberDict;
  buyback_log: any[];
  killed: NumberDict;
  stuns: number;
  obs: any;
  sen: any;
  lane_role: number | null;
  neutral_tokens_log: any[];
  neutral_item_history: NeutralItemHistory[];

  party_size?: number;

  // Computed
  is_roaming?: boolean | null;
  all_word_counts: NumberDict;
  my_word_counts: NumberDict;
  throw: number | undefined;
  comeback: number | undefined;
  loss: number | undefined;
  stomp: number | undefined;
  life_state: NumberDict;
  life_state_dead: number;
  actions: NumberDict;
  actions_per_min: number;
  purchase_ward_observer: number;
  purchase_ward_sentry: number;
  purchase_tpscroll: number;
  purchase_rapier: number;
  purchase_gem: number;
  item_win: NumberDict;
  item_usage: NumberDict;
  purchase_time: NumberDict;
  first_purchase_time: NumberDict;
  lane: number | undefined | null;
  lane_efficiency: number;
  lane_efficiency_pct: number;
  buyback_count: number;
  observer_uses: number;
  sentry_uses: number;
  neutral_kills: number;
  tower_kills: number;
  courier_kills: number;
  lane_kills: number;
  hero_kills: number;
  observer_kills: number;
  sentry_kills: number;
  roshan_kills: number;
  necronomicon_kills: number;
  ancient_kills: number;

  // Added temporarily
  rank_tier?: number;
}

interface NeutralItemHistory {
  time: number;
  item_neutral: string;
  item_neutral_enhancement: string;
}

// Data to pass to insertMatch from GC
interface GcMatch {
  match_id: number;
  cluster: number;
  replay_salt: number;
  series_type: number;
  series_id: number;
  players: GcPlayer[];
}

interface GcPlayer {
  player_slot: number;
  party_id: number;
  party_size: number;
  permanent_buffs: any[];
  account_id?: number;
}

interface ParserMatch {
  match_id: number;
  // Needed to determine whether to insert pro match data
  leagueid: number;
  // Used for dust and apm calculation
  start_time: number;
  duration: number;

  // Parsed fields
  version: number;
  chat: any[];
  cosmetics: any;
  objectives: any[];
  radiant_gold_adv: number[];
  players: ParserPlayer[];
}

interface ParserPlayer extends Partial<Player> {
  player_slot: number;
  kills_log: any[];
  // plus more parsed properties
}

type PlayerMatch = Player & Match & { players?: Player[] };
type ParsedPlayerMatch = ParsedPlayer &
  ParsedMatch & { players?: ParsedPlayer[]; is_contributor?: boolean };

type User = {
  account_id: number;
  fh_unavailable: boolean;
  steamid: string;
  personaname: string;
  avatarfull: string;
  last_match_time: Date;

  // Computed fields
  is_contributor: boolean;
  is_subscriber: boolean;
  status: number;
};

type PlayerRating = {
  account_id: number;
  rank_tier: number;
  leaderboard_rank: number;
};

type FullHistoryJob = {
  account_id: number;
  long_history?: boolean;

  // These fields don't exist on the job but we add them during processing
  fh_unavailable?: boolean;
};

type MmrJob = {
  account_id: number;
};

type GcDataJob = {
  match_id: number;
};

type CountsJob = import('./util/types').ApiMatch;
type ScenariosJob = string;
type CacheJob = string;

type ParseJob = {
  match_id: number;
  origin?: DataOrigin;
};

type QueueJob = QueueInput['data'];
type QueueName = QueueInput['name'];
type QueueInput =
  | {
      name: 'mmrQueue';
      data: MmrJob;
    }
  | {
      name: 'countsQueue';
      data: CountsJob;
    }
  | {
      name: 'fhQueue';
      data: FullHistoryJob;
    }
  | {
      name: 'scenariosQueue';
      data: ScenariosJob;
    }
  | {
      name: 'parse';
      data: ParseJob;
    }
  | {
      name: 'gcQueue';
      data: GcDataJob;
    }
  | {
      name: 'cacheQueue';
      data: CacheJob;
    };

type ReliableQueueRow = {
  id: number;
  type: string;
  timestamp: string;
  attempts: number;
  data: any;
  next_attempt_time: string;
  priority: number;
};

type JobMetadata = { attempts: number; timestamp: Date; priority: number };

type ReliableQueueOptions = {
  attempts?: number;
  priority?: number;
  caller?: string;
};

type ProPlayer = {
  name: string;
  account_id: number;
};

type DataType = 'api' | 'parsed' | 'gcdata' | 'meta' | 'identity' | 'ranks' | 'reconcile';
type DataOrigin = 'scanner';

type CommonInsertOptions = {
  origin?: DataOrigin;
  skipParse?: boolean;
  pgroup?: PGroup;
  endedAt?: number;
};

type ApiInsertOptions = {
  type: 'api';
} & CommonInsertOptions;

type NonApiInsertOptions = {
  type: DataType;
  // We can compute these if API, but otherwise required
  pgroup: PGroup;
  endedAt: number;
} & CommonInsertOptions;

type InsertMatchOptions = ApiInsertOptions | NonApiInsertOptions;

type PathVerbSpec = {
  operationId: string;
  summary: string;
  description: string;
  tags: string[];
  parameters?: any[];
  responses: {
    [key: number]: {
      description: string;
      content: any;
    };
  };
  route: () => string;
  func: (
    req: import('express').Request,
    res: import('express').Response,
    cb: ErrorCb,
  ) => Promise<any>;
};

type HttpVerb = 'get' | 'post';
type OpenAPISpec = {
  openapi: string;
  info: any;
  servers: any[];
  components: any;
  paths: {
    [path: string]: {
      [key in HttpVerb]?: PathVerbSpec;
    };
  };
};

type MetricName =
  | 'parsed'
  | 'steam_api_call'
  | 'steam_proxy_call'
  | 'steam_429'
  | 'steam_403'
  | 'web_crash'
  | '500_error'
  | 'api_hits_ui'
  | 'api_hits'
  | 'skip_seq_num'
  | 'retriever_player'
  | 'fullhistory'
  | 'fullhistory_skip'
  | 'fullhistory_short'
  | 'match_archive_read'
  | 'match_archive_write'
  | 'blob_archive_read'
  | 'auto_parse'
  | 'added_match'
  | 'distinct_match_player'
  | 'distinct_match_player_user'
  | 'distinct_match_player_recent_user'
  | 'parser'
  | 'meta_parse'
  | 'retriever'
  | 'build_match'
  | 'player_matches'
  | 'self_profile_view'
  | 'match_cache_hit'
  | 'player_temp_hit'
  | 'player_temp_miss'
  | 'player_temp_skip'
  | 'player_temp_wait'
  | 'player_temp_write'
  | 'player_temp_write_bytes'
  | 'distinct_player_temp'
  | 'auto_player_temp'
  | 'auto_player_temp_hit'
  | 'auto_player_temp_miss'
  | 'distinct_auto_player_temp'
  | 'steam_api_backfill'
  | 'steam_api_notfound'
  | 'steam_gc_backfill'
  | 'request_api_key'
  | 'request_ui'
  | 'request'
  | 'distinct_request'
  | 'reparse_early'
  | 'reparse'
  | 'regcdata'
  | 'reapi'
  | 'parser_fail'
  | 'parser_crash'
  | 'parser_skip'
  | 'incomplete_archive'
  | 'gen_api_key_invalid'
  | 'parser_job'
  | 'oldparse'
  | 'secondary_scanner'
  | 'archive_hit'
  | 'archive_miss'
  | 'archive_write_bytes'
  | 'archive_get_error'
  | 'archive_put_error'
  | 'slow_api_hit'
  | 'api_cassandra_read'
  | 'gcdata_cassandra_read'
  | 'parsed_cassandra_read'
  | 'cassandra_write'
  | 'request_api_fail'
  | 'pmh_fullhistory'
  | 'pmh_gcdata'
  | 'pmh_parsed'
  | 'reconcile';

// Object to map player_slot to basic info
type PGroup = {
  [player_slot: string]: {
    // Optional because some players are anonymous
    account_id?: number;
    hero_id: number;
  };
};

type GcExtraData = {
  origin?: DataOrigin;
  pgroup: PGroup;
};

type ParseExtraData = {
  leagueid: number;
  start_time: number;
  duration: number;
  origin?: DataOrigin;
  pgroup: PGroup;
  url: string;
};