@dynatrace-sdk/client-query 1.2.2 → 1.3.0

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 @dynatrace-sdk/client-query
 
+## 1.3.0
+
+### Minor Changes
+
+- Expose the metric metadata `fieldName`.
+
 ## 1.2.2
 
 ### Patch Changes

package/README.md

@@ -1,6 +1,6 @@
 # @dynatrace-sdk/client-query
 
-[![npm](https://img.shields.io/badge/npm-v1.2.2-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.2.2)
+[![npm](https://img.shields.io/badge/npm-v1.3.0-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.3.0)
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
 Exposes an API to fetch records stored in Grail

package/cjs/index.js

@@ -2185,10 +2185,10 @@ function isMetricMetadata(value) {
   if (Array.isArray(value)) {
     return false;
   }
-  const modelKeys = /* @__PURE__ */ new Set(["metric.key", "displayName", "description", "unit"]);
+  const modelKeys = /* @__PURE__ */ new Set(["metric.key", "displayName", "description", "unit", "fieldName"]);
   const hasAdditionalProperties = false;
   const requiredKeys = [];
-  const optionalKeys = ["metric.key", "displayName", "description", "unit"];
+  const optionalKeys = ["metric.key", "displayName", "description", "unit", "fieldName"];
   const valKeys = new Set(Object.keys(value));
   const containsRequiredOrOptionalKeys = requiredKeys.length > 0 ? requiredKeys.every((reqKey) => valKeys.has(reqKey)) : optionalKeys.some((key) => valKeys.has(key)) || hasAdditionalProperties;
   const doesNotContainExtraKeys = [...valKeys].every((key) => modelKeys.has(key)) || hasAdditionalProperties;
@@ -2204,31 +2204,33 @@ function isJson23(value) {
   if (Array.isArray(value)) {
     return false;
   }
-  const modelKeys = /* @__PURE__ */ new Set(["metric.key", "displayName", "description", "unit"]);
+  const modelKeys = /* @__PURE__ */ new Set(["metric.key", "displayName", "description", "unit", "fieldName"]);
   const hasAdditionalProperties = false;
   const requiredKeys = [];
-  const optionalKeys = ["metric.key", "displayName", "description", "unit"];
+  const optionalKeys = ["metric.key", "displayName", "description", "unit", "fieldName"];
   const valKeys = new Set(Object.keys(value));
   const containsRequiredOrOptionalKeys = requiredKeys.length > 0 ? requiredKeys.every((reqKey) => valKeys.has(reqKey)) : optionalKeys.some((key) => valKeys.has(key)) || hasAdditionalProperties;
   const doesNotContainExtraKeys = [...valKeys].every((key) => modelKeys.has(key)) || hasAdditionalProperties;
   return containsRequiredOrOptionalKeys && doesNotContainExtraKeys;
 }
 function fromJson23($model) {
-  const { "metric.key": metricKey, displayName, description, unit } = $model;
+  const { "metric.key": metricKey, displayName, description, unit, fieldName } = $model;
   return {
     "metric.key": metricKey,
     displayName,
     description,
-    unit
+    unit,
+    fieldName
   };
 }
 function toJson23($model) {
-  const { "metric.key": metricKey, displayName, description, unit } = $model;
+  const { "metric.key": metricKey, displayName, description, unit, fieldName } = $model;
   return {
     "metric.key": metricKey,
     displayName,
     description,
-    unit
+    unit,
+    fieldName
   };
 }
 

package/docs/DOCS.md

@@ -17,7 +17,7 @@ import NpmLogo from '@site/static/img/npm-logo.png';
     </a>
   </div>
   <div class="col" style={{textAlign: 'right'}}>
-    <a href="https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.2.2">v1.2.2</a>
+    <a href="https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.3.0">v1.3.0</a>
   </div>
 </div>
 
@@ -198,11 +198,11 @@ each node is of one of following types and may contain more fields:
 
 can be identified by checking whether `canonicalString` is present
 
-| Field                  | Mandatory | Description                                                                                                                                                                      |
-| ---------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| type                   | yes       | the type of the terminal node - do not confuse with the type of container nodes                                                                                                  |
-| canonicalString        | yes       | the canonical string representation. Concatenating the canonicalString of all nested terminal nodes provides the canonical form of the query.                                    |
-| isMandatoryOnUserOrder | no        | may only be present if (`type="BRACE_OPEN"` or `type="BRACE_CLOSE"`) and `isOptional=true`. For usage see section [Special node type: PARAMETERS](#special-node-type-parameters) |
+| Field                  | Mandatory | Description                                                                                                                                     |
+| ---------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
+| type                   | yes       | the type of the terminal node - do not confuse with the type of container nodes                                                                 |
+| canonicalString        | yes       | the canonical string representation. Concatenating the canonicalString of all nested terminal nodes provides the canonical form of the query.   |
+| isMandatoryOnUserOrder | no        | may only be present if (`type="BRACE_OPEN"` or `type="BRACE_CLOSE"`) and `isOptional=true`. For usage see section Special node type: PARAMETERS |
 
 ##### Current types of terminal nodes (list might grow):
 
@@ -1665,6 +1665,15 @@ The display name of the metadata.
 
 </div>
 
+</div>
+<div class="padding-left--md padding-bottom--md">
+<strong>fieldName</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>
+<div class="padding-left--md">
+
+The name of the associated field used in the query.
+
+</div>
+
 </div>
 <div class="padding-left--md padding-bottom--md">
 <strong>metric.key</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a>

package/dynatrace-metadata.json

@@ -12,7 +12,7 @@
   },
   "spec": {
     "title": "Storage – Query Service",
-    "version": "1.1.0",
+    "version": "1.2.0",
     "baseUrl": "/platform/storage/query/v1"
   }
 }

package/esm/index.js

@@ -2120,10 +2120,10 @@ function isMetricMetadata(value) {
   if (Array.isArray(value)) {
     return false;
   }
-  const modelKeys = /* @__PURE__ */ new Set(["metric.key", "displayName", "description", "unit"]);
+  const modelKeys = /* @__PURE__ */ new Set(["metric.key", "displayName", "description", "unit", "fieldName"]);
   const hasAdditionalProperties = false;
   const requiredKeys = [];
-  const optionalKeys = ["metric.key", "displayName", "description", "unit"];
+  const optionalKeys = ["metric.key", "displayName", "description", "unit", "fieldName"];
   const valKeys = new Set(Object.keys(value));
   const containsRequiredOrOptionalKeys = requiredKeys.length > 0 ? requiredKeys.every((reqKey) => valKeys.has(reqKey)) : optionalKeys.some((key) => valKeys.has(key)) || hasAdditionalProperties;
   const doesNotContainExtraKeys = [...valKeys].every((key) => modelKeys.has(key)) || hasAdditionalProperties;
@@ -2139,31 +2139,33 @@ function isJson23(value) {
   if (Array.isArray(value)) {
     return false;
   }
-  const modelKeys = /* @__PURE__ */ new Set(["metric.key", "displayName", "description", "unit"]);
+  const modelKeys = /* @__PURE__ */ new Set(["metric.key", "displayName", "description", "unit", "fieldName"]);
   const hasAdditionalProperties = false;
   const requiredKeys = [];
-  const optionalKeys = ["metric.key", "displayName", "description", "unit"];
+  const optionalKeys = ["metric.key", "displayName", "description", "unit", "fieldName"];
   const valKeys = new Set(Object.keys(value));
   const containsRequiredOrOptionalKeys = requiredKeys.length > 0 ? requiredKeys.every((reqKey) => valKeys.has(reqKey)) : optionalKeys.some((key) => valKeys.has(key)) || hasAdditionalProperties;
   const doesNotContainExtraKeys = [...valKeys].every((key) => modelKeys.has(key)) || hasAdditionalProperties;
   return containsRequiredOrOptionalKeys && doesNotContainExtraKeys;
 }
 function fromJson23($model) {
-  const { "metric.key": metricKey, displayName, description, unit } = $model;
+  const { "metric.key": metricKey, displayName, description, unit, fieldName } = $model;
   return {
     "metric.key": metricKey,
     displayName,
     description,
-    unit
+    unit,
+    fieldName
   };
 }
 function toJson23($model) {
-  const { "metric.key": metricKey, displayName, description, unit } = $model;
+  const { "metric.key": metricKey, displayName, description, unit, fieldName } = $model;
   return {
     "metric.key": metricKey,
     displayName,
     description,
-    unit
+    unit,
+    fieldName
   };
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dynatrace-sdk/client-query",
-  "version": "1.2.2",
+  "version": "1.3.0",
   "dependencies": {
     "@dynatrace-sdk/http-client": "^1.0.3"
   },

package/types/packages/client/query/src/lib/models/metric-metadata.d.ts

@@ -18,4 +18,8 @@ export interface MetricMetadata {
      * The unit used.
      */
     unit?: string;
+    /**
+     * The name of the associated field used in the query.
+     */
+    fieldName?: string;
 }

package/types/packages/client/query/src/lib/models/metric-metadata.transformation.d.ts

@@ -4,6 +4,7 @@ export interface AsJson {
     displayName?: string;
     description?: string;
     unit?: string;
+    fieldName?: string;
 }
 export declare function isMetricMetadata(value: any): value is MetricMetadata;
 export declare function isJson(value: any): value is AsJson;