Improved TimeSeries options.

highcharts · Jul 23, 2024 · ca85cec · ca85cec
1 parent 681084d
commit ca85cec
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 8 deletions.
diff --git a/src/TimeSeries/Converters/TimeSeriesDividendConverter.ts b/src/TimeSeries/Converters/TimeSeriesDividendConverter.ts
@@ -92,6 +92,7 @@ export class TimeSeriesDividendConverter extends MorningstarConverter {
             ...this.options,
             ...options
         };
+        const includeCurrency = userOptions.includeCurrency;
         const json = userOptions.json;
 
         // Validate JSON
@@ -141,7 +142,9 @@ export class TimeSeriesDividendConverter extends MorningstarConverter {
 
         for (const securityId of securityIds) {
             table.setColumn(securityId);
-            table.setColumn(`${securityId}_CID`);
+            if (includeCurrency) {
+                table.setColumn(`${securityId}_Currency`);
+            }
         }
 
         // Add dividends to table
@@ -155,7 +158,9 @@ export class TimeSeriesDividendConverter extends MorningstarConverter {
                 table.setCell('Date', ++currentTableIndex, currentTableDate);
             }
             table.setCell(dividend.Id, currentTableIndex, dividend.Value);
-            table.setCell(`${dividend.Id}_CID`, currentTableIndex, dividend.CurrencyId);
+            if (includeCurrency) {
+                table.setCell(`${dividend.Id}_Currency`, currentTableIndex, dividend.CurrencyId);
+            }
         }
 
     }

diff --git a/src/TimeSeries/TimeSeriesConnector.ts b/src/TimeSeries/TimeSeriesConnector.ts
@@ -110,11 +110,19 @@ class TimeSeriesConnector extends MorningstarConnector {
 
     public override async load(): Promise<this> {
         const options = this.options;
-        const url = new MorningstarURL('timeseries/cumulativereturn');
-        const api = new MorningstarAPI(options.api);
+        const securities = options.securities;
+        const tax = options.tax;
 
-        if (options.securities) {
-            url.searchParams.setSecurityOptions(options.securities);
+        if (securities) {
+            const url = new MorningstarURL('timeseries/cumulativereturn');
+            const searchParams = url.searchParams;
+            const api = new MorningstarAPI(options.api);
+
+            searchParams.setSecurityOptions(securities);
+
+            if (tax) {
+                searchParams.set('tax', tax);
+            }
 
             const response = await api.fetch(url);
             const json = await response.json() as unknown;

diff --git a/src/TimeSeries/TimeSeriesOptions.ts b/src/TimeSeries/TimeSeriesOptions.ts
@@ -56,6 +56,15 @@ export interface TimeSeriesCumulativeReturnOptions extends TimeSeriesConverterOp
 
 export interface TimeSeriesDividendOptions extends TimeSeriesConverterOptions {
 
+    /**
+     * Whether to include currency information as an additional column for each
+     * security (`true`), or not (`false`). The name of the additional column
+     * has the format `[SID]_Currency`, e.g. `F0GBR04S23_Currency`.
+     *
+     * @default false
+     */
+    includeCurrency?: boolean;
+
     /**
      * Series type to retrieve.
      */
@@ -114,12 +123,12 @@ export interface TimeSeriesOptions extends MorningstarOptions {
     /**
      * Type-based series options.
      */
-    series: TimeSeriesType;
+    series?: TimeSeriesType;
 
     /**
      * Tax option.
      */
-    tax: ('pretax'|'posttax');
+    tax?: ('pretax'|'posttax');
 
 }