@shopgate/pwa-common-commerce 7.12.0-beta.2 → 7.12.0-beta.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shopgate/pwa-common-commerce",
-  "version": "7.12.0-beta.2",
+  "version": "7.12.0-beta.4",
   "description": "Commerce library for the Shopgate Connect PWA.",
   "license": "Apache-2.0",
   "author": "Shopgate <support@shopgate.com>",
@@ -19,8 +19,8 @@
     "reselect": "^3.0.1"
   },
   "devDependencies": {
-    "@shopgate/pwa-common": "7.12.0-beta.2",
-    "@shopgate/pwa-core": "7.12.0-beta.2",
+    "@shopgate/pwa-common": "7.12.0-beta.4",
+    "@shopgate/pwa-core": "7.12.0-beta.4",
     "lodash": "^4.17.4",
     "react": "~16.12.0",
     "react-dom": "~16.12.0"

package/product/actions/fetchProducts.js

@@ -1,4 +1,4 @@
-function _objectWithoutProperties(source,excluded){if(source==null)return{};var target=_objectWithoutPropertiesLoose(source,excluded);var key,i;if(Object.getOwnPropertySymbols){var sourceSymbolKeys=Object.getOwnPropertySymbols(source);for(i=0;i<sourceSymbolKeys.length;i++){key=sourceSymbolKeys[i];if(excluded.indexOf(key)>=0)continue;if(!Object.prototype.propertyIsEnumerable.call(source,key))continue;target[key]=source[key];}}return target;}function _objectWithoutPropertiesLoose(source,excluded){if(source==null)return{};var target={};var sourceKeys=Object.keys(source);var key,i;for(i=0;i<sourceKeys.length;i++){key=sourceKeys[i];if(excluded.indexOf(key)>=0)continue;target[key]=source[key];}return target;}function _extends(){_extends=Object.assign||function(target){for(var i=1;i<arguments.length;i++){var source=arguments[i];for(var key in source){if(Object.prototype.hasOwnProperty.call(source,key)){target[key]=source[key];}}}return target;};return _extends.apply(this,arguments);}import difference from'lodash/difference';import PipelineRequest from'@shopgate/pwa-core/classes/PipelineRequest';import{generateResultHash,shouldFetchData}from'@shopgate/pwa-common/helpers/redux';import{isNumber}from'@shopgate/pwa-common/helpers/validation';import configuration from'@shopgate/pwa-common/collections/Configuration';import{DEFAULT_PRODUCTS_FETCH_PARAMS}from'@shopgate/pwa-common/constants/Configuration';import{SORT_SCOPE_CATEGORY}from'@shopgate/engage/filter/constants';import{makeGetDefaultSortOrder}from'@shopgate/engage/filter/selectors';import{getFulfillmentParams}from'@shopgate/pwa-common-commerce/product/selectors/product';import{SHOPGATE_CATALOG_GET_PRODUCTS,SHOPGATE_CATALOG_GET_HIGHLIGHT_PRODUCTS,SHOPGATE_CATALOG_GET_LIVESHOPPING_PRODUCTS}from"../constants/Pipelines";import buildRequestFilters from"../../filter/actions/helpers/buildRequestFilters";import requestProducts from"../action-creators/requestProducts";import receiveProducts from"../action-creators/receiveProducts";import errorProducts from"../action-creators/errorProducts";import deleteProductsByIds from"../action-creators/deleteProductsByIds";import receiveProductsCached from"../action-creators/receiveProductsCached";/**
+function _objectWithoutProperties(source,excluded){if(source==null)return{};var target=_objectWithoutPropertiesLoose(source,excluded);var key,i;if(Object.getOwnPropertySymbols){var sourceSymbolKeys=Object.getOwnPropertySymbols(source);for(i=0;i<sourceSymbolKeys.length;i++){key=sourceSymbolKeys[i];if(excluded.indexOf(key)>=0)continue;if(!Object.prototype.propertyIsEnumerable.call(source,key))continue;target[key]=source[key];}}return target;}function _objectWithoutPropertiesLoose(source,excluded){if(source==null)return{};var target={};var sourceKeys=Object.keys(source);var key,i;for(i=0;i<sourceKeys.length;i++){key=sourceKeys[i];if(excluded.indexOf(key)>=0)continue;target[key]=source[key];}return target;}function _extends(){_extends=Object.assign||function(target){for(var i=1;i<arguments.length;i++){var source=arguments[i];for(var key in source){if(Object.prototype.hasOwnProperty.call(source,key)){target[key]=source[key];}}}return target;};return _extends.apply(this,arguments);}import difference from'lodash/difference';import PipelineRequest from'@shopgate/pwa-core/classes/PipelineRequest';import{generateResultHash,shouldFetchData}from'@shopgate/pwa-common/helpers/redux';import{isNumber}from'@shopgate/pwa-common/helpers/validation';import configuration from'@shopgate/pwa-common/collections/Configuration';import{DEFAULT_PRODUCTS_FETCH_PARAMS}from'@shopgate/pwa-common/constants/Configuration';import{SORT_SCOPE_CATEGORY}from'@shopgate/engage/filter/constants';import{makeGetDefaultSortOrder}from'@shopgate/engage/filter/selectors';import{getFulfillmentParams}from'@shopgate/pwa-common-commerce/product/selectors/product';import{SHOPGATE_CATALOG_GET_PRODUCTS,SHOPGATE_CATALOG_GET_HIGHLIGHT_PRODUCTS,SHOPGATE_CATALOG_GET_LIVESHOPPING_PRODUCTS}from"../constants/Pipelines";import buildRequestFilters from"../../filter/actions/helpers/buildRequestFilters";import requestProducts from"../action-creators/requestProducts";import receiveProducts from"../action-creators/receiveProducts";import errorProducts from"../action-creators/errorProducts";import deleteProductsByIds from"../action-creators/deleteProductsByIds";import receiveProductsCached from"../action-creators/receiveProductsCached";import{makeGetProductResultByCustomHash}from"../selectors/product";/**
  * Process the pipeline params to be compatible.
  * Currently the categoryId field cannot be used in combination with the filter field. In order to
  * use them together the categoryId field has to be extracted into the filter field.
@@ -16,6 +16,7 @@ function _objectWithoutProperties(source,excluded){if(source==null)return{};var
  * @param {Object} options The options for the getProducts request.
  * @param {Object} options.params The params for the getProduct pipeline.
  * @param {string} [options.pipeline='getProducts'] The pipeline to call.
+ * @param {Object} [options.filters = null] Filters object for the request
  * @param {boolean} [options.cached=true] If the result will be cached.
  * @param {?number} [options.cachedTime=null] Cache TTL in ms.
  * @param {?string} [options.id=null] A unique id for the component that is using this action.
@@ -25,15 +26,17 @@ function _objectWithoutProperties(source,excluded){if(source==null)return{};var
  *   into the product hash and the request.
  * @param {Function} [options.onBeforeDispatch=() => {}] A callback which is fired, before new data
  *  will be returned.
+ * @param {boolean} [options.resolveCachedProducts=false] Whether to resolve with products even
+ * when no actual request was done due to cached data.
  * @return {Function} A Redux Thunk
- */function fetchProducts(options){var _options$params=options.params,params=_options$params===void 0?{}:_options$params,_options$filters=options.filters,filters=_options$filters===void 0?null:_options$filters,_options$pipeline=options.pipeline,pipeline=_options$pipeline===void 0?SHOPGATE_CATALOG_GET_PRODUCTS:_options$pipeline,_options$cached=options.cached,cached=_options$cached===void 0?true:_options$cached,_options$cachedTime=options.cachedTime,cachedTime=_options$cachedTime===void 0?null:_options$cachedTime,_options$id=options.id,id=_options$id===void 0?null:_options$id,_options$includeSort=options.includeSort,includeSort=_options$includeSort===void 0?true:_options$includeSort,_options$includeFilte=options.includeFilters,includeFilters=_options$includeFilte===void 0?true:_options$includeFilte,_options$includeFulfi=options.includeFulfillment,includeFulfillment=_options$includeFulfi===void 0?true:_options$includeFulfi,_options$onBeforeDisp=options.onBeforeDispatch,onBeforeDispatch=_options$onBeforeDisp===void 0?function(){}:_options$onBeforeDisp;return function(dispatch,getState){var state=getState();var offset=params.offset,limit=params.limit,hashParams=_objectWithoutProperties(params,["offset","limit"]);var defaultSort=getDefaultSortOrder(state,{scope:SORT_SCOPE_CATEGORY});var _hashParams$sort=hashParams.sort,sort=_hashParams$sort===void 0?defaultSort:_hashParams$sort;var getProductsRequestParams;if(pipeline===SHOPGATE_CATALOG_GET_PRODUCTS){getProductsRequestParams=configuration.get(DEFAULT_PRODUCTS_FETCH_PARAMS);}// Append additional global fulfillment parameters.
+ */function fetchProducts(options){var _options$params=options.params,params=_options$params===void 0?{}:_options$params,_options$filters=options.filters,filters=_options$filters===void 0?null:_options$filters,_options$pipeline=options.pipeline,pipeline=_options$pipeline===void 0?SHOPGATE_CATALOG_GET_PRODUCTS:_options$pipeline,_options$cached=options.cached,cached=_options$cached===void 0?true:_options$cached,_options$cachedTime=options.cachedTime,cachedTime=_options$cachedTime===void 0?null:_options$cachedTime,_options$id=options.id,id=_options$id===void 0?null:_options$id,_options$includeSort=options.includeSort,includeSort=_options$includeSort===void 0?true:_options$includeSort,_options$includeFilte=options.includeFilters,includeFilters=_options$includeFilte===void 0?true:_options$includeFilte,_options$includeFulfi=options.includeFulfillment,includeFulfillment=_options$includeFulfi===void 0?true:_options$includeFulfi,_options$onBeforeDisp=options.onBeforeDispatch,onBeforeDispatch=_options$onBeforeDisp===void 0?function(){}:_options$onBeforeDisp,_options$resolveCache=options.resolveCachedProducts,resolveCachedProducts=_options$resolveCache===void 0?false:_options$resolveCache;return function(dispatch,getState){var state=getState();var offset=params.offset,limit=params.limit,hashParams=_objectWithoutProperties(params,["offset","limit"]);var defaultSort=getDefaultSortOrder(state,{scope:SORT_SCOPE_CATEGORY});var _hashParams$sort=hashParams.sort,sort=_hashParams$sort===void 0?defaultSort:_hashParams$sort;var getProductsRequestParams;if(pipeline===SHOPGATE_CATALOG_GET_PRODUCTS){getProductsRequestParams=configuration.get(DEFAULT_PRODUCTS_FETCH_PARAMS);}// Append additional global fulfillment parameters.
 var fulfillmentParams={};if(includeFulfillment&&pipeline===SHOPGATE_CATALOG_GET_PRODUCTS){fulfillmentParams=getFulfillmentParams(state);}// We need to process the params to handle edge cases in the pipeline params.
 var requestParams=_extends({},fulfillmentParams,{},getProductsRequestParams,{},processParams(params,filters,includeSort,includeFilters));var hash=generateResultHash(_extends({pipeline:pipeline,sort:sort},fulfillmentParams,{},hashParams,{},filters&&Object.keys(filters).length&&{filters:filters},{},id&&{id:id}),includeSort,includeFilters);var result=state.product.resultsByHash[hash];var requiredProductCount=null;// Only set a required number of products if both offset and limit are valid.
 if(isNumber(offset)&&isNumber(limit)){requiredProductCount=offset+limit;}// Stop if we don't need to get any data.
 if(!shouldFetchData(result,'products',requiredProductCount)){var products=result.products;if(Array.isArray(products)){/**
          * Fire the onBeforeDispatch callback to inform
          * a caller that fetchProducts will return data.
-         */onBeforeDispatch();dispatch(receiveProductsCached({hash:hash,requestParams:requestParams,products:products}));return Promise.resolve(result);}return null;}// Fire the onBeforeDispatch callback to inform a caller that fetchProducts will return data.
+         */onBeforeDispatch();dispatch(receiveProductsCached({hash:hash,requestParams:requestParams,products:products}));return Promise.resolve(resolveCachedProducts?makeGetProductResultByCustomHash(hash)(state):result);}return null;}// Fire the onBeforeDispatch callback to inform a caller that fetchProducts will return data.
 onBeforeDispatch();dispatch(requestProducts({hash:hash,cached:cached,cachedTime:cachedTime,requestParams:requestParams}));var request=new PipelineRequest(pipeline).setInput(requestParams).dispatch();request.then(function(response){var totalResultCount=response.totalProductCount;/**
          * When the next check was written, getHighlightProducts and getLiveshoppingProducts
          * didn't deliver a totalProductCount within their responses - they simply returned all

package/product/selectors/product.js

@@ -254,6 +254,11 @@ var _ref5=images[baseProductId]||{},baseProductImages=_ref5.images;if(!Array.isA
  * @param {Object} props The component props.
  * @returns {Object} The product result.
  */export var getProductsResult=createSelector(function(state){return state;},function(state,props){return props;},getResultHash,getResultByHash,getPopulatedProductsResult);/**
+ * Selector factory which creates a selector to retrieve a product results object based on a custom
+ * hash string.
+ * @param {string} hash A resultsByHash hash string
+ * @returns {Function}
+ */export var makeGetProductResultByCustomHash=function makeGetProductResultByCustomHash(hash){var parsedHash=JSON.parse(hash);return createSelector(function(state){return state;},function(state,props){return props;},getProductState,function(state,props,productState){var searchPhrase=props.searchPhrase;var products=[];var totalProductCount=!hash?0:null;var sort=(parsedHash===null||parsedHash===void 0?void 0:parsedHash.sort)||getSortOrder(state,_extends({},props,{scope:typeof searchPhrase==='undefined'?SORT_SCOPE_CATEGORY:SORT_SCOPE_SEARCH}));var result=productState.resultsByHash[hash];if(result&&result.products){totalProductCount=result.totalResultCount;products=result.products.map(function(productId){return getProductById(state,{productId:productId}).productData;});}return{products:products,totalProductCount:totalProductCount,sort:sort,hash:hash};});};/**
  * Selector mappings for PWA < 6.0
  * @deprecated
  */export var getCurrentProduct=getProduct;export var getCurrentProductId=getProductId;export var getCurrentBaseProductId=getBaseProductId;export var getCurrentBaseProduct=getBaseProduct;export var getCurrentProductStock=getProductStock;export var getProductStockInfo=getProductStock;export var getProductBasePrice=getProductUnitPrice;export var isOrderable=isProductOrderable;

package/search/actions/fetchSearchResults.js

@@ -1,8 +1,17 @@
 function _extends(){_extends=Object.assign||function(target){for(var i=1;i<arguments.length;i++){var source=arguments[i];for(var key in source){if(Object.prototype.hasOwnProperty.call(source,key)){target[key]=source[key];}}}return target;};return _extends.apply(this,arguments);}import{ITEMS_PER_LOAD}from'@shopgate/pwa-common/constants/DisplayOptions';import{mutable}from'@shopgate/pwa-common/helpers/redux';import{makeGetDefaultSortOrder}from'@shopgate/engage/filter/selectors';import fetchProducts from"../../product/actions/fetchProducts";import requestSearchResults from"../action-creators/requestSearchResults";import receiveSearchResults from"../action-creators/receiveSearchResults";import errorSearchResults from"../action-creators/errorSearchResults";var getDefaultSortOrder=makeGetDefaultSortOrder();/**
  * Retrieves products for a certain search query.
- * @param {number} params The params for the products to request.
+ * @param {Object} params The params for the search products to request.
+ * @param {string} params.searchPhrase Search phrase for the request
+ * @param {number} [params.offset=0] Offset for the request
+ * @param {number} [params.limit=ITEMS_PER_LOAD] Limit for the request
+ * @param {string} [params.sort=DEFAULT_SORT] Limit for the request
+ * @param {Object} [params.filters = null] Filters object for the request
+ * @param {Object} [params.params = null] Additional params for the fetchProducts pipeline request
+ * @param {number} [params.cachedTime=null] Cache TTL in ms.
+ * @param {boolean} [params.resolveCachedProducts=false] Whether to resolve with products even
+ * when no actual request was done due to cached data.
  * @return {Function} The dispatched action.
- */var fetchSearchResults=function fetchSearchResults(params){return function(dispatch,getState){var defaultSortOrder=getDefaultSortOrder(getState(),{searchPhrase:params.searchPhrase});var _params$offset=params.offset,offset=_params$offset===void 0?0:_params$offset,searchPhrase=params.searchPhrase,_params$limit=params.limit,limit=_params$limit===void 0?ITEMS_PER_LOAD:_params$limit,_params$sort=params.sort,sort=_params$sort===void 0?defaultSortOrder:_params$sort,_params$filters=params.filters,filters=_params$filters===void 0?null:_params$filters,_params$params=params.params,searchParams=_params$params===void 0?null:_params$params,_params$cachedTime=params.cachedTime,cachedTime=_params$cachedTime===void 0?null:_params$cachedTime;if(!searchPhrase){return;}var promise=dispatch(fetchProducts({cachedTime:cachedTime,params:_extends({searchPhrase:searchPhrase,offset:offset,limit:limit,sort:sort},searchParams),filters:filters,onBeforeDispatch:function onBeforeDispatch(){// Dispatch the request action before the related pipeline request is executed.
+ */var fetchSearchResults=function fetchSearchResults(params){return function(dispatch,getState){var defaultSortOrder=getDefaultSortOrder(getState(),{searchPhrase:params.searchPhrase});var _params$offset=params.offset,offset=_params$offset===void 0?0:_params$offset,searchPhrase=params.searchPhrase,_params$limit=params.limit,limit=_params$limit===void 0?ITEMS_PER_LOAD:_params$limit,_params$sort=params.sort,sort=_params$sort===void 0?defaultSortOrder:_params$sort,_params$filters=params.filters,filters=_params$filters===void 0?null:_params$filters,_params$params=params.params,searchParams=_params$params===void 0?null:_params$params,_params$cachedTime=params.cachedTime,cachedTime=_params$cachedTime===void 0?null:_params$cachedTime,_params$resolveCached=params.resolveCachedProducts,resolveCachedProducts=_params$resolveCached===void 0?false:_params$resolveCached;if(!searchPhrase){return;}var promise=dispatch(fetchProducts({cachedTime:cachedTime,params:_extends({searchPhrase:searchPhrase,offset:offset,limit:limit,sort:sort},searchParams),filters:filters,resolveCachedProducts:resolveCachedProducts,onBeforeDispatch:function onBeforeDispatch(){// Dispatch the request action before the related pipeline request is executed.
 dispatch(requestSearchResults(searchPhrase,offset));}}));/**
    * Whenever fetchProducts is able to deliver product data
    * - either via a request or from the cache -