@dynatrace-sdk/client-query 1.2.0 → 1.3.0

package/CHANGELOG.md

@@ -2,17 +2,36 @@
 
 @dynatrace-sdk/client-query
 
+## 1.3.0
+
+### Minor Changes
+
+- Expose the metric metadata `fieldName`.
+
+## 1.2.2
+
+### Patch Changes
+
+- Update docs.
+
+## 1.2.1
+
+### Patch Changes
+
+- Add JSDoc @example for operations.
+- Fix handling of the application/cloudevent+json content type.
+
 ## 1.2.0
 
 ### Minor Changes
 
-- 88696f56: Add `sampled` property to GrailMetadata
+- Add `sampled` property to GrailMetadata
 
 ## 1.1.0
 
 ### Minor Changes
 
-- 6aca01cb: Export model transformations
+- Export model transformations
 
 ## 1.0.6
 
@@ -25,14 +44,14 @@
 
 ### Patch Changes
 
-- dfc1b337: Update `@dynatrace-sdk/http-client` to `^1.0.1`
-- dfc1b337: Use parsed response body in error serializer
+- Update `@dynatrace-sdk/http-client` to `^1.0.1`
+- Use parsed response body in error serializer
 
 ## 1.0.4
 
 ### Patch Changes
 
-- 39f914be: Send response body in error serializer
+- Send response body in error serializer
 - Updated dependencies
   - @dynatrace-sdk/http-client@1.0.0
 
@@ -40,13 +59,13 @@
 
 ### Patch Changes
 
-- ccfbe457: Updated descriptions and examples.
+- Updated descriptions and examples.
 
 ## 1.0.2
 
 ### Patch Changes
 
-- f225ca89: Generate client package with template-typescript-client v0.13.10. Query question mark is now removed from url when there are no search params.
+- Generate client package with template-typescript-client v0.13.10. Query question mark is now removed from url when there are no search params.
 
 ## 1.0.1
 
@@ -62,4 +81,4 @@
 
 ### Major Changes
 
-- dbca1de4: Initial release of @dynatrace-sdk/client-query.
+- Initial release of @dynatrace-sdk/client-query.

package/README.md

@@ -1,54 +1,25 @@
-# Storage – Query Service
-API version: `1.1.0`.
+# @dynatrace-sdk/client-query
 
+[![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
+Exposes an API to fetch records stored in Grail
 
 ## Installation
 
-```
+```bash
 npm install @dynatrace-sdk/client-query
 ```
 
-> **Important!** The content of this library is autogenerated.
-
-## [Experimental] Using client in nodejs/jest environment
-
-> **Important!** Node.js officially is not supported. This guide shows some workarounds to enable usage of the client in nodejs runtime.
-
-There is a possibility to use SDK clients in nodejs runtime. This may require additional setup:
-First, developer may need to polyfill `fetch` function with some library like [undici](https://github.com/nodejs/undici) or [node-fetch](https://github.com/node-fetch/node-fetch).
-Then, developer would need to provide the implementation of [HttpClient](https://bitbucket.lab.dynatrace.org/projects/APPFW/repos/dynatrace-sdk/browse/packages/http-client/src/lib/types/http-client.ts) interface. Sample code to achieve this:
-```typescript
-import { PlatformHttpClientResponse } from '@dynatrace-sdk/http-client';
-import { fetch } from 'undici';
-
-const myHttpClient = {
-    async send(options: any) {
-      return new PlatformHttpClientResponse(
-        await (fetch(`http://localhost:3000${options.url}`, { // here we would need to patch the request url to include hostname.
-          method: options.method,
-          headers: options.headers,
-          signal: options.abortSignal,
-          body: JSON.stringify(options.body), // but this will not work for form-data content-type
-        }) as any),
-      );
-    },
-  };
-```
+## API reference
 
-Then, once we have the instance of custom http client, we may instantiate the API Client instance:
+Full API reference for this SDK is available at [Dynatrace Developer](https://developer.dynatrace.com/reference/sdks/client-query/).
 
-```typescript
-import {
-  SettingsObjectsClient,
-} from '@dynatrace-sdk/client-example';
+## Getting help
 
-// ...
+- Visit [SDK for Typescript](https://developer.dynatrace.com/reference/sdks/) guide in the [Dynatrace Developer](https://developer.dynatrace.com/)
+- Ask a question in the [Dynatrace Community](https://community.dynatrace.com/)
 
-const settingsObjectsClient = new SettingsObjectsClient(myHttpClient);
+## License
 
-const settings = await settingsObjectsClient.getSettings({});
-```
+This SDK is distributed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0), see LICENSE for more information.

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
   };
 }