@commercetools/ts-client 1.2.1 → 2.0.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @commercetools/ts-client
 
+## 2.0.0
+
+### Major Changes
+
+- [#708](https://github.com/commercetools/commercetools-sdk-typescript/pull/708) [`e7e5ac7`](https://github.com/commercetools/commercetools-sdk-typescript/commit/e7e5ac73de07a8ce141ec0bc2b2abf492462ec73) Thanks [@lojzatran](https://github.com/lojzatran)! - Make ts-sdk-v3 consistent with v2
+
 ## 1.2.1
 
 ### Patch Changes

package/README.md

@@ -78,7 +78,6 @@ const client: Client = new ClientBuilder()
   .withHttpMiddleware(httpMiddlewareOptions)
   .withRetryMiddleware(retryOptions)
   .withMiddleware(middleware({})) // <<<------------------- add the custom middleware here
-  .withErrorMiddleware({})
   .build()
 
 const apiRoot = createApiBuilderFromCtpClient(client)

package/dist/commercetools-ts-client.browser.cjs.js

@@ -914,7 +914,7 @@ function createAuthMiddlewareForRefreshTokenFlow$1(options) {
   };
 }
 
-function createConcurrentModificationMiddleware$1() {
+function createConcurrentModificationMiddleware$1(modifierFunction) {
   return next => {
     return async request => {
       const response = await next(request);
@@ -928,13 +928,17 @@ function createConcurrentModificationMiddleware$1() {
 
         // update the resource version here
         if (version) {
-          request.body = typeof request.body == 'string' ? {
-            ...JSON.parse(request.body),
-            version
-          } : {
-            ...request.body,
-            version
-          };
+          if (modifierFunction) {
+            request.body = await modifierFunction(version, request, response);
+          } else {
+            request.body = typeof request.body == 'string' ? {
+              ...JSON.parse(request.body),
+              version
+            } : {
+              ...request.body,
+              version
+            };
+          }
           return next(request);
         }
       }
@@ -956,7 +960,7 @@ function createCorrelationIdMiddleware$1(options) {
   };
 }
 
-function createErrorMiddleware$1(options) {
+function createErrorMiddleware(options) {
   return next => async request => {
     const response = await next(request);
     if (response.error) {
@@ -988,7 +992,8 @@ async function executeRequest({
     request,
     abortController,
     maskSensitiveHeaderData,
-    includeRequestInErrorResponse
+    includeRequestInErrorResponse,
+    includeResponseHeaders
   } = clientOptions;
   try {
     if (timeout) timer = setTimeout(() => {
@@ -1003,6 +1008,9 @@ async function executeRequest({
         body: clientOptions.body
       } : {})
     });
+    if (!includeResponseHeaders) {
+      response.headers = null;
+    }
     if (response.statusCode >= 200 && response.statusCode < 300) {
       if (clientOptions.method == 'HEAD') {
         return {
@@ -1046,7 +1054,7 @@ async function executeRequest({
     };
   } catch (e) {
     // We know that this is a network error
-    const headers = getHeaders(e.response?.headers);
+    const headers = includeResponseHeaders ? getHeaders(e.response?.headers) : null;
     const statusCode = e.response?.status || e.response?.data0 || 0;
     const message = e.response?.data?.message;
     const error = createError({
@@ -1083,7 +1091,8 @@ function createHttpMiddleware$1(options) {
     retryConfig,
     getAbortController,
     includeOriginalRequest,
-    includeRequestInErrorResponse,
+    includeRequestInErrorResponse = true,
+    includeResponseHeaders = true,
     maskSensitiveHeaderData,
     httpClientOptions
   } = options;
@@ -1119,6 +1128,7 @@ function createHttpMiddleware$1(options) {
         headers: requestHeader,
         includeRequestInErrorResponse,
         maskSensitiveHeaderData,
+        includeResponseHeaders,
         ...httpClientOptions
       };
       if (credentialsMode) {
@@ -1152,43 +1162,17 @@ function createHttpMiddleware$1(options) {
   };
 }
 
-// error, info, success
 function createLoggerMiddleware$1(options) {
   return next => {
     return async request => {
       let response = await next(request);
       const originalResponse = Object.assign({}, response);
       const {
-        loggerFn = console.log,
-        // logLevel = 'ERROR',
-        maskSensitiveHeaderData = true,
-        includeOriginalRequest = true,
-        includeResponseHeaders = true
-        // includeRequestInErrorResponse
+        loggerFn = console.log
       } = options || {};
-      if (includeOriginalRequest && maskSensitiveHeaderData) {
-        maskAuthData(response.request);
-      }
-      if (!includeOriginalRequest) {
-        const {
-          request,
-          ...rest
-        } = response;
-        response = rest;
-      }
-      if (!includeResponseHeaders) {
-        const {
-          headers,
-          ...rest
-        } = response;
-        response = rest;
-      }
       if (loggerFn && typeof loggerFn == 'function') {
         loggerFn(response);
-        // return originalResponse
       }
-
-      // console.log({ Response: response })
       return originalResponse;
     };
   };
@@ -1240,7 +1224,7 @@ function createQueueMiddleware$1({
 
 var packageJson = {
 	name: "@commercetools/ts-client",
-	version: "1.2.1",
+	version: "2.0.0",
 	engines: {
 		node: ">=14"
 	},
@@ -1299,7 +1283,8 @@ var packageJson = {
 	scripts: {
 		organize_imports: "find src -type f -name '*.ts' | xargs organize-imports-cli",
 		postbuild: "yarn organize_imports",
-		post_process_generate: "yarn organize_imports"
+		post_process_generate: "yarn organize_imports",
+		docs: "typedoc --out docs"
 	}
 };
 
@@ -1307,7 +1292,7 @@ function createUserAgentMiddleware$1(options) {
   return next => async request => {
     const userAgent = createUserAgent({
       ...options,
-      name: `commercetools-sdk-javascript-v3/${packageJson.version}`
+      name: `${options.name ? options.name + '/' : ''}commercetools-sdk-javascript-v3/${packageJson.version}`
     });
     const requestWithUserAgent = {
       ...request,
@@ -1329,7 +1314,7 @@ var middleware = /*#__PURE__*/Object.freeze({
   createAuthMiddlewareForRefreshTokenFlow: createAuthMiddlewareForRefreshTokenFlow$1,
   createConcurrentModificationMiddleware: createConcurrentModificationMiddleware$1,
   createCorrelationIdMiddleware: createCorrelationIdMiddleware$1,
-  createErrorMiddleware: createErrorMiddleware$1,
+  createErrorMiddleware: createErrorMiddleware,
   createHttpMiddleware: createHttpMiddleware$1,
   createLoggerMiddleware: createLoggerMiddleware$1,
   createQueueMiddleware: createQueueMiddleware$1,
@@ -1495,8 +1480,7 @@ const {
   createLoggerMiddleware,
   createQueueMiddleware,
   createUserAgentMiddleware,
-  createConcurrentModificationMiddleware,
-  createErrorMiddleware
+  createConcurrentModificationMiddleware
 } = middleware;
 class ClientBuilder {
   constructor() {
@@ -1508,7 +1492,9 @@ class ClientBuilder {
     _defineProperty(this, "loggerMiddleware", void 0);
     _defineProperty(this, "queueMiddleware", void 0);
     _defineProperty(this, "concurrentMiddleware", void 0);
-    _defineProperty(this, "errorMiddleware", void 0);
+    _defineProperty(this, "telemetryMiddleware", void 0);
+    _defineProperty(this, "beforeMiddleware", void 0);
+    _defineProperty(this, "afterMiddleware", void 0);
     _defineProperty(this, "middlewares", []);
     this.userAgentMiddleware = createUserAgentMiddleware({});
   }
@@ -1627,30 +1613,49 @@ class ClientBuilder {
     });
     return this;
   }
-  withConcurrentModificationMiddleware() {
-    this.concurrentMiddleware = createConcurrentModificationMiddleware();
+  withConcurrentModificationMiddleware(options) {
+    this.concurrentMiddleware = createConcurrentModificationMiddleware(options?.concurrentModificationHandlerFn);
     return this;
   }
-  withErrorMiddleware(options) {
-    this.errorMiddleware = createErrorMiddleware(options);
+  withTelemetryMiddleware(options) {
+    const {
+      createTelemetryMiddleware,
+      ...rest
+    } = options;
+    this.withUserAgentMiddleware({
+      customAgent: rest?.userAgent || 'typescript-sdk-apm-middleware'
+    });
+    this.telemetryMiddleware = createTelemetryMiddleware(rest);
+    return this;
+  }
+  withBeforeExecutionMiddleware(options) {
+    const {
+      middleware,
+      ...rest
+    } = options || {};
+    this.beforeMiddleware = options.middleware(rest);
+    return this;
+  }
+  withAfterExecutionMiddleware(options) {
+    const {
+      middleware,
+      ...rest
+    } = options || {};
+    this.afterMiddleware = options.middleware(rest);
     return this;
   }
   build() {
     const middlewares = this.middlewares.slice();
-
-    /**
-     * - use default retry policy if not explicity added
-     * - add retry middleware to be used by concurrent modification
-     *   middleware if not explicitly added as part of the middleware
-     */
+    if (this.telemetryMiddleware) middlewares.push(this.telemetryMiddleware);
     if (this.correlationIdMiddleware) middlewares.push(this.correlationIdMiddleware);
     if (this.userAgentMiddleware) middlewares.push(this.userAgentMiddleware);
     if (this.authMiddleware) middlewares.push(this.authMiddleware);
+    if (this.beforeMiddleware) middlewares.push(this.beforeMiddleware);
     if (this.queueMiddleware) middlewares.push(this.queueMiddleware);
     if (this.loggerMiddleware) middlewares.push(this.loggerMiddleware);
-    if (this.errorMiddleware) middlewares.push(this.errorMiddleware);
     if (this.concurrentMiddleware) middlewares.push(this.concurrentMiddleware);
     if (this.httpMiddleware) middlewares.push(this.httpMiddleware);
+    if (this.afterMiddleware) middlewares.push(this.afterMiddleware);
     return createClient({
       middlewares
     });

package/dist/commercetools-ts-client.browser.esm.js

@@ -905,7 +905,7 @@ function createAuthMiddlewareForRefreshTokenFlow$1(options) {
   };
 }
 
-function createConcurrentModificationMiddleware$1() {
+function createConcurrentModificationMiddleware$1(modifierFunction) {
   return next => {
     return async request => {
       const response = await next(request);
@@ -919,13 +919,17 @@ function createConcurrentModificationMiddleware$1() {
 
         // update the resource version here
         if (version) {
-          request.body = typeof request.body == 'string' ? {
-            ...JSON.parse(request.body),
-            version
-          } : {
-            ...request.body,
-            version
-          };
+          if (modifierFunction) {
+            request.body = await modifierFunction(version, request, response);
+          } else {
+            request.body = typeof request.body == 'string' ? {
+              ...JSON.parse(request.body),
+              version
+            } : {
+              ...request.body,
+              version
+            };
+          }
           return next(request);
         }
       }
@@ -947,7 +951,7 @@ function createCorrelationIdMiddleware$1(options) {
   };
 }
 
-function createErrorMiddleware$1(options) {
+function createErrorMiddleware(options) {
   return next => async request => {
     const response = await next(request);
     if (response.error) {
@@ -979,7 +983,8 @@ async function executeRequest({
     request,
     abortController,
     maskSensitiveHeaderData,
-    includeRequestInErrorResponse
+    includeRequestInErrorResponse,
+    includeResponseHeaders
   } = clientOptions;
   try {
     if (timeout) timer = setTimeout(() => {
@@ -994,6 +999,9 @@ async function executeRequest({
         body: clientOptions.body
       } : {})
     });
+    if (!includeResponseHeaders) {
+      response.headers = null;
+    }
     if (response.statusCode >= 200 && response.statusCode < 300) {
       if (clientOptions.method == 'HEAD') {
         return {
@@ -1037,7 +1045,7 @@ async function executeRequest({
     };
   } catch (e) {
     // We know that this is a network error
-    const headers = getHeaders(e.response?.headers);
+    const headers = includeResponseHeaders ? getHeaders(e.response?.headers) : null;
     const statusCode = e.response?.status || e.response?.data0 || 0;
     const message = e.response?.data?.message;
     const error = createError({
@@ -1074,7 +1082,8 @@ function createHttpMiddleware$1(options) {
     retryConfig,
     getAbortController,
     includeOriginalRequest,
-    includeRequestInErrorResponse,
+    includeRequestInErrorResponse = true,
+    includeResponseHeaders = true,
     maskSensitiveHeaderData,
     httpClientOptions
   } = options;
@@ -1110,6 +1119,7 @@ function createHttpMiddleware$1(options) {
         headers: requestHeader,
         includeRequestInErrorResponse,
         maskSensitiveHeaderData,
+        includeResponseHeaders,
         ...httpClientOptions
       };
       if (credentialsMode) {
@@ -1143,43 +1153,17 @@ function createHttpMiddleware$1(options) {
   };
 }
 
-// error, info, success
 function createLoggerMiddleware$1(options) {
   return next => {
     return async request => {
       let response = await next(request);
       const originalResponse = Object.assign({}, response);
       const {
-        loggerFn = console.log,
-        // logLevel = 'ERROR',
-        maskSensitiveHeaderData = true,
-        includeOriginalRequest = true,
-        includeResponseHeaders = true
-        // includeRequestInErrorResponse
+        loggerFn = console.log
       } = options || {};
-      if (includeOriginalRequest && maskSensitiveHeaderData) {
-        maskAuthData(response.request);
-      }
-      if (!includeOriginalRequest) {
-        const {
-          request,
-          ...rest
-        } = response;
-        response = rest;
-      }
-      if (!includeResponseHeaders) {
-        const {
-          headers,
-          ...rest
-        } = response;
-        response = rest;
-      }
       if (loggerFn && typeof loggerFn == 'function') {
         loggerFn(response);
-        // return originalResponse
       }
-
-      // console.log({ Response: response })
       return originalResponse;
     };
   };
@@ -1231,7 +1215,7 @@ function createQueueMiddleware$1({
 
 var packageJson = {
 	name: "@commercetools/ts-client",
-	version: "1.2.1",
+	version: "2.0.0",
 	engines: {
 		node: ">=14"
 	},
@@ -1290,7 +1274,8 @@ var packageJson = {
 	scripts: {
 		organize_imports: "find src -type f -name '*.ts' | xargs organize-imports-cli",
 		postbuild: "yarn organize_imports",
-		post_process_generate: "yarn organize_imports"
+		post_process_generate: "yarn organize_imports",
+		docs: "typedoc --out docs"
 	}
 };
 
@@ -1298,7 +1283,7 @@ function createUserAgentMiddleware$1(options) {
   return next => async request => {
     const userAgent = createUserAgent({
       ...options,
-      name: `commercetools-sdk-javascript-v3/${packageJson.version}`
+      name: `${options.name ? options.name + '/' : ''}commercetools-sdk-javascript-v3/${packageJson.version}`
     });
     const requestWithUserAgent = {
       ...request,
@@ -1320,7 +1305,7 @@ var middleware = /*#__PURE__*/Object.freeze({
   createAuthMiddlewareForRefreshTokenFlow: createAuthMiddlewareForRefreshTokenFlow$1,
   createConcurrentModificationMiddleware: createConcurrentModificationMiddleware$1,
   createCorrelationIdMiddleware: createCorrelationIdMiddleware$1,
-  createErrorMiddleware: createErrorMiddleware$1,
+  createErrorMiddleware: createErrorMiddleware,
   createHttpMiddleware: createHttpMiddleware$1,
   createLoggerMiddleware: createLoggerMiddleware$1,
   createQueueMiddleware: createQueueMiddleware$1,
@@ -1486,8 +1471,7 @@ const {
   createLoggerMiddleware,
   createQueueMiddleware,
   createUserAgentMiddleware,
-  createConcurrentModificationMiddleware,
-  createErrorMiddleware
+  createConcurrentModificationMiddleware
 } = middleware;
 class ClientBuilder {
   constructor() {
@@ -1499,7 +1483,9 @@ class ClientBuilder {
     _defineProperty(this, "loggerMiddleware", void 0);
     _defineProperty(this, "queueMiddleware", void 0);
     _defineProperty(this, "concurrentMiddleware", void 0);
-    _defineProperty(this, "errorMiddleware", void 0);
+    _defineProperty(this, "telemetryMiddleware", void 0);
+    _defineProperty(this, "beforeMiddleware", void 0);
+    _defineProperty(this, "afterMiddleware", void 0);
     _defineProperty(this, "middlewares", []);
     this.userAgentMiddleware = createUserAgentMiddleware({});
   }
@@ -1618,30 +1604,49 @@ class ClientBuilder {
     });
     return this;
   }
-  withConcurrentModificationMiddleware() {
-    this.concurrentMiddleware = createConcurrentModificationMiddleware();
+  withConcurrentModificationMiddleware(options) {
+    this.concurrentMiddleware = createConcurrentModificationMiddleware(options?.concurrentModificationHandlerFn);
     return this;
   }
-  withErrorMiddleware(options) {
-    this.errorMiddleware = createErrorMiddleware(options);
+  withTelemetryMiddleware(options) {
+    const {
+      createTelemetryMiddleware,
+      ...rest
+    } = options;
+    this.withUserAgentMiddleware({
+      customAgent: rest?.userAgent || 'typescript-sdk-apm-middleware'
+    });
+    this.telemetryMiddleware = createTelemetryMiddleware(rest);
+    return this;
+  }
+  withBeforeExecutionMiddleware(options) {
+    const {
+      middleware,
+      ...rest
+    } = options || {};
+    this.beforeMiddleware = options.middleware(rest);
+    return this;
+  }
+  withAfterExecutionMiddleware(options) {
+    const {
+      middleware,
+      ...rest
+    } = options || {};
+    this.afterMiddleware = options.middleware(rest);
     return this;
   }
   build() {
     const middlewares = this.middlewares.slice();
-
-    /**
-     * - use default retry policy if not explicity added
-     * - add retry middleware to be used by concurrent modification
-     *   middleware if not explicitly added as part of the middleware
-     */
+    if (this.telemetryMiddleware) middlewares.push(this.telemetryMiddleware);
     if (this.correlationIdMiddleware) middlewares.push(this.correlationIdMiddleware);
     if (this.userAgentMiddleware) middlewares.push(this.userAgentMiddleware);
     if (this.authMiddleware) middlewares.push(this.authMiddleware);
+    if (this.beforeMiddleware) middlewares.push(this.beforeMiddleware);
     if (this.queueMiddleware) middlewares.push(this.queueMiddleware);
     if (this.loggerMiddleware) middlewares.push(this.loggerMiddleware);
-    if (this.errorMiddleware) middlewares.push(this.errorMiddleware);
     if (this.concurrentMiddleware) middlewares.push(this.concurrentMiddleware);
     if (this.httpMiddleware) middlewares.push(this.httpMiddleware);
+    if (this.afterMiddleware) middlewares.push(this.afterMiddleware);
     return createClient({
       middlewares
     });