Add missing logDisplays filter

src/piWebserviceProvider.ts

@@ -20,6 +20,7 @@ import type {
     filterActionsFilter,
     WorkflowsFilter,
     ModuleRuntimesFilter,
+    LogDisplaysFilter,
     LogDisplayLogsFilter
 } from "./requestParameters";
 import type {TopologyNodeResponse} from "./response/topology";
@@ -95,8 +96,8 @@ export class PiWebserviceProvider {
      * @returns Locations PI API response
      * @throws 'Fetch Error' if fetch result is not ok
      */
-    async getLogDisplays(): Promise<LogsDisplaysResponse> {
-        const url = this.logDisplaysUrl();
+    async getLogDisplays(filter: LogDisplaysFilter): Promise<LogsDisplaysResponse> {
+        const url = this.logDisplaysUrl(filter);
         const res = await this.webservice.getData<LogsDisplaysResponse>(url.toString());
         return res.data;
     }
@@ -537,9 +538,10 @@ export class PiWebserviceProvider {
      *
      * @returns complete url for making a request
      */
-    logDisplaysUrl(): URL {
+    logDisplaysUrl(filter: LogDisplaysFilter): URL {
+        const queryParameters = filterToParams(filter)
         return new URL(
-            `${this._baseUrl.pathname}${this.API_ENDPOINT}/logdisplays`,
+            `${this._baseUrl.pathname}${this.API_ENDPOINT}/logdisplays${queryParameters}`,
             this._baseUrl
         )
     }

src/requestParameters/index.ts

@@ -28,4 +28,5 @@ export * from './timeSeriesTopologyActionsFilter.js'
 export * from './runTaskFilter.js'
 export * from './workflowsFilter.js'
 export * from './dashboardsFilter.js'
+export * from './logDisplaysFilter.js'
 export * from './logDisplayLogsFilter.js'

src/requestParameters/logDisplaysFilter.ts

@@ -0,0 +1,8 @@
+import type { BaseFilter } from "./baseFilter";
+
+export interface LogDisplaysFilter extends BaseFilter {
+  /**
+   * the id of the log display
+   */
+  logDisplayId: string;
+}

test/unit/fews/logDisplays.spec.ts

@@ -2,21 +2,25 @@ import {PiWebserviceProvider} from '../../../src/piWebserviceProvider'
 import 'cross-fetch/polyfill';
 import fetchMock from "fetch-mock";
 import expectedResponse from '../mock/logDisplays.json'
+import { LogDisplaysFilter } from '../../../src';
 
 describe("logDisplays", function () {
     afterAll(function () {
         fetchMock.restore();
     });
 
     it("logdisplays json response", async function () {
-        fetchMock.get("https://mock.dev/fewswebservices/rest/fewspiservice/v1/logdisplays", {
+        fetchMock.get("https://mock.dev/fewswebservices/rest/fewspiservice/v1/logdisplays?logDisplayId=admin.log", {
             status: 200,
             body: JSON.stringify(expectedResponse)
         });
 
         const provider = new PiWebserviceProvider("https://mock.dev/fewswebservices")
 
-        const results = await provider.getLogDisplays();
+        const filter: LogDisplaysFilter = {
+            logDisplayId: "admin.log"
+        }
+        const results = await provider.getLogDisplays(filter);
         expect(results).toStrictEqual(expectedResponse);
         expect("logDisplays" in results).toBe(true);
         expect(results?.logDisplays?.length).toBe(2);