mws-zodane-advanced

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <base data-ice="baseUrl" href="../../../"> <title data-ice="title">lib/util/transformers.js | mws-advanced</title> <link type="text/css" rel="stylesheet" href="css/style.css"> <link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css"> <script src="script/prettify/prettify.js"></script> <script src="script/manual.js"></script> </head> <body class="layout-container" data-ice="rootContainer"> <header> <a href="./">Home</a> <a href="identifiers.html">Reference</a> <a href="source.html">Source</a> <div class="search-box"> <img src="./image/search.png"> <input class="search-input"> <ul class="search-result"></ul> </div> </header> <nav class="navigation" data-ice="nav"><div> <ul> <li data-ice="doc">F<a href="function/index.html#static-function-callEndpoint">callEndpoint</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-init">init</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getLowestPricedOffersForASIN">getLowestPricedOffersForASIN</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getMarketplaces">getMarketplaces</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getMatchingProductForId">getMatchingProductForId</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-listFinancialEvents">listFinancialEvents</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-listInventorySupply">listInventorySupply</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-listOrderItems">listOrderItems</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-listOrders">listOrders</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getReport">getReport</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getReportList">getReportList</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getReportListAll">getReportListAll</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getReportListByNextToken">getReportListByNextToken</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getReportRequestList">getReportRequestList</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-requestAndDownloadReport">requestAndDownloadReport</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-requestReport">requestReport</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-MWS_ENDPOINTS">MWS_ENDPOINTS</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-MWS_MARKETPLACES">MWS_MARKETPLACES</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-BuyBoxPrice">BuyBoxPrice</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-DetailedShippingTime">DetailedShippingTime</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-LowestPrice">LowestPrice</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-LowestPricedOffers">LowestPricedOffers</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-Money">Money</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-Offer">Offer</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-OfferCount">OfferCount</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-OfferSummary">OfferSummary</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-SellerFeedbackRating">SellerFeedbackRating</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-ShipsFrom">ShipsFrom</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-MarketDetail">MarketDetail</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-OrderItemList">OrderItemList</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-GetReportRequestListResult">GetReportRequestListResult</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-GetReportRequestListResult">GetReportRequestListResult</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-ReportRequestInfo">ReportRequestInfo</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#endpoints">endpoints</a>V<a href="variable/index.html#static-variable-REPORT_PROCESSING_STATUS_TYPES">REPORT_PROCESSING_STATUS_TYPES</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-REQUEST_REPORT_TYPES">REQUEST_REPORT_TYPES</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-feeds">feeds</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-finances">finances</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-inbound">inbound</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-inventory">inventory</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-merchFulfillment">merchFulfillment</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-orders">orders</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-outbound">outbound</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-products">products</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-reports">reports</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-sellers">sellers</a></li> <li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#util">util</a>F<a href="function/index.html#static-function-camelize">camelize</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-forceArray">forceArray</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-isUpperCase">isUpperCase</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-objToValueSub">objToValueSub</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-subObjUpLevel">subObjUpLevel</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-transformKey">transformKey</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-transformObjectKeys">transformObjectKeys</a></li> </ul> </div> </nav> <div class="content" data-ice="content"><h1 data-ice="title">lib/util/transformers.js</h1> <pre class="source-code line-number raw-source-code"><code class="prettyprint linenums" data-ice="content">/** * @module transformers * More than meets the eye. */ /** * Force parameter to be an array. If it's already an array, return a copy of the original. * If it's not an array, then return it inside an array. Useful for ensuring that things that * should always be arrays, are actually always arrays. * * @param {any} arr - item to force to array * @return {array} - copy of array, or an array containing arr */ const forceArray = arr => [].concat(arr !== undefined ? arr : []); /** * Test if a string is all upper case * * @param {string} str string to test * @return {boolean} true if string is all UPPERCASE */ const isUpperCase = str => typeof str === 'string' && str === str.toUpperCase(); // https://stackoverflow.com/questions/2970525/converting-any-string-into-camel-case /** * Attempt to relatively intelligently convert any string to camelCase (CamelCase => camelCase) * * @param {string} - string to convert * @returns {string} - camelCase version of string */ const camelize = (str) => { const ret = str.replace( /(?:^\w|[A-Z]|\b\w)/g, (letter, index) => (index === 0 ? letter.toLowerCase() : letter.toUpperCase()), ).replace(/\s+/g, ''); return ret; }; /** * Move all contents of a subobject 'key' down one level * @param {string} key - key to move * @param {object} obj - object to move in * @return {object} new object with sub-object contents of 'key' moved one level lower */ const subObjUpLevel = (key, obj) => { const ret = { ...obj, ...obj[key], }; delete ret[key]; return ret; }; // This is a version of subObjUpLevel that fails tests -- // somehow, on objects that had key, it would work, but on objects that didn't contain // key, it would create key as undefined. It's not clear why it would effectively delete // key if it had already existed, because it should be setting it to undefined. So, I think there // may be either a node bug, or something i'm not familiar with in the spec. I'm leaving this // here right now for future investigation, I should write a test case for the most basic // version and query some devs to see if it's a bug. // const subObjUpLevel = (key, obj) => ({ // ...obj, // ...obj[key], // [key]: undefined, // }); /** * Rename obj._ to obj.value, and move contents of obj.$ one level lower * * @param {object} obj - object to operate on * @return {object} transformed object */ const objToValueSub = obj => ({ value: obj._, ...obj.$, }); const transformKey = k => (isUpperCase(k) ? k : camelize(k)); /* eslint-disable no-param-reassign */ const transformObjectKeys = (obj, keyTransformer = transformKey) => { if (typeof obj.$ === 'object') { if (obj._) { obj = objToValueSub(obj); } else { obj = subObjUpLevel('$', obj); } } const ret = Object.keys(obj).reduce((r, key) => { const destKey = keyTransformer(key); if (typeof obj[key] === 'object') { r[destKey] = transformObjectKeys(obj[key], keyTransformer); } else { r[destKey] = obj[key]; } return r; }, {}); return ret; }; /* eslint-enable no-param-reassign */ module.exports = { camelize, forceArray, isUpperCase, objToValueSub, subObjUpLevel, transformObjectKeys, transformKey, }; </code></pre> </div> <footer class="footer"> Generated by <a href="https://esdoc.org">ESDoc(1.0.4)<img src="./image/esdoc-logo-mini-black.png"></a> </footer> <script src="script/search_index.js"></script> <script src="script/search.js"></script> <script src="script/pretty-print.js"></script> <script src="script/inherited-summary.js"></script> <script src="script/test-summary.js"></script> <script src="script/inner-link.js"></script> <script src="script/patch-for-local.js"></script> </body> </html>