feat(freecompany): update free company parsing to return both id and …

…name
XIVStats · Jan 2, 2022 · ad3cb5c · ad3cb5c
1 parent cdc2f0b
commit ad3cb5c
Show file tree

Hide file tree

Showing 6 changed files with 33 additions and 12 deletions.
diff --git a/docs/api/classes/client_LodestoneClient.default.md b/docs/api/classes/client_LodestoneClient.default.md
@@ -30,7 +30,7 @@ Client for interfacing with the Final Fantasy XIV Lodestone.
 
 #### Defined in
 
-[client/LodestoneClient.ts:56](https://github.com/XIVStats/lodestone/blob/ee12e9b/src/client/LodestoneClient.ts#L56)
+[client/LodestoneClient.ts:56](https://github.com/XIVStats/lodestone/blob/cdc2f0b/src/client/LodestoneClient.ts#L56)
 
 ## Properties
 
@@ -44,4 +44,4 @@ An instance will be generated by default, but as a consumer you can provide your
 
 #### Defined in
 
-[client/LodestoneClient.ts:50](https://github.com/XIVStats/lodestone/blob/ee12e9b/src/client/LodestoneClient.ts#L50)
+[client/LodestoneClient.ts:50](https://github.com/XIVStats/lodestone/blob/cdc2f0b/src/client/LodestoneClient.ts#L50)
diff --git a/src/config/DomConfig.ts b/src/config/DomConfig.ts
@@ -56,7 +56,10 @@ export default class DomConfig {
           '#character > div.frame__chara.js__toggle_wrapper > a > div.frame__chara__box > p.frame__chara__world',
         transformationFunction: (value: string) => value.split('(')[1].replace(')', '').trim(),
       },
-      freeCompanyName: 'div.character__freecompany__name > h4',
+      freeCompany: {
+				selector: 'div.character__freecompany__name > h4',
+				isGroupLink: true
+			},
       pvpTeam: {
         selector: 'div.character__pvpteam__name > h4',
         isGroupLink: true,

diff --git a/src/entity/Character.ts b/src/entity/Character.ts
@@ -67,7 +67,7 @@ export default class Character implements ICharacter {
 
   grandCompanyRank?: string | undefined
 
-  freeCompanyName?: string | undefined
+  freeCompany?: IPlayerGroup | undefined
 
   pvpTeam?: IPlayerGroup | undefined
 

diff --git a/src/entity/__tests__/Character.test.ts b/src/entity/__tests__/Character.test.ts
@@ -45,7 +45,10 @@ describe('Character', () => {
       guardian: 'Thaliak, the Scholar',
       grandCompany: 'Order of the Twin Adder',
       grandCompanyRank: 'First Serpent Lieutenant',
-      freeCompanyName: 'Archadian Moogles',
+      freeCompany: {
+				id: '9234631035923259083',
+				name: 'Archadian Moogles'
+			},
       activeClass: Class.Conjurer,
       gear: {
         arm: {
@@ -261,7 +264,10 @@ describe('Character', () => {
       nameDay: '4th Sun of the 4th Astral Moon',
       guardian: 'Nymeia, the Spinner',
       gender: 'Female',
-      freeCompanyName: "Gandalf's Gangstas",
+      freeCompany: {
+				id: '9228860798900682722',
+				name:"Gandalf's Gangstas"
+			},
       activeClass: Class.Arcanist,
       grandCompany: undefined,
     }
@@ -276,7 +282,10 @@ describe('Character', () => {
       homeWorld: 'Cerberus',
       title: 'Outlander',
       dataCenter: 'Chaos',
-      freeCompanyName: 'Archadian Moogles',
+			freeCompany: {
+				id: '9234631035923259083',
+				name: 'Archadian Moogles'
+			},
       gear: {
         shield: {
           category: GearCategory.Shield,
@@ -303,7 +312,10 @@ describe('Character', () => {
       homeWorld: 'Cerberus',
       title: 'Monster Hunter',
       dataCenter: 'Chaos',
-      freeCompanyName: 'Archadian Moogles',
+			freeCompany: {
+				id: '9234631035923259083',
+				name: 'Archadian Moogles'
+			},
       gender: 'Male',
       grandCompany: 'Order of the Twin Adder',
       grandCompanyRank: 'Serpent Captain',
@@ -328,7 +340,10 @@ describe('Character', () => {
       homeWorld: 'Cerberus',
       title: 'The Liberator',
       dataCenter: 'Chaos',
-      freeCompanyName: 'Archadian Moogles',
+      freeCompany: {
+				id: '9234631035923259083',
+				name: 'Archadian Moogles'
+			},
       gender: 'Female',
       grandCompany: 'Maelstrom',
       grandCompanyRank: 'Second Storm Lieutenant',
@@ -353,7 +368,10 @@ describe('Character', () => {
       homeWorld: 'Aegis',
       title: 'Peacemaker',
       dataCenter: 'Elemental',
-      freeCompanyName: 'DawnGarden',
+      freeCompany: {
+				id: '9236038410806755415x',
+				name: 'DawnGarden'
+			},
       gender: 'Male',
       grandCompany: 'Immortal Flames',
       grandCompanyRank: 'Flame Captain',

diff --git a/src/interface/ICharacter.ts b/src/interface/ICharacter.ts
@@ -61,7 +61,7 @@ export default interface ICharacter extends IMappableCharacter {
 
   readonly grandCompanyRank?: string
 
-  readonly freeCompanyName?: string
+  readonly freeCompany?: IPlayerGroup
 
   readonly pvpTeam?: IPlayerGroup
 

diff --git a/src/interface/IMappableCharacter.ts b/src/interface/IMappableCharacter.ts
@@ -61,7 +61,7 @@ export interface IMappableCharacter {
 
   readonly grandCompanyRank?: string | IAttributeMapping
 
-  readonly freeCompanyName?: string | IAttributeMapping
+  readonly freeCompany?: IPlayerGroup | IAttributeMapping
 
   readonly pvpTeam?: IPlayerGroup | IAttributeMapping