Added user-agent and versioning. (#32)

* Added user agent.
* Added versioning.

package-build.json

@@ -1,6 +1,6 @@
 {
     "private": true,
-    "version": "0.4.0",
+    "version": "0.4.1",
     "name": "@highcharts/connectors-morningstar",
     "license": "UNLICENSED",
     "description": "Highcharts connectors for Morningstar Direct Web Services",
@@ -27,7 +27,7 @@
         "Morningstar",
         "Time Series"
     ],
-    "peerDependencies": {
-        "@highcharts/dashboards": "^2.2.0"
+    "optionalDependencies": {
+        "@highcharts/dashboards": ">=2.3.0"
     }
 }

src/Shared/MorningstarAPI.ts

@@ -28,6 +28,7 @@ import MorningstarAuthentication from './MorningstarAccess';
 import MorningstarError from './MorningstarError';
 import MorningstarRegion from './MorningstarRegion';
 import MorningstarURL from './MorningstarURL';
+import { version } from '../version';
 
 
 /* *
@@ -144,6 +145,14 @@ export class MorningstarAPI {
             requestInit = this.access.authorizeRequest(requestInit);
         }
 
+        const headers = (
+            requestInit.headers instanceof Headers ?
+                requestInit.headers :
+                new Headers(requestInit.headers)
+        );
+
+        headers.set('User-Agent', `HighchartsConnectorsMorningstar/${version}`);
+
         const response = await window.fetch(url, requestInit);
 
         if (!response.url.startsWith('https')) {

src/Shared/MorningstarAccess.ts

@@ -25,6 +25,7 @@
 import type { MorningstarAccessOptions } from './MorningstarOptions';
 
 import MorningstarRegion from './MorningstarRegion';
+import { version } from '../version';
 
 
 /* *
@@ -221,7 +222,8 @@ export class MorningstarAccess {
             cache: 'no-cache',
             credentials: 'omit',
             headers: new Headers({
-                Authorization: `Basic ${payload}`
+                Authorization: `Basic ${payload}`,
+                'User-Agent': `HighchartsConnectorsMorningstar/${version}`
             }),
             method: 'POST',
             redirect: 'error'

src/index.ts

@@ -25,6 +25,7 @@
 import RNANews from './RNANews/index';
 import * as Shared from './Shared/index';
 import TimeSeries from './TimeSeries/index';
+import { version } from './version';
 
 
 /* *
@@ -37,6 +38,7 @@ import TimeSeries from './TimeSeries/index';
 export * from './RNANews/index';
 export * as Shared from './Shared/index';
 export * from './TimeSeries/index';
+export { version } from './version';
 
 
 /* *
@@ -49,5 +51,6 @@ export * from './TimeSeries/index';
 export default {
     RNANews,
     Shared,
-    TimeSeries
+    TimeSeries,
+    version
 };

src/version.ts

@@ -0,0 +1,3 @@
+// Generated by tools/dist. !!!!!!! DO NOT EDIT !!!!!!!
+export const version = '0.4.1';
+export default version;

test/unit-tests/Shared/MorningstarAPI.test.ts

@@ -3,7 +3,7 @@ import * as MC from '../../../code/connectors-morningstar.src';
 
 export async function apiAccess (
     apiOptions: MC.Shared.MorningstarAPIOptions
-) {
+): Promise<void> {
     const api = new MC.Shared.MorningstarAPI(apiOptions);
 
     Assert.ok(

test/unit-tests/version.test.ts

@@ -0,0 +1,18 @@
+import * as Assert from 'node:assert/strict';
+import * as MC from '../../code/connectors-morningstar.src';
+
+export function version (): void {
+
+    Assert.strictEqual(
+        typeof MC.version,
+        'string',
+        'Morningstar API version should be a string.'
+    );
+
+    Assert.strictEqual(
+        MC.version.split('.').length,
+        3,
+        'Morningstar API version should be valid.'
+    );
+
+}

tools/dist.ts

@@ -135,6 +135,7 @@ async function build (): Promise<void> {
     const packageJSON =
         JSON.parse(await FSP.readFile(packagePath, 'utf8')) as Record<string, string>;
     const originalVersion = packageJSON.version;
+    const versionPath = Path.join(__dirname, '..', 'src', 'version.ts');
 
     try {
 
@@ -144,6 +145,13 @@ async function build (): Promise<void> {
             JSON.stringify(packageJSON, null, '    ') + '\n',
             'utf8'
         );
+        await FSP.writeFile(
+            versionPath,
+            '// Generated by tools/dist. !!!!!!! DO NOT EDIT !!!!!!!\n' +
+            `export const version = '${ARGS.release.replace(/'/gu, '"')}';\n` +
+            'export default version;\n',
+            'utf8'
+        );
 
         log('⏳', 'Build', '...');
         ChildProcess.execFileSync('npm', [ 'run', 'build' ], { stdio: 'inherit' });

webpack.config.ts

@@ -116,7 +116,7 @@ const sharedConfiguration: Configuration = {
 
     mode: 'production',
 
-    devtool: 'hidden-source-map',
+    devtool: 'source-map',
 
     performance: {
         hints: 'error',