@dynatrace-sdk/client-classic-environment-v2 0.6.7 → 0.6.8

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 @dynatrace-sdk/client-classic-environment-v2
 
+## 0.6.8
+
+### Patch Changes
+
+- 0eb1fe63: Add README.md section about usage of the client in node.js environment.
+- 3f1feef1: Update spec to the latest version.
+- Updated dependencies [0eb1fe63]
+  - @dynatrace-sdk/http-client@0.4.9
+
 ## 0.6.7
 
 ### Patch Changes

package/README.md

@@ -20,3 +20,42 @@ npm install @dynatrace-sdk/client-classic-environment-v2
 ```
 
 > **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),
+      );
+    },
+  };
+```
+
+Then, once we have the instance of custom http client, we may instantiate the API Client instance:
+
+```typescript
+import {
+  SettingsObjectsClient,
+} from '@dynatrace-sdk/client-example';
+
+// ...
+
+const settingsObjectsClient = new SettingsObjectsClient(myHttpClient);
+
+const settings = await settingsObjectsClient.getSettings({});
+```