Merge branch 'release/2.2.1'

.github/workflows/codecov.yml

@@ -9,17 +9,17 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
-      - name: Set up Node 17
-        uses: actions/setup-node@v3
+        uses: actions/checkout@v4
+      - name: Set up Node 20
+        uses: actions/setup-node@v4
         with:
-          node-version: 17
+          node-version: 20
       - name: Install dependencies
         run: npm install
       - name: Run tests and collect coverage
         run: npm run coverage
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v4
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           flags: unittests

lib/net/datumMetadataUrlHelperMixin.d.ts

@@ -86,13 +86,6 @@ declare const DatumMetadataUrlHelperMixin: <T extends UrlHelperConstructor>(supe
         env(key: string, newValue: any): import("./environment.js").EnvironmentConfig & import("./environment.js").HostConfig;
         parameter(key: string): any;
         parameter(key: string, newValue: any): import("../util/configuration.js").default;
-        /**
-         * Generate a URL for deleting datum metadata via a `DELETE` request.
-         *
-         * @param nodeId - a specific node ID to use; if not provided the `nodeId` parameter of this instance will be used
-         * @param sourceId - a specific source ID to use; if not provided the `sourceId` parameter of this instance will be used
-         * @returns the URL
-         */
         param<T_1>(key: string): T_1 | undefined;
         hostUrl(): string;
         hostRequestUrl(): string;

lib/net/environment.d.ts

@@ -1,4 +1,23 @@
 import Configuration from "../util/configuration.js";
+/**
+ * Network environment configuration.
+ */
+interface HostConfigInfo {
+    /** The hostname. */
+    host: string;
+    /** The protocol. */
+    protocol: string;
+    /**
+     * The port number.
+     *
+     * Can be a number or string, to support a browser `Location` object.
+     */
+    port?: number | string;
+    /** An optional proxy URL prefix, for example `https://query.solarnetwork.net/1m`. */
+    proxyUrlPrefix?: string;
+    /** Arbitrary additional properties. */
+    [k: string]: any;
+}
 /**
  * Network environment configuration.
  */
@@ -43,7 +62,7 @@ declare class EnvironmentConfig extends Configuration {
      *
      * @param config - an optional set of properties to start with
      */
-    constructor(config?: Partial<HostConfig>);
+    constructor(config?: Partial<HostConfigInfo>);
     /**
      * Check if TLS is in use via the `https` protocol.
      *
@@ -57,9 +76,9 @@ interface EnvironmentConstructor {
      * Constructor.
      * @param config - an optional set of properties to start with
      */
-    new (config?: Partial<HostConfig>): EnvironmentConfig & HostConfig;
+    new (config?: Partial<HostConfigInfo>): EnvironmentConfig & HostConfig;
 }
 declare const _default: EnvironmentConfig & HostConfig & EnvironmentConstructor;
 export default _default;
-export { EnvironmentConfig, type HostConfig, type EnvironmentConstructor };
+export { EnvironmentConfig, type HostConfig, type HostConfigInfo, type EnvironmentConstructor, };
 //# sourceMappingURL=environment.d.ts.map

lib/net/index.d.ts

@@ -3,7 +3,7 @@ export { default as AuthTokenUrlHelperMixin } from "./authTokenUrlHelperMixin.js
 export { default as AuthorizationV2Builder } from "./authV2.js";
 export { default as DatumUrlHelperMixin } from "./datumUrlHelperMixin.js";
 export { default as DatumMetadataUrlHelperMixin } from "./datumMetadataUrlHelperMixin.js";
-export { default as Environment, EnvironmentConfig, type HostConfig, type EnvironmentConstructor, } from "./environment.js";
+export { default as Environment, EnvironmentConfig, type HostConfig, type HostConfigInfo, type EnvironmentConstructor, } from "./environment.js";
 export { default as HttpHeaders, HttpContentType, HttpMethod, } from "./httpHeaders.js";
 export { default as InstructionUrlHelperMixin, type QueueInstructionRequest, type QueueInstructionSimpleRequest, } from "./instructionUrlHelperMixin.js";
 export { default as NodesUrlHelperMixin } from "./nodesUrlHelperMixin.js";

lib/net/urlHelper.d.ts

@@ -1,5 +1,5 @@
 import Configuration from "../util/configuration.js";
-import { EnvironmentConfig, HostConfig } from "./environment.js";
+import { EnvironmentConfig, HostConfig, HostConfigInfo } from "./environment.js";
 import { Constructor } from "../util/objects.js";
 import { default as DatumFilter } from "../domain/datumFilter.js";
 /**
@@ -22,11 +22,11 @@ declare class UrlHelper {
     /**
      * Constructor.
      *
-     * @param environment - the optional initial environment to use;
+     * @param environment the optional initial environment to use;
      *        if a non-`Environment` object is passed then the properties of that object will
      *        be used to construct a new `Environment` instance
      */
-    constructor(environment?: HostConfig);
+    constructor(environment?: HostConfigInfo);
     /**
      * Get the environment configuration.
      */