feat: added support for lore search

Author: Supamiu

src/model/lore-search-result.ts

@@ -0,0 +1,11 @@
+import { Pagination } from './pagination';
+
+export interface LoreSearchResult {
+    Results: {
+        Context: string;
+        Source: string;
+        SourceID: number;
+        Text: string;
+    };
+    Pagination: Pagination;
+}

src/xivapi.service.ts

@@ -15,6 +15,7 @@ import {
 import { CharacterResponse, CharacterVerification } from './model/schema/character';
 import { MarketboardItem } from './model/schema/market/marketboard-item';
 import { GCF_URL } from './xivapi-client.module';
+import { LoreSearchResult } from './model/lore-search-result';
 
 @Injectable()
 export class XivapiService {
@@ -39,6 +40,15 @@ export class XivapiService {
         return this.request<T>(`/${endpoint}/${id}`, options);
     }
 
+    /**
+     * Makes a request on a given endpoint with an id.
+     *
+     * @param query Text to search inside the lore.
+     */
+    public searchLore(query: string): Observable<LoreSearchResult> {
+        return this.doGet<LoreSearchResult>(`${XivapiService.API_BASE_URL}/lore`, new HttpParams().set('string', query));
+    }
+
     /**
      * Makes a request to a given endpoint to list resources available.
      *

test/xivapi.service.spec.ts

@@ -43,4 +43,14 @@ describe('Client tests', () => {
         expect(req.request.params.has('url')).toBeTruthy();
         expect(req.request.params.get('url')).toEqual('aHR0cHM6Ly94aXZhcGkuY29tL0l0ZW0vMTIwODc=');
     });
+
+    it('Should search Lore properly', () => {
+        const service: XivapiService = new XivapiService(httpClient);
+        service.searchLore('legendary').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');
+    });
 });