fix(lore): better support for additional lore data

Author: Supamiu

src/model/lore-search-result.ts

@@ -1,11 +1,12 @@
 import { Pagination } from './pagination';
 
 export interface LoreSearchResult {
+    Data?: any;
     Results: {
         Context: string;
         Source: string;
         SourceID: number;
         Text: string;
-    };
+    }[];
     Pagination: Pagination;
 }

src/xivapi.service.ts

@@ -44,9 +44,20 @@ export class XivapiService {
      * Makes a request on a given endpoint with an id.
      *
      * @param query Text to search inside the lore.
+     * @param dataColumns
      */
-    public searchLore(query: string): Observable<LoreSearchResult> {
-        return this.doGet<LoreSearchResult>(`${XivapiService.API_BASE_URL}/lore`, new HttpParams().set('string', query));
+    public searchLore(query: string, dataColumns?: string[]): Observable<LoreSearchResult> {
+        let httpParams: HttpParams = new HttpParams().set('string', query);
+        if (dataColumns && dataColumns.length > 0) {
+            httpParams = httpParams.set('columns', [
+                'Context',
+                'Source',
+                'SourceID',
+                'Text',
+                ...dataColumns.map(col => `Data.${col}`)
+            ].join(','));
+        }
+        return this.doGet<LoreSearchResult>(`${XivapiService.API_BASE_URL}/lore`, httpParams);
     }
 
     /**

test/xivapi.service.spec.ts

@@ -53,4 +53,15 @@ describe('Client tests', () => {
         expect(req.request.params.has('string')).toBeTruthy();
         expect(req.request.params.get('string')).toEqual('legendary');
     });
+
+    it('Should search Lore properly with custom data columns', () => {
+        const service: XivapiService = new XivapiService(httpClient);
+        service.searchLore('legendary', ['Icon']).subscribe();
+        const req: TestRequest = <TestRequest>httpMock.match({method: 'GET'})
+            .find(row => row.request.url === `${XivapiService.API_BASE_URL}/lore`);
+        expect(req).not.toBeUndefined();
+        expect(req.request.params.has('string')).toBeTruthy();
+        expect(req.request.params.get('string')).toEqual('legendary');
+        expect(req.request.params.get('columns')).toEqual('Context,Source,SourceID,Text,Data.Icon');
+    });
 });