scanner.d.ts

import { FullModel } from './utility'
import DeviceModel = require('server/src/models/Device')
import GymModel = require('server/src/models/Gym')
import NestModel = require('server/src/models/Nest')
import PokestopModel = require('server/src/models/Pokestop')
import PokemonModel = require('server/src/models/Pokemon')
import PortalModel = require('server/src/models/Portal')
import ScanCellModel = require('server/src/models/ScanCell')
import SpawnpointModel = require('server/src/models/Spawnpoint')
import WeatherModel = require('server/src/models/Weather')
import RouteModel = require('server/src/models/Route')
import StationModel = require('server/src/models/Station')
import TappableModel = require('server/src/models/Tappable')

import { S2Polygon } from './general'

export type Gender = 0 | 1 | 2 | 3

export interface Device {
  id: string
  instance_name: string
  updated: number
  lat: number
  lon: number
  type: string
  isMad: boolean
  route: any // JSON
  radius: number
}

export type FullDevice = FullModel<Device, DeviceModel.Device>

export interface PokemonDisplay {
  form: number
  costume: number
  gender: number
  shiny: boolean
  temp_evolution: number
  temp_evolution_finish_ms?: number
  alignment: number
  badge: number
  background: number
}

export interface PokemonShinyStats {
  shiny_seen: number
  encounters_seen: number
  since_date?: string
}

export interface Defender extends PokemonDisplay {
  pokemon_id: number
  deployed_ms: number
  deployed_time: number
  battles_won: number
  battles_lost: number
  times_fed: number
  motivation_now: number
  cp_when_deployed: number
  cp_now: number
}

export interface Gym {
  id: string
  lat: number
  lon: number
  name: string
  url: string
  last_modified_timestamp: number
  raid_end_timestamp: number
  raid_spawn_timestamp: number
  raid_battle_timestamp: number
  raid_pokemon_id: number
  updated: number
  guarding_pokemon_id: number
  guarding_pokemon_display: PokemonDisplay
  defenders: Defender[]
  available_slots: number
  team_id: number
  raid_level: number
  ex_raid_eligible: boolean
  in_battle: boolean
  raid_pokemon_move_1: number
  raid_pokemon_move_2: number
  raid_pokemon_form: number
  raid_pokemon_cp: number
  raid_pokemon_alignment: number
  raid_is_exclusive: boolean
  total_cp: number
  first_seen_timestamp: number
  sponsor_id: number
  partner_id: number
  raid_pokemon_costume: number
  raid_pokemon_gender: Gender
  raid_pokemon_evolution: number
  ar_scan_eligible: boolean
  badge: number
  power_up_level: number
  power_up_points: number
  power_up_end_timestamp: number
  deleted: boolean
  enabled: boolean
}

export type FullGym = FullModel<Gym, GymModel.Gym>

export interface Nest {
  id: number
  lat: number
  lon: number
  pokemon_id: number
  updated: number
  type: number
  name: string
  pokemon_count: number
  pokemon_avg: number
  pokemon_form: number
  polygon_type: number
  polygon_path: string
  polygon?: string | object
  submitted_by: string
}

export type FullNest = FullModel<Nest, NestModel.Nest>

export interface Quest {
  quest_type: number
  quest_timestamp: number
  quest_target: number
  quest_conditions: string
  quest_rewards: string
  quest_template: string
  quest_reward_type: number
  quest_task: string
  quest_item_id: number
  quest_title: string
  item_amount: number
  stardust_amount: number
  quest_pokemon_id: number
  quest_form_id: number
  quest_gender_id: Gender
  quest_costume_id: number
  quest_background: number
  quest_bread_mode: number
  quest_shiny: number
  quest_shiny_probability?: number
  mega_pokemon_id: number
  mega_amount: number
  candy_pokemon_id: number
  candy_amount: number
  xl_candy_pokemon_id: number
  xl_candy_amount: number
  xp_amount: number
  with_ar: boolean
  key: string
}

export interface Invasion {
  grunt_type: number
  incident_expire_timestamp: number
  confirmed: boolean
  slot_1_pokemon_id: number
  slot_1_form: number
  slot_2_pokemon_id: number
  slot_2_form: number
  slot_3_pokemon_id: number
  slot_3_form: number
}

export interface ShowcaseEntry extends PokemonDisplay {
  rank: number
  pokemon_id: number
  score: number
}

export interface ShowcaseDetails {
  total_entries: number
  last_update: number
  contest_entries: ShowcaseEntry[]
}

export interface Event {
  display_type: number
  event_expire_timestamp: number
  showcase_pokemon_id: number
  showcase_pokemon_form_id: number
  showcase_pokemon_type_id: number
  showcase_rankings: ShowcaseDetails
  showcase_ranking_standard: number
}

export interface Pokestop {
  id: string
  lat: number
  lon: number
  url: string
  name: string
  lure_id: number
  lure_expire_timestamp: number
  updated: number
  last_modified_timestamp: number
  pokestop_display: number
  first_seen_timestamp: number
  sponsor_id: number
  partner_id: number
  ar_scan_eligible: boolean
  quests: Quest[]
  invasions: Invasion[]
  events: Event[]
  power_up_level: number
  power_up_points: number
  power_up_end_timestamp: number
  showcase_expiry?: number
  showcase_pokemon_id?: number
  showcase_ranking_standard?: number
  showcase_rankings?: ShowcaseDetails | string
  hasShowcase: boolean
}

export type FullPokestop = FullModel<Pokestop, PokestopModel.Pokestop>

export type CleanPvp = Record<string, import('ohbem').PvPRankEntry[]>

export interface Pokemon {
  id: string
  encounter_id: number
  spawnpoint_id: string
  lat: number
  lon: number
  pokemon_id: number
  form: number
  costume: number
  gender: Gender
  display_pokemon_id: number
  weight: number
  height: number
  size: number
  move_1: number
  move_2: number
  cp: number
  level: number
  iv: number
  atk_iv: number
  def_iv: number
  sta_iv: number
  weather: number
  background?: number
  capture_1: number
  capture_2: number
  capture_3: number
  cleanPvp: CleanPvp
  bestPvp: number
  seen_type: string
  changed: boolean
  expire_timestamp: number
  first_seen_timestamp: number
  expire_timestamp_verified: boolean
  updated: number
  pvp: CleanPvp
  pvp_rankings_great_league?: import('ohbem').PvPRankEntry[]
  pvp_rankings_ultra_league?: import('ohbem').PvPRankEntry[]
  distance?: number
  shiny?: boolean
}

export type FullPokemon = FullModel<Pokemon, PokemonModel.Pokemon>

export interface Portal {
  id: string
  external_id: string
  lat: number
  lon: number
  name: string
  url: string
  imported: number
  updated: number
}

export type FullPortal = FullModel<Portal, PortalModel.Portal>

export interface Tappable {
  id: string
  lat: number
  lon: number
  type: string
  fort_id: string | null
  item_id: number
  count: number | null
  expire_timestamp: number | null
  expire_timestamp_verified: boolean
  updated: number
}

export type FullTappable = FullModel<Tappable, TappableModel.Tappable>

export interface ScanCell {
  id?: string
  level?: number
  center_lat?: number
  center_lon?: number
  updated?: number
  polygon?: S2Polygon
}

export type FullScanCell = FullModel<ScanCell, ScanCellModel.ScanCell>

export interface Spawnpoint {
  id: string
  lat: number
  lon: number
  updated: number
  despawn_sec: number
}

export type FullSpawnpoint = FullModel<Spawnpoint, SpawnpointModel.Spawnpoint>

export interface Weather {
  id: string
  level: number
  latitude: number
  longitude: number
  gameplay_condition: number
  wind_direction: number
  cloud_level: number
  rain_level: number
  wind_level: number
  snow_level: number
  fog_level: number
  special_effect_level: number
  severity: boolean
  warn_weather: boolean
  updated: number
  polygon: S2Polygon
}

export type FullWeather = FullModel<Weather, WeatherModel.Weather>

export interface ScannerApi {
  status: string
  message: string
}

export interface Waypoint {
  lat_degrees: number
  lng_degrees: number
  elevation_in_meters: number
}

export interface Route {
  id: string
  name: string
  description: string
  distance_meters: number
  duration_seconds: number
  start_fort_id: string
  start_lat: number
  start_lon: number
  start_image: string
  end_fort_id: string
  end_lat: number
  end_lon: number
  end_image: string
  image: string
  image_border_color: string
  reversible: boolean
  tags: string[]
  type: number
  updated: number
  version: number
  waypoints: Waypoint[]
}

export type FullRoute = FullModel<Route, RouteModel.Route>

export interface StationPokemon extends PokemonDisplay {
  pokemon_id: number
  bread_mode: number
}

export interface Station<Parsed extends boolean = false> {
  id: string
  lat: number
  lon: number
  name: string
  // cell_id: BIGINT
  start_time: number
  end_time: number
  cooldown_complete: number
  is_battle_available: boolean
  is_inactive: boolean

  battle_level: number
  battle_start?: number
  battle_end?: number

  battle_pokemon_id: number
  battle_pokemon_form: number
  battle_pokemon_costume: number
  battle_pokemon_gender: Gender
  battle_pokemon_alignment: number
  battle_pokemon_bread_mode: number
  battle_pokemon_move_1: number
  battle_pokemon_move_2: number
  battle_pokemon_stamina?: number
  battle_pokemon_cp_multiplier?: number
  battle_pokemon_estimated_cp?: number

  total_stationed_pokemon: number
  total_stationed_gmax: number
  stationed_pokemon: Parsed extends true
    ? StationPokemon[]
    : string | StationPokemon[]
  updated: number
}

export type FullStation = FullModel<Station, StationModel.Station>