continue parsed OAPI types

src/classes/Nations.ts

@@ -26,7 +26,7 @@ class Nations implements Base {
         const nations = await this.all()
         if (!nations) throw new FetchError('Error fetching nations! Please try again.')
 
-        const existing = fn.getExisting(nations, nationList, 'name') as Nation | Nation[]
+        const existing = fn.getExisting(nations, nationList, 'name') as Nation[] | Nation
         const isArr = existing instanceof Array
 
         return isArr ? 

src/classes/OAPI.ts

@@ -2,9 +2,10 @@ import {
     RawTown,
     RawNation, 
     RawResident,
-    ApiResident,
     RawServerInfo,
-    OAPITown
+    OAPITown,
+    OAPIResident,
+    OAPINation
 } from '../types.js'
 
 import { townyData } from '../utils/endpoint.js'
@@ -20,10 +21,12 @@ class OfficialAPI {
         const res = await townyData(`/residents/${name}`) as RawResident
         if (!res) throw new FetchError(`Could not fetch resident '${name}'. Received invalid response.`)
 
-        const obj: any = {
-            online: res.status?.isOnline ?? false,
-            balance: res.stats?.balance ?? 0
-        }
+        const obj: any = {}
+        if (res.status?.isOnline) 
+            obj.online = res.status.isOnline
+
+        if (res.stats?.balance) 
+            obj.balance = res.stats.balance
 
         if (res.timestamps) obj.timestamps = res.timestamps
         if (res.strings?.username) obj.name = res.strings.username
@@ -50,41 +53,34 @@ class OfficialAPI {
             }
         }
 
-        obj.friends = res.friends || []
-        return obj as ApiResident
+        return obj as OAPIResident
     }
 
     static town = async (name: string) => {
         if (!name) return
 
         const town = await townyData(`/towns/${name}`) as RawTown
-
-        // TODO: Implement a proper error
-        if (!town) return 
+        if (!town) return // TODO: Implement a proper error
 
         return {
             name: town.strings.town,
             founder: town.strings.founder,
             created: town.timestamps?.registered,
-            joinedNation: town.timestamps?.joinedNationAt
+            joinedNation: town.timestamps?.joinedNationAt,
+            ...town
         } as OAPITown
     }
 
     static nation = async (name: string) => {
         if (!name) return
 
         const nation = await townyData(`/nations/${name}`) as RawNation
-        const obj: any = {}
-
-        if (nation) {
-            if (nation.stats) obj.stats = nation.stats
-            if (nation.ranks) obj.ranks = nation.ranks
-
-            if (nation.timestamps?.registered) 
-                obj.created = nation.timestamps.registered
-        }
+        if (!nation) return // TODO: Implement a proper error
 
-        return obj
+        return {
+            name: nation.strings.nation,
+            created: nation.timestamps.registered
+        } as OAPINation
     }
 }
 

src/types/nation.ts

@@ -5,10 +5,12 @@ export type Nation = {
     residents: string[]
     area: number
     wiki?: string
-    capital: {
-        name: string
-        x: number
-        z: number
-    }
+    capital: NationCapital
     stats: unknown
+}
+
+export type NationCapital = {
+    name: string
+    x: number
+    z: number
 }

src/types/oapi_v1.ts

@@ -5,6 +5,55 @@ type NestedOmit<T, K extends PropertyKey> = {
     NestedOmit<T[P], K extends `${Exclude<P, symbol>}.${infer R}` ? R : never>
 } extends infer O ? { [P in keyof O]: O[P] } : never;
 
+//#region Parsed
+export type OAPITown = NestedOmit<RawTown, 
+    "strings.town" | 
+    "strings.founder" |
+    "timestamps.registered" |
+    "timestamps"
+> & {
+    name: string
+    founder: string
+    created: number
+    joinedNation: number
+}
+
+export type OAPINation = NestedOmit<RawNation,
+    "strings.nation" |
+    "timestamps"
+> & {
+    name: string
+    created: number
+}
+
+export type OAPIResident = NestedOmit<RawResident, 
+    "strings" |
+    "affiliation" |
+    "ranks" |
+    "perms" |
+    "status" |
+    "stats"
+> & {
+    name: string
+    title?: string
+    surname?: string
+    town?: string
+    nation?: string
+    townRanks: string[]
+    nationRanks: string[]
+    timestamps: Timestamps
+    perms?: {
+        build: RawResidentPerms
+        destroy: RawResidentPerms
+        switch: RawResidentPerms
+        itemUse: RawResidentPerms
+        flags: RawFlagPerms
+    }
+    online: boolean
+    balance: number
+}
+//#endregion
+
 //#region Raw, unparsed types
 export type RawEntity = {
     status: RawEntityStatus
@@ -99,6 +148,12 @@ export type RawNation = RawEntity & {
     enemies: string[]
 }
 
+export type Timestamps = {
+    joinedTownAt?: number
+    registered: number
+    lastOnline?: number
+}
+
 export type RawResident = RawEntity & {
     strings: {
         title: string
@@ -109,11 +164,7 @@ export type RawResident = RawEntity & {
         town: string
         nation: string
     }>
-    timestamps?: {
-        joinedTownAt?: number
-        registered: number
-        lastOnline: number
-    }
+    timestamps?: Timestamps
     perms: RawEntityPerms<RawResidentPerms>
     friends: string[]
 }
@@ -138,26 +189,4 @@ export type RawServerInfo = {
         numTownBlocks: number
     }
 }
-//#endregion
-
-//#region Parsed
-export type OAPITown = NestedOmit<RawTown, 
-    "strings.town" | 
-    "strings.founder" |
-    "timestamps.registered" |
-    "timestamps.joinedNationAt"
-> & {
-    name: string
-    founder: string
-    created: number
-    joinedNation: number
-}
-
-export type OAPINation = Partial<RawEntity> & {
-    s
-}
-
-export type OAPIResident = Partial<RawEntity> & {
-    s
-}
 //#endregion

src/types/resident.ts

@@ -1,37 +1,6 @@
-import { RawFlagPerms, RawResidentPerms } from '../types.js'
-
 export type Resident = {
     name: string
     town: string
     nation?: string
     rank: string
-}
-
-export type ApiResident = {
-    name: string
-    title: string
-    surname: string
-    town?: string
-    nation?: string
-    balance: number
-    online: boolean
-    timestamps?: {
-        joinedTownAt?: number
-        registered: number
-        lastOnline: number
-    }
-    townRanks: ResidentRanks
-    nationRanks: ResidentRanks
-    perms?: {
-        build: RawResidentPerms
-        destroy: RawResidentPerms
-        switch: RawResidentPerms
-        itemUse: RawResidentPerms
-        flags: RawFlagPerms
-    }
-    friends?: string[]
-}
-
-type ResidentRanks = {
-    ranks?: { [key: string]: string[] }
 }

tests/oapi.test.ts

@@ -4,14 +4,14 @@ import {
 } from 'vitest'
 
 import { OfficialAPI } from '../src/main'
-import { ApiResident, ServerInfoRaw } from '../src/types'
+import { OAPINation, OAPIResident, RawServerInfo } from '../src/types'
 
 describe('OfficialAPI', async () => {
     it('can get valid towny/server info (v2)', async () => {
         const info = await OfficialAPI.serverInfo()
 
         expect(info).toBeDefined()
-        assertType<ServerInfoRaw>(info)
+        assertType<RawServerInfo>(info)
 
         expect(info.world).toBeDefined()
         expect(info.players).toBeDefined()
@@ -26,8 +26,19 @@ describe('OfficialAPI', async () => {
         const res = await OfficialAPI.resident('owen3h')
 
         expect(res).toBeDefined()
-        assertType<ApiResident>(res)
+        assertType<OAPIResident>(res)
 
         expect(res.name).toBe("Owen3H")
+        //console.log(res)
+    })
+
+    it('can get valid nation (v1)', async () => {
+        const nation = await OfficialAPI.nation('venice')
+
+        expect(nation).toBeDefined()
+        assertType<OAPINation>(nation)
+
+        expect(nation.name).toBe("Venice")
+        console.log(nation)
     })
 })