@commercetools/sdk-client-v2 1.2.0 → 1.3.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @commercetools/sdk-client-v2
 
+## 1.3.0
+
+### Minor Changes
+
+- [#241](https://github.com/commercetools/commercetools-sdk-typescript/pull/241) [`85f5be3`](https://github.com/commercetools/commercetools-sdk-typescript/commit/85f5be349a9b0fa46539259981bfd8d5fc2ffdc6) Thanks [@ajimae](https://github.com/ajimae)! - Releasing the TS SDK with the following changelogs
+
+  - added functionalities to extend client user agent
+  - custom field added to OrderFromCardDraft
+
 ## 1.2.0
 
 ### Minor Changes

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

@@ -39,13 +39,104 @@ function validate(funcName, request, options = {
   if (!options.allowedMethods.includes(request.method)) throw new Error(`The "${funcName}" Request object requires a valid method. See https://commercetools.github.io/nodejs/sdk/Glossary.html#clientrequest`);
 }
 
+let _options;
+
 function compose(...funcs) {
   funcs = funcs.filter(func => typeof func === 'function');
   if (funcs.length === 1) return funcs[0];
   return funcs.reduce((a, b) => (...args) => a(b(...args)));
 }
 
+function process$1(request, fn, processOpt) {
+  validate('process', request, {
+    allowedMethods: ['GET']
+  });
+  if (typeof fn !== 'function') throw new Error('The "process" function accepts a "Function" as a second argument that returns a Promise. See https://commercetools.github.io/nodejs/sdk/api/sdkClient.html#processrequest-processfn-options'); // Set default process options
+
+  const opt = {
+    total: Number.POSITIVE_INFINITY,
+    accumulate: true,
+    ...processOpt
+  };
+  return new Promise((resolve, reject) => {
+    let _path,
+        _queryString = '';
+
+    if (request && request.uri) {
+      const [path, queryString] = request.uri.split('?');
+      _path = path;
+      _queryString = queryString;
+    }
+
+    const requestQuery = { ...qs__default["default"].parse(_queryString)
+    };
+    const query = {
+      // defaults
+      limit: 20,
+      // merge given query params
+      ...requestQuery
+    };
+    let hasFirstPageBeenProcessed = false;
+    let itemsToGet = opt.total;
+
+    const processPage = async (lastId, acc = []) => {
+      // Use the lesser value between limit and itemsToGet in query
+      const limit = query.limit < itemsToGet ? query.limit : itemsToGet;
+      const originalQueryString = qs__default["default"].stringify({ ...query,
+        limit
+      });
+      const enhancedQuery = {
+        sort: 'id asc',
+        withTotal: false,
+        ...(lastId ? {
+          where: `id > "${lastId}"`
+        } : {})
+      };
+      const enhancedQueryString = qs__default["default"].stringify(enhancedQuery);
+      const enhancedRequest = { ...request,
+        uri: `${_path}?${enhancedQueryString}&${originalQueryString}`
+      };
+
+      try {
+        const payload = await createClient(_options).execute(enhancedRequest);
+        const {
+          results,
+          count: resultsLength
+        } = payload.body;
+
+        if (!resultsLength && hasFirstPageBeenProcessed) {
+          return resolve(acc || []);
+        }
+
+        const result = await Promise.resolve(fn(payload));
+        let accumulated;
+        hasFirstPageBeenProcessed = true;
+        if (opt.accumulate) accumulated = acc.concat(result || []);
+        itemsToGet -= resultsLength; // If there are no more items to get, it means the total number
+        // of items in the original request have been fetched so we
+        // resolve the promise.
+        // Also, if we get less results in a page then the limit set it
+        // means that there are no more pages and that we can finally
+        // resolve the promise.
+
+        if (resultsLength < query.limit || !itemsToGet) {
+          return resolve(accumulated || []);
+        }
+
+        const last = results[resultsLength - 1];
+        const newLastId = last && last.id;
+        processPage(newLastId, accumulated);
+      } catch (error) {
+        reject(error);
+      }
+    }; // Start iterating through pages
+
+
+    processPage();
+  });
+}
 function createClient(options) {
+  _options = options;
   if (!options) throw new Error('Missing required options');
   if (options.middlewares && !Array.isArray(options.middlewares)) throw new Error('Middlewares should be an array');
   if (!options.middlewares || !Array.isArray(options.middlewares) || !options.middlewares.length) throw new Error('You need to provide at least one middleware');
@@ -53,6 +144,8 @@ function createClient(options) {
     /**
      * Given a request object,
      */
+    process: process$1,
+
     execute(request) {
       validate('exec', request);
       return new Promise((resolve, reject) => {
@@ -81,95 +174,6 @@ function createClient(options) {
           error: undefined
         });
       });
-    },
-
-    process(request, fn, processOpt) {
-      validate('process', request, {
-        allowedMethods: ['GET']
-      });
-      if (typeof fn !== 'function') throw new Error('The "process" function accepts a "Function" as a second argument that returns a Promise. See https://commercetools.github.io/nodejs/sdk/api/sdkClient.html#processrequest-processfn-options'); // Set default process options
-
-      const opt = {
-        total: Number.POSITIVE_INFINITY,
-        accumulate: true,
-        ...processOpt
-      };
-      return new Promise((resolve, reject) => {
-        let _path,
-            _queryString = '';
-
-        if (request && request.uri) {
-          const [path, queryString] = request.uri.split('?');
-          _path = path;
-          _queryString = queryString;
-        }
-
-        const requestQuery = { ...qs__default["default"].parse(_queryString)
-        };
-        const query = {
-          // defaults
-          limit: 20,
-          // merge given query params
-          ...requestQuery
-        };
-        let hasFirstPageBeenProcessed = false;
-        let itemsToGet = opt.total;
-
-        const processPage = async (lastId, acc = []) => {
-          // Use the lesser value between limit and itemsToGet in query
-          const limit = query.limit < itemsToGet ? query.limit : itemsToGet;
-          const originalQueryString = qs__default["default"].stringify({ ...query,
-            limit
-          });
-          const enhancedQuery = {
-            sort: 'id asc',
-            withTotal: false,
-            ...(lastId ? {
-              where: `id > "${lastId}"`
-            } : {})
-          };
-          const enhancedQueryString = qs__default["default"].stringify(enhancedQuery);
-          const enhancedRequest = { ...request,
-            uri: `${_path}?${enhancedQueryString}&${originalQueryString}`
-          };
-
-          try {
-            const payload = await this.execute(enhancedRequest);
-            const {
-              results,
-              count: resultsLength
-            } = payload.body;
-
-            if (!resultsLength && hasFirstPageBeenProcessed) {
-              return resolve(acc || []);
-            }
-
-            const result = await Promise.resolve(fn(payload));
-            let accumulated;
-            hasFirstPageBeenProcessed = true;
-            if (opt.accumulate) accumulated = acc.concat(result || []);
-            itemsToGet -= resultsLength; // If there are no more items to get, it means the total number
-            // of items in the original request have been fetched so we
-            // resolve the promise.
-            // Also, if we get less results in a page then the limit set it
-            // means that there are no more pages and that we can finally
-            // resolve the promise.
-
-            if (resultsLength < query.limit || !itemsToGet) {
-              return resolve(accumulated || []);
-            }
-
-            const last = results[resultsLength - 1];
-            const newLastId = last && last.id;
-            processPage(newLastId, accumulated);
-          } catch (error) {
-            reject(error);
-          }
-        }; // Start iterating through pages
-
-
-        processPage();
-      });
     }
 
   };
@@ -749,7 +753,8 @@ function createHttpMiddleware({
     maxRetries = 10,
     backoff = true,
     retryDelay = 200,
-    maxDelay = Infinity
+    maxDelay = Infinity,
+    retryCodes = [503]
   } = {},
   fetch: fetcher,
   getAbortController
@@ -767,20 +772,29 @@ function createHttpMiddleware({
     fetchFunction = fetch;
   }
 
+  if (!Array.isArray(retryCodes)) {
+    throw new Error('`retryCodes` option must be an array of retry status (error) codes.');
+  }
+
   return next => (request, response) => {
     let abortController;
     if (timeout || getAbortController) abortController = (getAbortController ? getAbortController() : null) || new AbortController();
     const url = host.replace(/\/$/, '') + request.uri;
-    const body = typeof request.body === 'string' || Buffer.isBuffer(request.body) ? request.body : // NOTE: `stringify` of `null` gives the String('null')
-    JSON.stringify(request.body || undefined);
     const requestHeader = { ...request.headers
-    };
+    }; // Unset the content-type header if explicitly asked to (passing `null` as value).
 
-    if (!Object.prototype.hasOwnProperty.call(requestHeader, 'Content-Type')) {
-      requestHeader['Content-Type'] = 'application/json';
+    if (requestHeader['Content-Type'] === null) {
+      delete requestHeader['Content-Type'];
     }
 
-    if (body) {
+    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);
+
+    if (body && (typeof body === 'string' || Buffer.isBuffer(body))) {
       requestHeader['Content-Length'] = Buffer.byteLength(body).toString();
     }
 
@@ -849,15 +863,25 @@ 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
+        } // 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
         // return a proper error type with all necessary meta information.
 
+
         res.text().then(text => {
           // Try to parse the error response as JSON
           let parsed;
@@ -881,6 +905,15 @@ function createHttpMiddleware({
               body: parsed
             })
           });
+
+          if (enableRetry && (retryCodes.indexOf(error.statusCode) !== -1 || (retryCodes === null || retryCodes === void 0 ? void 0 : retryCodes.indexOf(error.message)) !== -1)) {
+            if (retryCount < maxRetries) {
+              setTimeout(executeFetch, calcDelayDuration(retryCount, retryDelay, maxRetries, backoff, maxDelay));
+              retryCount += 1;
+              return;
+            }
+          }
+
           maskAuthData(error.originalRequest, maskSensitiveHeaderData); // Let the final resolver to reject the promise
 
           const parsedResponse = { ...response,
@@ -982,7 +1015,7 @@ function createQueueMiddleware({
 
 var packageJson = {
 	name: "@commercetools/sdk-client-v2",
-	version: "1.2.0",
+	version: "1.3.0",
 	description: "commercetools TypeScript SDK client.",
 	keywords: [
 		"commercetools",
@@ -1073,12 +1106,14 @@ function createUserAgent(options) {
   let contactInfo = null;
   if (options.contactUrl && !options.contactEmail) contactInfo = `(+${options.contactUrl})`;else if (!options.contactUrl && options.contactEmail) contactInfo = `(+${options.contactEmail})`;else if (options.contactUrl && options.contactEmail) contactInfo = `(+${options.contactUrl}; +${options.contactEmail})`; // System info
 
-  const systemInfo = getSystemInfo();
-  return [baseInfo, systemInfo, libraryInfo, contactInfo].filter(Boolean).join(' ');
+  const systemInfo = getSystemInfo(); // customName
+
+  const customAgent = options.customAgent || '';
+  return [baseInfo, systemInfo, libraryInfo, contactInfo, customAgent].filter(Boolean).join(' ');
 }
 
-function createUserAgentMiddleware() {
-  const userAgent = createUserAgent({
+function createUserAgentMiddleware(options) {
+  const userAgent = createUserAgent({ ...options,
     name: `commercetools-sdk-javascript-v2/${packageJson.version}`
   });
   return next => (request, response) => {
@@ -1219,8 +1254,8 @@ class ClientBuilder {
     return this;
   }
 
-  withUserAgentMiddleware() {
-    this.userAgentMiddleware = createUserAgentMiddleware();
+  withUserAgentMiddleware(options) {
+    this.userAgentMiddleware = createUserAgentMiddleware(options);
     return this;
   }
 
@@ -1261,6 +1296,7 @@ class ClientBuilder {
 }
 
 exports.ClientBuilder = ClientBuilder;
+exports.Process = process$1;
 exports.createAuthForAnonymousSessionFlow = createAuthMiddlewareForAnonymousSessionFlow$1;
 exports.createAuthForClientCredentialsFlow = createAuthMiddlewareForClientCredentialsFlow$1;
 exports.createAuthForPasswordFlow = createAuthMiddlewareForPasswordFlow$1;