accept date range parameters

cityssm · Aug 4, 2023 · 8ef3ec8 · 8ef3ec8
1 parent 4f34eef
commit 8ef3ec8
Show file tree

Hide file tree

Showing 14 changed files with 194 additions and 25 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -1,4 +1,5 @@
 import { type types as greenButtonTypes } from '@cityssm/green-button-parser';
+import type { DateTimeFilters } from './types.js';
 export interface Configuration {
     baseUrl: `${string}/`;
     clientId?: string;
@@ -7,8 +8,8 @@ export interface Configuration {
 }
 export declare function setConfiguration(configuration: Configuration): void;
 export declare function setUtilityApiConfiguration(apiToken: string, baseUrl?: `${string}/`): void;
-export declare function getEndpoint(endpoint: string): Promise<string | undefined>;
-export declare function getGreenButtonEndpoint(greenButtonEndpoint: `/${string}`): Promise<greenButtonTypes.GreenButtonJson | undefined>;
+export declare function getEndpoint(endpoint: string, getParameters?: Record<string, string>): Promise<string | undefined>;
+export declare function getGreenButtonEndpoint(greenButtonEndpoint: `/${string}`, getParameters?: Record<string, string>): Promise<greenButtonTypes.GreenButtonJson | undefined>;
 export declare function getAuthorizations(): Promise<greenButtonTypes.GreenButtonJson | undefined>;
 export declare function getAuthorization(authorizationId: string): Promise<greenButtonTypes.GreenButtonJson | undefined>;
 export declare function getUsagePoints(authorizationId: string): Promise<greenButtonTypes.GreenButtonJson | undefined>;
@@ -19,8 +20,8 @@ export declare function getElectricPowerQualitySummaries(authorizationId: string
 export declare function getCustomers(authorizationId: string): Promise<greenButtonTypes.GreenButtonJson | undefined>;
 export declare function getCustomerAccounts(authorizationId: string, customerId: string): Promise<greenButtonTypes.GreenButtonJson | undefined>;
 export declare function getCustomerAgreements(authorizationId: string, customerId: string, customerAccountId: string): Promise<greenButtonTypes.GreenButtonJson | undefined>;
-export declare function getBatchSubscriptionsByAuthorization(authorizationId: string): Promise<greenButtonTypes.GreenButtonJson | undefined>;
-export declare function getBatchSubscriptionsByMeter(authorizationId: string, meterId: string): Promise<greenButtonTypes.GreenButtonJson | undefined>;
+export declare function getBatchSubscriptionsByAuthorization(authorizationId: string, dateTimeFilters?: DateTimeFilters): Promise<greenButtonTypes.GreenButtonJson | undefined>;
+export declare function getBatchSubscriptionsByMeter(authorizationId: string, meterId: string, dateTimeFilters?: DateTimeFilters): Promise<greenButtonTypes.GreenButtonJson | undefined>;
 declare const _default: {
     setConfiguration: typeof setConfiguration;
     setUtilityApiConfiguration: typeof setUtilityApiConfiguration;

diff --git a/index.js b/index.js
@@ -1,6 +1,7 @@
 import { atomToGreenButtonJson } from '@cityssm/green-button-parser';
 import axios from 'axios';
 import Debug from 'debug';
+import { formatDateTimeFiltersParameters } from './utilities.js';
 const debug = Debug('green-button-subscriber');
 let _configuration;
 let _token;
@@ -42,7 +43,7 @@ async function getAccessToken() {
         debug('Error getting access token:', error.response.data);
     }
 }
-export async function getEndpoint(endpoint) {
+export async function getEndpoint(endpoint, getParameters = {}) {
     if (_token === undefined || Date.now() >= _token.expires_in * 1000) {
         debug('Token expired.');
         await getAccessToken();
@@ -52,17 +53,23 @@ export async function getEndpoint(endpoint) {
     };
     const apiEndpoint = _configuration.baseUrl + endpoint;
     debug(`End Point: ${apiEndpoint}`);
+    const requestOptions = {
+        headers
+    };
+    if (getParameters !== undefined && Object.keys(getParameters).length > 0) {
+        requestOptions.params = getParameters;
+    }
     try {
-        const response = await axios.get(apiEndpoint, { headers });
+        const response = await axios.get(apiEndpoint, requestOptions);
         return response.data;
     }
     catch (error) {
         debug('Error accessing API endpoint:', error.response.data);
     }
     return undefined;
 }
-export async function getGreenButtonEndpoint(greenButtonEndpoint) {
-    const greenButtonXml = await getEndpoint(`DataCustodian/espi/1_1/resource${greenButtonEndpoint}`);
+export async function getGreenButtonEndpoint(greenButtonEndpoint, getParameters) {
+    const greenButtonXml = await getEndpoint(`DataCustodian/espi/1_1/resource${greenButtonEndpoint}`, getParameters);
     if (greenButtonXml === undefined) {
         return undefined;
     }
@@ -98,11 +105,11 @@ export async function getCustomerAccounts(authorizationId, customerId) {
 export async function getCustomerAgreements(authorizationId, customerId, customerAccountId) {
     return await getGreenButtonEndpoint(`/RetailCustomer/${authorizationId}/Customer/${customerId}/CustomerAccount/${customerAccountId}/CustomerAgreement`);
 }
-export async function getBatchSubscriptionsByAuthorization(authorizationId) {
-    return await getGreenButtonEndpoint(`/Batch/Subscription/${authorizationId}`);
+export async function getBatchSubscriptionsByAuthorization(authorizationId, dateTimeFilters) {
+    return await getGreenButtonEndpoint(`/Batch/Subscription/${authorizationId}`, formatDateTimeFiltersParameters(dateTimeFilters));
 }
-export async function getBatchSubscriptionsByMeter(authorizationId, meterId) {
-    return await getGreenButtonEndpoint(`/Batch/Subscription/${authorizationId}/UsagePoint/${meterId}`);
+export async function getBatchSubscriptionsByMeter(authorizationId, meterId, dateTimeFilters) {
+    return await getGreenButtonEndpoint(`/Batch/Subscription/${authorizationId}/UsagePoint/${meterId}`, formatDateTimeFiltersParameters(dateTimeFilters));
 }
 export default {
     setConfiguration,

diff --git a/index.ts b/index.ts
@@ -5,9 +5,12 @@ import {
   atomToGreenButtonJson,
   type types as greenButtonTypes
 } from '@cityssm/green-button-parser'
-import axios from 'axios'
+import axios, { type AxiosRequestConfig } from 'axios'
 import Debug from 'debug'
 
+import type { DateTimeFilters } from './types.js'
+import { formatDateTimeFiltersParameters } from './utilities.js'
+
 const debug = Debug('green-button-subscriber')
 
 export interface Configuration {
@@ -76,7 +79,8 @@ async function getAccessToken(): Promise<void> {
 }
 
 export async function getEndpoint(
-  endpoint: string
+  endpoint: string,
+  getParameters: Record<string, string> = {}
 ): Promise<string | undefined> {
   if (_token === undefined || Date.now() >= _token.expires_in * 1000) {
     // If the token is not obtained or has expired, get a new one
@@ -92,8 +96,16 @@ export async function getEndpoint(
   const apiEndpoint = _configuration.baseUrl + endpoint
   debug(`End Point: ${apiEndpoint}`)
 
+  const requestOptions: AxiosRequestConfig = {
+    headers
+  }
+
+  if (getParameters !== undefined && Object.keys(getParameters).length > 0) {
+    requestOptions.params = getParameters
+  }
+
   try {
-    const response = await axios.get(apiEndpoint, { headers })
+    const response = await axios.get(apiEndpoint, requestOptions)
     return response.data
   } catch (error) {
     debug('Error accessing API endpoint:', error.response.data)
@@ -103,10 +115,12 @@ export async function getEndpoint(
 }
 
 export async function getGreenButtonEndpoint(
-  greenButtonEndpoint: `/${string}`
+  greenButtonEndpoint: `/${string}`,
+  getParameters?: Record<string, string>
 ): Promise<greenButtonTypes.GreenButtonJson | undefined> {
   const greenButtonXml = await getEndpoint(
-    `DataCustodian/espi/1_1/resource${greenButtonEndpoint}`
+    `DataCustodian/espi/1_1/resource${greenButtonEndpoint}`,
+    getParameters
   )
 
   if (greenButtonXml === undefined) {
@@ -244,9 +258,13 @@ export async function getCustomerAgreements(
  * @returns
  */
 export async function getBatchSubscriptionsByAuthorization(
-  authorizationId: string
+  authorizationId: string,
+  dateTimeFilters?: DateTimeFilters
 ): Promise<greenButtonTypes.GreenButtonJson | undefined> {
-  return await getGreenButtonEndpoint(`/Batch/Subscription/${authorizationId}`)
+  return await getGreenButtonEndpoint(
+    `/Batch/Subscription/${authorizationId}`,
+    formatDateTimeFiltersParameters(dateTimeFilters)
+  )
 }
 
 /**
@@ -258,10 +276,12 @@ export async function getBatchSubscriptionsByAuthorization(
  */
 export async function getBatchSubscriptionsByMeter(
   authorizationId: string,
-  meterId: string
+  meterId: string,
+  dateTimeFilters?: DateTimeFilters
 ): Promise<greenButtonTypes.GreenButtonJson | undefined> {
   return await getGreenButtonEndpoint(
-    `/Batch/Subscription/${authorizationId}/UsagePoint/${meterId}`
+    `/Batch/Subscription/${authorizationId}/UsagePoint/${meterId}`,
+    formatDateTimeFiltersParameters(dateTimeFilters)
   )
 }
 

diff --git a/test/test.js b/test/test.js
@@ -126,7 +126,9 @@ describe('node-green-button-subscriber', () => {
     });
     it('Retrieves batch subscriptions by authorization', async () => {
         try {
-            const response = await greenButtonSubscriber.getBatchSubscriptionsByAuthorization(authorizationId);
+            const response = await greenButtonSubscriber.getBatchSubscriptionsByAuthorization(authorizationId, {
+                publishedMax: new Date(2023, 3 - 1, 28)
+            });
             assert.ok(response !== undefined);
             const entries = greenButtonHelpers.getEntriesByContentType(response, 'IntervalBlock');
             assert.ok(entries.length > 0);
@@ -138,7 +140,10 @@ describe('node-green-button-subscriber', () => {
     });
     it('Retrieves batch subscriptions by meter', async () => {
         try {
-            const response = await greenButtonSubscriber.getBatchSubscriptionsByMeter(authorizationId, meterId);
+            const response = await greenButtonSubscriber.getBatchSubscriptionsByMeter(authorizationId, meterId, {
+                publishedMin: new Date(2023, 7 - 1, 1),
+                publishedMax: '2023-08-31T23:59:59Z'
+            });
             assert.ok(response !== undefined);
             const entries = greenButtonHelpers.getEntriesByContentType(response, 'IntervalBlock');
             assert.ok(entries.length > 0);

diff --git a/test/test.ts b/test/test.ts
@@ -219,7 +219,10 @@ describe('node-green-button-subscriber', () => {
     try {
       const response =
         await greenButtonSubscriber.getBatchSubscriptionsByAuthorization(
-          authorizationId
+          authorizationId,
+          {
+            publishedMax: new Date(2023, 3 - 1, 28)
+          }
         )
 
       assert.ok(response !== undefined)
@@ -239,7 +242,11 @@ describe('node-green-button-subscriber', () => {
     try {
       const response = await greenButtonSubscriber.getBatchSubscriptionsByMeter(
         authorizationId,
-        meterId
+        meterId,
+        {
+          publishedMin: new Date(2023, 7 - 1, 1),
+          publishedMax: '2023-08-31T23:59:59Z'
+        }
       )
 
       assert.ok(response !== undefined)

diff --git a/test/utilities.d.ts b/test/utilities.d.ts
@@ -0,0 +1 @@
+export {};
diff --git a/test/utilities.js b/test/utilities.js
@@ -0,0 +1,14 @@
+import assert from 'node:assert';
+import { formatDateTimeFiltersParameters } from '../utilities.js';
+describe('node-green-button-subscriber/helpers', () => {
+    it('Formats Dates and ISO strings properly', () => {
+        const isoDate = '2023-01-02T12:34:56Z';
+        const dateTimeFilters = {
+            publishedMin: isoDate,
+            publishedMax: new Date(isoDate)
+        };
+        const parameters = formatDateTimeFiltersParameters(dateTimeFilters);
+        assert.strictEqual(parameters['published-min'], isoDate);
+        assert.strictEqual(parameters['published-max'], isoDate);
+    });
+});
diff --git a/test/utilities.ts b/test/utilities.ts
@@ -0,0 +1,20 @@
+import assert from 'node:assert'
+
+import type { DateTimeFilters, IsoDateString } from '../types.js'
+import { formatDateTimeFiltersParameters } from '../utilities.js'
+
+describe('node-green-button-subscriber/helpers', () => {
+  it('Formats Dates and ISO strings properly', () => {
+    const isoDate: IsoDateString = '2023-01-02T12:34:56Z'
+
+    const dateTimeFilters: DateTimeFilters = {
+      publishedMin: isoDate,
+      publishedMax: new Date(isoDate)
+    }
+
+    const parameters = formatDateTimeFiltersParameters(dateTimeFilters)
+
+    assert.strictEqual(parameters['published-min'], isoDate)
+    assert.strictEqual(parameters['published-max'], isoDate)
+  })
+})
diff --git a/types.d.ts b/types.d.ts
@@ -0,0 +1,8 @@
+export type IsoDateString = `${string}-${string}-${string}T${string}:${string}:${string}Z`;
+export type DateOrIsoDateString = Date | IsoDateString;
+export interface DateTimeFilters {
+    publishedMin?: DateOrIsoDateString;
+    publishedMax?: DateOrIsoDateString;
+    updatedMin?: DateOrIsoDateString;
+    updatedMax?: DateOrIsoDateString;
+}
diff --git a/types.js b/types.js
@@ -0,0 +1 @@
+export {};
diff --git a/types.ts b/types.ts
@@ -0,0 +1,11 @@
+export type IsoDateString =
+  `${string}-${string}-${string}T${string}:${string}:${string}Z`
+
+export type DateOrIsoDateString = Date | IsoDateString
+
+export interface DateTimeFilters {
+  publishedMin?: DateOrIsoDateString
+  publishedMax?: DateOrIsoDateString
+  updatedMin?: DateOrIsoDateString
+  updatedMax?: DateOrIsoDateString
+}
diff --git a/utilities.d.ts b/utilities.d.ts
@@ -0,0 +1,3 @@
+import type { DateOrIsoDateString, DateTimeFilters, IsoDateString } from './types.js';
+export declare function formatDateTime(dateOrIsoDateString: DateOrIsoDateString): IsoDateString;
+export declare function formatDateTimeFiltersParameters(dateTimeFilters?: DateTimeFilters): Record<string, string>;
diff --git a/utilities.js b/utilities.js
@@ -0,0 +1,26 @@
+export function formatDateTime(dateOrIsoDateString) {
+    if (typeof dateOrIsoDateString === 'string') {
+        return dateOrIsoDateString;
+    }
+    const isoDateString = dateOrIsoDateString.toISOString();
+    if (isoDateString.length === 24) {
+        return (isoDateString.slice(0, -5) + 'Z');
+    }
+    return isoDateString;
+}
+export function formatDateTimeFiltersParameters(dateTimeFilters = {}) {
+    const parameters = {};
+    if (dateTimeFilters.publishedMin !== undefined) {
+        parameters['published-min'] = formatDateTime(dateTimeFilters.publishedMin);
+    }
+    if (dateTimeFilters.publishedMax !== undefined) {
+        parameters['published-max'] = formatDateTime(dateTimeFilters.publishedMax);
+    }
+    if (dateTimeFilters.updatedMin !== undefined) {
+        parameters['updated-min'] = formatDateTime(dateTimeFilters.updatedMin);
+    }
+    if (dateTimeFilters.updatedMax !== undefined) {
+        parameters['updated-max'] = formatDateTime(dateTimeFilters.updatedMax);
+    }
+    return parameters;
+}
diff --git a/utilities.ts b/utilities.ts
@@ -0,0 +1,45 @@
+import type {
+  DateOrIsoDateString,
+  DateTimeFilters,
+  IsoDateString
+} from './types.js'
+
+export function formatDateTime(
+  dateOrIsoDateString: DateOrIsoDateString
+): IsoDateString {
+  if (typeof dateOrIsoDateString === 'string') {
+    return dateOrIsoDateString
+  }
+
+  const isoDateString = dateOrIsoDateString.toISOString()
+
+  if (isoDateString.length === 24) {
+    return (isoDateString.slice(0, -5) + 'Z') as IsoDateString
+  }
+
+  return isoDateString as IsoDateString
+}
+
+export function formatDateTimeFiltersParameters(
+  dateTimeFilters: DateTimeFilters = {}
+): Record<string, string> {
+  const parameters = {}
+
+  if (dateTimeFilters.publishedMin !== undefined) {
+    parameters['published-min'] = formatDateTime(dateTimeFilters.publishedMin)
+  }
+
+  if (dateTimeFilters.publishedMax !== undefined) {
+    parameters['published-max'] = formatDateTime(dateTimeFilters.publishedMax)
+  }
+
+  if (dateTimeFilters.updatedMin !== undefined) {
+    parameters['updated-min'] = formatDateTime(dateTimeFilters.updatedMin)
+  }
+
+  if (dateTimeFilters.updatedMax !== undefined) {
+    parameters['updated-max'] = formatDateTime(dateTimeFilters.updatedMax)
+  }
+
+  return parameters
+}