@shopgate/engage 7.31.6 → 7.32.0-beta.10

package/components/v2/CircularProgress/CircularProgress.js

@@ -17,6 +17,7 @@ const CircularProgress = /*#__PURE__*/forwardRef((props, ref) => {
     thickness = 3.6,
     style,
     className,
+    classes: classesProp,
     ...other
   } = props;
   const {
@@ -26,7 +27,7 @@ const CircularProgress = /*#__PURE__*/forwardRef((props, ref) => {
     color
   }, {
     props: {
-      classes: props.classes
+      classes: classesProp
     }
   });
   const circleStyle = {};
@@ -40,10 +41,10 @@ const CircularProgress = /*#__PURE__*/forwardRef((props, ref) => {
     rootStyle.transform = 'rotate(-90deg)';
   }
   return /*#__PURE__*/_jsx("div", {
-    className: cx(classes.root, className, {
+    className: cx(classes.root, {
       [classes.indeterminate]: variant === 'indeterminate',
       [classes.determinate]: variant === 'determinate'
-    }),
+    }, 'engage__circular-progress', className),
     style: {
       width: size,
       height: size,
@@ -52,6 +53,9 @@ const CircularProgress = /*#__PURE__*/forwardRef((props, ref) => {
     },
     ref: ref,
     role: "progressbar",
+    "data-variant": variant,
+    "data-color": color,
+    "data-disable-shrink": disableShrink || undefined,
     ...rootProps,
     ...other,
     children: /*#__PURE__*/_jsx("svg", {
@@ -108,8 +112,8 @@ const useStyles = makeStyles({
   return {
     root: {
       display: 'inline-block',
-      '--sg-circular-progress-circle-color': cssColor,
-      color: 'var(--sg-circular-progress-circle-color)'
+      '--circular-progress-color': cssColor,
+      color: 'var(--circular-progress-color)'
     },
     svg: {
       display: 'block'
@@ -136,4 +140,5 @@ const useStyles = makeStyles({
     }
   };
 });
+CircularProgress.displayName = 'CircularProgress';
 export default CircularProgress;

package/core/action-creators/merchantSettings.d.ts

@@ -1,2 +1,2 @@
-export function receiveMerchantSettings(settings: any[]): Object;
+export * from "../../settings/action-creators/merchantSettings";
 //# sourceMappingURL=merchantSettings.d.ts.map

package/core/action-creators/merchantSettings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"merchantSettings.d.ts","sourceRoot":"","sources":["../../../core/action-creators/merchantSettings.js"],"names":[],"mappings":"AAOO,0DAFM,MAAM,CAKjB"}
+{"version":3,"file":"merchantSettings.d.ts","sourceRoot":"","sources":["../../../core/action-creators/merchantSettings.js"],"names":[],"mappings":""}

package/core/action-creators/merchantSettings.js

@@ -1,11 +1,3 @@
-import { RECEIVE_MERCHANT_SETTINGS } from "../constants";
-
-/**
- * Creates the dispatched RECEIVE_MERCHANT_SETTINGS action object.
- * @param {Array} settings A list of shop settings.
- * @returns {Object} The dispatched action object.
- */
-export const receiveMerchantSettings = settings => ({
-  type: RECEIVE_MERCHANT_SETTINGS,
-  settings
-});
+// Backwards-compatible shim. The merchant settings action-creators now live in the
+// dedicated `settings` package: @shopgate/engage/settings/action-creators/merchantSettings
+export * from "../../settings/action-creators/merchantSettings";

package/core/action-creators/shopSettings.d.ts

@@ -1,3 +1,2 @@
-export function receiveShopSettings(settings: any[]): Object;
-export function errorShopSettings(error: Object): Object;
+export * from "../../settings/action-creators/shopSettings";
 //# sourceMappingURL=shopSettings.d.ts.map

package/core/action-creators/shopSettings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"shopSettings.d.ts","sourceRoot":"","sources":["../../../core/action-creators/shopSettings.js"],"names":[],"mappings":"AAOO,sDAFM,MAAM,CAKjB;AAOK,yCAHI,MAAM,GACJ,MAAM,CAKjB"}
+{"version":3,"file":"shopSettings.d.ts","sourceRoot":"","sources":["../../../core/action-creators/shopSettings.js"],"names":[],"mappings":""}

package/core/action-creators/shopSettings.js

@@ -1,21 +1,3 @@
-import { RECEIVE_SHOP_SETTINGS, ERROR_SHOP_SETTINGS } from "../constants";
-
-/**
- * Creates the dispatched RECEIVE_SHOP_SETTINGS action object.
- * @param {Array} settings A list of shop settings.
- * @returns {Object} The dispatched action object.
- */
-export const receiveShopSettings = settings => ({
-  type: RECEIVE_SHOP_SETTINGS,
-  settings
-});
-
-/**
- * Creates the dispatched ERROR_SHOP_SETTINGS action object.
- * @param {Object} error An error object.
- * @returns {Object} The dispatched action object.
- */
-export const errorShopSettings = error => ({
-  type: ERROR_SHOP_SETTINGS,
-  error
-});
+// Backwards-compatible shim. The shop settings action-creators now live in the
+// dedicated `settings` package: @shopgate/engage/settings/action-creators/shopSettings
+export * from "../../settings/action-creators/shopSettings";

package/core/constants/merchantSettings.d.ts

@@ -1,12 +1,2 @@
-export const RECEIVE_MERCHANT_SETTINGS: "RECEIVE_MERCHANT_SETTINGS";
-export const MERCHANT_SETTINGS_LOCATION_BASED_SHOPPING_ENABLED: "locationBasedShoppingEnabled";
-export const MERCHANT_SETTINGS_SUBSTITUTION_PREFERENCES_ENABLED: "enableSubstitutionPreferences";
-export const MERCHANT_SETTINGS_CUSTOMER_ATTRIBUTES: "customerAttributes";
-export const MERCHANT_SETTINGS_FULFILLMENT_SCHEDULED_ENABLED: "enableFulfillmentScheduling";
-export const MERCHANT_SETTINGS_RESTRICT_MULTI_LOCATION_ORDERS: "restrictMultiLocationOrders";
-export const MERCHANT_SETTINGS_DEFAULT_CURRENCY: "defaultCurrency";
-export const MERCHANT_SETTINGS_ENABLE_WEB_INDEXING: "enableWebIndexing";
-export const MERCHANT_SETTINGS_PRODUCT_SHOW_ALTERNATIVE_LOCATION: "productShowAlternativeLocation";
-export const MERCHANT_SETTINGS_PRODUCTLIST_SHOW_INVENTORY: "productListShowInventory";
-export const MERCHANT_SETTINGS_ENABLED_CMS_VERSION: "enabledCmsVersion";
+export * from "../../settings/constants/merchantSettings";
 //# sourceMappingURL=merchantSettings.d.ts.map

package/core/constants/merchantSettings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"merchantSettings.d.ts","sourceRoot":"","sources":["../../../core/constants/merchantSettings.js"],"names":[],"mappings":"AAAA,wCAAyC,2BAA2B,CAAC;AACrE,gEAAiE,8BAA8B,CAAC;AAChG,iEAAkE,+BAA+B,CAAC;AAClG,oDAAqD,oBAAoB,CAAC;AAC1E,8DAA+D,6BAA6B,CAAC;AAC7F,+DAAgE,6BAA6B,CAAC;AAC9F,iDAAkD,iBAAiB,CAAC;AACpE,oDAAqD,mBAAmB,CAAC;AACzE,kEAAmE,gCAAgC,CAAC;AACpG,2DAA4D,0BAA0B,CAAC;AACvF,oDAAqD,mBAAmB,CAAC"}
+{"version":3,"file":"merchantSettings.d.ts","sourceRoot":"","sources":["../../../core/constants/merchantSettings.js"],"names":[],"mappings":""}

package/core/constants/merchantSettings.js

@@ -1,11 +1,3 @@
-export const RECEIVE_MERCHANT_SETTINGS = 'RECEIVE_MERCHANT_SETTINGS';
-export const MERCHANT_SETTINGS_LOCATION_BASED_SHOPPING_ENABLED = 'locationBasedShoppingEnabled';
-export const MERCHANT_SETTINGS_SUBSTITUTION_PREFERENCES_ENABLED = 'enableSubstitutionPreferences';
-export const MERCHANT_SETTINGS_CUSTOMER_ATTRIBUTES = 'customerAttributes';
-export const MERCHANT_SETTINGS_FULFILLMENT_SCHEDULED_ENABLED = 'enableFulfillmentScheduling';
-export const MERCHANT_SETTINGS_RESTRICT_MULTI_LOCATION_ORDERS = 'restrictMultiLocationOrders';
-export const MERCHANT_SETTINGS_DEFAULT_CURRENCY = 'defaultCurrency';
-export const MERCHANT_SETTINGS_ENABLE_WEB_INDEXING = 'enableWebIndexing';
-export const MERCHANT_SETTINGS_PRODUCT_SHOW_ALTERNATIVE_LOCATION = 'productShowAlternativeLocation';
-export const MERCHANT_SETTINGS_PRODUCTLIST_SHOW_INVENTORY = 'productListShowInventory';
-export const MERCHANT_SETTINGS_ENABLED_CMS_VERSION = 'enabledCmsVersion';
+// Backwards-compatible shim. The merchant settings constants now live in the
+// dedicated `settings` package: @shopgate/engage/settings/constants/merchantSettings
+export * from "../../settings/constants/merchantSettings";

package/core/constants/shopSettings.d.ts

@@ -1,28 +1,2 @@
-export const RECEIVE_SHOP_SETTINGS: "RECEIVE_SHOP_SETTINGS";
-export const ERROR_SHOP_SETTINGS: "ERROR_SHOP_SETTINGS";
-export const CACHE_LEASE_SHOP_SETTINGS: number;
-export const SHOP_SETTING_GOOGLE_SITE_VERIFICATION_CODE: "googleSiteVerificationCode";
-export const SHOP_SETTING_CART_SUPPLEMENTAL_CONTENT: "cartSupplementalContent";
-export const SHOP_SETTING_ORDER_SUPPLEMENTAL_CONTENT: "orderSupplementalContent";
-export const SHOP_SETTING_SHOW_SHOP_LOGO_IN_APP: "showShopLogoInApp";
-export const SHOP_SETTING_SHOW_SHOP_LOGO_IN_WEB: "showShopLogoInWeb";
-export const SHOP_SETTING_PRODUCTS_SORT_ORDER: "productsSortOrder";
-export const SHOP_SETTING_WISHLIST_MODE: "wishlistMode";
-export const SHOP_SETTING_COOKIE_CONSENT_MODE: "cookieConsentMode";
-export const SHOP_SETTING_DISPLAY_PRICE_PER_MEASURE_UNIT: "displayPricePerMeasureUnit";
-export const SHOP_SETTING_IMAGES: "images";
-export const SHOP_SETTING_IMAGES_PRODUCT_PLACEHOLDER: "productPlaceholder";
-export const SHOP_SETTING_IMAGES_CATEGORY_PLACEHOLDER: "categoryPlaceholder";
-export const SHOP_SETTING_IMAGES_FAVICON: "favicon";
-export const SHOP_SETTING_NUMBER_OF_ADDRESS_LINES: "numberOfAddressLines";
-export const SHOP_SETTINGS_SHOW_CATEGORY_IMAGES: "showCategoryImages";
-export const SHOP_SETTING_REGISTRATION_MODE: "registrationMode";
-export const SHOP_SETTING_REGISTRATION_MODE_SIMPLE: "simple";
-export const SHOP_SETTING_REGISTRATION_MODE_EXTENDED: "extended";
-export const SHOP_SETTING_WISHLIST_ITEM_QUANTITY_ENABLED: "wishlistItemQuantityEnabled";
-export const SHOP_SETTING_WISHLIST_ITEM_NOTES_ENABLED: "wishlistItemNotesEnabled";
-export const SHOP_SETTING_LOAD_WISHLIST_ON_APP_START_ENABLED: "loadWishlistOnAppStartEnabled";
-export const SHOP_SETTING_SHOW_WISHLIST_ITEMS_COUNT_BADGE: "showWishlistItemsCountBadge";
-export const SHOP_SETTING_ENABLE_CMS_2_FOR_ALL_SHOPPERS: "enableCms2ForAllShoppers";
-export const WISHLIST_MODE_PERSIST_ON_ADD: "persistOnAdd";
+export * from "../../settings/constants/shopSettings";
 //# sourceMappingURL=shopSettings.d.ts.map

package/core/constants/shopSettings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"shopSettings.d.ts","sourceRoot":"","sources":["../../../core/constants/shopSettings.js"],"names":[],"mappings":"AAAA,oCAAqC,uBAAuB,CAAC;AAC7D,kCAAmC,qBAAqB,CAAC;AACzD,+CAAwD;AACxD,yDAA0D,4BAA4B,CAAC;AACvF,qDAAsD,yBAAyB,CAAC;AAChF,sDAAuD,0BAA0B,CAAC;AAClF,iDAAkD,mBAAmB,CAAC;AACtE,iDAAkD,mBAAmB,CAAC;AACtE,+CAAgD,mBAAmB,CAAC;AACpE,yCAA0C,cAAc,CAAC;AACzD,+CAAgD,mBAAmB,CAAC;AACpE,0DAA2D,4BAA4B,CAAC;AACxF,kCAAmC,QAAQ,CAAC;AAC5C,sDAAuD,oBAAoB,CAAC;AAC5E,uDAAwD,qBAAqB,CAAC;AAC9E,0CAA2C,SAAS,CAAC;AACrD,mDAAoD,sBAAsB,CAAC;AAC3E,iDAAkD,oBAAoB,CAAC;AACvE,6CAA8C,kBAAkB,CAAC;AACjE,oDAAqD,QAAQ,CAAC;AAC9D,sDAAuD,UAAU,CAAC;AAClE,0DAA2D,6BAA6B,CAAC;AACzF,uDAAwD,0BAA0B,CAAC;AACnF,8DAA+D,+BAA+B,CAAC;AAC/F,2DAA4D,6BAA6B,CAAC;AAC1F,yDAA0D,0BAA0B,CAAC;AAErF,2CAA4C,cAAc,CAAC"}
+{"version":3,"file":"shopSettings.d.ts","sourceRoot":"","sources":["../../../core/constants/shopSettings.js"],"names":[],"mappings":""}

package/core/constants/shopSettings.js

@@ -1,27 +1,3 @@
-export const RECEIVE_SHOP_SETTINGS = 'RECEIVE_SHOP_SETTINGS';
-export const ERROR_SHOP_SETTINGS = 'ERROR_SHOP_SETTINGS';
-export const CACHE_LEASE_SHOP_SETTINGS = 10 * 60 * 1000; // 10 minutes in milliseconds
-export const SHOP_SETTING_GOOGLE_SITE_VERIFICATION_CODE = 'googleSiteVerificationCode';
-export const SHOP_SETTING_CART_SUPPLEMENTAL_CONTENT = 'cartSupplementalContent';
-export const SHOP_SETTING_ORDER_SUPPLEMENTAL_CONTENT = 'orderSupplementalContent';
-export const SHOP_SETTING_SHOW_SHOP_LOGO_IN_APP = 'showShopLogoInApp';
-export const SHOP_SETTING_SHOW_SHOP_LOGO_IN_WEB = 'showShopLogoInWeb';
-export const SHOP_SETTING_PRODUCTS_SORT_ORDER = 'productsSortOrder';
-export const SHOP_SETTING_WISHLIST_MODE = 'wishlistMode';
-export const SHOP_SETTING_COOKIE_CONSENT_MODE = 'cookieConsentMode';
-export const SHOP_SETTING_DISPLAY_PRICE_PER_MEASURE_UNIT = 'displayPricePerMeasureUnit';
-export const SHOP_SETTING_IMAGES = 'images';
-export const SHOP_SETTING_IMAGES_PRODUCT_PLACEHOLDER = 'productPlaceholder';
-export const SHOP_SETTING_IMAGES_CATEGORY_PLACEHOLDER = 'categoryPlaceholder';
-export const SHOP_SETTING_IMAGES_FAVICON = 'favicon';
-export const SHOP_SETTING_NUMBER_OF_ADDRESS_LINES = 'numberOfAddressLines';
-export const SHOP_SETTINGS_SHOW_CATEGORY_IMAGES = 'showCategoryImages';
-export const SHOP_SETTING_REGISTRATION_MODE = 'registrationMode';
-export const SHOP_SETTING_REGISTRATION_MODE_SIMPLE = 'simple';
-export const SHOP_SETTING_REGISTRATION_MODE_EXTENDED = 'extended';
-export const SHOP_SETTING_WISHLIST_ITEM_QUANTITY_ENABLED = 'wishlistItemQuantityEnabled';
-export const SHOP_SETTING_WISHLIST_ITEM_NOTES_ENABLED = 'wishlistItemNotesEnabled';
-export const SHOP_SETTING_LOAD_WISHLIST_ON_APP_START_ENABLED = 'loadWishlistOnAppStartEnabled';
-export const SHOP_SETTING_SHOW_WISHLIST_ITEMS_COUNT_BADGE = 'showWishlistItemsCountBadge';
-export const SHOP_SETTING_ENABLE_CMS_2_FOR_ALL_SHOPPERS = 'enableCms2ForAllShoppers';
-export const WISHLIST_MODE_PERSIST_ON_ADD = 'persistOnAdd';
+// Backwards-compatible shim. The shop settings constants now live in the
+// dedicated `settings` package: @shopgate/engage/settings/constants/shopSettings
+export * from "../../settings/constants/shopSettings";

package/core/helpers/getFullImageSource.d.ts

@@ -1,5 +1,9 @@
-export function getFullImageSource(src: string, { width, height }?: {
+export function getFullImageSource(src: string | null, { width, height }?: {
     width: number;
     height: number;
+}, settings?: {
+    quality?: number | undefined;
+    fillColor?: string | undefined;
+    fillTransparent?: boolean | undefined;
 }): string;
 //# sourceMappingURL=getFullImageSource.d.ts.map

package/core/helpers/getFullImageSource.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getFullImageSource.d.ts","sourceRoot":"","sources":["../../../core/helpers/getFullImageSource.js"],"names":[],"mappings":"AA+CO,wCANI,MAAM,sBAEd;IAA0B,KAAK,EAAvB,MAAM;IACY,MAAM,EAAxB,MAAM;CACd,GAAU,MAAM,CAgDlB"}
+{"version":3,"file":"getFullImageSource.d.ts","sourceRoot":"","sources":["../../../core/helpers/getFullImageSource.js"],"names":[],"mappings":"AAiEO,wCAVI,MAAM,GAAC,IAAI,sBAEnB;IAA0B,KAAK,EAAvB,MAAM;IACY,MAAM,EAAxB,MAAM;CACd,aACA;IAA0B,OAAO;IACP,SAAS;IACR,eAAe;CAC1C,GAAU,MAAM,CAyDlB"}

package/core/helpers/getFullImageSource.js

@@ -5,9 +5,18 @@ import "core-js/modules/web.url.to-json.js";
 import "core-js/modules/web.url-search-params.js";
 import { CONFIGURATION_COLLECTION_CREATE_EXTERNAL_IMAGE_URL } from '@shopgate/engage/core/constants';
 import { configuration } from '@shopgate/engage/core/collections';
-import { getProductImageSettings } from "../../product/helpers";
+import { DEFAULT_IMAGE_FILL_COLOR, DEFAULT_IMAGE_FILL_TRANSPARENT, DEFAULT_IMAGE_QUALITY } from '@shopgate/engage/settings/constants/imageSettings';
 import { getImageFormat } from "./getImageFormat";
 
+/**
+ * The settings applied when the caller passes none.
+ */
+const defaultSettings = {
+  quality: DEFAULT_IMAGE_QUALITY,
+  fillColor: DEFAULT_IMAGE_FILL_COLOR,
+  fillTransparent: DEFAULT_IMAGE_FILL_TRANSPARENT
+};
+
 /**
  * Regex to detect the "fill" query parameter
  */
@@ -43,29 +52,38 @@ const buildUrl = (baseUrl, params = {}) => {
 };
 
 /**
- * Returns the actual url to the image, by adding url parameters with the dimensions for img-cdn
- * @param {string} src Source to the image.
+ * Builds the url that requests an image at a given size. A src that no known image source
+ * recognizes is returned untouched.
+ * @param {string|null} src Source to the image.
  * @param {Object} dimension Dimension of the requested image.
  * @param {number} dimension.width Width in pixels.
  * @param {number} dimension.height Height in pixels.
+ * @param {Object} [settings] Image service settings, as resolved by useImageServiceSettings.
+ * @param {number} [settings.quality] Compression quality.
+ * @param {string} [settings.fillColor] Fill color as a hash free hex, not a CSS color.
+ * @param {boolean} [settings.fillTransparent] Whether transparent areas are filled too.
  * @returns {string}
  */
 export const getFullImageSource = (src, {
   width,
   height
-} = {}) => {
+} = {}, settings = {}) => {
+  const {
+    quality,
+    fillColor,
+    fillTransparent
+  } = {
+    ...defaultSettings,
+    ...settings
+  };
   if (src && src.includes('images.shopgate.services')) {
-    const {
-      fillColor,
-      quality
-    } = getProductImageSettings();
     const format = getImageFormat();
     return buildUrl(src, {
       format,
       width,
       height,
       quality,
-      fill: fillColor.replace('#', '')
+      fill: fillTransparent ? `${fillColor},1` : fillColor
     });
   }
   if (src && src.startsWith('https://img-cdn.shopgate.com') && !src.includes('?')) {
@@ -74,17 +92,14 @@ export const getFullImageSource = (src, {
       h: height,
       q: 70,
       zd: 'resize',
-      fillc: 'FFFFFF'
+      // No transparency flag here - the legacy cdn only understands a plain color.
+      fillc: fillColor
     });
   }
 
   // Check if an extension registered an external image url handler within the config collection.
   const createUrlFn = configuration.get(CONFIGURATION_COLLECTION_CREATE_EXTERNAL_IMAGE_URL);
   if (typeof createUrlFn === 'function') {
-    const {
-      fillColor,
-      quality
-    } = getProductImageSettings();
     const format = getImageFormat();
 
     // Invoke the handler with all relevant parameters.
@@ -92,6 +107,7 @@ export const getFullImageSource = (src, {
       width,
       height,
       fillColor,
+      fillTransparent,
       quality,
       format
     });

package/core/helpers/scrollContainer.js

@@ -1,11 +1,11 @@
-import { IS_PAGE_PREVIEW_ACTIVE } from '@shopgate/engage/page/constants';
+import { isAdminPreviewActive } from '@shopgate/engage/admin-preview/helpers';
 import { hasWebBridge } from "./bridge";
 
 /**
  * Checks whether the app shall use a scroll container
  * @returns {boolean}
  */
-export const applyScrollContainer = () => IS_PAGE_PREVIEW_ACTIVE || !hasWebBridge();
+export const applyScrollContainer = () => isAdminPreviewActive() || !hasWebBridge();
 
 /**
  * exports the old function name for backwards compatibility

package/core/hooks/html/useLoadImage.d.ts

@@ -1,7 +1,7 @@
 /**
  * Load image hook
- * @param {string} src .
- * @returns {boolean}
+ * @param {string|null} src The image to preload. A falsy src is a no-op.
+ * @returns {boolean} Whether the image has finished loading.
  */
-export function useLoadImage(src: string): boolean;
+export function useLoadImage(src: string | null): boolean;
 //# sourceMappingURL=useLoadImage.d.ts.map

package/core/hooks/html/useLoadImage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useLoadImage.d.ts","sourceRoot":"","sources":["../../../../core/hooks/html/useLoadImage.js"],"names":[],"mappings":"AAGA;;;;GAIG;AACH,kCAHW,MAAM,GACJ,OAAO,CAUnB"}
+{"version":3,"file":"useLoadImage.d.ts","sourceRoot":"","sources":["../../../../core/hooks/html/useLoadImage.js"],"names":[],"mappings":"AAGA;;;;GAIG;AACH,kCAHW,MAAM,GAAC,IAAI,GACT,OAAO,CAUnB"}

package/core/hooks/html/useLoadImage.js

@@ -3,8 +3,8 @@ import { loadImage } from '@shopgate/pwa-common/helpers/html/handleDOM';
 
 /**
  * Load image hook
- * @param {string} src .
- * @returns {boolean}
+ * @param {string|null} src The image to preload. A falsy src is a no-op.
+ * @returns {boolean} Whether the image has finished loading.
  */
 export function useLoadImage(src) {
   const [loaded, setIsLoaded] = useState(false);

package/core/hooks/useLocalStorage.d.ts

@@ -11,6 +11,14 @@ interface UseLocalStorageOptions<T> {
      * @default true
      */
     sync?: boolean;
+    /**
+     * Whether the value is written to localStorage at all. Set to false in contexts that must not
+     * leak state into the visitor's browser and should stay ephemeral. With this off the hook is a
+     * plain useState: it neither reads nor writes localStorage, and it ignores updates from other
+     * tabs.
+     * @default true
+     */
+    persist?: boolean;
 }
 type SetValueAction<T> = T | null | ((prev: T | null) => T | null);
 /**

package/core/hooks/useLocalStorage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useLocalStorage.d.ts","sourceRoot":"","sources":["../../../core/hooks/useLocalStorage.ts"],"names":[],"mappings":"AASA;;GAEG;AACH,UAAU,sBAAsB,CAAC,CAAC;IAChC;;OAEG;IACH,YAAY,CAAC,EAAE,CAAC,CAAC;IAEjB;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,KAAK,cAAc,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,GAAG,IAAI,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;AAEnE;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,eAAe,CAAC,CAAC,EACvC,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,sBAAsB,CAAC,CAAC,CAAM,GACtC,SAAS,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CA8EzD"}
+{"version":3,"file":"useLocalStorage.d.ts","sourceRoot":"","sources":["../../../core/hooks/useLocalStorage.ts"],"names":[],"mappings":"AASA;;GAEG;AACH,UAAU,sBAAsB,CAAC,CAAC;IAChC;;OAEG;IACH,YAAY,CAAC,EAAE,CAAC,CAAC;IAEjB;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,KAAK,cAAc,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,GAAG,IAAI,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;AAEnE;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,eAAe,CAAC,CAAC,EACvC,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,sBAAsB,CAAC,CAAC,CAAM,GACtC,SAAS,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAqFzD"}

package/core/hooks/useLocalStorage.js

@@ -19,10 +19,12 @@ const {
 export default function useLocalStorage(key, options = {}) {
   const {
     initialValue = null,
-    sync = true
+    sync = true,
+    persist = true
   } = options;
   const storageKey = useMemo(() => `${appId}_${key}`, [key]);
   const readValue = useCallback(() => {
+    if (!persist) return initialValue;
     try {
       const item = window.localStorage.getItem(storageKey);
       if (item == null) return initialValue;
@@ -30,7 +32,7 @@ export default function useLocalStorage(key, options = {}) {
     } catch (error) {
       return initialValue;
     }
-  }, [storageKey, initialValue]);
+  }, [storageKey, initialValue, persist]);
   const [storedValue, setStoredValue] = useState(readValue);
 
   /**
@@ -38,20 +40,25 @@ export default function useLocalStorage(key, options = {}) {
    * @param value The new value to store.
    */
   const setValue = useCallback(value => {
-    try {
-      const valueToStore = typeof value === 'function' ? value(readValue()) : value;
-      setStoredValue(valueToStore);
-      if (valueToStore == null) {
-        window.localStorage.removeItem(storageKey);
-      } else {
-        window.localStorage.setItem(storageKey, JSON.stringify(valueToStore));
+    // Resolve an updater against the live React state, so it sees the current value whether or not
+    // the value is persisted (when persist is off there is nothing to read back from storage).
+    setStoredValue(prev => {
+      const valueToStore = typeof value === 'function' ? value(prev) : value;
+      if (!persist) return valueToStore;
+      try {
+        if (valueToStore == null) {
+          window.localStorage.removeItem(storageKey);
+        } else {
+          window.localStorage.setItem(storageKey, JSON.stringify(valueToStore));
+        }
+      } catch (error) {
+        //
       }
-    } catch (error) {
-      //
-    }
-  }, [storageKey, readValue]);
+      return valueToStore;
+    });
+  }, [storageKey, persist]);
   useEffect(() => {
-    if (!sync) return undefined;
+    if (!sync || !persist) return undefined;
 
     /**
      * Handles cross-document localStorage updates.
@@ -78,6 +85,6 @@ export default function useLocalStorage(key, options = {}) {
     return () => {
       window.removeEventListener('storage', handleStorageChange);
     };
-  }, [storageKey, initialValue, sync]);
+  }, [storageKey, initialValue, sync, persist]);
   return [storedValue, setValue];
 }

package/core/hooks/useNavigation.d.ts

@@ -1,6 +1,14 @@
+import { push, pop, replace, reset, update } from '../router/helpers';
+export interface Navigation {
+    push: typeof push;
+    pop: typeof pop;
+    replace: typeof replace;
+    reset: typeof reset;
+    update: typeof update;
+}
 /**
  * Provides functions for navigation.
- * @returns {Object}
+ * @returns The navigation functions.
  */
-export function useNavigation(): Object;
+export declare function useNavigation(): Navigation;
 //# sourceMappingURL=useNavigation.d.ts.map

package/core/hooks/useNavigation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useNavigation.d.ts","sourceRoot":"","sources":["../../../core/hooks/useNavigation.js"],"names":[],"mappings":"AAIA;;;GAGG;AACH,iCAFa,MAAM,CAUlB"}
+{"version":3,"file":"useNavigation.d.ts","sourceRoot":"","sources":["../../../core/hooks/useNavigation.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAClC,MAAM,mBAAmB,CAAC;AAE3B,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,OAAO,IAAI,CAAC;IAClB,GAAG,EAAE,OAAO,GAAG,CAAC;IAChB,OAAO,EAAE,OAAO,OAAO,CAAC;IACxB,KAAK,EAAE,OAAO,KAAK,CAAC;IACpB,MAAM,EAAE,OAAO,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,wBAAgB,aAAa,IAAI,UAAU,CAQ1C"}

package/core/hooks/useNavigation.js

@@ -1,8 +1,7 @@
 import { push, pop, replace, reset, update } from "../router/helpers";
-
 /**
  * Provides functions for navigation.
- * @returns {Object}
+ * @returns The navigation functions.
  */
 export function useNavigation() {
   return {

package/core/initialization/fetchSettings.d.ts

@@ -0,0 +1,12 @@
+interface SettingsStore {
+    dispatch: (action: unknown) => void;
+}
+/**
+ * Fetches all configured JSONP settings sources in parallel. Sources without a configured url
+ * are skipped. Never rejects - every source falls back to the defaults of its reducer.
+ * @param store Reference to the store.
+ * @returns A promise that resolves once all configured sources settled.
+ */
+export declare const fetchSettings: (store: SettingsStore) => Promise<void>;
+export {};
+//# sourceMappingURL=fetchSettings.d.ts.map

package/core/initialization/fetchSettings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetchSettings.d.ts","sourceRoot":"","sources":["../../../core/initialization/fetchSettings.ts"],"names":[],"mappings":"AA0BA,UAAU,aAAa;IACrB,QAAQ,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;CACrC;AAwHD;;;;;GAKG;AACH,eAAO,MAAM,aAAa,GAAU,OAAO,aAAa,KAAG,OAAO,CAAC,IAAI,CA0CtE,CAAC"}