Merge pull request #871 from WatWowMap/wayfarer-enhancements

feat: Wayfarer enhancements

packages/locales/lib/human/en.json

@@ -672,5 +672,8 @@
   "fast": "Fast",
   "charged": "Charged",
   "offline_mode": "Offline Mode",
+  "include_sponsored": "Include Sponsored",
+  "showcase_color": "Showcase Color",
+  "partner_color": "Partner Color",
   "disable": "Disable {{- name}}"
 }

packages/types/lib/general.d.ts

@@ -36,6 +36,8 @@ export interface PoI {
   id: string
   lat: number
   lon: number
+  showcase: boolean
+  partner: boolean
 }
 
 export interface BaseCell {

packages/types/lib/scanner.d.ts

@@ -53,6 +53,7 @@ export interface Gym {
   total_cp: number
   first_seen_timestamp: number
   sponsor_id: number
+  partner_id: number
   raid_pokemon_costume: number
   raid_pokemon_gender: number
   raid_pokemon_evolution: number
@@ -161,13 +162,18 @@ export interface Pokestop {
   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
 }
 
 export type FullPokestop = FullModel<Pokestop, PokestopModel>

server/src/configs/default.json

@@ -412,6 +412,8 @@
       "darkMapBorder": "#ff0000",
       "cellBlocked": "#000000",
       "poiColor": "#03ffff",
+      "showcaseColor": "#D365F5",
+      "partnerColor": "#F60042",
       "enablePortalPopupCoords": false
     },
     "s2cells": {
@@ -554,7 +556,8 @@
       "enabled": false,
       "rings": true,
       "s17Cells": true,
-      "s14Cells": true
+      "s14Cells": true,
+      "includeSponsored": true
     },
     "s2cells": {
       "enabled": false,

server/src/graphql/typeDefs/map.graphql

@@ -131,6 +131,8 @@ type PoI {
   id: ID
   lat: Float
   lon: Float
+  showcase: Boolean
+  partner: Boolean
 }
 
 type SubmissionCell {

server/src/graphql/typeDefs/scanner.graphql

@@ -37,6 +37,7 @@ type Gym {
   total_cp: Int
   first_seen_timestamp: Int
   sponsor_id: Int
+  partner_id: Int
   raid_pokemon_costume: Int
   raid_pokemon_gender: Int
   raid_pokemon_evolution: Int
@@ -140,6 +141,7 @@ type Pokestop {
   pokestop_display: Int
   first_seen_timestamp: Int
   sponsor_id: Int
+  partner_id: Int
   ar_scan_eligible: Boolean
   quests: [Quest]
   invasions: [Invasion]

server/src/models/Gym.js

@@ -53,6 +53,18 @@ class Gym extends Model {
     return 'gym'
   }
 
+  /**
+   *
+   * @param {import('objection').QueryBuilder<Gym, Gym[]>} query
+   * @param {boolean} isMad
+   */
+  static onlyValid(query, isMad) {
+    query.andWhere('enabled', true)
+    if (!isMad) {
+      query.andWhere('deleted', false)
+    }
+  }
+
   static async getAll(perms, args, { isMad, availableSlotsCol }, userId) {
     const {
       gyms: gymPerms,
@@ -118,7 +130,7 @@ class Gym extends Model {
     query
       .whereBetween(isMad ? 'latitude' : 'lat', [args.minLat, args.maxLat])
       .andWhereBetween(isMad ? 'longitude' : 'lon', [args.minLon, args.maxLon])
-      .andWhere(isMad ? 'enabled' : 'deleted', isMad)
+    Gym.onlyValid(query, isMad)
 
     const raidBosses = new Set()
     const raidForms = new Set()
@@ -459,7 +471,6 @@ class Gym extends Model {
         'url',
         distance,
       ])
-      .where(isMad ? 'enabled' : 'deleted', isMad)
       .whereRaw(`LOWER(name) LIKE '%${search}%'`)
       .limit(searchResultsLimit)
       .orderBy('distance')
@@ -469,6 +480,8 @@ class Gym extends Model {
     if (!getAreaSql(query, areaRestrictions, onlyAreas, isMad)) {
       return []
     }
+    Gym.onlyValid(query, isMad)
+
     return query
   }
 
@@ -507,7 +520,6 @@ class Gym extends Model {
         '>=',
         isMad ? this.knex().fn.now() : ts,
       )
-      .andWhere(isMad ? 'enabled' : 'deleted', isMad)
     if (isMad) {
       query
         .leftJoin('gymdetails', 'gym.gym_id', 'gymdetails.gym_id')
@@ -519,6 +531,8 @@ class Gym extends Model {
     if (!getAreaSql(query, perms.areaRestrictions, onlyAreas, isMad)) {
       return []
     }
+    Gym.onlyValid(query, isMad)
+
     return query
   }
 
@@ -567,36 +581,42 @@ class Gym extends Model {
       .first()
   }
 
-  static getSubmissions(perms, args, { isMad }) {
+  static async getSubmissions(perms, args, { isMad }) {
     const {
-      filters: { onlyAreas = [] },
+      filters: { onlyAreas = [], onlyIncludeSponsored = true },
       minLat,
       minLon,
       maxLat,
       maxLon,
     } = args
+    const wiggle = 0.025
     const query = this.query()
       .whereBetween(`lat${isMad ? 'itude' : ''}`, [
-        minLat - 0.025,
-        maxLat + 0.025,
+        minLat - wiggle,
+        maxLat + wiggle,
       ])
       .andWhereBetween(`lon${isMad ? 'gitude' : ''}`, [
-        minLon - 0.025,
-        maxLon + 0.025,
+        minLon - wiggle,
+        maxLon + wiggle,
       ])
-      .andWhere(isMad ? 'enabled' : 'deleted', isMad)
     if (isMad) {
       query.select(['gym_id AS id', 'latitude AS lat', 'longitude AS lon'])
     } else {
-      query.select(['id', 'lat', 'lon']).andWhere((poi) => {
-        poi.whereNull('sponsor_id').orWhere('sponsor_id', 0)
-      })
+      query.select(['id', 'lat', 'lon', 'partner_id'])
+
+      if (!onlyIncludeSponsored) {
+        query.andWhere((poi) => {
+          poi.whereNull('partner_id').orWhere('partner_id', 0)
+        })
+      }
     }
     if (!getAreaSql(query, perms.areaRestrictions, onlyAreas, isMad)) {
       return []
     }
+    Gym.onlyValid(query, isMad)
 
-    return query
+    const results = await query
+    return results
   }
 }
 

server/src/models/PoI.js

@@ -4,11 +4,15 @@ class PoI {
    * @param {string} id
    * @param {number} lat
    * @param {number} lon
+   * @param {boolean} [partner]
+   * @param {boolean} [showcase]
    */
-  constructor(id, lat, lon) {
+  constructor(id, lat, lon, partner = false, showcase = false) {
     this.id = id
     this.lat = lat
     this.lon = lon
+    this.partner = partner
+    this.showcase = showcase
   }
 }
 

server/src/models/Pokestop.js

@@ -62,6 +62,18 @@ class Pokestop extends Model {
     return 'pokestop'
   }
 
+  /**
+   *
+   * @param {import('objection').QueryBuilder<Pokestop, Pokestop[]>} query
+   * @param {boolean} isMad
+   */
+  static onlyValid(query, isMad) {
+    query.andWhere('enabled', true)
+    if (!isMad) {
+      query.andWhere('deleted', false)
+    }
+  }
+
   static async getAll(
     perms,
     args,
@@ -176,7 +188,8 @@ class Pokestop extends Model {
     query
       .whereBetween(isMad ? 'latitude' : 'lat', [args.minLat, args.maxLat])
       .andWhereBetween(isMad ? 'longitude' : 'lon', [args.minLon, args.maxLon])
-      .andWhere(isMad ? 'enabled' : 'deleted', isMad)
+
+    Pokestop.onlyValid(query, isMad)
     if (!getAreaSql(query, areaRestrictions, onlyAreas, isMad)) {
       return []
     }
@@ -1557,13 +1570,13 @@ class Pokestop extends Model {
         isMad ? 'image AS url' : 'url',
         distance,
       ])
-      .where(isMad ? 'enabled' : 'deleted', isMad)
       .whereRaw(`LOWER(name) LIKE '%${search}%'`)
       .limit(searchResultsLimit)
       .orderBy('distance')
     if (!getAreaSql(query, perms.areaRestrictions, onlyAreas, isMad)) {
       return []
     }
+    Pokestop.onlyValid(query, isMad)
     return query
   }
 
@@ -1606,7 +1619,6 @@ class Pokestop extends Model {
         isMad ? 'quest_reward AS quest_rewards' : 'quest_rewards',
         distance,
       ])
-      .where(isMad ? 'enabled' : 'deleted', isMad)
       .andWhere('quest_timestamp', '>=', midnight || 0)
       .andWhere((quests) => {
         quests
@@ -1628,6 +1640,8 @@ class Pokestop extends Model {
     if (!getAreaSql(query, perms.areaRestrictions, onlyAreas, isMad)) {
       return []
     }
+    Pokestop.onlyValid(query, isMad)
+
     const results = await query
     const mapped = results.map((q) => ({ ...q, with_ar: q.with_ar ?? true }))
 
@@ -1697,7 +1711,6 @@ class Pokestop extends Model {
           : 'lure_expire_timestamp',
         distance,
       ])
-      .where(isMad ? 'enabled' : 'deleted', isMad)
       .andWhere(
         isMad ? 'lure_expiration' : 'lure_expire_timestamp',
         '>=',
@@ -1709,6 +1722,8 @@ class Pokestop extends Model {
     if (!getAreaSql(query, perms.areaRestrictions, onlyAreas, isMad)) {
       return []
     }
+    Pokestop.onlyValid(query, isMad)
+
     const results = await query
     return results
   }
@@ -1723,9 +1738,9 @@ class Pokestop extends Model {
       .first()
   }
 
-  static getSubmissions(perms, args, { isMad }) {
+  static getSubmissions(perms, args, { isMad, hasShowcaseData }) {
     const {
-      filters: { onlyAreas = [] },
+      filters: { onlyAreas = [], onlyIncludeSponsored = true },
       minLat,
       minLon,
       maxLat,
@@ -1740,17 +1755,24 @@ class Pokestop extends Model {
         minLon - 0.025,
         maxLon + 0.025,
       ])
-      .andWhere(isMad ? 'enabled' : 'deleted', isMad)
     if (isMad) {
       query.select(['pokestop_id AS id', 'latitude AS lat', 'longitude AS lon'])
     } else {
-      query.select(['id', 'lat', 'lon']).andWhere((poi) => {
-        poi.whereNull('sponsor_id').orWhere('sponsor_id', 0)
-      })
+      query.select(['id', 'lat', 'lon', 'partner_id'])
+      if (!onlyIncludeSponsored) {
+        query.andWhere((poi) => {
+          poi.whereNull('partner_id').orWhere('partner_id', 0)
+        })
+      }
+      if (hasShowcaseData) {
+        query.select('showcase_expiry')
+      }
     }
     if (!getAreaSql(query, perms.areaRestrictions, onlyAreas, isMad)) {
       return []
     }
+    Pokestop.onlyValid(query, isMad)
+
     return query
   }
 }

server/src/services/filters/builder/base.js

@@ -158,6 +158,7 @@ function buildDefaultFilters(perms, database) {
             rings: defaultFilters.submissionCells.rings,
             s17Cells: defaultFilters.submissionCells.s17Cells,
             s14Cells: defaultFilters.submissionCells.s14Cells,
+            includeSponsored: defaultFilters.submissionCells.includeSponsored,
             filter: { global: new BaseFilter() },
           }
         : undefined,

server/src/services/functions/getPlacementCells.js

@@ -60,7 +60,16 @@ function getPlacementCells(filters, pokestops, gyms) {
       ? Object.values(indexedCells)
       : [],
     pois: filters.filters.onlyRings
-      ? allCoords.map((poi) => new PoI(poi.id, poi.lat, poi.lon))
+      ? allCoords.map(
+          (poi) =>
+            new PoI(
+              poi.id,
+              poi.lat,
+              poi.lon,
+              !!poi.partner_id,
+              'showcase_expiry' in poi ? !!poi.showcase_expiry : false,
+            ),
+        )
       : [],
   }
 }

server/src/services/ui/clientOptions.js

@@ -82,6 +82,8 @@ function clientOptions(perms) {
       darkMapBorder: { type: 'color', perm: ['submissionCells'] },
       cellBlocked: { type: 'color', perm: ['submissionCells'] },
       poiColor: { type: 'color', perm: ['submissionCells'] },
+      partnerColor: { type: 'color', perm: ['submissionCells'] },
+      showcaseColor: { type: 'color', perm: ['submissionCells'] },
     },
     s2cells: {
       lightMapBorder: { type: 'color', perm: ['s2cells'] },