@commercetools/sdk-client-v2 1.4.0 → 1.4.2

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @commercetools/sdk-client-v2
 
+## 1.4.2
+
+### Patch Changes
+
+- [#331](https://github.com/commercetools/commercetools-sdk-typescript/pull/331) [`007d9c6`](https://github.com/commercetools/commercetools-sdk-typescript/commit/007d9c6e056c3286c0c521427576b2cc1df664b2) Thanks [@ajimae](https://github.com/ajimae)! - - Fix issues with buffer request body always being converted to json (`stringified`)
+  - Abandon the static `Buffer.isBuffer()` method in favour of custom `isBuffer` function
+
+## 1.4.1
+
+### Patch Changes
+
+- [#317](https://github.com/commercetools/commercetools-sdk-typescript/pull/317) [`d921acd`](https://github.com/commercetools/commercetools-sdk-typescript/commit/d921acda35dadf135dffb53419b8825c915477b1) Thanks [@ajimae](https://github.com/ajimae)! - Allow `sdk-client` to accept request headers with `application/graphql` content-type.
+
+* [#311](https://github.com/commercetools/commercetools-sdk-typescript/pull/311) [`588a0f9`](https://github.com/commercetools/commercetools-sdk-typescript/commit/588a0f9b981a538a16a23a449e810c56956f352c) Thanks [@ajimae](https://github.com/ajimae)! - Change token fetch window from 2 hours to 5 minutes
+
+- [#320](https://github.com/commercetools/commercetools-sdk-typescript/pull/320) [`7510e0b`](https://github.com/commercetools/commercetools-sdk-typescript/commit/7510e0bf69cc4b63c43d0431d338502d048524aa) Thanks [@JohnMarsden24](https://github.com/JohnMarsden24)! - fix: make options for `withExistingTokenFlow` method optional
+
 ## 1.4.0
 
 ### Minor Changes

package/README.md

@@ -1,4 +1,4 @@
-# Commercetools TypeScript SDK client.
+# Commercetools Composable Commerce TypeScript SDK client
 
 ## Usage examples
 
@@ -77,7 +77,7 @@ const client = new ClientBuilder()
 
 const apiRoot = createApiBuilderFromCtpClient(client)
 
-// calling the platform functions
+// calling the Composable Commerce functions
 // get project details
 apiRoot
   .withProjectKey({

package/dist/commercetools-sdk-client-v2.browser.cjs.js

@@ -4,6 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var fetch$1 = require('node-fetch');
 var qs = require('querystring');
+var _ = require('buffer/');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
 
@@ -181,7 +182,7 @@ function createClient(options) {
 
 // POST https://{host}/oauth/token?grant_type=client_credentials&scope={scope}
 // Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
-const Buffer$2 = require('buffer/').Buffer;
+const Buffer$1 = require('buffer/').Buffer;
 
 function buildRequestForClientCredentialsFlow(options) {
   if (!options) throw new Error('Missing required options');
@@ -194,7 +195,7 @@ function buildRequestForClientCredentialsFlow(options) {
   } = options.credentials;
   if (!(clientId && clientSecret)) throw new Error('Missing required credentials (clientId, clientSecret)');
   const scope = options.scopes ? options.scopes.join(' ') : undefined;
-  const basicAuth = Buffer$2.from(`${clientId}:${clientSecret}`).toString('base64'); // This is mostly useful for internal testing purposes to be able to check
+  const basicAuth = Buffer$1.from(`${clientId}:${clientSecret}`).toString('base64'); // This is mostly useful for internal testing purposes to be able to check
   // other oauth endpoints.
 
   const oauthUri = options.oauthUri || '/oauth/token';
@@ -225,14 +226,14 @@ function buildRequestForPasswordFlow(options) {
   if (!(username && password)) throw new Error('Missing required user credentials (username, password)');
   const scope = (options.scopes || []).join(' ');
   const scopeStr = scope ? `&scope=${scope}` : '';
-  const basicAuth = Buffer$2.from(`${clientId}:${clientSecret}`).toString('base64');
+  const basicAuth = Buffer$1.from(`${clientId}:${clientSecret}`).toString('base64');
   /**
    * This is mostly useful for internal testing purposes to be able to check
    * other oauth endpoints.
    */
 
   const oauthUri = options.oauthUri || `/oauth/${pKey}/customers/token`;
-  const url = options.host.replace(/\/$/, '') + oauthUri; // encode username and password as requested by platform
+  const url = options.host.replace(/\/$/, '') + oauthUri; // encode username and password as requested by the system
 
   const body = `grant_type=password&username=${encodeURIComponent(username)}&password=${encodeURIComponent(password)}${scopeStr}`;
   return {
@@ -252,7 +253,7 @@ function buildRequestForRefreshTokenFlow(options) {
     clientSecret
   } = options.credentials;
   if (!(clientId && clientSecret)) throw new Error('Missing required credentials (clientId, clientSecret)');
-  const basicAuth = Buffer$2.from(`${clientId}:${clientSecret}`).toString('base64'); // This is mostly useful for internal testing purposes to be able to check
+  const basicAuth = Buffer$1.from(`${clientId}:${clientSecret}`).toString('base64'); // This is mostly useful for internal testing purposes to be able to check
   // other oauth endpoints.
 
   const oauthUri = options.oauthUri || '/oauth/token';
@@ -275,7 +276,7 @@ function buildRequestForAnonymousSessionFlow(options) {
   };
 }
 
-const Buffer$1 = require('buffer/').Buffer;
+const Buffer = require('buffer/').Buffer;
 
 function mergeAuthHeader(token, req) {
   return { ...req,
@@ -286,8 +287,8 @@ function mergeAuthHeader(token, req) {
 }
 
 function calculateExpirationTime(expiresIn) {
-  return Date.now() + // Add a gap of 2 hours before expiration time.
-  expiresIn * 1000 - 2 * 60 * 60 * 1000;
+  return Date.now() + // Add a gap of 5 minutes before expiration time.
+  expiresIn * 1000 - 5 * 60 * 1000;
 }
 
 async function executeRequest({
@@ -306,7 +307,7 @@ async function executeRequest({
       method: 'POST',
       headers: {
         Authorization: `Basic ${basicAuth}`,
-        'Content-Length': Buffer$1.byteLength(body).toString(),
+        'Content-Length': Buffer.byteLength(body).toString(),
         'Content-Type': 'application/x-www-form-urlencoded'
       },
       body
@@ -627,6 +628,19 @@ function createCorrelationIdMiddleware(options) {
   };
 }
 
+function parseHeaders(headers) {
+  if (headers.raw) // node-fetch
+    return headers.raw(); // Tmp fix for Firefox until it supports iterables
+
+  if (!headers.forEach) return {}; // whatwg-fetch
+
+  const map = {};
+  headers.forEach((value, name) => {
+    map[name] = value;
+  });
+  return map;
+}
+
 function defineError(statusCode, message, meta = {}) {
   this.status = this.statusCode = this.code = statusCode;
   this.message = message;
@@ -698,21 +712,10 @@ function getErrorByCode(code) {
   }
 }
 
-function parseHeaders(headers) {
-  if (headers.raw) // node-fetch
-    return headers.raw(); // Tmp fix for Firefox until it supports iterables
-
-  if (!headers.forEach) return {}; // whatwg-fetch
-
-  const map = {};
-  headers.forEach((value, name) => {
-    map[name] = value;
-  });
-  return map;
+function isBuffer(obj) {
+  return obj != null && obj.constructor != null && typeof obj.constructor.isBuffer === 'function' && obj.constructor.isBuffer(obj);
 }
 
-const Buffer = require('buffer/').Buffer;
-
 function createError({
   statusCode,
   message,
@@ -760,8 +763,9 @@ function createHttpMiddleware({
   fetch: fetcher,
   getAbortController
 }) {
-  if (!fetcher && typeof fetch === 'undefined') throw new Error('`fetch` is not available. Please pass in `fetch` as an option or have it globally available.');
-  if (timeout && !getAbortController && typeof AbortController === 'undefined') throw new Error('`AbortController` is not available. Please pass in `getAbortController` as an option or have AbortController globally available when using timeout.');
+  //nodejs v18 has the fetch available and not the version 16
+  if (!fetcher) throw new Error('`fetch` is not available. Please pass in `fetch` as an option or have it globally available.');
+  if (timeout && !getAbortController) throw new Error('`AbortController` is not available. Please pass in `getAbortController` as an option or have AbortController globally available when using timeout.');
   let fetchFunction;
 
   if (fetcher) {
@@ -788,15 +792,15 @@ function createHttpMiddleware({
       delete requestHeader['Content-Type'];
     }
 
-    if (!Object.prototype.hasOwnProperty.call(requestHeader, 'Content-Type') || !Object.prototype.hasOwnProperty.call(requestHeader, 'content-type')) {
+    if (!(Object.prototype.hasOwnProperty.call(requestHeader, 'Content-Type') || Object.prototype.hasOwnProperty.call(requestHeader, 'content-type'))) {
       requestHeader['Content-Type'] = 'application/json';
     } // Ensure body is a string if content type is application/json
 
 
-    const body = requestHeader['Content-Type'] === 'application/json' && typeof request.body === 'string' || Buffer.isBuffer(request.body) ? request.body : JSON.stringify(request.body || undefined);
+    const body = ['application/json', 'application/graphql'].indexOf(requestHeader['Content-Type']) > -1 && typeof request.body === 'string' || isBuffer(request.body) ? request.body : JSON.stringify(request.body || undefined);
 
-    if (body && (typeof body === 'string' || Buffer.isBuffer(body))) {
-      requestHeader['Content-Length'] = Buffer.byteLength(body).toString();
+    if (body && (typeof body === 'string' || isBuffer(body))) {
+      requestHeader['Content-Length'] = _.Buffer.byteLength(body).toString();
     }
 
     const fetchOptions = {
@@ -864,22 +868,7 @@ function createHttpMiddleware({
             next(request, parsedResponse);
           });
           return;
-        } // if (res.status === 503 && enableRetry)
-        //   if (retryCount < maxRetries) {
-        //     setTimeout(
-        //       executeFetch,
-        //       calcDelayDuration(
-        //         retryCount,
-        //         retryDelay,
-        //         maxRetries,
-        //         backoff,
-        //         maxDelay
-        //       )
-        //     )
-        //     retryCount += 1
-        //     return
-        //   }
-        // Server responded with an error. Try to parse it as JSON, then
+        } // Server responded with an error. Try to parse it as JSON, then
         // return a proper error type with all necessary meta information.
 
 
@@ -1019,10 +1008,11 @@ function createQueueMiddleware({
 
 var packageJson = {
 	name: "@commercetools/sdk-client-v2",
-	version: "1.4.0",
-	description: "commercetools TypeScript SDK client.",
+	version: "1.4.2",
+	description: "commercetools Composable Commerce TypeScript SDK client.",
 	keywords: [
 		"commercetools",
+		"composable commerce",
 		"sdk",
 		"typescript",
 		"client",
@@ -1066,10 +1056,10 @@ var packageJson = {
 	devDependencies: {
 		"abort-controller": "3.0.0",
 		"common-tags": "1.8.2",
-		dotenv: "16.0.0",
-		jest: "27.4.7",
+		dotenv: "16.0.1",
+		jest: "28.1.1",
 		nock: "12.0.3",
-		"organize-imports-cli": "0.9.0"
+		"organize-imports-cli": "0.10.0"
 	},
 	scripts: {
 		organize_imports: "find src -type f -name '*.ts' | xargs organize-imports-cli",
@@ -1289,9 +1279,9 @@ class ClientBuilder {
     if (this.correlationIdMiddleware) middlewares.push(this.correlationIdMiddleware);
     if (this.userAgentMiddleware) middlewares.push(this.userAgentMiddleware);
     if (this.authMiddleware) middlewares.push(this.authMiddleware);
-    if (this.loggerMiddleware) middlewares.push(this.loggerMiddleware);
     if (this.queueMiddleware) middlewares.push(this.queueMiddleware);
     if (this.httpMiddleware) middlewares.push(this.httpMiddleware);
+    if (this.loggerMiddleware) middlewares.push(this.loggerMiddleware);
     return createClient({
       middlewares
     });

package/dist/commercetools-sdk-client-v2.browser.esm.js

@@ -1,5 +1,6 @@
 import fetch$1 from 'node-fetch';
 import qs from 'querystring';
+import { Buffer as Buffer$2 } from 'buffer/';
 
 function _defineProperty(obj, key, value) {
   if (key in obj) {
@@ -172,7 +173,7 @@ function createClient(options) {
 
 // POST https://{host}/oauth/token?grant_type=client_credentials&scope={scope}
 // Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
-const Buffer$2 = require('buffer/').Buffer;
+const Buffer$1 = require('buffer/').Buffer;
 
 function buildRequestForClientCredentialsFlow(options) {
   if (!options) throw new Error('Missing required options');
@@ -185,7 +186,7 @@ function buildRequestForClientCredentialsFlow(options) {
   } = options.credentials;
   if (!(clientId && clientSecret)) throw new Error('Missing required credentials (clientId, clientSecret)');
   const scope = options.scopes ? options.scopes.join(' ') : undefined;
-  const basicAuth = Buffer$2.from(`${clientId}:${clientSecret}`).toString('base64'); // This is mostly useful for internal testing purposes to be able to check
+  const basicAuth = Buffer$1.from(`${clientId}:${clientSecret}`).toString('base64'); // This is mostly useful for internal testing purposes to be able to check
   // other oauth endpoints.
 
   const oauthUri = options.oauthUri || '/oauth/token';
@@ -216,14 +217,14 @@ function buildRequestForPasswordFlow(options) {
   if (!(username && password)) throw new Error('Missing required user credentials (username, password)');
   const scope = (options.scopes || []).join(' ');
   const scopeStr = scope ? `&scope=${scope}` : '';
-  const basicAuth = Buffer$2.from(`${clientId}:${clientSecret}`).toString('base64');
+  const basicAuth = Buffer$1.from(`${clientId}:${clientSecret}`).toString('base64');
   /**
    * This is mostly useful for internal testing purposes to be able to check
    * other oauth endpoints.
    */
 
   const oauthUri = options.oauthUri || `/oauth/${pKey}/customers/token`;
-  const url = options.host.replace(/\/$/, '') + oauthUri; // encode username and password as requested by platform
+  const url = options.host.replace(/\/$/, '') + oauthUri; // encode username and password as requested by the system
 
   const body = `grant_type=password&username=${encodeURIComponent(username)}&password=${encodeURIComponent(password)}${scopeStr}`;
   return {
@@ -243,7 +244,7 @@ function buildRequestForRefreshTokenFlow(options) {
     clientSecret
   } = options.credentials;
   if (!(clientId && clientSecret)) throw new Error('Missing required credentials (clientId, clientSecret)');
-  const basicAuth = Buffer$2.from(`${clientId}:${clientSecret}`).toString('base64'); // This is mostly useful for internal testing purposes to be able to check
+  const basicAuth = Buffer$1.from(`${clientId}:${clientSecret}`).toString('base64'); // This is mostly useful for internal testing purposes to be able to check
   // other oauth endpoints.
 
   const oauthUri = options.oauthUri || '/oauth/token';
@@ -266,7 +267,7 @@ function buildRequestForAnonymousSessionFlow(options) {
   };
 }
 
-const Buffer$1 = require('buffer/').Buffer;
+const Buffer = require('buffer/').Buffer;
 
 function mergeAuthHeader(token, req) {
   return { ...req,
@@ -277,8 +278,8 @@ function mergeAuthHeader(token, req) {
 }
 
 function calculateExpirationTime(expiresIn) {
-  return Date.now() + // Add a gap of 2 hours before expiration time.
-  expiresIn * 1000 - 2 * 60 * 60 * 1000;
+  return Date.now() + // Add a gap of 5 minutes before expiration time.
+  expiresIn * 1000 - 5 * 60 * 1000;
 }
 
 async function executeRequest({
@@ -297,7 +298,7 @@ async function executeRequest({
       method: 'POST',
       headers: {
         Authorization: `Basic ${basicAuth}`,
-        'Content-Length': Buffer$1.byteLength(body).toString(),
+        'Content-Length': Buffer.byteLength(body).toString(),
         'Content-Type': 'application/x-www-form-urlencoded'
       },
       body
@@ -618,6 +619,19 @@ function createCorrelationIdMiddleware(options) {
   };
 }
 
+function parseHeaders(headers) {
+  if (headers.raw) // node-fetch
+    return headers.raw(); // Tmp fix for Firefox until it supports iterables
+
+  if (!headers.forEach) return {}; // whatwg-fetch
+
+  const map = {};
+  headers.forEach((value, name) => {
+    map[name] = value;
+  });
+  return map;
+}
+
 function defineError(statusCode, message, meta = {}) {
   this.status = this.statusCode = this.code = statusCode;
   this.message = message;
@@ -689,21 +703,10 @@ function getErrorByCode(code) {
   }
 }
 
-function parseHeaders(headers) {
-  if (headers.raw) // node-fetch
-    return headers.raw(); // Tmp fix for Firefox until it supports iterables
-
-  if (!headers.forEach) return {}; // whatwg-fetch
-
-  const map = {};
-  headers.forEach((value, name) => {
-    map[name] = value;
-  });
-  return map;
+function isBuffer(obj) {
+  return obj != null && obj.constructor != null && typeof obj.constructor.isBuffer === 'function' && obj.constructor.isBuffer(obj);
 }
 
-const Buffer = require('buffer/').Buffer;
-
 function createError({
   statusCode,
   message,
@@ -751,8 +754,9 @@ function createHttpMiddleware({
   fetch: fetcher,
   getAbortController
 }) {
-  if (!fetcher && typeof fetch === 'undefined') throw new Error('`fetch` is not available. Please pass in `fetch` as an option or have it globally available.');
-  if (timeout && !getAbortController && typeof AbortController === 'undefined') throw new Error('`AbortController` is not available. Please pass in `getAbortController` as an option or have AbortController globally available when using timeout.');
+  //nodejs v18 has the fetch available and not the version 16
+  if (!fetcher) throw new Error('`fetch` is not available. Please pass in `fetch` as an option or have it globally available.');
+  if (timeout && !getAbortController) throw new Error('`AbortController` is not available. Please pass in `getAbortController` as an option or have AbortController globally available when using timeout.');
   let fetchFunction;
 
   if (fetcher) {
@@ -779,15 +783,15 @@ function createHttpMiddleware({
       delete requestHeader['Content-Type'];
     }
 
-    if (!Object.prototype.hasOwnProperty.call(requestHeader, 'Content-Type') || !Object.prototype.hasOwnProperty.call(requestHeader, 'content-type')) {
+    if (!(Object.prototype.hasOwnProperty.call(requestHeader, 'Content-Type') || Object.prototype.hasOwnProperty.call(requestHeader, 'content-type'))) {
       requestHeader['Content-Type'] = 'application/json';
     } // Ensure body is a string if content type is application/json
 
 
-    const body = requestHeader['Content-Type'] === 'application/json' && typeof request.body === 'string' || Buffer.isBuffer(request.body) ? request.body : JSON.stringify(request.body || undefined);
+    const body = ['application/json', 'application/graphql'].indexOf(requestHeader['Content-Type']) > -1 && typeof request.body === 'string' || isBuffer(request.body) ? request.body : JSON.stringify(request.body || undefined);
 
-    if (body && (typeof body === 'string' || Buffer.isBuffer(body))) {
-      requestHeader['Content-Length'] = Buffer.byteLength(body).toString();
+    if (body && (typeof body === 'string' || isBuffer(body))) {
+      requestHeader['Content-Length'] = Buffer$2.byteLength(body).toString();
     }
 
     const fetchOptions = {
@@ -855,22 +859,7 @@ function createHttpMiddleware({
             next(request, parsedResponse);
           });
           return;
-        } // if (res.status === 503 && enableRetry)
-        //   if (retryCount < maxRetries) {
-        //     setTimeout(
-        //       executeFetch,
-        //       calcDelayDuration(
-        //         retryCount,
-        //         retryDelay,
-        //         maxRetries,
-        //         backoff,
-        //         maxDelay
-        //       )
-        //     )
-        //     retryCount += 1
-        //     return
-        //   }
-        // Server responded with an error. Try to parse it as JSON, then
+        } // Server responded with an error. Try to parse it as JSON, then
         // return a proper error type with all necessary meta information.
 
 
@@ -1010,10 +999,11 @@ function createQueueMiddleware({
 
 var packageJson = {
 	name: "@commercetools/sdk-client-v2",
-	version: "1.4.0",
-	description: "commercetools TypeScript SDK client.",
+	version: "1.4.2",
+	description: "commercetools Composable Commerce TypeScript SDK client.",
 	keywords: [
 		"commercetools",
+		"composable commerce",
 		"sdk",
 		"typescript",
 		"client",
@@ -1057,10 +1047,10 @@ var packageJson = {
 	devDependencies: {
 		"abort-controller": "3.0.0",
 		"common-tags": "1.8.2",
-		dotenv: "16.0.0",
-		jest: "27.4.7",
+		dotenv: "16.0.1",
+		jest: "28.1.1",
 		nock: "12.0.3",
-		"organize-imports-cli": "0.9.0"
+		"organize-imports-cli": "0.10.0"
 	},
 	scripts: {
 		organize_imports: "find src -type f -name '*.ts' | xargs organize-imports-cli",
@@ -1280,9 +1270,9 @@ class ClientBuilder {
     if (this.correlationIdMiddleware) middlewares.push(this.correlationIdMiddleware);
     if (this.userAgentMiddleware) middlewares.push(this.userAgentMiddleware);
     if (this.authMiddleware) middlewares.push(this.authMiddleware);
-    if (this.loggerMiddleware) middlewares.push(this.loggerMiddleware);
     if (this.queueMiddleware) middlewares.push(this.queueMiddleware);
     if (this.httpMiddleware) middlewares.push(this.httpMiddleware);
+    if (this.loggerMiddleware) middlewares.push(this.loggerMiddleware);
     return createClient({
       middlewares
     });