DATA-4295: SDK/CLI changes to support ExportTabularData and GetLatestTabularData (#587)

Author: Emerald-Z

src/app/data-client.spec.ts

@@ -217,6 +217,39 @@ describe('DataClient tests', () => {
 
       expect(capReq).toStrictEqual(expectedRequest);
     });
+
+    // Test for additional params
+    const additionalParams = {
+      key: 'value1',
+    };
+
+    it('gets tabular data for an interval with additional params', async () => {
+      await subject().exportTabularData(
+        'partId1',
+        'resource1',
+        'resource1:subtype',
+        'Readings',
+        timeCaptured1,
+        timeCaptured2,
+        additionalParams
+      );
+
+      const expectedRequest = new ExportTabularDataRequest({
+        partId: 'partId1',
+        resourceName: 'resource1',
+        resourceSubtype: 'resource1:subtype',
+        methodName: 'Readings',
+        interval: {
+          start: Timestamp.fromDate(timeCaptured1),
+          end: Timestamp.fromDate(timeCaptured2),
+        },
+        additionalParameters: Struct.fromJson({
+          key: 'value1',
+        }),
+      });
+
+      expect(capReq).toStrictEqual(expectedRequest);
+    });
   });
 
   describe('tabularDataBySQL tests', () => {

src/app/data-client.ts

@@ -125,7 +125,8 @@ export class DataClient {
     resourceSubtype: string,
     methodName: string,
     startTime?: Date,
-    endTime?: Date
+    endTime?: Date,
+    additionalParams?: Record<string, JsonValue>
   ) {
     const interval = new CaptureInterval();
     if (startTime) {
@@ -135,12 +136,18 @@ export class DataClient {
       interval.end = Timestamp.fromDate(endTime);
     }
 
+    let additionalParameters: Struct | undefined;
+    if (additionalParams) {
+      additionalParameters = Struct.fromJson(additionalParams);
+    }
+
     const req = {
       partId,
       resourceName,
       resourceSubtype,
       methodName,
       interval,
+      additionalParameters,
     };
 
     const responses = this.dataClient.exportTabularData(req);
@@ -1317,13 +1324,20 @@ export class DataClient {
     partId: string,
     resourceName: string,
     resourceSubtype: string,
-    methodName: string
+    methodName: string,
+    additionalParams?: Record<string, JsonValue>
   ): Promise<[Date, Date, Record<string, JsonValue>] | null> {
+    let additionalParameters: Struct | undefined;
+    if (additionalParams) {
+      additionalParameters = Struct.fromJson(additionalParams);
+    }
+
     const resp = await this.dataClient.getLatestTabularData({
       partId,
       resourceName,
       resourceSubtype,
       methodName,
+      additionalParameters,
     });
 
     if (!resp.payload || !resp.timeCaptured || !resp.timeSynced) {