@shopgate/engage 7.30.0-alpha.1 → 7.30.0-alpha.11

package/locations/helpers/getAvailabilitySettings.js

@@ -1,12 +1,44 @@
-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{availabilityTypes,AVAILABILITY_TYPE_NOT_AVAILABLE,AVAILABILITY_TYPE_AVAILABLE,AVAILABILITY_TYPE_COMING_SOON}from"../../product/constants";/**
+import { availabilityTypes, AVAILABILITY_TYPE_NOT_AVAILABLE, AVAILABILITY_TYPE_AVAILABLE, AVAILABILITY_TYPE_COMING_SOON } from "../../product/constants";
+
+/**
  * Takes the location stock info settings and finds the matching settings for the given inventory.
  * @param {Object} settings The settings find a match in.
  * @param {Object|null} location The location object.
  * @param {Object|null} productInventory The product inventory.
  * @returns {Object}
- */export default(function(settings,location,productInventory){if(location===null||location===void 0?void 0:location.isComingSoon){return settings[AVAILABILITY_TYPE_COMING_SOON];}if(!productInventory){return{};}var _productInventory$isA=productInventory.isAvailable,isAvailable=_productInventory$isA===void 0?false:_productInventory$isA,_productInventory$vis=productInventory.visible,visible=_productInventory$vis===void 0?0:_productInventory$vis;if(isAvailable===false){return settings[AVAILABILITY_TYPE_NOT_AVAILABLE];}if(visible===null){return _extends({},settings[AVAILABILITY_TYPE_AVAILABLE],{availabilityText:'locations.stock_info.available'});}// Filter by inventory blind and visible inventory (must match both).
-var matchingTypes=availabilityTypes.filter(function(type){return!settings[type].comingSoon;}).filter(function(type){return(// When inventory blind is set in the current availability setting, then this should also
-// account for the inventory blind from the given store. Ignore inventory blind otherwise.
-!settings[type].includeInventoryBlind||settings[type].includeInventoryBlind&&!!visible);}).filter(function(type){return(// Don't filter, when inventoryBlind filter is already active
-settings[type].includeInventoryBlind||// Also, inventory must be truthy or 0, or otherwise there is nothing to search for.
-visible>=settings[type].visibleInventoryFrom&&(settings[type].visibleInventoryTo===null||visible<=settings[type].visibleInventoryTo));});if(matchingTypes.length>0){return settings[matchingTypes[0]];}return{};});
+ */
+export default (settings, location, productInventory) => {
+  if (location?.isComingSoon) {
+    return settings[AVAILABILITY_TYPE_COMING_SOON];
+  }
+  if (!productInventory) {
+    return {};
+  }
+  const {
+    isAvailable = false,
+    visible = 0
+  } = productInventory;
+  if (isAvailable === false) {
+    return settings[AVAILABILITY_TYPE_NOT_AVAILABLE];
+  }
+  if (visible === null) {
+    return {
+      ...settings[AVAILABILITY_TYPE_AVAILABLE],
+      availabilityText: 'locations.stock_info.available'
+    };
+  }
+
+  // Filter by inventory blind and visible inventory (must match both).
+  const matchingTypes = availabilityTypes.filter(type => !settings[type].comingSoon).filter(type =>
+  // When inventory blind is set in the current availability setting, then this should also
+  // account for the inventory blind from the given store. Ignore inventory blind otherwise.
+  !settings[type].includeInventoryBlind || settings[type].includeInventoryBlind && !!visible).filter(type =>
+  // Don't filter, when inventoryBlind filter is already active
+  settings[type].includeInventoryBlind ||
+  // Also, inventory must be truthy or 0, or otherwise there is nothing to search for.
+  visible >= settings[type].visibleInventoryFrom && (settings[type].visibleInventoryTo === null || visible <= settings[type].visibleInventoryTo));
+  if (matchingTypes.length > 0) {
+    return settings[matchingTypes[0]];
+  }
+  return {};
+};

package/locations/helpers/index.js

@@ -1 +1,4 @@
-export{default as createOrder}from"./createOrder";export{default as getAvailabilitySettings}from"./getAvailabilitySettings";export{isProductAvailable}from"./productInventory";export*from"./showInventoryInLists";
+export { default as createOrder } from "./createOrder";
+export { default as getAvailabilitySettings } from "./getAvailabilitySettings";
+export { isProductAvailable } from "./productInventory";
+export * from "./showInventoryInLists";

package/locations/helpers/productInventory.js

@@ -3,5 +3,24 @@
  * @param {Object} location The location to check.
  * @param {Object} inventory The location inventory to check.
  * @returns {boolean}
- */export function isProductAvailable(){var location=arguments.length>0&&arguments[0]!==undefined?arguments[0]:{};var inventory=arguments.length>1&&arguments[1]!==undefined?arguments[1]:{};var _ref=location||{},isComingSoon=_ref.isComingSoon;var _ref2=inventory||{},_ref2$isAvailable=_ref2.isAvailable,isAvailable=_ref2$isAvailable===void 0?false:_ref2$isAvailable,_ref2$visible=_ref2.visible,visible=_ref2$visible===void 0?0:_ref2$visible;if(isComingSoon){return false;}if(isAvailable===false){return false;}if(visible===null){// Blind mode
-return true;}return visible>0;}
+ */
+export function isProductAvailable(location = {}, inventory = {}) {
+  const {
+    isComingSoon
+  } = location || {};
+  const {
+    isAvailable = false,
+    visible = 0
+  } = inventory || {};
+  if (isComingSoon) {
+    return false;
+  }
+  if (isAvailable === false) {
+    return false;
+  }
+  if (visible === null) {
+    // Blind mode
+    return true;
+  }
+  return visible > 0;
+}

package/locations/helpers/showInventoryInLists.js

@@ -1,7 +1,33 @@
-import{setABFeatureFlag,isFeatureEnabled}from'@shopgate/engage/core';import appConfig from'@shopgate/pwa-common/helpers/config';import{getProductListShowInventory}from"../../core/selectors";var STORE_KEY='showInventoryInLists.v1';var enabled=null;/**
+import { setABFeatureFlag, isFeatureEnabled } from '@shopgate/engage/core';
+import appConfig from '@shopgate/pwa-common/helpers/config';
+import { getProductListShowInventory } from "../../core/selectors";
+const STORE_KEY = 'showInventoryInLists.v1';
+let enabled = null;
+
+/**
  * @param {Object} state state
  * @returns {boolean}
- */export function showInventoryInLists(state){var config=getProductListShowInventory(state);if(!config){return false;}if(enabled===null){var _appConfig$featureFla;// activate feature for x percent of user
-var percentage=(appConfig===null||appConfig===void 0?void 0:(_appConfig$featureFla=appConfig.featureFlagPercentages)===null||_appConfig$featureFla===void 0?void 0:_appConfig$featureFla.showInventoryInLists)||100;enabled=isFeatureEnabled(STORE_KEY,percentage);}return enabled;}/**
+ */
+export function showInventoryInLists(state) {
+  const config = getProductListShowInventory(state);
+  if (!config) {
+    return false;
+  }
+  if (enabled === null) {
+    // activate feature for x percent of user
+    const percentage = appConfig?.featureFlagPercentages?.showInventoryInLists || 100;
+    enabled = isFeatureEnabled(STORE_KEY, percentage);
+  }
+  return enabled;
+}
+
+/**
  * @param {Object} state state
- */export function setShowInventoryInLists(state){var config=getProductListShowInventory(state);if(!config){return;}setABFeatureFlag(STORE_KEY);}
+ */
+export function setShowInventoryInLists(state) {
+  const config = getProductListShowInventory(state);
+  if (!config) {
+    return;
+  }
+  setABFeatureFlag(STORE_KEY);
+}

package/locations/index.js

@@ -1,9 +1,42 @@
 // ACTIONS
-export{fetchProductLocations}from"./actions";// COMPONENTS
-export{FulfillmentSelector,FulfillmentSheet,FulfillmentPathSelector,StoreList,StoreAddress,StoreOpeningHours,StorePhoneNumber,CartItemProductChangeLocation,CartChangeFulfillmentMethod,CartContextMenuItemChangeLocation,CartContextMenuItemChangeFulfillment,CartContextMenuChangeFulfillment,GlobalLocationSelector,GlobalLocationSwitcher,FulfillmentSlotSwitcher,StoreFinder,StockInfoLists}from"./components";// CONSTANTS
-export{PRODUCT_FULFILLMENT_SELECTOR,PRODUCT_LOCATION_STOCK_INFO,DIRECT_SHIP,DIRECT_SHIP_LABEL,IN_STORE_PICKUP_BOPIS_LABEL,IN_STORE_PICKUP_ROPIS_LABEL,ROPIS,BOPIS,DEFAULT_ROPE_FULFILLMENT_METHOD,QUICK_RESERVE,MULTI_LINE_RESERVE,STAGE_SELECT_STORE,STAGE_RESERVE_FORM,STAGE_RESPONSE_SUCCESS,STAGE_RESPONSE_ERROR,STAGE_FULFILLMENT_METHOD,STORE_FINDER_PATTERN}from"./constants";// SELECTORS
-export*from"./selectors";// STREAMS
-export{submitReservationSuccess$,preferredLocationDidUpdate$,preferredLocationDidUpdateGlobal$,preferredLocationDidUpdateGlobalNotOnCategory$,preferredLocationDidUpdateGlobalOnCategory$,preferredLocationDidUpdateGlobalNotOnSearch$,preferredLocationDidUpdateGlobalOnSearch$,sendDefaultLocationCodeSuccess$}from"./locations.streams";// HOOKS
-export{useFulfillmentState}from"./locations.hooks";// TYPES
+export { fetchProductLocations } from "./actions";
+
+// COMPONENTS
+export { FulfillmentSelector, FulfillmentSheet, FulfillmentPathSelector, StoreList, StoreAddress, StoreOpeningHours, StorePhoneNumber, CartItemProductChangeLocation, CartChangeFulfillmentMethod, CartContextMenuItemChangeLocation, CartContextMenuItemChangeFulfillment, CartContextMenuChangeFulfillment, GlobalLocationSelector, GlobalLocationSwitcher, FulfillmentSlotSwitcher, StoreFinder, StockInfoLists } from "./components";
+
+// CONSTANTS
+export { PRODUCT_FULFILLMENT_SELECTOR, PRODUCT_LOCATION_STOCK_INFO, DIRECT_SHIP, DIRECT_SHIP_LABEL, IN_STORE_PICKUP_BOPIS_LABEL, IN_STORE_PICKUP_ROPIS_LABEL, ROPIS, BOPIS, DEFAULT_ROPE_FULFILLMENT_METHOD, QUICK_RESERVE, MULTI_LINE_RESERVE, STAGE_SELECT_STORE, STAGE_RESERVE_FORM, STAGE_RESPONSE_SUCCESS, STAGE_RESPONSE_ERROR, STAGE_FULFILLMENT_METHOD, STORE_FINDER_PATTERN } from "./constants";
+
+// SELECTORS
+export * from "./selectors";
+
+// STREAMS
+export { submitReservationSuccess$, preferredLocationDidUpdate$, preferredLocationDidUpdateGlobal$, preferredLocationDidUpdateGlobalNotOnCategory$, preferredLocationDidUpdateGlobalOnCategory$, preferredLocationDidUpdateGlobalNotOnSearch$, preferredLocationDidUpdateGlobalOnSearch$, sendDefaultLocationCodeSuccess$ } from "./locations.streams";
+
+// HOOKS
+export { useFulfillmentState } from "./locations.hooks";
+
+// TYPES
+export
+  /** @typedef {import('./locations.types').LocationAddress} */
+  /** @typedef {import('./locations.types').Location} */
+  /** @typedef {import('./locations.types').LocationsByIdState} */
+  /** @typedef {import('./locations.types').LocationsByProductIdState} */
+  /** @typedef {import('./locations.types').FulfillmentPath} */
+  /** @typedef {import('./locations.types').UserLocationState} */
+  /** @typedef {import('./locations.types').ReservationFormValues} */
+  /** @typedef {import('./locations.types').UserLocationFulfillmentMethod} */
+  /** @typedef {import('./locations.types').UserLocationLocationCode} */
+  /** @typedef {import('./locations.types').UserFormInputState} */
+  /** @typedef {import('./locations.types').LocationsState} */
+  /** @typedef {import('./locations.types').SheetStage} */
+  /** @typedef {import('./locations.types').SheetCallbackFn} */
+  /** @typedef {import('./locations.types').SheetOpenParams} */
+  /** @typedef {import('./locations.types').ReservationResponse} */
+  /** @typedef {import('./locations.types').LocationOperationHours} */
+  /** @typedef {import('./locations.types').LocationAware} */
+  /** @typedef {import('./locations.types').OptionalLocationAware} */
+{} from "./locations.types";
+
 // CONTEXT
-export{FulfillmentContext}from"./locations.context";
+export { FulfillmentContext } from "./locations.context";

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
+ */