@dynatrace-sdk/client-classic-environment-v2 9.0.0 → 9.0.1

package/CHANGELOG.md

@@ -2,13 +2,21 @@
 
 @dynatrace-sdk/client-classic-environment-v2
 
+## 9.0.1
+
+### Patch Changes
+
+- Fix encoding of the fields query parameter - reserved characters are now preserved verbatim instead of being percent-encoded. (APPDEV-19736)
+
 ## 9.0.0
 
 ### Major Changes
+
 - BREAKING: `SyntheticLocationsNodesAndConfigurationClient.updateConfiguration` now returns `Promise<void>` because the endpoint returns HTTP 204 without a response body. Do not consume the resolved `SyntheticConfigDto`.
 - BREAKING: `SyntheticConfigDto.maintenanceWindowsExcludedFromAvailability` is now required. Include this field in every `updateConfiguration` request.
 
 ### Minor Changes
+
 - Add optional `monitorCrossOriginFrames` to `SyntheticBrowserMonitorConfigurationDto`.
 - Add `asHistogram` to metric descriptor transformations.
 - Deprecate the API-token operations on `accessTokensApiTokensClient`.

package/README.md

@@ -1,6 +1,6 @@
 # @dynatrace-sdk/client-classic-environment-v2
 
-[![npm](https://img.shields.io/badge/npm-v9.0.0-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-classic-environment-v2/v/9.0.0)
+[![npm](https://img.shields.io/badge/npm-v9.0.1-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-classic-environment-v2/v/9.0.1)
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
 

package/cjs/index.js

@@ -613,29 +613,36 @@ function transformToFormDataField(value, field) {
 }
 
 // packages/client/classic-environment-v2/src/lib/utils/url-helpers.ts
-var encodeQueryParam = (key, value) => {
+var flagFor = (flags, key, fallback) => flags && Object.prototype.hasOwnProperty.call(flags, key) ? flags[key] : fallback;
+var encodeAllowingReserved = (value) => value.replace(/[^:/?#[\]@!$&'()*+,;=]+/g, (unreserved) => encodeURIComponent(unreserved));
+var encodeQueryParamValue = (value, allowReserved) => {
+  const rawValue = String(value);
+  return allowReserved ? encodeAllowingReserved(rawValue) : encodeURIComponent(rawValue);
+};
+var encodeQueryParam = (key, value, allowReserved) => {
   const encodedKey = encodeURIComponent(key);
-  return `${encodedKey}=${encodeURIComponent(typeof value === "number" ? value : String(value))}`;
+  return `${encodedKey}=${encodeQueryParamValue(value, allowReserved)}`;
 };
-var addExplodedArrayQueryParam = (query, key) => {
+var addExplodedArrayQueryParam = (query, key, allowReserved) => {
   const arrayValue = query[key];
-  return arrayValue.map((value) => encodeQueryParam(key, value)).join("&");
+  return arrayValue.map((value) => encodeQueryParam(key, value, allowReserved)).join("&");
 };
-var addNonExplodedArrayQueryParams = (query, key) => {
+var addNonExplodedArrayQueryParams = (query, key, allowReserved) => {
   const encodedKey = encodeURIComponent(key);
-  const encodedParamsList = query[key].map((value) => encodeURIComponent(typeof value === "number" ? value : String(value))).join(",");
+  const encodedParamsList = query[key].map((value) => encodeQueryParamValue(value, allowReserved)).join(",");
   return `${encodedKey}=${encodedParamsList}`;
 };
-var addQueryParam = (query, key) => encodeQueryParam(key, query[key]);
-var arrayQueryParams = (query, key, explode) => {
-  return explode ? addExplodedArrayQueryParam(query, key) : addNonExplodedArrayQueryParams(query, key);
+var addQueryParam = (query, key, allowReserved) => encodeQueryParam(key, query[key], allowReserved);
+var arrayQueryParams = (query, key, explode, allowReserved) => {
+  return explode ? addExplodedArrayQueryParam(query, key, allowReserved) : addNonExplodedArrayQueryParams(query, key, allowReserved);
 };
 var toQueryString = (rawQuery, flags = {}) => {
   const query = rawQuery || {};
   const keys = Object.keys(query).filter((key) => typeof query[key] !== "undefined");
-  const queryString = keys.map(
-    (key) => Array.isArray(query[key]) ? arrayQueryParams(query, key, flags.explode?.hasOwnProperty(key) ? flags.explode[key] : true) : addQueryParam(query, key)
-  ).join("&");
+  const queryString = keys.map((key) => {
+    const allowReserved = flagFor(flags.allowReserved, key, false);
+    return Array.isArray(query[key]) ? arrayQueryParams(query, key, flagFor(flags.explode, key, true), allowReserved) : addQueryParam(query, key, allowReserved);
+  }).join("&");
   return queryString ? `?${queryString}` : "";
 };
 
@@ -18423,16 +18430,19 @@ var MetricsClient = class {
     if (!config) {
       throw new import_shared_errors28.ApiClientError("API client error", "API client call is missing mandatory config parameter");
     }
-    const query = toQueryString({
-      nextPageKey: config.nextPageKey,
-      pageSize: config.pageSize,
-      metricSelector: config.metricSelector,
-      text: config.text,
-      fields: config.fields,
-      writtenSince: config.writtenSince,
-      writtenSinceMode: config.writtenSinceMode,
-      metadataSelector: config.metadataSelector
-    });
+    const query = toQueryString(
+      {
+        nextPageKey: config.nextPageKey,
+        pageSize: config.pageSize,
+        metricSelector: config.metricSelector,
+        text: config.text,
+        fields: config.fields,
+        writtenSince: config.writtenSince,
+        writtenSinceMode: config.writtenSinceMode,
+        metadataSelector: config.metadataSelector
+      },
+      { allowReserved: { fields: true } }
+    );
     try {
       const response = await this.httpClient.send({
         url: `/platform/classic/environment-api/v2/metrics${query}`,
@@ -19419,7 +19429,10 @@ var MetricsUnitsClient = class {
     if (!config) {
       throw new import_shared_errors29.ApiClientError("API client error", "API client call is missing mandatory config parameter");
     }
-    const query = toQueryString({ unitSelector: config.unitSelector, fields: config.fields });
+    const query = toQueryString(
+      { unitSelector: config.unitSelector, fields: config.fields },
+      { allowReserved: { fields: true } }
+    );
     try {
       const response = await this.httpClient.send({
         url: `/platform/classic/environment-api/v2/units${query}`,
@@ -20815,15 +20828,18 @@ var MonitoredEntitiesClient = class {
     if (!config) {
       throw new import_shared_errors31.ApiClientError("API client error", "API client call is missing mandatory config parameter");
     }
-    const query = toQueryString({
-      nextPageKey: config.nextPageKey,
-      pageSize: config.pageSize,
-      entitySelector: config.entitySelector,
-      from: config.from,
-      to: config.to,
-      fields: config.fields,
-      sort: config.sort
-    });
+    const query = toQueryString(
+      {
+        nextPageKey: config.nextPageKey,
+        pageSize: config.pageSize,
+        entitySelector: config.entitySelector,
+        from: config.from,
+        to: config.to,
+        fields: config.fields,
+        sort: config.sort
+      },
+      { allowReserved: { fields: true } }
+    );
     try {
       const response = await this.httpClient.send({
         url: `/platform/classic/environment-api/v2/entities${query}`,
@@ -21428,7 +21444,10 @@ var MonitoredEntitiesClient = class {
     if (!config) {
       throw new import_shared_errors31.ApiClientError("API client error", "API client call is missing mandatory config parameter");
     }
-    const query = toQueryString({ from: config.from, to: config.to, fields: config.fields });
+    const query = toQueryString(
+      { from: config.from, to: config.to, fields: config.fields },
+      { allowReserved: { fields: true } }
+    );
     try {
       const response = await this.httpClient.send({
         url: `/platform/classic/environment-api/v2/entities/${config.entityId}${query}`,

package/dynatrace-metadata.json

@@ -1,9 +1,9 @@
 {
   "dynagen": {
-    "version": "0.23.0",
+    "version": "0.23.2",
     "template": {
       "name": "@dynatrace-sdk/template-typescript-client",
-      "version": "0.36.1"
+      "version": "0.37.0"
     },
     "featureFlags": {}
   },

package/esm/index.js

@@ -238,29 +238,36 @@ function transformToFormDataField(value, field) {
 }
 
 // packages/client/classic-environment-v2/src/lib/utils/url-helpers.ts
-var encodeQueryParam = (key, value) => {
+var flagFor = (flags, key, fallback) => flags && Object.prototype.hasOwnProperty.call(flags, key) ? flags[key] : fallback;
+var encodeAllowingReserved = (value) => value.replace(/[^:/?#[\]@!$&'()*+,;=]+/g, (unreserved) => encodeURIComponent(unreserved));
+var encodeQueryParamValue = (value, allowReserved) => {
+  const rawValue = String(value);
+  return allowReserved ? encodeAllowingReserved(rawValue) : encodeURIComponent(rawValue);
+};
+var encodeQueryParam = (key, value, allowReserved) => {
   const encodedKey = encodeURIComponent(key);
-  return `${encodedKey}=${encodeURIComponent(typeof value === "number" ? value : String(value))}`;
+  return `${encodedKey}=${encodeQueryParamValue(value, allowReserved)}`;
 };
-var addExplodedArrayQueryParam = (query, key) => {
+var addExplodedArrayQueryParam = (query, key, allowReserved) => {
   const arrayValue = query[key];
-  return arrayValue.map((value) => encodeQueryParam(key, value)).join("&");
+  return arrayValue.map((value) => encodeQueryParam(key, value, allowReserved)).join("&");
 };
-var addNonExplodedArrayQueryParams = (query, key) => {
+var addNonExplodedArrayQueryParams = (query, key, allowReserved) => {
   const encodedKey = encodeURIComponent(key);
-  const encodedParamsList = query[key].map((value) => encodeURIComponent(typeof value === "number" ? value : String(value))).join(",");
+  const encodedParamsList = query[key].map((value) => encodeQueryParamValue(value, allowReserved)).join(",");
   return `${encodedKey}=${encodedParamsList}`;
 };
-var addQueryParam = (query, key) => encodeQueryParam(key, query[key]);
-var arrayQueryParams = (query, key, explode) => {
-  return explode ? addExplodedArrayQueryParam(query, key) : addNonExplodedArrayQueryParams(query, key);
+var addQueryParam = (query, key, allowReserved) => encodeQueryParam(key, query[key], allowReserved);
+var arrayQueryParams = (query, key, explode, allowReserved) => {
+  return explode ? addExplodedArrayQueryParam(query, key, allowReserved) : addNonExplodedArrayQueryParams(query, key, allowReserved);
 };
 var toQueryString = (rawQuery, flags = {}) => {
   const query = rawQuery || {};
   const keys = Object.keys(query).filter((key) => typeof query[key] !== "undefined");
-  const queryString = keys.map(
-    (key) => Array.isArray(query[key]) ? arrayQueryParams(query, key, flags.explode?.hasOwnProperty(key) ? flags.explode[key] : true) : addQueryParam(query, key)
-  ).join("&");
+  const queryString = keys.map((key) => {
+    const allowReserved = flagFor(flags.allowReserved, key, false);
+    return Array.isArray(query[key]) ? arrayQueryParams(query, key, flagFor(flags.explode, key, true), allowReserved) : addQueryParam(query, key, allowReserved);
+  }).join("&");
   return queryString ? `?${queryString}` : "";
 };
 
@@ -18237,16 +18244,19 @@ var MetricsClient = class {
     if (!config) {
       throw new ApiClientError22("API client error", "API client call is missing mandatory config parameter");
     }
-    const query = toQueryString({
-      nextPageKey: config.nextPageKey,
-      pageSize: config.pageSize,
-      metricSelector: config.metricSelector,
-      text: config.text,
-      fields: config.fields,
-      writtenSince: config.writtenSince,
-      writtenSinceMode: config.writtenSinceMode,
-      metadataSelector: config.metadataSelector
-    });
+    const query = toQueryString(
+      {
+        nextPageKey: config.nextPageKey,
+        pageSize: config.pageSize,
+        metricSelector: config.metricSelector,
+        text: config.text,
+        fields: config.fields,
+        writtenSince: config.writtenSince,
+        writtenSinceMode: config.writtenSinceMode,
+        metadataSelector: config.metadataSelector
+      },
+      { allowReserved: { fields: true } }
+    );
     try {
       const response = await this.httpClient.send({
         url: `/platform/classic/environment-api/v2/metrics${query}`,
@@ -19242,7 +19252,10 @@ var MetricsUnitsClient = class {
     if (!config) {
       throw new ApiClientError23("API client error", "API client call is missing mandatory config parameter");
     }
-    const query = toQueryString({ unitSelector: config.unitSelector, fields: config.fields });
+    const query = toQueryString(
+      { unitSelector: config.unitSelector, fields: config.fields },
+      { allowReserved: { fields: true } }
+    );
     try {
       const response = await this.httpClient.send({
         url: `/platform/classic/environment-api/v2/units${query}`,
@@ -20658,15 +20671,18 @@ var MonitoredEntitiesClient = class {
     if (!config) {
       throw new ApiClientError25("API client error", "API client call is missing mandatory config parameter");
     }
-    const query = toQueryString({
-      nextPageKey: config.nextPageKey,
-      pageSize: config.pageSize,
-      entitySelector: config.entitySelector,
-      from: config.from,
-      to: config.to,
-      fields: config.fields,
-      sort: config.sort
-    });
+    const query = toQueryString(
+      {
+        nextPageKey: config.nextPageKey,
+        pageSize: config.pageSize,
+        entitySelector: config.entitySelector,
+        from: config.from,
+        to: config.to,
+        fields: config.fields,
+        sort: config.sort
+      },
+      { allowReserved: { fields: true } }
+    );
     try {
       const response = await this.httpClient.send({
         url: `/platform/classic/environment-api/v2/entities${query}`,
@@ -21271,7 +21287,10 @@ var MonitoredEntitiesClient = class {
     if (!config) {
       throw new ApiClientError25("API client error", "API client call is missing mandatory config parameter");
     }
-    const query = toQueryString({ from: config.from, to: config.to, fields: config.fields });
+    const query = toQueryString(
+      { from: config.from, to: config.to, fields: config.fields },
+      { allowReserved: { fields: true } }
+    );
     try {
       const response = await this.httpClient.send({
         url: `/platform/classic/environment-api/v2/entities/${config.entityId}${query}`,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dynatrace-sdk/client-classic-environment-v2",
-  "version": "9.0.0",
+  "version": "9.0.1",
   "description": "Client for the Dynatrace Environment API v2",
   "license": "Apache-2.0",
   "dependencies": {