@shopgate/engage 7.30.0-alpha.7 → 7.30.0-alpha.9

package/locations/locations.context.js

@@ -1 +1,78 @@
-import{createContext}from'react';import{STAGE_SELECT_STORE}from"./constants";export var FulfillmentContext=createContext({selectLocation:function selectLocation(){return Promise.resolve();},selectStoreFinderLocation:function selectStoreFinderLocation(){},changeFulfillment:function changeFulfillment(){},sendReservation:function sendReservation(){return Promise.resolve();},isStage:function isStage(){return false;},handleOpen:function handleOpen(){},handleClose:function handleClose(){},setIsLoading:function setIsLoading(){},location:null,storeFinderLocation:null,locations:[],orderNumbers:[],baseProduct:null,product:null,userInput:null,stage:STAGE_SELECT_STORE,title:null,fulfillmentPath:null,fulfillmentMethods:null,enabledFulfillmentMethods:null,shopSettings:null,isOpen:false,errors:null,noLocationSelection:false,isStoreFinder:false,isLoading:false});export var StoreFinderContext=createContext({});
+import { createContext } from 'react';
+import { STAGE_SELECT_STORE } from "./constants";
+/* eslint-disable max-len */
+/** @typedef {import('@shopgate/engage/locations/locations.types').Location} Location */
+/** @typedef {import('@shopgate/engage/locations/locations.types').ReservationFormValues} ReservationFormValues */
+/** @typedef {import('@shopgate/engage/locations/locations.types').SheetStage} SheetStage */
+/** @typedef {import('@shopgate/engage/locations/locations.types').FulfillmentPath} FulfillmentPath */
+/** @typedef {import('@shopgate/engage/locations/locations.types').SheetOpenParams} SheetOpenParams */
+/** @typedef {import('@shopgate/engage/locations/locations.types').SheetCallbackFn} SheetCallbackFn */
+/** @typedef {import('../product/product.types').Product} Product */
+/** @typedef {import('../core/config/config.types').ShopSettings} ShopSettings */
+/* eslint-enable max-len */
+
+/**
+ * @typedef {Object} FulfillmentContextProps
+ * @property {function(Location): Promise<void>} selectLocation
+ * @property {function(Location): void} selectStoreFinderLocation
+ * @property {(method: string, cartItem: Object<string, any>) => void} changeFulfillment
+ * @property {function(ReservationFormValues): Promise<void>} sendReservation
+ * @property {function(SheetStage): boolean} isStage
+ * @property {function(SheetOpenParams): void} handleOpen
+ * @property {(isLoading: boolean) => void} setIsLoading
+ * @property {SheetCallbackFn} handleClose
+ * @property {Location|null} location
+ * @property {Location|null} storeFinderLocation
+ * @property {Location[]|null} locations
+ * @property {string[]|null} orderNumbers
+ * @property {Product|null} baseProduct
+ * @property {Product|null} product
+ * @property {ReservationFormValues|null} userInput
+ * @property {SheetStage|null} stage
+ * @property {string|null} title
+ * @property {FulfillmentPath|null} fulfillmentPath
+ * @property {string[]|null} fulfillmentMethods
+ * @property {string[]|null} enabledFulfillmentMethods
+ * @property {ShopSettings|null} shopSettings
+ * @property {boolean} isOpen
+ * @property {string[]|null} errors
+ * @property {boolean} [noLocationSelection]
+ * @property {boolean} [isStoreFinder]
+ * @property {boolean} [isLoading]
+ * @property {Object} [meta]
+ */
+
+export const FulfillmentContext = /*#__PURE__*/createContext(/** @type {FulfillmentContextProps} */{
+  selectLocation: () => Promise.resolve(),
+  selectStoreFinderLocation: () => {},
+  changeFulfillment: () => {},
+  sendReservation: () => Promise.resolve(),
+  isStage: () => false,
+  handleOpen: () => {},
+  handleClose: () => {},
+  setIsLoading: () => {},
+  location: null,
+  storeFinderLocation: null,
+  locations: [],
+  orderNumbers: [],
+  baseProduct: null,
+  product: null,
+  userInput: null,
+  stage: STAGE_SELECT_STORE,
+  title: null,
+  fulfillmentPath: null,
+  fulfillmentMethods: null,
+  enabledFulfillmentMethods: null,
+  shopSettings: null,
+  isOpen: false,
+  errors: null,
+  noLocationSelection: false,
+  isStoreFinder: false,
+  isLoading: false
+});
+
+/**
+ * @typedef {Object} StoreFinderContextProps
+ */
+
+export const StoreFinderContext = /*#__PURE__*/createContext(/** @type {StoreFinderContextProps} */{});

package/locations/locations.hooks.js

@@ -1,4 +1,10 @@
-import*as React from'react';import{FulfillmentContext}from"./locations.context";/**
+import * as React from 'react';
+import { FulfillmentContext } from "./locations.context";
+
+/**
  * Returns the fulfillment context state.
  * @returns {Object} The fulfillment context state.
- */export function useFulfillmentState(){return React.useContext(FulfillmentContext);}
+ */
+export function useFulfillmentState() {
+  return React.useContext(FulfillmentContext);
+}

package/locations/locations.streams.js

@@ -1,3 +1,175 @@
-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{main$}from'@shopgate/pwa-common/streams';import{Observable}from'rxjs/Observable';import{cartReceived$}from'@shopgate/pwa-common-commerce/cart/streams';import{makeGetRoutePattern,getCurrentState,getCurrentRoute}from'@shopgate/pwa-common/selectors/router';import{routeWillEnter$}from'@shopgate/pwa-common/streams/router';import{ITEM_PATTERN}from'@shopgate/pwa-common-commerce/product/constants';import{getProductDataById}from'@shopgate/pwa-common-commerce/product/selectors/product';import{SEARCH_PATTERN}from'@shopgate/pwa-common-commerce/search/constants';import{CATEGORY_PATTERN}from'@shopgate/pwa-common-commerce/category/constants';import{FAVORITES_PATH}from'@shopgate/pwa-common-commerce/favorites/constants';import{SUBMIT_RESERVATION_SUCCESS,RECEIVE_PRODUCT_LOCATIONS,RECEIVE_LOCATIONS,SET_USER_SEARCH_COUNTRY_CODE,SET_USER_SEARCH_POSTAL_CODE,SET_USER_SEARCH_GEOLOCATION,SET_STORE_FINDER_SEARCH_RADIUS,SELECT_GLOBAL_LOCATION,STORE_FINDER_PATTERN,PROVIDE_PRODUCT_ALTERNATIVE_LOCATION,SELECT_LOCATION,STORE_DETAILS_PATTERN,SEND_SET_DEFAULT_LOCATION_CODE_SUCCESS}from"./constants";import{RECEIVE_ORDER_DETAILS}from"../orders/constants";import{WISH_LIST_PATH}from"../account/constants";export var submitReservationSuccess$=main$.filter(function(_ref){var action=_ref.action;return action.type===SUBMIT_RESERVATION_SUCCESS;});export var receiveProductLocations$=main$.filter(function(_ref2){var action=_ref2.action;return action.type===RECEIVE_PRODUCT_LOCATIONS;});export var receiveOrderDetails$=main$.filter(function(_ref3){var action=_ref3.action;return action.type===RECEIVE_ORDER_DETAILS;});export var cartReceivedWithROPE$=cartReceived$.filter(function(_ref4){var _ref4$action$cart=_ref4.action.cart,_ref4$action$cart2=_ref4$action$cart===void 0?{}:_ref4$action$cart,_ref4$action$cart2$ca=_ref4$action$cart2.cartItems,cartItems=_ref4$action$cart2$ca===void 0?[]:_ref4$action$cart2$ca;return cartItems.some(function(item){var _item$fulfillment,_item$fulfillment$loc;return item===null||item===void 0?void 0:(_item$fulfillment=item.fulfillment)===null||_item$fulfillment===void 0?void 0:(_item$fulfillment$loc=_item$fulfillment.location)===null||_item$fulfillment$loc===void 0?void 0:_item$fulfillment$loc.code;});});export var userSearchChanged$=main$.filter(function(_ref5){var action=_ref5.action;return action.type===SET_USER_SEARCH_COUNTRY_CODE||action.type===SET_USER_SEARCH_POSTAL_CODE||action.type===SET_USER_SEARCH_GEOLOCATION||action.type===SET_STORE_FINDER_SEARCH_RADIUS;});export var fulfillmentLocationsReceivedFromProduct$=receiveProductLocations$.switchMap(function(data){var locations=data.action.locations;var locationCodes=locations.map(function(_ref6){var code=_ref6.code;return code;});return Observable.of(_extends({},data,{locationCodes:locationCodes}));});export var fulfillmentLocationsReceivedFromCart$=cartReceivedWithROPE$.switchMap(function(data){var _data$action$cart=data.action.cart,_data$action$cart2=_data$action$cart===void 0?{}:_data$action$cart,_data$action$cart2$ca=_data$action$cart2.cartItems,cartItems=_data$action$cart2$ca===void 0?[]:_data$action$cart2$ca;var locationCodes=cartItems.map(function(item){var _item$fulfillment2,_item$fulfillment2$lo;return item===null||item===void 0?void 0:(_item$fulfillment2=item.fulfillment)===null||_item$fulfillment2===void 0?void 0:(_item$fulfillment2$lo=_item$fulfillment2.location)===null||_item$fulfillment2$lo===void 0?void 0:_item$fulfillment2$lo.code;}).filter(Boolean);locationCodes=Array.from(new Set(locationCodes));return Observable.of(_extends({},data,{locationCodes:locationCodes}));});export var fulfillmentLocationsReceivedFromOrder$=receiveOrderDetails$.filter(function(_ref7){var _ref7$action$order=_ref7.action.order,_ref7$action$order2=_ref7$action$order===void 0?{}:_ref7$action$order,_ref7$action$order2$l=_ref7$action$order2.lineItems,lineItems=_ref7$action$order2$l===void 0?[]:_ref7$action$order2$l;return lineItems.some(function(item){return item.fulfillmentLocationCode;});}).switchMap(function(data){var _data$action$order=data.action.order,_data$action$order2=_data$action$order===void 0?{}:_data$action$order,_data$action$order2$l=_data$action$order2.lineItems,lineItems=_data$action$order2$l===void 0?[]:_data$action$order2$l;var locationCodes=lineItems.map(function(item){return item===null||item===void 0?void 0:item.fulfillmentLocationCode;}).filter(Boolean);locationCodes=Array.from(new Set(locationCodes));return Observable.of(_extends({},data,{locationCodes:locationCodes}));});export var fulfillmentLocationsReceived$=fulfillmentLocationsReceivedFromCart$.merge(fulfillmentLocationsReceivedFromOrder$).merge(fulfillmentLocationsReceivedFromProduct$);export var preferredLocationDidUpdateGlobal$=main$.filter(function(_ref8){var action=_ref8.action;return action.type===SELECT_GLOBAL_LOCATION;});export var preferredLocationDidUpdateGlobalOnWishlist$=preferredLocationDidUpdateGlobal$.filter(function(_ref9){var getState=_ref9.getState;var _getCurrentRoute=getCurrentRoute(getState()),pattern=_getCurrentRoute.pattern;return pattern===FAVORITES_PATH||pattern===WISH_LIST_PATH;});export var preferredLocationDidUpdateGlobalOnSearch$=preferredLocationDidUpdateGlobal$.filter(function(_ref10){var getState=_ref10.getState;var _getCurrentRoute2=getCurrentRoute(getState()),pattern=_getCurrentRoute2.pattern;return pattern===SEARCH_PATTERN;});export var preferredLocationDidUpdateGlobalNotOnSearch$=preferredLocationDidUpdateGlobal$.filter(function(_ref11){var getState=_ref11.getState;var _getCurrentRoute3=getCurrentRoute(getState()),pattern=_getCurrentRoute3.pattern;return pattern!==SEARCH_PATTERN;});export var preferredLocationDidUpdateGlobalOnCategory$=preferredLocationDidUpdateGlobal$.filter(function(_ref12){var getState=_ref12.getState;var _getCurrentRoute4=getCurrentRoute(getState()),pattern=_getCurrentRoute4.pattern;return pattern===CATEGORY_PATTERN;});export var preferredLocationDidUpdateGlobalNotOnCategory$=preferredLocationDidUpdateGlobal$.filter(function(_ref13){var getState=_ref13.getState;var _getCurrentRoute5=getCurrentRoute(getState()),pattern=_getCurrentRoute5.pattern;return pattern!==CATEGORY_PATTERN;});/**
+import { main$ } from '@shopgate/pwa-common/streams';
+import { Observable } from 'rxjs/Observable';
+import { cartReceived$ } from '@shopgate/pwa-common-commerce/cart/streams';
+import { makeGetRoutePattern, getCurrentState, getCurrentRoute } from '@shopgate/pwa-common/selectors/router';
+import { routeWillEnter$ } from '@shopgate/pwa-common/streams/router';
+import { ITEM_PATTERN } from '@shopgate/pwa-common-commerce/product/constants';
+import { getProductDataById } from '@shopgate/pwa-common-commerce/product/selectors/product';
+import { SEARCH_PATTERN } from '@shopgate/pwa-common-commerce/search/constants';
+import { CATEGORY_PATTERN } from '@shopgate/pwa-common-commerce/category/constants';
+import { FAVORITES_PATH } from '@shopgate/pwa-common-commerce/favorites/constants';
+import { SUBMIT_RESERVATION_SUCCESS, RECEIVE_PRODUCT_LOCATIONS, RECEIVE_LOCATIONS, SET_USER_SEARCH_COUNTRY_CODE, SET_USER_SEARCH_POSTAL_CODE, SET_USER_SEARCH_GEOLOCATION, SET_STORE_FINDER_SEARCH_RADIUS, SELECT_GLOBAL_LOCATION, STORE_FINDER_PATTERN, PROVIDE_PRODUCT_ALTERNATIVE_LOCATION, SELECT_LOCATION, STORE_DETAILS_PATTERN, SEND_SET_DEFAULT_LOCATION_CODE_SUCCESS } from "./constants";
+import { RECEIVE_ORDER_DETAILS } from "../orders/constants";
+import { WISH_LIST_PATH } from "../account/constants";
+export const submitReservationSuccess$ = main$.filter(({
+  action
+}) => action.type === SUBMIT_RESERVATION_SUCCESS);
+export const receiveProductLocations$ = main$.filter(({
+  action
+}) => action.type === RECEIVE_PRODUCT_LOCATIONS);
+export const receiveOrderDetails$ = main$.filter(({
+  action
+}) => action.type === RECEIVE_ORDER_DETAILS);
+export const cartReceivedWithROPE$ = cartReceived$.filter(({
+  action: {
+    cart: {
+      cartItems = []
+    } = {}
+  }
+}) => cartItems.some(item => item?.fulfillment?.location?.code));
+export const userSearchChanged$ = main$.filter(({
+  action
+}) => action.type === SET_USER_SEARCH_COUNTRY_CODE || action.type === SET_USER_SEARCH_POSTAL_CODE || action.type === SET_USER_SEARCH_GEOLOCATION || action.type === SET_STORE_FINDER_SEARCH_RADIUS);
+export const fulfillmentLocationsReceivedFromProduct$ = receiveProductLocations$.switchMap(data => {
+  const {
+    action: {
+      locations
+    }
+  } = data;
+  const locationCodes = locations.map(({
+    code
+  }) => code);
+  return Observable.of({
+    ...data,
+    locationCodes
+  });
+});
+export const fulfillmentLocationsReceivedFromCart$ = cartReceivedWithROPE$.switchMap(data => {
+  const {
+    action: {
+      cart: {
+        cartItems = []
+      } = {}
+    }
+  } = data;
+  let locationCodes = cartItems.map(item => item?.fulfillment?.location?.code).filter(Boolean);
+  locationCodes = Array.from(new Set(locationCodes));
+  return Observable.of({
+    ...data,
+    locationCodes
+  });
+});
+export const fulfillmentLocationsReceivedFromOrder$ = receiveOrderDetails$.filter(({
+  action: {
+    order: {
+      lineItems = []
+    } = {}
+  }
+}) => lineItems.some(item => item.fulfillmentLocationCode)).switchMap(data => {
+  const {
+    action: {
+      order: {
+        lineItems = []
+      } = {}
+    }
+  } = data;
+  let locationCodes = lineItems.map(item => item?.fulfillmentLocationCode).filter(Boolean);
+  locationCodes = Array.from(new Set(locationCodes));
+  return Observable.of({
+    ...data,
+    locationCodes
+  });
+});
+export const fulfillmentLocationsReceived$ = fulfillmentLocationsReceivedFromCart$.merge(fulfillmentLocationsReceivedFromOrder$).merge(fulfillmentLocationsReceivedFromProduct$);
+export const preferredLocationDidUpdateGlobal$ = main$.filter(({
+  action
+}) => action.type === SELECT_GLOBAL_LOCATION);
+export const preferredLocationDidUpdateGlobalOnWishlist$ = preferredLocationDidUpdateGlobal$.filter(({
+  getState
+}) => {
+  const {
+    pattern
+  } = getCurrentRoute(getState());
+  return pattern === FAVORITES_PATH || pattern === WISH_LIST_PATH;
+});
+export const preferredLocationDidUpdateGlobalOnSearch$ = preferredLocationDidUpdateGlobal$.filter(({
+  getState
+}) => {
+  const {
+    pattern
+  } = getCurrentRoute(getState());
+  return pattern === SEARCH_PATTERN;
+});
+export const preferredLocationDidUpdateGlobalNotOnSearch$ = preferredLocationDidUpdateGlobal$.filter(({
+  getState
+}) => {
+  const {
+    pattern
+  } = getCurrentRoute(getState());
+  return pattern !== SEARCH_PATTERN;
+});
+export const preferredLocationDidUpdateGlobalOnCategory$ = preferredLocationDidUpdateGlobal$.filter(({
+  getState
+}) => {
+  const {
+    pattern
+  } = getCurrentRoute(getState());
+  return pattern === CATEGORY_PATTERN;
+});
+export const preferredLocationDidUpdateGlobalNotOnCategory$ = preferredLocationDidUpdateGlobal$.filter(({
+  getState
+}) => {
+  const {
+    pattern
+  } = getCurrentRoute(getState());
+  return pattern !== CATEGORY_PATTERN;
+});
+
+/**
  * Emits when users select a new location
- */export var preferredLocationDidUpdate$=main$.filter(function(_ref14){var action=_ref14.action;return action.type===SELECT_LOCATION;});export var storeFinderWillEnter$=routeWillEnter$.filter(function(_ref15){var action=_ref15.action;return action.route.pattern===STORE_FINDER_PATTERN;});export var receiveLocations$=main$.filter(function(_ref16){var action=_ref16.action;return action.type===RECEIVE_LOCATIONS;});export var provideAlternativeLocation$=main$.filter(function(_ref17){var action=_ref17.action;return action.type===PROVIDE_PRODUCT_ALTERNATIVE_LOCATION;});export var preferredLocationDidUpdateOnPDP$=preferredLocationDidUpdateGlobal$.filter(function(_ref18){var getState=_ref18.getState;var getRoutePattern=makeGetRoutePattern();var routePattern=getRoutePattern(getState());return routePattern===ITEM_PATTERN;}).switchMap(function(_ref19){var dispatch=_ref19.dispatch,getState=_ref19.getState,action=_ref19.action;var state=getState();var _getCurrentState=getCurrentState(state),productId=_getCurrentState.productId;var productData=getProductDataById(state,{productId:productId});return Observable.of({action:_extends({},action,{productData:productData}),dispatch:dispatch,getState:getState});});export var storeDetailPageWillEnter$=routeWillEnter$.filter(function(_ref20){var action=_ref20.action;return action.route.pattern===STORE_DETAILS_PATTERN;});export var sendDefaultLocationCodeSuccess$=main$.filter(function(_ref21){var action=_ref21.action;return action.type===SEND_SET_DEFAULT_LOCATION_CODE_SUCCESS;});
+ */
+export const preferredLocationDidUpdate$ = main$.filter(({
+  action
+}) => action.type === SELECT_LOCATION);
+export const storeFinderWillEnter$ = routeWillEnter$.filter(({
+  action
+}) => action.route.pattern === STORE_FINDER_PATTERN);
+export const receiveLocations$ = main$.filter(({
+  action
+}) => action.type === RECEIVE_LOCATIONS);
+export const provideAlternativeLocation$ = main$.filter(({
+  action
+}) => action.type === PROVIDE_PRODUCT_ALTERNATIVE_LOCATION);
+export const preferredLocationDidUpdateOnPDP$ = preferredLocationDidUpdateGlobal$.filter(({
+  getState
+}) => {
+  const getRoutePattern = makeGetRoutePattern();
+  const routePattern = getRoutePattern(getState());
+  return routePattern === ITEM_PATTERN;
+}).switchMap(({
+  dispatch,
+  getState,
+  action
+}) => {
+  const state = getState();
+  const {
+    productId
+  } = getCurrentState(state);
+  const productData = getProductDataById(state, {
+    productId
+  });
+  return Observable.of({
+    action: {
+      ...action,
+      productData
+    },
+    dispatch,
+    getState
+  });
+});
+export const storeDetailPageWillEnter$ = routeWillEnter$.filter(({
+  action
+}) => action.route.pattern === STORE_DETAILS_PATTERN);
+export const sendDefaultLocationCodeSuccess$ = main$.filter(({
+  action
+}) => action.type === SEND_SET_DEFAULT_LOCATION_CODE_SUCCESS);

package/locations/locations.types.js

@@ -1 +1,170 @@
-import{DIRECT_SHIP,ROPIS,BOPIS,STAGE_SELECT_STORE,STAGE_RESERVE_FORM,STAGE_RESPONSE_SUCCESS,STAGE_RESPONSE_ERROR,QUICK_RESERVE,MULTI_LINE_RESERVE}from"./constants";
+/**
+ * @typedef {Object} LocationType
+ * @property {string} code
+ * @property {string} name
+ */
+
+/**
+ * @typedef {Object} LocationOperationHours
+ * @property {string|null} sun
+ * @property {string|null} mon
+ * @property {string|null} tue
+ * @property {string|null} wed
+ * @property {string|null} thu
+ * @property {string|null} fri
+ * @property {string|null} sat
+ */
+
+/**
+ * @typedef {Object} LocationProductInventory
+ * @property {boolean} isAvailable
+ * @property {number|null} visible
+ */
+
+/**
+ * @typedef {Object} LocationAddress
+ * @property {string} code
+ * @property {string} name
+ * @property {string} street
+ * @property {string|null} street2
+ * @property {string|null} street3
+ * @property {string|null} street4
+ * @property {string} postalCode
+ * @property {string} city
+ * @property {string} region
+ * @property {string} country
+ * @property {string} [phoneNumber]
+ * @property {string} [faxNumber]
+ * @property {string} [emailAddress]
+ * @property {boolean} isPrimary
+ */
+
+/**
+ * @typedef {Object} Location
+ * @property {string|null} code
+ * @property {string|null} name
+ * @property {string} [status]
+ * @property {string[]} [supportedFulfillmentMethods]
+ * @property {number} [latitude]
+ * @property {number} [longitude]
+ * @property {string} [timeZone]
+ * @property {string} [localeCode]
+ * @property {boolean} [isComingSoon]
+ * @property {boolean} [isDefault]
+ * @property {LocationType} [type]
+ * @property {LocationOperationHours} [operationHours]
+ * @property {LocationAddress} [address]
+ * @property {LocationAddress[]} [addresses]
+ * @property {LocationProductInventory} [productInventory]
+ * @property {number} [distance]
+ * @property {string} [unitSystem]
+ * @property {Object} [inventory]
+ */
+
+/**
+ * @typedef {Object} LocationAware
+ * @property {Location} location
+ * @property {string|null} [fulfillmentMethod]
+ */
+
+/**
+ * @typedef {Object} OptionalLocationAware
+ * @property {Location|null} [location]
+ * @property {string|null} [fulfillmentMethod]
+ */
+
+/**
+ * @typedef {Object} ProductLocations
+ * @property {boolean} isFetching
+ * @property {number} expires
+ * @property {Location[]} locations
+ */
+
+/**
+ * @typedef {Object<string, Location>} LocationsByIdState
+ */
+
+/**
+ * @typedef {Object<string, ProductLocations>} LocationsByProductIdState
+ */
+
+/**
+ * @typedef {Object} UserLocationState
+ * @property {string|null} code
+ * @property {string|null} name
+ * @property {string|null} productCode
+ * @property {number|null} visibleInventory
+ * @property {string|null} addressCode
+ * @property {string|null} fulfillmentMethod
+ */
+
+/**
+ * @typedef {Object} ReservationFormValues
+ * @property {string} [firstName]
+ * @property {string} [lastName]
+ * @property {string} [cellPhone]
+ * @property {string} [email]
+ * @property {string} [firstName2]
+ * @property {string} [lastName2]
+ * @property {string} [cellPhone2]
+ * @property {string} [email2]
+ */
+
+/**
+ * @typedef {Object<string, string|null>} UserFormInputState
+ */
+
+/**
+ * @typedef {(
+ *   typeof import('./constants').QUICK_RESERVE |
+ *   typeof import('./constants').MULTI_LINE_RESERVE
+ * )} FulfillmentPath
+ */
+
+/**
+ * @callback SheetCallbackFn
+ * @param {import('../../locations.types').Location | null} location
+ * @param {string | null} productId
+ * @param {boolean | null} orderSuccess
+ * @returns {void}
+ */
+
+/**
+ * @typedef {(typeof DIRECT_SHIP | typeof ROPIS| typeof BOPIS)} UserLocationFulfillmentMethod
+ */
+
+/**
+ * @typedef {string | null} UserLocationLocationCode
+ */
+
+/**
+ * @typedef {Object} LocationsState
+ * @property {LocationsByIdState|{}} locationsById
+ * @property {LocationsByProductIdState|{}} locationsByProductId
+ * @property {UserLocationState|{}} userLocation
+ * @property {ReservationFormValues} userFormInput
+ * @property {string} userSearchQuery
+ */
+
+/**
+ * @typedef {(
+ *   typeof import('./constants').STAGE_SELECT_STORE |
+ *   typeof import('./constants').STAGE_RESERVE_FORM |
+ *   typeof import('./constants').STAGE_RESPONSE_SUCCESS |
+ *   typeof import('./constants').STAGE_RESPONSE_ERROR
+ * )} SheetStage
+ */
+
+/**
+ * @typedef {Object} SheetOpenParams
+ * @property {SheetCallbackFn} [callback]
+ * @property {SheetStage} [stage]
+ * @property {FulfillmentPath} [fulfillmentPath]
+ * @property {boolean} [changeOnly]
+ */
+
+/**
+ * @typedef {Object} ReservationResponse
+ * @property {string[]|null} orderNumbers
+ * @property {string[]|null} errors
+ */

package/locations/providers/FulfillmentProvider.connector.js

@@ -1,10 +1,68 @@
-import{connect}from'react-redux';import _showModal from'@shopgate/pwa-common/actions/modal/showModal';import{getBaseProduct,getProduct}from'@shopgate/pwa-common-commerce/product/selectors/product';import _addProductsToCart from'@shopgate/pwa-common-commerce/cart/actions/addProductsToCart';import _updateProductsInCart from'@shopgate/pwa-common-commerce/cart/actions/updateProductsInCart';import{getCartProducts,getActiveFulfillmentSlot,getActiveFulfillmentSlotLocationCode}from'@shopgate/engage/cart/cart.selectors';import{makeGetFulfillmentPaths,makeGetEnabledFulfillmentMethods,getShopSettings}from'@shopgate/engage/core/config';import{getRestrictMultiLocationOrders,getFulfillmentSchedulingEnabled}from'@shopgate/engage/core';import{selectLocation as _selectLocation,storeFormInput as _storeFormInput}from"../action-creators";import{getFilteredLocations,makeGetLocationInventory,makeGetLocationsForProduct,getPreferredLocation,getUserFormInput,getProductFulfillmentMethods,getIsFetching}from"../selectors";import{submitReservation as _submitReservation}from"../actions";/**
+import { connect } from 'react-redux';
+import showModal from '@shopgate/pwa-common/actions/modal/showModal';
+import { getBaseProduct, getProduct } from '@shopgate/pwa-common-commerce/product/selectors/product';
+import addProductsToCart from '@shopgate/pwa-common-commerce/cart/actions/addProductsToCart';
+import updateProductsInCart from '@shopgate/pwa-common-commerce/cart/actions/updateProductsInCart';
+import { getCartProducts, getActiveFulfillmentSlot, getActiveFulfillmentSlotLocationCode } from '@shopgate/engage/cart/cart.selectors';
+import { makeGetFulfillmentPaths, makeGetEnabledFulfillmentMethods, getShopSettings } from '@shopgate/engage/core/config';
+import { getRestrictMultiLocationOrders, getFulfillmentSchedulingEnabled } from '@shopgate/engage/core';
+import { selectLocation, storeFormInput } from "../action-creators";
+import { getFilteredLocations, makeGetLocationInventory, makeGetLocationsForProduct, getPreferredLocation, getUserFormInput, getProductFulfillmentMethods, getIsFetching } from "../selectors";
+import { submitReservation } from "../actions";
+/**
+ * @typedef {import('./FulfillmentProvider.types').OwnProps} OwnProps
+ * @typedef {import('./FulfillmentProvider.types').StateProps} StateProps
+ * @typedef {import('./FulfillmentProvider.types').DispatchProps} DispatchProps
+ */
+
+/**
  * @returns {Function}
- */function makeMapStateToProps(){/* eslint-disable require-jsdoc */var getProductCode=function getProductCode(_,props){return props.variantId||props.productId||null;};/* eslint-enable require-jsdoc */var getInventory=makeGetLocationInventory(function(state,props){var _getPreferredLocation;return((_getPreferredLocation=getPreferredLocation(state,props))===null||_getPreferredLocation===void 0?void 0:_getPreferredLocation.code)||null;},getProductCode);var getProductLocations=makeGetLocationsForProduct(getProductCode);var getFulfillmentPaths=makeGetFulfillmentPaths();var getEnabledFulfillmentMethods=makeGetEnabledFulfillmentMethods();/**
-   * @param {Object} state The application state.
-   * @param {Object} props The component props.
+ */
+function makeMapStateToProps() {
+  /* eslint-disable require-jsdoc */
+  const getProductCode = (_, props) => props.variantId || props.productId || null;
+  /* eslint-enable require-jsdoc */
+
+  const getInventory = makeGetLocationInventory((state, props) => getPreferredLocation(state, props)?.code || null, getProductCode);
+  const getProductLocations = makeGetLocationsForProduct(getProductCode);
+  const getFulfillmentPaths = makeGetFulfillmentPaths();
+  const getEnabledFulfillmentMethods = makeGetEnabledFulfillmentMethods();
+
+  /**
+   * @param {StateProps} state The application state.
+   * @param {OwnProps} props The component props.
    * @returns {Object}
-   */return function(state,props){return{locations:props.noProduct?getFilteredLocations(state,props):getProductLocations(state,props),baseProduct:getBaseProduct(state,props),product:getProduct(state,props),location:getPreferredLocation(state,props),inventory:getInventory(state,props),userInput:getUserFormInput(state),fulfillmentPaths:getFulfillmentPaths(state),fulfillmentMethods:getProductFulfillmentMethods(state,props),enabledFulfillmentMethods:getEnabledFulfillmentMethods(state,props),shopSettings:getShopSettings(state),isFetching:getIsFetching(state),restrictMultiLocationOrders:getRestrictMultiLocationOrders(state),cartProducts:getCartProducts(state),fulfillmentSchedulingEnabled:getFulfillmentSchedulingEnabled(state),activeFulfillmentSlot:getActiveFulfillmentSlot(state),activeFulfillmentSlotLocationCode:getActiveFulfillmentSlotLocationCode(state)};};}/**
- * @param {Function} dispatch The dispatch function.
+   */
+  return (state, props) => ({
+    locations: props.noProduct ? getFilteredLocations(state, props) : getProductLocations(state, props),
+    baseProduct: getBaseProduct(state, props),
+    product: getProduct(state, props),
+    location: getPreferredLocation(state, props),
+    inventory: getInventory(state, props),
+    userInput: getUserFormInput(state),
+    fulfillmentPaths: getFulfillmentPaths(state),
+    fulfillmentMethods: getProductFulfillmentMethods(state, props),
+    enabledFulfillmentMethods: getEnabledFulfillmentMethods(state, props),
+    shopSettings: getShopSettings(state),
+    isFetching: getIsFetching(state),
+    restrictMultiLocationOrders: getRestrictMultiLocationOrders(state),
+    cartProducts: getCartProducts(state),
+    fulfillmentSchedulingEnabled: getFulfillmentSchedulingEnabled(state),
+    activeFulfillmentSlot: getActiveFulfillmentSlot(state),
+    activeFulfillmentSlotLocationCode: getActiveFulfillmentSlotLocationCode(state)
+  });
+}
+
+/**
+ * @param {DispatchProps} dispatch The dispatch function.
  * @returns {Object}
- */var mapDispatchToProps=function mapDispatchToProps(dispatch){return{selectLocation:function selectLocation(){return dispatch(_selectLocation.apply(void 0,arguments));},submitReservation:function submitReservation(){return dispatch(_submitReservation.apply(void 0,arguments));},storeFormInput:function storeFormInput(){return dispatch(_storeFormInput.apply(void 0,arguments));},addProductsToCart:function addProductsToCart(){return dispatch(_addProductsToCart.apply(void 0,arguments));},updateProductsInCart:function updateProductsInCart(){return dispatch(_updateProductsInCart.apply(void 0,arguments));},showModal:function showModal(){return dispatch(_showModal.apply(void 0,arguments));}};};export default connect(makeMapStateToProps,mapDispatchToProps);
+ */
+const mapDispatchToProps = dispatch => ({
+  selectLocation: (...params) => dispatch(selectLocation(...params)),
+  submitReservation: (...params) => dispatch(submitReservation(...params)),
+  storeFormInput: (...params) => dispatch(storeFormInput(...params)),
+  addProductsToCart: (...params) => dispatch(addProductsToCart(...params)),
+  updateProductsInCart: (...params) => dispatch(updateProductsInCart(...params)),
+  showModal: (...params) => dispatch(showModal(...params))
+});
+export default connect(makeMapStateToProps, mapDispatchToProps);