@commercetools/ts-sdk-apm 2.0.0 → 3.1.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @commercetools/ts-sdk-apm
 
+## 3.1.0
+
+### Minor Changes
+
+- [#861](https://github.com/commercetools/commercetools-sdk-typescript/pull/861) [`e8a0e92`](https://github.com/commercetools/commercetools-sdk-typescript/commit/e8a0e928e2ab48bd47d6ff6384f385b24e485755) Thanks [@ajimae](https://github.com/ajimae)! - Add custom metric
+
+## 3.0.0
+
+### Major Changes
+
+- [#896](https://github.com/commercetools/commercetools-sdk-typescript/pull/896) [`f9b8cb6`](https://github.com/commercetools/commercetools-sdk-typescript/commit/f9b8cb605d99fe5ece13bdc3c152eb4818e19b3b) Thanks [@lojzatran](https://github.com/lojzatran)! - Remove support of nodejs 16
+
 ## 2.0.0
 
 ### Major Changes

package/README.md

@@ -63,12 +63,9 @@ Example
 const telemetryOptions = {
   createTelemetryMiddleware, // coming from the `@commercetools/ts-sdk-apm or a custom implementation
   tracer: () =>
-    require(require('path').join(
-      __dirname,
-      '..',
-      '..',
-      'custom-telemetry-module.js'
-    )), // make sure the require takes in an absolute path to the custom tracer module.
+    require(
+      require('path').join(__dirname, '..', '..', 'custom-telemetry-module.js')
+    ), // make sure the require takes in an absolute path to the custom tracer module.
 }
 ```
 

package/dist/commercetools-ts-sdk-apm.browser.cjs.js

@@ -2,6 +2,74 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+var datadog = require('dd-trace');
+var newrelic = require('newrelic');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
+
+var datadog__default = /*#__PURE__*/_interopDefault(datadog);
+var newrelic__default = /*#__PURE__*/_interopDefault(newrelic);
+
+const time = () => performance.now();
+
+// record for datadog
+const recordDatadog = (metric, tags) => {
+  datadog__default["default"].init().dogstatsd.gauge(`Commercetools_Client_Response_Total`, metric, tags);
+};
+
+// record for newrelic
+const recordNewrelic = metric => {
+  newrelic__default["default"].recordMetric(`Commercetools/Client/Response/Total`, metric);
+};
+
+/**
+ * default newrelic APM and
+ * opentelemetry tracer modules
+ */
+const defaultOptions$1 = {
+  /**
+   * if this is to be used with newrelic, then
+   * pass this (apm) as an option in the `createTelemetryMiddleware`
+   * function e.g createTelemetryMiddleware({ apm: () => require('newrelic'), ... })
+   */
+  apm: () => require('newrelic'),
+  tracer: () => require('../opentelemetry')
+};
+function createTelemetryMiddleware$1(options) {
+  // trace
+  function trace() {
+    // validate apm and tracer
+    if (!(options?.apm && typeof options.apm == 'function')) {
+      options.apm = defaultOptions$1.apm;
+    }
+    if (!(options?.tracer && typeof options.tracer == 'function')) {
+      options.tracer = defaultOptions$1.tracer;
+    }
+    options.apm();
+    options.tracer();
+  }
+  trace(); // expose tracing modules
+  return next => async request => {
+    // get start (high resolution milliseconds) timestamp
+    const start = time();
+    const nextRequest = {
+      ...request,
+      ...options
+    };
+    const response = await next(nextRequest);
+    const response_time = time() - start;
+
+    // send `response_time` to APM platforms
+    if (options?.customMetrics) {
+      options.customMetrics.newrelic && recordNewrelic(response_time);
+      options.customMetrics.datadog && recordDatadog(response_time, {
+        env: 'dev'
+      });
+    }
+    return response;
+  };
+}
+
 /**
  * default newrelic APM and
  * opentelemetry tracer modules
@@ -16,14 +84,20 @@ const defaultOptions = {
   apm: () => {},
   tracer: () => require('../opentelemetry')
 };
+
+/**
+ * @deprecated use new `createTelemetryMiddleware`
+ * @param options
+ * @returns
+ */
 function createTelemetryMiddleware(options) {
   // trace
   function trace() {
     // validate apm and tracer
-    if (!(options !== null && options !== void 0 && options.apm && typeof options.apm == 'function')) {
+    if (!(options?.apm && typeof options.apm == 'function')) {
       options.apm = defaultOptions.apm;
     }
-    if (!(options !== null && options !== void 0 && options.tracer && typeof options.tracer == 'function')) {
+    if (!(options?.tracer && typeof options.tracer == 'function')) {
       options.tracer = defaultOptions.tracer;
     }
     options.apm();
@@ -39,4 +113,13 @@ function createTelemetryMiddleware(options) {
   };
 }
 
-exports.createTelemetryMiddleware = createTelemetryMiddleware;
+Object.defineProperty(exports, 'datadog', {
+  enumerable: true,
+  get: function () { return datadog__default["default"]; }
+});
+Object.defineProperty(exports, 'newrelic', {
+  enumerable: true,
+  get: function () { return newrelic__default["default"]; }
+});
+exports.createTelemetryMiddleware = createTelemetryMiddleware$1;
+exports.createTelemetryMiddlewareLegacy = createTelemetryMiddleware;

package/dist/commercetools-ts-sdk-apm.browser.esm.js

@@ -1,3 +1,68 @@
+import datadog from 'dd-trace';
+export { default as datadog } from 'dd-trace';
+import newrelic from 'newrelic';
+export { default as newrelic } from 'newrelic';
+
+const time = () => performance.now();
+
+// record for datadog
+const recordDatadog = (metric, tags) => {
+  datadog.init().dogstatsd.gauge(`Commercetools_Client_Response_Total`, metric, tags);
+};
+
+// record for newrelic
+const recordNewrelic = metric => {
+  newrelic.recordMetric(`Commercetools/Client/Response/Total`, metric);
+};
+
+/**
+ * default newrelic APM and
+ * opentelemetry tracer modules
+ */
+const defaultOptions$1 = {
+  /**
+   * if this is to be used with newrelic, then
+   * pass this (apm) as an option in the `createTelemetryMiddleware`
+   * function e.g createTelemetryMiddleware({ apm: () => require('newrelic'), ... })
+   */
+  apm: () => require('newrelic'),
+  tracer: () => require('../opentelemetry')
+};
+function createTelemetryMiddleware$1(options) {
+  // trace
+  function trace() {
+    // validate apm and tracer
+    if (!(options?.apm && typeof options.apm == 'function')) {
+      options.apm = defaultOptions$1.apm;
+    }
+    if (!(options?.tracer && typeof options.tracer == 'function')) {
+      options.tracer = defaultOptions$1.tracer;
+    }
+    options.apm();
+    options.tracer();
+  }
+  trace(); // expose tracing modules
+  return next => async request => {
+    // get start (high resolution milliseconds) timestamp
+    const start = time();
+    const nextRequest = {
+      ...request,
+      ...options
+    };
+    const response = await next(nextRequest);
+    const response_time = time() - start;
+
+    // send `response_time` to APM platforms
+    if (options?.customMetrics) {
+      options.customMetrics.newrelic && recordNewrelic(response_time);
+      options.customMetrics.datadog && recordDatadog(response_time, {
+        env: 'dev'
+      });
+    }
+    return response;
+  };
+}
+
 /**
  * default newrelic APM and
  * opentelemetry tracer modules
@@ -12,14 +77,20 @@ const defaultOptions = {
   apm: () => {},
   tracer: () => require('../opentelemetry')
 };
+
+/**
+ * @deprecated use new `createTelemetryMiddleware`
+ * @param options
+ * @returns
+ */
 function createTelemetryMiddleware(options) {
   // trace
   function trace() {
     // validate apm and tracer
-    if (!(options !== null && options !== void 0 && options.apm && typeof options.apm == 'function')) {
+    if (!(options?.apm && typeof options.apm == 'function')) {
       options.apm = defaultOptions.apm;
     }
-    if (!(options !== null && options !== void 0 && options.tracer && typeof options.tracer == 'function')) {
+    if (!(options?.tracer && typeof options.tracer == 'function')) {
       options.tracer = defaultOptions.tracer;
     }
     options.apm();
@@ -35,4 +106,4 @@ function createTelemetryMiddleware(options) {
   };
 }
 
-export { createTelemetryMiddleware };
+export { createTelemetryMiddleware$1 as createTelemetryMiddleware, createTelemetryMiddleware as createTelemetryMiddlewareLegacy };

package/dist/commercetools-ts-sdk-apm.cjs.d.ts

@@ -1,2 +1,2 @@
-export * from "./declarations/src/index";
-//# sourceMappingURL=commercetools-ts-sdk-apm.cjs.d.ts.map
+export * from "./declarations/src/index.js";
+//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29tbWVyY2V0b29scy10cy1zZGstYXBtLmNqcy5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi9kZWNsYXJhdGlvbnMvc3JjL2luZGV4LmQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEifQ==

package/dist/commercetools-ts-sdk-apm.cjs.dev.js

@@ -2,6 +2,74 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+var datadog = require('dd-trace');
+var newrelic = require('newrelic');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
+
+var datadog__default = /*#__PURE__*/_interopDefault(datadog);
+var newrelic__default = /*#__PURE__*/_interopDefault(newrelic);
+
+const time = () => performance.now();
+
+// record for datadog
+const recordDatadog = (metric, tags) => {
+  datadog__default["default"].init().dogstatsd.gauge(`Commercetools_Client_Response_Total`, metric, tags);
+};
+
+// record for newrelic
+const recordNewrelic = metric => {
+  newrelic__default["default"].recordMetric(`Commercetools/Client/Response/Total`, metric);
+};
+
+/**
+ * default newrelic APM and
+ * opentelemetry tracer modules
+ */
+const defaultOptions$1 = {
+  /**
+   * if this is to be used with newrelic, then
+   * pass this (apm) as an option in the `createTelemetryMiddleware`
+   * function e.g createTelemetryMiddleware({ apm: () => require('newrelic'), ... })
+   */
+  apm: () => require('newrelic'),
+  tracer: () => require('../opentelemetry')
+};
+function createTelemetryMiddleware$1(options) {
+  // trace
+  function trace() {
+    // validate apm and tracer
+    if (!(options?.apm && typeof options.apm == 'function')) {
+      options.apm = defaultOptions$1.apm;
+    }
+    if (!(options?.tracer && typeof options.tracer == 'function')) {
+      options.tracer = defaultOptions$1.tracer;
+    }
+    options.apm();
+    options.tracer();
+  }
+  trace(); // expose tracing modules
+  return next => async request => {
+    // get start (high resolution milliseconds) timestamp
+    const start = time();
+    const nextRequest = {
+      ...request,
+      ...options
+    };
+    const response = await next(nextRequest);
+    const response_time = time() - start;
+
+    // send `response_time` to APM platforms
+    if (options?.customMetrics) {
+      options.customMetrics.newrelic && recordNewrelic(response_time);
+      options.customMetrics.datadog && recordDatadog(response_time, {
+        env: 'dev'
+      });
+    }
+    return response;
+  };
+}
+
 /**
  * default newrelic APM and
  * opentelemetry tracer modules
@@ -16,14 +84,20 @@ const defaultOptions = {
   apm: () => {},
   tracer: () => require('../opentelemetry')
 };
+
+/**
+ * @deprecated use new `createTelemetryMiddleware`
+ * @param options
+ * @returns
+ */
 function createTelemetryMiddleware(options) {
   // trace
   function trace() {
     // validate apm and tracer
-    if (!(options !== null && options !== void 0 && options.apm && typeof options.apm == 'function')) {
+    if (!(options?.apm && typeof options.apm == 'function')) {
       options.apm = defaultOptions.apm;
     }
-    if (!(options !== null && options !== void 0 && options.tracer && typeof options.tracer == 'function')) {
+    if (!(options?.tracer && typeof options.tracer == 'function')) {
       options.tracer = defaultOptions.tracer;
     }
     options.apm();
@@ -39,4 +113,13 @@ function createTelemetryMiddleware(options) {
   };
 }
 
-exports.createTelemetryMiddleware = createTelemetryMiddleware;
+Object.defineProperty(exports, 'datadog', {
+  enumerable: true,
+  get: function () { return datadog__default["default"]; }
+});
+Object.defineProperty(exports, 'newrelic', {
+  enumerable: true,
+  get: function () { return newrelic__default["default"]; }
+});
+exports.createTelemetryMiddleware = createTelemetryMiddleware$1;
+exports.createTelemetryMiddlewareLegacy = createTelemetryMiddleware;

package/dist/commercetools-ts-sdk-apm.cjs.prod.js

@@ -2,6 +2,74 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+var datadog = require('dd-trace');
+var newrelic = require('newrelic');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
+
+var datadog__default = /*#__PURE__*/_interopDefault(datadog);
+var newrelic__default = /*#__PURE__*/_interopDefault(newrelic);
+
+const time = () => performance.now();
+
+// record for datadog
+const recordDatadog = (metric, tags) => {
+  datadog__default["default"].init().dogstatsd.gauge(`Commercetools_Client_Response_Total`, metric, tags);
+};
+
+// record for newrelic
+const recordNewrelic = metric => {
+  newrelic__default["default"].recordMetric(`Commercetools/Client/Response/Total`, metric);
+};
+
+/**
+ * default newrelic APM and
+ * opentelemetry tracer modules
+ */
+const defaultOptions$1 = {
+  /**
+   * if this is to be used with newrelic, then
+   * pass this (apm) as an option in the `createTelemetryMiddleware`
+   * function e.g createTelemetryMiddleware({ apm: () => require('newrelic'), ... })
+   */
+  apm: () => require('newrelic'),
+  tracer: () => require('../opentelemetry')
+};
+function createTelemetryMiddleware$1(options) {
+  // trace
+  function trace() {
+    // validate apm and tracer
+    if (!(options?.apm && typeof options.apm == 'function')) {
+      options.apm = defaultOptions$1.apm;
+    }
+    if (!(options?.tracer && typeof options.tracer == 'function')) {
+      options.tracer = defaultOptions$1.tracer;
+    }
+    options.apm();
+    options.tracer();
+  }
+  trace(); // expose tracing modules
+  return next => async request => {
+    // get start (high resolution milliseconds) timestamp
+    const start = time();
+    const nextRequest = {
+      ...request,
+      ...options
+    };
+    const response = await next(nextRequest);
+    const response_time = time() - start;
+
+    // send `response_time` to APM platforms
+    if (options?.customMetrics) {
+      options.customMetrics.newrelic && recordNewrelic(response_time);
+      options.customMetrics.datadog && recordDatadog(response_time, {
+        env: 'dev'
+      });
+    }
+    return response;
+  };
+}
+
 /**
  * default newrelic APM and
  * opentelemetry tracer modules
@@ -16,14 +84,20 @@ const defaultOptions = {
   apm: () => {},
   tracer: () => require('../opentelemetry')
 };
+
+/**
+ * @deprecated use new `createTelemetryMiddleware`
+ * @param options
+ * @returns
+ */
 function createTelemetryMiddleware(options) {
   // trace
   function trace() {
     // validate apm and tracer
-    if (!(options !== null && options !== void 0 && options.apm && typeof options.apm == 'function')) {
+    if (!(options?.apm && typeof options.apm == 'function')) {
       options.apm = defaultOptions.apm;
     }
-    if (!(options !== null && options !== void 0 && options.tracer && typeof options.tracer == 'function')) {
+    if (!(options?.tracer && typeof options.tracer == 'function')) {
       options.tracer = defaultOptions.tracer;
     }
     options.apm();
@@ -39,4 +113,13 @@ function createTelemetryMiddleware(options) {
   };
 }
 
-exports.createTelemetryMiddleware = createTelemetryMiddleware;
+Object.defineProperty(exports, 'datadog', {
+  enumerable: true,
+  get: function () { return datadog__default["default"]; }
+});
+Object.defineProperty(exports, 'newrelic', {
+  enumerable: true,
+  get: function () { return newrelic__default["default"]; }
+});
+exports.createTelemetryMiddleware = createTelemetryMiddleware$1;
+exports.createTelemetryMiddlewareLegacy = createTelemetryMiddleware;

package/dist/commercetools-ts-sdk-apm.esm.js

@@ -1,3 +1,68 @@
+import datadog from 'dd-trace';
+export { default as datadog } from 'dd-trace';
+import newrelic from 'newrelic';
+export { default as newrelic } from 'newrelic';
+
+const time = () => performance.now();
+
+// record for datadog
+const recordDatadog = (metric, tags) => {
+  datadog.init().dogstatsd.gauge(`Commercetools_Client_Response_Total`, metric, tags);
+};
+
+// record for newrelic
+const recordNewrelic = metric => {
+  newrelic.recordMetric(`Commercetools/Client/Response/Total`, metric);
+};
+
+/**
+ * default newrelic APM and
+ * opentelemetry tracer modules
+ */
+const defaultOptions$1 = {
+  /**
+   * if this is to be used with newrelic, then
+   * pass this (apm) as an option in the `createTelemetryMiddleware`
+   * function e.g createTelemetryMiddleware({ apm: () => require('newrelic'), ... })
+   */
+  apm: () => require('newrelic'),
+  tracer: () => require('../opentelemetry')
+};
+function createTelemetryMiddleware$1(options) {
+  // trace
+  function trace() {
+    // validate apm and tracer
+    if (!(options?.apm && typeof options.apm == 'function')) {
+      options.apm = defaultOptions$1.apm;
+    }
+    if (!(options?.tracer && typeof options.tracer == 'function')) {
+      options.tracer = defaultOptions$1.tracer;
+    }
+    options.apm();
+    options.tracer();
+  }
+  trace(); // expose tracing modules
+  return next => async request => {
+    // get start (high resolution milliseconds) timestamp
+    const start = time();
+    const nextRequest = {
+      ...request,
+      ...options
+    };
+    const response = await next(nextRequest);
+    const response_time = time() - start;
+
+    // send `response_time` to APM platforms
+    if (options?.customMetrics) {
+      options.customMetrics.newrelic && recordNewrelic(response_time);
+      options.customMetrics.datadog && recordDatadog(response_time, {
+        env: 'dev'
+      });
+    }
+    return response;
+  };
+}
+
 /**
  * default newrelic APM and
  * opentelemetry tracer modules
@@ -12,14 +77,20 @@ const defaultOptions = {
   apm: () => {},
   tracer: () => require('../opentelemetry')
 };
+
+/**
+ * @deprecated use new `createTelemetryMiddleware`
+ * @param options
+ * @returns
+ */
 function createTelemetryMiddleware(options) {
   // trace
   function trace() {
     // validate apm and tracer
-    if (!(options !== null && options !== void 0 && options.apm && typeof options.apm == 'function')) {
+    if (!(options?.apm && typeof options.apm == 'function')) {
       options.apm = defaultOptions.apm;
     }
-    if (!(options !== null && options !== void 0 && options.tracer && typeof options.tracer == 'function')) {
+    if (!(options?.tracer && typeof options.tracer == 'function')) {
       options.tracer = defaultOptions.tracer;
     }
     options.apm();
@@ -35,4 +106,4 @@ function createTelemetryMiddleware(options) {
   };
 }
 
-export { createTelemetryMiddleware };
+export { createTelemetryMiddleware$1 as createTelemetryMiddleware, createTelemetryMiddleware as createTelemetryMiddlewareLegacy };

package/dist/declarations/src/apm-legacy.d.ts

@@ -0,0 +1,8 @@
+import type { MiddlewareLegacy, OTelemetryMiddlewareOptions } from "../types/types.js";
+/**
+ * @deprecated use new `createTelemetryMiddleware`
+ * @param options
+ * @returns
+ */
+export default function createTelemetryMiddleware(options: OTelemetryMiddlewareOptions): MiddlewareLegacy;
+//# sourceMappingURL=apm-legacy.d.ts.map

package/dist/declarations/src/apm-legacy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"apm-legacy.d.ts","sourceRoot":"../../../src","sources":["apm-legacy.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAKhB,2BAA2B,EAC5B,0BAAsB;AAiBvB;;;;GAIG;AACH,MAAM,CAAC,OAAO,UAAU,yBAAyB,CAC/C,OAAO,EAAE,2BAA2B,GACnC,gBAAgB,CA0BlB"}

package/dist/declarations/src/apm.d.ts

@@ -1,2 +1,3 @@
 import type { Middleware, OTelemetryMiddlewareOptions } from "../types/types.js";
 export default function createTelemetryMiddleware(options: OTelemetryMiddlewareOptions): Middleware;
+//# sourceMappingURL=apm.d.ts.map

package/dist/declarations/src/apm.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"apm.d.ts","sourceRoot":"../../../src","sources":["apm.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,UAAU,EAIV,2BAA2B,EAC5B,0BAAsB;AAiBvB,MAAM,CAAC,OAAO,UAAU,yBAAyB,CAC/C,OAAO,EAAE,2BAA2B,GACnC,UAAU,CAuCZ"}

package/dist/declarations/src/index.d.ts

@@ -1,2 +1,5 @@
 export * from "../types/types.js";
 export { default as createTelemetryMiddleware } from "./apm.js";
+export { default as createTelemetryMiddlewareLegacy } from "./apm-legacy.js";
+export * from "./lib/agents.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/declarations/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"../../../src","sources":["index.ts"],"names":[],"mappings":"AAAA,kCAAgC;AAChC,OAAO,EAAE,OAAO,IAAI,yBAAyB,EAAE,iBAAa;AAC5D,OAAO,EAAE,OAAO,IAAI,+BAA+B,EAAE,wBAAoB;AACzE,gCAA6B"}

package/dist/declarations/src/lib/agents.d.ts

@@ -0,0 +1,4 @@
+import datadog from 'dd-trace';
+import newrelic from 'newrelic';
+export { datadog, newrelic };
+//# sourceMappingURL=agents.d.ts.map

package/dist/declarations/src/lib/agents.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"agents.d.ts","sourceRoot":"../../../../src/lib","sources":["agents.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,UAAU,CAAA;AAC9B,OAAO,QAAQ,MAAM,UAAU,CAAA;AAE/B,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAA"}

package/dist/declarations/types/types.d.ts

@@ -1,48 +1,57 @@
 export type JsonObject<T = unknown> = { [key: string]: T }
 export type MiddlewareRequest = ClientRequest
-export type Middleware = (next: Dispatch) => Dispatch
 
-export type Dispatch = (
-  request: MiddlewareRequest,
-  response: MiddlewareResponse
-) => unknown
+export type Middleware = (next: Next) => (request: MiddlewareRequest) => Promise<MiddlewareResponse>
 
-export type Next = (
-  request: MiddlewareRequest,
-  response: MiddlewareResponse
-) => unknown
+// export type Dispatch = (next: Next) => (request: MiddlewareRequest) => Promise<MiddlewareResponse>
+export type Next = (request: MiddlewareRequest) => Promise<MiddlewareResponse>
 
-export type MiddlewareResponse = {
-  resolve(response: JsonObject): void
-  reject(error: JsonObject): void
-  body?: JsonObject
-  error?: HttpErrorType
-  statusCode: number
-  headers?: JsonObject<string>
-  request?: JsonObject
+export type MiddlewareResponse<T = unknown> = {
+  resolve: Function;
+  reject: Function;
+  body: T;
+  error?: HttpErrorType;
+  statusCode: number;
+  headers?: Record<string, any>
+  originalRequest?: MiddlewareRequest;
 }
 
 export interface ClientRequest {
   baseUri?: string
   uri?: string
-  headers?: VariableMap
+  headers?: Record<string, any>
   method: MethodType
   uriTemplate?: string
   pathVariables?: VariableMap
   queryParams?: VariableMap
-  body?: any,
+  body?: Record<string, any> | string | Uint8Array;
+  response?: ClientResponse
+  resolve?: Function;
+  reject?: Function;
+  [key: string]: any
+}
+
+export type ClientResponse<T = any> = {
+  body: T
+  code?: number
+  statusCode?: number
+  headers?: Record<string, any>
+  error?: HttpErrorType
+  retryCount?: number
 }
 
 export type HttpErrorType = {
-  name: string
+  name?: string
   message: string
-  code: number
-  status: number
+  code?: number
+  status?: number
+  method: MethodType
   statusCode: number
-  originalRequest: ClientRequest
-  body?: JsonObject
+  originalRequest?: ClientRequest
+  body: JsonObject
   retryCount?: number
-  headers?: JsonObject<string>
+  headers?: Record<string, any>
+  [key: string]: any
 }
 
 export type VariableMap = {
@@ -58,47 +67,75 @@ export type QueryParam =
   | boolean[]
   | undefined
 
-export type MethodType =
-  | 'ACL'
-  | 'BIND'
-  | 'CHECKOUT'
-  | 'CONNECT'
-  | 'COPY'
-  | 'DELETE'
+  export type MethodType =
   | 'GET'
   | 'HEAD'
-  | 'LINK'
-  | 'LOCK'
-  | 'M-SEARCH'
-  | 'MERGE'
-  | 'MKACTIVITY'
-  | 'MKCALENDAR'
-  | 'MKCOL'
-  | 'MOVE'
-  | 'NOTIFY'
-  | 'OPTIONS'
-  | 'PATCH'
   | 'POST'
-  | 'PROPFIND'
-  | 'PROPPATCH'
-  | 'PURGE'
   | 'PUT'
-  | 'REBIND'
-  | 'REPORT'
-  | 'SEARCH'
-  | 'SOURCE'
-  | 'SUBSCRIBE'
+  | 'PATCH'
+  | 'DELETE'
+  | 'CONNECT'
+  | 'OPTIONS'
   | 'TRACE'
-  | 'UNBIND'
-  | 'UNLINK'
-  | 'UNLOCK'
-  | 'UNSUBSCRIBE'
+
+export type CustomMetric = {
+  newrelic?: boolean;
+  datadog?: boolean;
+}
 
 export type TelemetryMiddlewareOptions = {
   apm?: Function;
   tracer?: Function;
   userAgent?: string;
+  customMetrics?: CustomMetric;
   createTelemetryMiddleware: (options?: OTelemetryMiddlewareOptions) => Middleware
 }
 
 export type OTelemetryMiddlewareOptions = Omit<TelemetryMiddlewareOptions, 'createTelemetryMiddleware'>
+
+
+// LEGACY TYPES
+/**
+ * @deprecated
+ */
+export type NextLegacy = (
+  request: MiddlewareRequestLegacy,
+  response: MiddlewareResponseLegacy
+) => unknown
+
+/**
+ * @deprecated
+ */
+export type MiddlewareResponseLegacy = {
+  resolve(response: JsonObject): void
+  reject(error: JsonObject): void
+  body?: JsonObject
+  error?: HttpErrorType
+  statusCode: number
+  headers?: JsonObject<string>
+  request?: JsonObject
+}
+
+/**
+ * @deprecated
+ */
+export interface ClientRequestLegacy {
+  baseUri?: string
+  uri?: string
+  headers?: VariableMap
+  method: MethodType
+  uriTemplate?: string
+  pathVariables?: VariableMap
+  queryParams?: VariableMap
+  body?: any,
+}
+
+/**
+ * @deprecated
+ */
+export type MiddlewareLegacy = (next: NextLegacy) => NextLegacy
+
+/**
+ * @deprecated
+ */
+export type MiddlewareRequestLegacy = ClientRequestLegacy

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commercetools/ts-sdk-apm",
-  "version": "2.0.0",
+  "version": "3.1.0",
   "description": "commercetools typescript SDK application performance monitoring.",
   "main": "dist/commercetools-ts-sdk-apm.cjs.js",
   "module": "dist/commercetools-ts-sdk-apm.esm.js",
@@ -9,16 +9,18 @@
   "private": false,
   "dependencies": {
     "@opentelemetry/api": "^1.4.1",
-    "@opentelemetry/auto-instrumentations-node": "^0.38.0",
-    "@opentelemetry/exporter-metrics-otlp-http": "^0.41.0",
-    "@opentelemetry/sdk-node": "^0.41.0",
-    "uuid": "9.0.0"
+    "@opentelemetry/auto-instrumentations-node": "^0.55.0",
+    "@opentelemetry/exporter-metrics-otlp-http": "^0.57.0",
+    "@opentelemetry/sdk-node": "^0.57.0",
+    "dd-trace": "^5.31.0",
+    "newrelic": "^12.10.0",
+    "uuid": "11.0.4"
   },
   "publishConfig": {
     "access": "public"
   },
   "engines": {
-    "node": ">=14"
+    "node": ">=18"
   },
   "keywords": [
     "commercetools",
@@ -51,5 +53,8 @@
     "organize_imports": "find src -type f -name '*.ts' | xargs organize-imports-cli",
     "postbuild": "yarn organize_imports",
     "post_process_generate": "yarn organize_imports"
+  },
+  "devDependencies": {
+    "@types/newrelic": "^9.14.6"
   }
 }

package/dist/commercetools-ts-sdk-apm.cjs.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"commercetools-ts-sdk-apm.cjs.d.ts","sourceRoot":"","sources":["./declarations/src/index.d.ts"],"names":[],"mappings":"AAAA"}