@shopgate/pwa-common-commerce 7.30.0-alpha.7 → 7.30.0-alpha.8

package/product/selectors/product.mock.js

@@ -1,15 +1,330 @@
-import cloneDeep from'lodash/cloneDeep';/* eslint-disable camelcase */export var mockedRouterState={currentRoute:null,stack:[]};export var mockedProductMetadata={some:'product metadata'};export var mockedVariantProductMetadata={some:'variant product metadata'};export var mockedProductsById={// Base product with variants
-product_1:{isFetching:false,productData:{id:'product_1',active:true,baseProductId:null,flags:{hasChildren:false,hasOptions:false,hasVariants:true},stock:{ignoreQuantity:false,quantity:0,info:'Out of stock',orderable:false,minOrderQuantity:1,maxOrderQuantity:10000},metadata:mockedProductMetadata}},// Variant product of product_1
-product_2:{isFetching:false,productData:{id:'product_2',active:true,baseProductId:'product_1',flags:{hasChildren:false,hasOptions:false,hasVariants:false},stock:{ignoreQuantity:true,quantity:200,info:'In stock',orderable:true,minOrderQuantity:1,maxOrderQuantity:10000},metadata:mockedVariantProductMetadata}},// Variant product of product_1 which is not orderable
-product_3:{isFetching:false,productData:{id:'product_3',active:true,baseProductId:'product_1',flags:{hasChildren:false,hasOptions:false,hasVariants:false},stock:{ignoreQuantity:false,quantity:0,info:'Out of stock',orderable:false,minOrderQuantity:1,maxOrderQuantity:10000}}},// Currently fetching product
-product_4:{isFetching:true,productData:null},// Simple product without variants
-product_5:{isFetching:false,productData:{id:'product_5',active:true,baseProductId:null,flags:{hasChildren:false,hasOptions:false,hasVariants:false},name:'Fancy Product',longName:'Fancy Long Product Name',manufacturer:'ACME',price:{currency:'EUR',info:'',unitPrice:90,unitPriceStriked:95,unitPriceMin:0,unitPriceMax:0,unitPriceNet:150,unitPriceWithTax:150,taxAmount:0,taxPercent:0,msrp:100,tiers:[],discount:10},rating:{count:2,average:50,reviewCount:2},stock:{ignoreQuantity:true,quantity:200,info:'In stock',orderable:true,minOrderQuantity:1,maxOrderQuantity:10000},availability:{text:'In stock',state:'ok'},metadata:{some:'metadata'}}},product_7:{isFetching:false,productData:{name:'Short product name'}},// Taken from the original getKnownRelatives() selector test for variants.
-parent:{productData:{id:'parent',baseProductId:null,flags:{hasVariants:true}}},child:{productData:{id:'child',baseProductId:'parent',flags:{hasVariants:false}}},child2:{productData:{id:'child2',baseProductId:'parent',flags:{hasVariants:false}}},notAChild:{productData:{id:'notAChild',baseProductId:'foo',flags:{hasVariants:false}}}};export var mockedShippingByProductId={product_1:{isFetching:false,shipping:{currency:'EUR',price:499}},product_5:{isFetching:true}};export var mockedDescriptionsByProductId={product_1:{isFetching:false,description:'Lorem ipsum dolor'},product_5:{isFetching:true}};export var mockedProperty1={label:'Article No.',value:'9252529931'};export var mockedProperty2={label:'Manufacturer',value:'Nike'};export var mockedPropertiesByProductId={product_1:{isFetching:false,properties:[mockedProperty1,mockedProperty2]},product_5:{isFetching:true}};export var mockedProductImagesBase=['https://img-cdn.shopgate.com/a43fac2d','https://img-cdn.shopgate.com/b543f421'];export var mockedProductImagesVariant=['https://img-cdn.shopgate.com/a43fac2d','https://img-cdn.shopgate.com/b543f421'];export var mockedImagesByProductId={product_1:{isFetching:false,images:mockedProductImagesBase},product_2:{isFetching:false,images:mockedProductImagesVariant},product_3:{isFetching:false,images:[]},product_5:{isFetching:true}};export var mockedVariantMetadata={some:'variant metadata'};export var mockedVariantsByProductId={product_1:{isFetching:false,variants:{products:[{id:'product_2',characteristics:{1:'1'},availability:{text:'In stock',state:'ok'}},{id:'product_3',characteristics:{1:'2'},availability:{text:'Only 3 items left',state:'warning'},metadata:mockedVariantMetadata}],characteristics:[{id:'1',label:'Color',values:[{id:'1',label:'Black'},{id:'2',label:'Green'}]}]}}};export var mockedState={router:mockedRouterState,product:{productsById:mockedProductsById,shippingByProductId:mockedShippingByProductId,descriptionsByProductId:mockedDescriptionsByProductId,propertiesByProductId:mockedPropertiesByProductId,imagesByProductId:mockedImagesByProductId,variantsByProductId:mockedVariantsByProductId,optionsByProductId:{}}};/**
+import cloneDeep from 'lodash/cloneDeep';
+/* eslint-disable camelcase */
+export const mockedRouterState = {
+  currentRoute: null,
+  stack: []
+};
+export const mockedProductMetadata = {
+  some: 'product metadata'
+};
+export const mockedVariantProductMetadata = {
+  some: 'variant product metadata'
+};
+export const mockedProductsById = {
+  // Base product with variants
+  product_1: {
+    isFetching: false,
+    productData: {
+      id: 'product_1',
+      active: true,
+      baseProductId: null,
+      flags: {
+        hasChildren: false,
+        hasOptions: false,
+        hasVariants: true
+      },
+      stock: {
+        ignoreQuantity: false,
+        quantity: 0,
+        info: 'Out of stock',
+        orderable: false,
+        minOrderQuantity: 1,
+        maxOrderQuantity: 10000
+      },
+      metadata: mockedProductMetadata
+    }
+  },
+  // Variant product of product_1
+  product_2: {
+    isFetching: false,
+    productData: {
+      id: 'product_2',
+      active: true,
+      baseProductId: 'product_1',
+      flags: {
+        hasChildren: false,
+        hasOptions: false,
+        hasVariants: false
+      },
+      stock: {
+        ignoreQuantity: true,
+        quantity: 200,
+        info: 'In stock',
+        orderable: true,
+        minOrderQuantity: 1,
+        maxOrderQuantity: 10000
+      },
+      metadata: mockedVariantProductMetadata
+    }
+  },
+  // Variant product of product_1 which is not orderable
+  product_3: {
+    isFetching: false,
+    productData: {
+      id: 'product_3',
+      active: true,
+      baseProductId: 'product_1',
+      flags: {
+        hasChildren: false,
+        hasOptions: false,
+        hasVariants: false
+      },
+      stock: {
+        ignoreQuantity: false,
+        quantity: 0,
+        info: 'Out of stock',
+        orderable: false,
+        minOrderQuantity: 1,
+        maxOrderQuantity: 10000
+      }
+    }
+  },
+  // Currently fetching product
+  product_4: {
+    isFetching: true,
+    productData: null
+  },
+  // Simple product without variants
+  product_5: {
+    isFetching: false,
+    productData: {
+      id: 'product_5',
+      active: true,
+      baseProductId: null,
+      flags: {
+        hasChildren: false,
+        hasOptions: false,
+        hasVariants: false
+      },
+      name: 'Fancy Product',
+      longName: 'Fancy Long Product Name',
+      manufacturer: 'ACME',
+      price: {
+        currency: 'EUR',
+        info: '',
+        unitPrice: 90,
+        unitPriceStriked: 95,
+        unitPriceMin: 0,
+        unitPriceMax: 0,
+        unitPriceNet: 150,
+        unitPriceWithTax: 150,
+        taxAmount: 0,
+        taxPercent: 0,
+        msrp: 100,
+        tiers: [],
+        discount: 10
+      },
+      rating: {
+        count: 2,
+        average: 50,
+        reviewCount: 2
+      },
+      stock: {
+        ignoreQuantity: true,
+        quantity: 200,
+        info: 'In stock',
+        orderable: true,
+        minOrderQuantity: 1,
+        maxOrderQuantity: 10000
+      },
+      availability: {
+        text: 'In stock',
+        state: 'ok'
+      },
+      metadata: {
+        some: 'metadata'
+      }
+    }
+  },
+  product_7: {
+    isFetching: false,
+    productData: {
+      name: 'Short product name'
+    }
+  },
+  // Taken from the original getKnownRelatives() selector test for variants.
+  parent: {
+    productData: {
+      id: 'parent',
+      baseProductId: null,
+      flags: {
+        hasVariants: true
+      }
+    }
+  },
+  child: {
+    productData: {
+      id: 'child',
+      baseProductId: 'parent',
+      flags: {
+        hasVariants: false
+      }
+    }
+  },
+  child2: {
+    productData: {
+      id: 'child2',
+      baseProductId: 'parent',
+      flags: {
+        hasVariants: false
+      }
+    }
+  },
+  notAChild: {
+    productData: {
+      id: 'notAChild',
+      baseProductId: 'foo',
+      flags: {
+        hasVariants: false
+      }
+    }
+  }
+};
+export const mockedShippingByProductId = {
+  product_1: {
+    isFetching: false,
+    shipping: {
+      currency: 'EUR',
+      price: 499
+    }
+  },
+  product_5: {
+    isFetching: true
+  }
+};
+export const mockedDescriptionsByProductId = {
+  product_1: {
+    isFetching: false,
+    description: 'Lorem ipsum dolor'
+  },
+  product_5: {
+    isFetching: true
+  }
+};
+export const mockedProperty1 = {
+  label: 'Article No.',
+  value: '9252529931'
+};
+export const mockedProperty2 = {
+  label: 'Manufacturer',
+  value: 'Nike'
+};
+export const mockedPropertiesByProductId = {
+  product_1: {
+    isFetching: false,
+    properties: [mockedProperty1, mockedProperty2]
+  },
+  product_5: {
+    isFetching: true
+  }
+};
+export const mockedProductImagesBase = ['https://img-cdn.shopgate.com/a43fac2d', 'https://img-cdn.shopgate.com/b543f421'];
+export const mockedProductImagesVariant = ['https://img-cdn.shopgate.com/a43fac2d', 'https://img-cdn.shopgate.com/b543f421'];
+export const mockedImagesByProductId = {
+  product_1: {
+    isFetching: false,
+    images: mockedProductImagesBase
+  },
+  product_2: {
+    isFetching: false,
+    images: mockedProductImagesVariant
+  },
+  product_3: {
+    isFetching: false,
+    images: []
+  },
+  product_5: {
+    isFetching: true
+  }
+};
+export const mockedVariantMetadata = {
+  some: 'variant metadata'
+};
+export const mockedVariantsByProductId = {
+  product_1: {
+    isFetching: false,
+    variants: {
+      products: [{
+        id: 'product_2',
+        characteristics: {
+          1: '1'
+        },
+        availability: {
+          text: 'In stock',
+          state: 'ok'
+        }
+      }, {
+        id: 'product_3',
+        characteristics: {
+          1: '2'
+        },
+        availability: {
+          text: 'Only 3 items left',
+          state: 'warning'
+        },
+        metadata: mockedVariantMetadata
+      }],
+      characteristics: [{
+        id: '1',
+        label: 'Color',
+        values: [{
+          id: '1',
+          label: 'Black'
+        }, {
+          id: '2',
+          label: 'Green'
+        }]
+      }]
+    }
+  }
+};
+export const mockedState = {
+  router: mockedRouterState,
+  product: {
+    productsById: mockedProductsById,
+    shippingByProductId: mockedShippingByProductId,
+    descriptionsByProductId: mockedDescriptionsByProductId,
+    propertiesByProductId: mockedPropertiesByProductId,
+    imagesByProductId: mockedImagesByProductId,
+    variantsByProductId: mockedVariantsByProductId,
+    optionsByProductId: {}
+  }
+};
+
+/**
  * The following mocked states can be used simplified product variant testing. They mimic the
  * product state in different stages of product data fetching.
  * product_1 is the base product of product_2 and product_2.
- */ // Base product and all its variants are available.
-export var mockedVariantStateComplete={product:{productsById:{product_1:cloneDeep(mockedState.product.productsById.product_1),product_2:cloneDeep(mockedState.product.productsById.product_2),product_3:cloneDeep(mockedState.product.productsById.product_3)},variantsByProductId:mockedVariantsByProductId}};// Everything is fetching.
-export var mockedVariantStateAllFetching=cloneDeep(mockedVariantStateComplete);delete mockedVariantStateAllFetching.product.variantsByProductId.product_1;delete mockedVariantStateAllFetching.product.productsById.product_1;delete mockedVariantStateAllFetching.product.productsById.product_2;delete mockedVariantStateAllFetching.product.productsById.product_3;// Base product is available, but variants data and variants ara fetching.
-export var mockedVariantStateVariantDataFetching=cloneDeep(mockedVariantStateComplete);delete mockedVariantStateVariantDataFetching.product.variantsByProductId.product_1;delete mockedVariantStateVariantDataFetching.product.productsById.product_2;delete mockedVariantStateVariantDataFetching.product.productsById.product_3;// Base product and variants data is available, but variants ara fetching.
-export var mockedVariantStateVariantsFetching=cloneDeep(mockedVariantStateComplete);delete mockedVariantStateVariantsFetching.product.productsById.product_2;delete mockedVariantStateVariantsFetching.product.productsById.product_3;/* eslint-enable camelcase */
+ */
+
+// Base product and all its variants are available.
+export const mockedVariantStateComplete = {
+  product: {
+    productsById: {
+      product_1: cloneDeep(mockedState.product.productsById.product_1),
+      product_2: cloneDeep(mockedState.product.productsById.product_2),
+      product_3: cloneDeep(mockedState.product.productsById.product_3)
+    },
+    variantsByProductId: mockedVariantsByProductId
+  }
+};
+
+// Everything is fetching.
+export const mockedVariantStateAllFetching = cloneDeep(mockedVariantStateComplete);
+delete mockedVariantStateAllFetching.product.variantsByProductId.product_1;
+delete mockedVariantStateAllFetching.product.productsById.product_1;
+delete mockedVariantStateAllFetching.product.productsById.product_2;
+delete mockedVariantStateAllFetching.product.productsById.product_3;
+
+// Base product is available, but variants data and variants ara fetching.
+export const mockedVariantStateVariantDataFetching = cloneDeep(mockedVariantStateComplete);
+delete mockedVariantStateVariantDataFetching.product.variantsByProductId.product_1;
+delete mockedVariantStateVariantDataFetching.product.productsById.product_2;
+delete mockedVariantStateVariantDataFetching.product.productsById.product_3;
+
+// Base product and variants data is available, but variants ara fetching.
+export const mockedVariantStateVariantsFetching = cloneDeep(mockedVariantStateComplete);
+delete mockedVariantStateVariantsFetching.product.productsById.product_2;
+delete mockedVariantStateVariantsFetching.product.productsById.product_3;
+
+/* eslint-enable camelcase */

package/product/selectors/relations.js

@@ -1,14 +1,29 @@
-import{createSelector}from'reselect';import{generateProductRelationsHash}from"../helpers";import{getProducts}from"./product";/**
+import { createSelector } from 'reselect';
+import { generateProductRelationsHash } from "../helpers";
+import { getProducts } from "./product";
+
+/**
  * Returns productRelations state.
  * @param {Object} state State.
  * @returns {Object}
  * @deprecated
- */export var getProductRelationsState=function getProductRelationsState(state){return state.product.productRelationsByHash;};/**
+ */
+export const getProductRelationsState = state => state.product.productRelationsByHash;
+
+/**
  * Factory of a function that returns selector of product relations state for given hash.
  * @param {string} hash State hash.
  * @returns {Function}
  * @deprecated
- */export var getProductRelationsByHash=function getProductRelationsByHash(hash){return createSelector(getProductRelationsState,function(state){if(state[hash]){return state[hash].productIds;}return undefined;});};/**
+ */
+export const getProductRelationsByHash = hash => createSelector(getProductRelationsState, state => {
+  if (state[hash]) {
+    return state[hash].productIds;
+  }
+  return undefined;
+});
+
+/**
  * Selector factory.
  * Accepts parameters as arguments. When used within `mapStateToProps` factory won't be called
  * as long as `state` and `props` didn't change (shallow comparison).
@@ -18,10 +33,25 @@ import{createSelector}from'reselect';import{generateProductRelationsHash}from"..
  * @param {number} limit Query limit.
  * @returns {Function} Selector.
  * @deprecated Use `makeGetProductRelations` from `@shopgate/engage/products` instead.
- */export var getProductRelations=function getProductRelations(_ref){var productId=_ref.productId,type=_ref.type,limit=_ref.limit;return function(state){var hash=generateProductRelationsHash({productId:productId,type:type,limit:limit});return getProductRelationsByHash(hash)(state);};};/**
+ */
+export const getProductRelations = ({
+  productId,
+  type,
+  limit
+}) => state => {
+  const hash = generateProductRelationsHash({
+    productId,
+    type,
+    limit
+  });
+  return getProductRelationsByHash(hash)(state);
+};
+
+/**
  * Returns products data for product id.
  *
  * @param {Object} params Params, see `.getProductRelations`
  * @returns {Array}
  * @deprecated Use `makeGetRelatedProducts` from `@shopgate/engage/products` instead.
- */export var getRelatedProducts=function getRelatedProducts(params){return createSelector(getProductRelations(params),getProducts,function(){var relations=arguments.length>0&&arguments[0]!==undefined?arguments[0]:[];var productsById=arguments.length>1?arguments[1]:undefined;return relations.filter(function(id){return productsById[id]&&productsById[id].productData;}).map(function(id){return productsById[id].productData;});});};
+ */
+export const getRelatedProducts = params => createSelector(getProductRelations(params), getProducts, (relations = [], productsById) => relations.filter(id => productsById[id] && productsById[id].productData).map(id => productsById[id].productData));

package/product/selectors/variants.js

@@ -1,29 +1,105 @@
-import{createSelector}from'reselect';import{getProducts,getProductById,getProductVariants,hasBaseProductVariants,isVariantSelected,getSelectedVariant,getVariantProductId}from"./product";/**
+import "core-js/modules/es.regexp.flags.js";
+import { createSelector } from 'reselect';
+import { getProducts, getProductById, getProductVariants, hasBaseProductVariants, isVariantSelected, getSelectedVariant, getVariantProductId } from "./product";
+
+/**
  * Retrieves the metadata from the product data within the variants.
  * @param {Object} state The current application state.
  * @param {Object} props The component props.
  * @return {Object|null}
- */export var getSelectedVariantMetadata=createSelector(getProductVariants,getSelectedVariant,getVariantProductId,function(variants,variant,variantId){if(!variants&&!variant){return null;}// Prefer variant data, if available
-if(variants&&variantId!==null){// Get the product data of the selected product from the variants.
-var _ref2=variants.products.find(function(_ref3){var id=_ref3.id;return id===variantId;})||{},metadata=_ref2.metadata;if(metadata){return metadata;}}// Check if variant data is available in product list
-// istanbul ignore else
-if(variant){return variant.metadata;}/**
-     * This statement should never be reached since getProductVariants will not return data when the
-     * variant product entity can't be found to determine a baseProductId.
-     */ // istanbul ignore next
-return null;});/**
+ */
+export const getSelectedVariantMetadata = createSelector(getProductVariants, getSelectedVariant, getVariantProductId, (variants, variant, variantId) => {
+  if (!variants && !variant) {
+    return null;
+  }
+  // Prefer variant data, if available
+  if (variants && variantId !== null) {
+    // Get the product data of the selected product from the variants.
+    const {
+      metadata
+    } = variants.products.find(({
+      id
+    }) => id === variantId) || {};
+    if (metadata) {
+      return metadata;
+    }
+  }
+
+  // Check if variant data is available in product list
+  // istanbul ignore else
+  if (variant) {
+    return variant.metadata;
+  }
+
+  /**
+   * This statement should never be reached since getProductVariants will not return data when the
+   * variant product entity can't be found to determine a baseProductId.
+   */
+
+  // istanbul ignore next
+  return null;
+});
+
+/**
  * Matches all products relatives which are already fetched and stored in redux.
  * If this ever would be too slow, the calculation should happen in the reducer.
  * @param {Object} state Current state.
  * @returns {Object}
- */export var getKnownProductRelatives=createSelector([getProducts],function(products){var relativesByBaseProductId={};Object.keys(products).forEach(function(id){if(!products[id].productData){// It's possible that product has no data yet. Skip it then.
-return;}var productData=products[id].productData;var parentId=productData.id;if(productData.baseProductId){parentId=productData.baseProductId;}if(!relativesByBaseProductId[parentId]){relativesByBaseProductId[parentId]=[];}relativesByBaseProductId[parentId].push(productData.id);if(parentId!==productData.id&&!relativesByBaseProductId[parentId].includes(parentId)){relativesByBaseProductId[parentId].push(parentId);}});return relativesByBaseProductId;});/**
+ */
+export const getKnownProductRelatives = createSelector([getProducts], products => {
+  const relativesByBaseProductId = {};
+  Object.keys(products).forEach(id => {
+    if (!products[id].productData) {
+      // It's possible that product has no data yet. Skip it then.
+      return;
+    }
+    const {
+      productData
+    } = products[id];
+    let parentId = productData.id;
+    if (productData.baseProductId) {
+      parentId = productData.baseProductId;
+    }
+    if (!relativesByBaseProductId[parentId]) {
+      relativesByBaseProductId[parentId] = [];
+    }
+    relativesByBaseProductId[parentId].push(productData.id);
+    if (parentId !== productData.id && !relativesByBaseProductId[parentId].includes(parentId)) {
+      relativesByBaseProductId[parentId].push(parentId);
+    }
+  });
+  return relativesByBaseProductId;
+});
+
+/**
  * Returns relatives which are already fetched into a client app for given product id.
  * @param {Object} state Current state.
  * @param {string} productId Product id.
  * @returns {Array}
- */export var getKnownRelatives=createSelector(getProductById,getKnownProductRelatives,function(product,knownRelations){if(!product){return[];}var productData=product.productData;var parentId=productData.id;// Product is parent.
-if(productData.flags.hasVariants){parentId=productData.id;}else if(productData.baseProductId){parentId=productData.baseProductId;}return knownRelations[parentId]||[];});/**
+ */
+export const getKnownRelatives = createSelector(getProductById, getKnownProductRelatives, (product, knownRelations) => {
+  if (!product) {
+    return [];
+  }
+  const {
+    productData
+  } = product;
+  let parentId = productData.id;
+  // Product is parent.
+  if (productData.flags.hasVariants) {
+    parentId = productData.id;
+  } else if (productData.baseProductId) {
+    parentId = productData.baseProductId;
+  }
+  return knownRelations[parentId] || [];
+});
+
+/**
  * Selector mappings for PWA < 6.0
  * @deprecated
- */export var getCurrentProductVariantId=getVariantProductId;export var hasCurrentProductVariants=hasBaseProductVariants;export var isProductChildrenSelected=isVariantSelected;export var getVariantsByProductId=getProductVariants;export var getCurrentBaseProductVariants=getProductVariants;
+ */
+export const getCurrentProductVariantId = getVariantProductId;
+export const hasCurrentProductVariants = hasBaseProductVariants;
+export const isProductChildrenSelected = isVariantSelected;
+export const getVariantsByProductId = getProductVariants;
+export const getCurrentBaseProductVariants = getProductVariants;