@commercetools/ts-client 1.1.0 → 1.1.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @commercetools/ts-client
 
+## 1.1.1
+
+### Patch Changes
+
+- [#620](https://github.com/commercetools/commercetools-sdk-typescript/pull/620) [`f0028a3`](https://github.com/commercetools/commercetools-sdk-typescript/commit/f0028a343fe3417bbc3caeb76cc6658a5d7bff73) Thanks [@lojzatran](https://github.com/lojzatran)! - Fix issue with concurrent modification middleware functionality.
+
 ## 1.1.0
 
 ### Minor Changes

package/README.md

@@ -124,3 +124,58 @@ apiRoot
     /*...*/
   })
 ```
+
+## Create a client
+
+To create a client, use the `ClientBuilder` class. The `ClientBuilder` class provides a fluent API to configure the client.
+
+```ts
+const authMiddlewareOptions = {
+  credentials: {
+    clientId: 'xxx',
+    clientSecret: 'xxx',
+  },
+  host: 'https://auth.europe-west1.gcp.commercetools.com',
+  projectKey: 'xxx',
+}
+
+const httpMiddlewareOptions = {
+  host: 'https://api.europe-west1.gcp.commercetools.com',
+  httpClient: fetch,
+}
+
+const client = new ClientBuilder()
+  .withHttpMiddleware(httpMiddlewareOptions)
+  .withConcurrentModificationMiddleware()
+  .withClientCredentialsFlow(authMiddlewareOptions)
+  .build()
+```
+
+> [!WARNING]
+> Do not add the built-in middlewares using `withMiddleware` method. Adding by this method does not respect the ordering of the middlewares and could lead to unexpected behavior.
+
+```ts
+// WRONG CODE!!!!!
+const authMiddlewareOptions = {
+  credentials: {
+    clientId: 'xxx',
+    clientSecret: 'xxx',
+  },
+  host: 'https://auth.europe-west1.gcp.commercetools.com',
+  projectKey: 'xxx',
+}
+
+const httpMiddlewareOptions = {
+  host: 'https://api.europe-west1.gcp.commercetools.com',
+  httpClient: fetch,
+}
+
+const client = new ClientBuilder()
+  .withMiddleware(
+    createAuthMiddlewareForClientCredentialsFlow(authMiddlewareOptions)
+  )
+  .withMiddleware(createHttpMiddleware(httpMiddlewareOptions))
+  .withMiddleware(createConcurrentModificationMiddleware())
+  .build()
+// WRONG CODE!!!!!
+```

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

@@ -3,34 +3,33 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var fetch$1 = require('node-fetch');
-var crytpo = require('crypto');
+var uuid = require('uuid');
 var _ = require('buffer/');
 var AbortController = require('abort-controller');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
 
 var fetch__default = /*#__PURE__*/_interopDefault(fetch$1);
-var crytpo__default = /*#__PURE__*/_interopDefault(crytpo);
 var AbortController__default = /*#__PURE__*/_interopDefault(AbortController);
 
-function _toPrimitive(input, hint) {
-  if (typeof input !== "object" || input === null) return input;
-  var prim = input[Symbol.toPrimitive];
-  if (prim !== undefined) {
-    var res = prim.call(input, hint || "default");
-    if (typeof res !== "object") return res;
+function toPrimitive(t, r) {
+  if ("object" != typeof t || !t) return t;
+  var e = t[Symbol.toPrimitive];
+  if (void 0 !== e) {
+    var i = e.call(t, r || "default");
+    if ("object" != typeof i) return i;
     throw new TypeError("@@toPrimitive must return a primitive value.");
   }
-  return (hint === "string" ? String : Number)(input);
+  return ("string" === r ? String : Number)(t);
 }
 
-function _toPropertyKey(arg) {
-  var key = _toPrimitive(arg, "string");
-  return typeof key === "symbol" ? key : String(key);
+function toPropertyKey(t) {
+  var i = toPrimitive(t, "string");
+  return "symbol" == typeof i ? i : String(i);
 }
 
 function _defineProperty(obj, key, value) {
-  key = _toPropertyKey(key);
+  key = toPropertyKey(key);
   if (key in obj) {
     Object.defineProperty(obj, key, {
       value: value,
@@ -115,9 +114,8 @@ function createError({
   message,
   ...rest
 }) {
-  var _rest$originalRequest;
   let errorMessage = message || 'Unexpected non-JSON error response';
-  if (statusCode === 404) errorMessage = `URI not found: ${((_rest$originalRequest = rest.originalRequest) === null || _rest$originalRequest === void 0 ? void 0 : _rest$originalRequest.uri) || rest.uri}`;
+  if (statusCode === 404) errorMessage = `URI not found: ${rest.originalRequest?.uri || rest.uri}`;
   const ResponseError = getErrorByCode(statusCode);
   if (ResponseError) return new ResponseError(errorMessage, rest);
   return new HttpError(statusCode, errorMessage, rest);
@@ -126,7 +124,7 @@ function createError({
 function predicate(retryCodes, response) {
   return !
   // retryCodes.includes(response?.error?.message) ||
-  [503, ...retryCodes].includes((response === null || response === void 0 ? void 0 : response.status) || (response === null || response === void 0 ? void 0 : response.statusCode));
+  [503, ...retryCodes].includes(response?.status || response?.statusCode);
 }
 async function executeHttpClientRequest(fetcher, config) {
   async function sendRequest() {
@@ -237,9 +235,8 @@ async function executor(request) {
   return data;
 }
 
-// TODO: Polyfill crypto for browsers
 function generateID() {
-  return crytpo__default["default"].randomBytes(32).toString('base64').replace(/[\/\-=+]/gi, '');
+  return uuid.v4();
 }
 
 function parse(headers) {
@@ -266,7 +263,7 @@ function isBuffer(obj) {
 
 function maskAuthData(request) {
   const _request = Object.assign({}, request);
-  if (_request !== null && _request !== void 0 && _request.headers) {
+  if (_request?.headers) {
     if (_request.headers.Authorization) {
       _request.headers['Authorization'] = 'Bearer ********';
     }
@@ -310,8 +307,7 @@ function sleep(ms) {
 }
 
 function buildTokenCacheKey(options) {
-  var _options$credentials;
-  if (!(options !== null && options !== void 0 && (_options$credentials = options.credentials) !== null && _options$credentials !== void 0 && _options$credentials.clientId) || !options.projectKey || !options.host) throw new Error('Missing required options.');
+  if (!options?.credentials?.clientId || !options.projectKey || !options.host) throw new Error('Missing required options.');
   return {
     clientId: options.credentials.clientId,
     host: options.host,
@@ -335,6 +331,35 @@ function store(initVal) {
   };
 }
 
+function urlParser(url) {
+  const object = {};
+  const data = new URLSearchParams(url);
+  for (let x of data.keys()) {
+    if (data.getAll(x).length > 1) {
+      object[x] = data.getAll(x);
+    } else {
+      object[x] = data.get(x);
+    }
+  }
+  return object;
+}
+function urlStringifier(object) {
+  const params = new URLSearchParams(object);
+  for (const [key, value] of Object.entries(object)) {
+    if (Array.isArray(value)) {
+      params.delete(key);
+      value.filter(Boolean).forEach(v => params.append(key, v));
+    }
+  }
+  return params.toString();
+}
+function parseURLString(url, parser = urlParser) {
+  return parser(url);
+}
+function stringifyURLString(object, stringifier = urlStringifier) {
+  return urlStringifier(object);
+}
+
 // import { validateUserAgentOptions } from '../utils'
 
 /*
@@ -347,9 +372,8 @@ function store(initVal) {
 */
 const isBrowser = () => window.document && window.document.nodeType === 9;
 function getSystemInfo() {
-  var _process;
   if (isBrowser()) return window.navigator.userAgent;
-  const nodeVersion = ((_process = process) === null || _process === void 0 ? void 0 : _process.version.slice(1)) || 'unknow'; // unknow environment like  React Native etc
+  const nodeVersion = process?.version.slice(1) || 'unknow'; // unknow environment like  React Native etc
   const platformInfo = `(${process.platform}; ${process.arch})`;
 
   // return `node.js/${nodeVersion}`
@@ -391,35 +415,6 @@ function createUserAgent(options) {
   return [baseInfo, systemInfo, libraryInfo, contactInfo, customAgent].filter(Boolean).join(' ');
 }
 
-function urlParser(url) {
-  const object = {};
-  const data = new URLSearchParams(url);
-  for (let x of data.keys()) {
-    if (data.getAll(x).length > 1) {
-      object[x] = data.getAll(x);
-    } else {
-      object[x] = data.get(x);
-    }
-  }
-  return object;
-}
-function urlStringifier(object) {
-  const params = new URLSearchParams(object);
-  for (const [key, value] of Object.entries(object)) {
-    if (Array.isArray(value)) {
-      params.delete(key);
-      value.filter(Boolean).forEach(v => params.append(key, v));
-    }
-  }
-  return params.toString();
-}
-function parseURLString(url, parser = urlParser) {
-  return parser(url);
-}
-function stringifyURLString(object, stringifier = urlStringifier) {
-  return urlStringifier(object);
-}
-
 /**
  * validate some essential http options
  * @param options
@@ -662,12 +657,11 @@ async function executeRequest$1(options) {
       body
     });
     if (response.statusCode >= 200 && response.statusCode < 300) {
-      var _response;
       const {
         access_token: token,
         expires_in: expiresIn,
         refresh_token: refreshToken
-      } = (_response = response) === null || _response === void 0 ? void 0 : _response.data;
+      } = response?.data;
 
       // calculate token expiration time
       const expirationTime = calculateExpirationTime(expiresIn);
@@ -821,7 +815,7 @@ function createAuthMiddlewareForExistingTokenFlow$1(authorization, options) {
   return next => {
     return async request => {
       if (typeof authorization !== 'string') throw new Error('authorization must be a string');
-      const isForce = (options === null || options === void 0 ? void 0 : options.force) === undefined ? true : options.force;
+      const isForce = options?.force === undefined ? true : options.force;
 
       /**
        * The request will not be modified if:
@@ -915,13 +909,12 @@ function createConcurrentModificationMiddleware$1() {
     return async request => {
       const response = await next(request);
       if (response.statusCode == 409) {
-        var _response$error, _response$error$body, _response$error$body$, _response$error$body$2;
         /**
          * extract the currentVersion
          * from the error body and update
          * request with the currentVersion
          */
-        const version = (_response$error = response.error) === null || _response$error === void 0 ? void 0 : (_response$error$body = _response$error.body) === null || _response$error$body === void 0 ? void 0 : (_response$error$body$ = _response$error$body.errors) === null || _response$error$body$ === void 0 ? void 0 : (_response$error$body$2 = _response$error$body$[0]) === null || _response$error$body$2 === void 0 ? void 0 : _response$error$body$2.currentVersion;
+        const version = response.error.body?.errors?.[0]?.currentVersion;
 
         // update the resource version here
         if (version) {
@@ -988,7 +981,6 @@ async function executeRequest({
     includeRequestInErrorResponse
   } = clientOptions;
   try {
-    var _response$data, _response$data2;
     if (timeout) timer = setTimeout(() => {
       abortController.abort();
     }, timeout);
@@ -1018,8 +1010,8 @@ async function executeRequest({
       };
     }
     const error = createError({
-      message: (response === null || response === void 0 ? void 0 : (_response$data = response.data) === null || _response$data === void 0 ? void 0 : _response$data.message) || (response === null || response === void 0 ? void 0 : response.message),
-      statusCode: response.statusCode || (response === null || response === void 0 ? void 0 : (_response$data2 = response.data) === null || _response$data2 === void 0 ? void 0 : _response$data2.statusCode),
+      message: response?.data?.message || response?.message,
+      statusCode: response.statusCode || response?.data?.statusCode,
       headers: getHeaders(response.headers),
       method: clientOptions.method,
       body: response.data,
@@ -1043,19 +1035,18 @@ async function executeRequest({
       error
     };
   } catch (e) {
-    var _e$response, _e$response2, _e$response3, _e$response4, _e$response4$data, _e$response5, _e$response6;
     // We know that this is a network error
-    const headers = getHeaders((_e$response = e.response) === null || _e$response === void 0 ? void 0 : _e$response.headers);
-    const statusCode = ((_e$response2 = e.response) === null || _e$response2 === void 0 ? void 0 : _e$response2.status) || ((_e$response3 = e.response) === null || _e$response3 === void 0 ? void 0 : _e$response3.data0) || 0;
-    const message = (_e$response4 = e.response) === null || _e$response4 === void 0 ? void 0 : (_e$response4$data = _e$response4.data) === null || _e$response4$data === void 0 ? void 0 : _e$response4$data.message;
+    const headers = getHeaders(e.response?.headers);
+    const statusCode = e.response?.status || e.response?.data0 || 0;
+    const message = e.response?.data?.message;
     const error = createError({
       statusCode,
       code: statusCode,
       status: statusCode,
       message: message || e.message,
       headers,
-      body: ((_e$response5 = e.response) === null || _e$response5 === void 0 ? void 0 : _e$response5.data) || e,
-      error: (_e$response6 = e.response) === null || _e$response6 === void 0 ? void 0 : _e$response6.data,
+      body: e.response?.data || e,
+      error: e.response?.data,
       ...(includeRequestInErrorResponse ? {
         originalRequest: maskSensitiveHeaderData ? maskAuthData(request) : request
       } : {
@@ -1239,7 +1230,7 @@ function createQueueMiddleware$1({
 
 var packageJson = {
 	name: "@commercetools/ts-client",
-	version: "1.1.0",
+	version: "1.1.1",
 	engines: {
 		node: ">=14"
 	},
@@ -1274,7 +1265,8 @@ var packageJson = {
 	dependencies: {
 		"abort-controller": "3.0.0",
 		buffer: "^6.0.3",
-		"node-fetch": "^2.6.1"
+		"node-fetch": "^2.6.1",
+		uuid: "9.0.0"
 	},
 	files: [
 		"dist",
@@ -1289,8 +1281,8 @@ var packageJson = {
 	},
 	devDependencies: {
 		"common-tags": "1.8.2",
-		dotenv: "16.0.3",
-		jest: "29.5.0",
+		dotenv: "16.3.1",
+		jest: "29.6.2",
 		nock: "12.0.3",
 		"organize-imports-cli": "0.10.0"
 	},
@@ -1399,7 +1391,7 @@ function process$1(request, fn, processOpt) {
         const {
           results,
           count: resultsLength
-        } = (payload === null || payload === void 0 ? void 0 : payload.body) || {};
+        } = payload?.body || {};
         if (!resultsLength && hasFirstPageBeenProcessed) {
           return resolve(acc || []);
         }
@@ -1453,15 +1445,10 @@ function createClient(middlewares) {
         ...(includeOriginalRequest ? {
           originalRequest: maskSensitiveHeaderData ? maskAuthData(request) : request
         } : {}),
-        ...(response !== null && response !== void 0 && response.retryCount ? {
+        ...(response?.retryCount ? {
           retryCount: response.retryCount
         } : {})
       };
-      if (res.error) {
-        res.reject(res.error);
-        return res;
-      }
-      res.resolve(res);
       return res;
     }
   };
@@ -1471,11 +1458,11 @@ function createClient(middlewares) {
     execute(request) {
       validate('exec', request);
       return new Promise((resolve, reject) => {
-        return dispatch({
+        dispatch({
           reject,
           resolve,
           ...request
-        });
+        }).then(resolve).catch(reject);
       });
     }
   };
@@ -1619,7 +1606,7 @@ class ClientBuilder {
   }
   withCorrelationIdMiddleware(options) {
     this.correlationIdMiddleware = createCorrelationIdMiddleware({
-      generate: options === null || options === void 0 ? void 0 : options.generate,
+      generate: options?.generate,
       ...options
     });
     return this;
@@ -1662,6 +1649,7 @@ exports.createAuthMiddlewareForExistingTokenFlow = createAuthMiddlewareForExisti
 exports.createAuthMiddlewareForPasswordFlow = createAuthMiddlewareForPasswordFlow$1;
 exports.createAuthMiddlewareForRefreshTokenFlow = createAuthMiddlewareForRefreshTokenFlow$1;
 exports.createClient = createClient;
+exports.createConcurrentModificationMiddleware = createConcurrentModificationMiddleware$1;
 exports.createCorrelationIdMiddleware = createCorrelationIdMiddleware$1;
 exports.createHttpMiddleware = createHttpMiddleware$1;
 exports.createLoggerMiddleware = createLoggerMiddleware$1;