@shopgate/engage 7.32.0-beta.2 → 7.32.0-beta.20

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"}

package/core/initialization/fetchSettings.js

@@ -0,0 +1,134 @@
+import { withScope, captureMessage, Severity as SentrySeverity } from '@sentry/browser';
+import appConfig from '@shopgate/pwa-common/helpers/config';
+import { receiveShopSettings, errorShopSettings } from '@shopgate/engage/settings/action-creators/shopSettings';
+import { receiveMerchantSettings } from '@shopgate/engage/settings/action-creators/merchantSettings';
+import { receiveAppSettings } from '@shopgate/engage/settings/action-creators/appSettings';
+const REQUEST_TIMEOUT = 3000;
+
+/**
+ * The payload types the settings action creators declare. Derived rather than written out,
+ * because shopSettings and merchantSettings are untyped JS whose JSDoc describes their payload
+ * as `{Array}` / `{Object}` whereas the JSONP files actually send a settings object. Deriving
+ * keeps this file honest about the mismatch and picks up the real types once that JSDoc is fixed.
+ */
+
+/**
+ * Injects a script tag to fetch a settings JSONP.
+ * @param id The script id.
+ * @param src The script url.
+ * @param onError Callback for error situations.
+ */
+const injectScript = (id, src, onError) => {
+  const existingTag = document.querySelector(`#${id}`);
+  if (existingTag) {
+    existingTag.remove();
+  }
+  const scriptTag = document.createElement('script');
+  scriptTag.setAttribute('src', src);
+  scriptTag.setAttribute('id', id);
+  scriptTag.onerror = onError;
+  document.head.appendChild(scriptTag);
+};
+
+/**
+ * Loads a single JSONP settings source. Resolves when the payload arrived, when the script
+ * failed to load, or when REQUEST_TIMEOUT elapsed - it never rejects, so that no single
+ * source can block or delay app start indefinitely.
+ * @param params The loader params.
+ * @returns A promise that resolves once the source settled.
+ */
+const loadJsonpSettings = params => new Promise(resolve => {
+  const {
+    id,
+    url,
+    callbackName,
+    onReceive,
+    onError
+  } = params;
+  let settled = false;
+  let timeout;
+
+  /**
+   * Resolves the promise once, whichever of payload / error / timeout comes first.
+   */
+  const settle = () => {
+    if (settled) {
+      return;
+    }
+    settled = true;
+    clearTimeout(timeout);
+    resolve();
+  };
+
+  // Started before the callback and the script are wired up, so that a synchronously firing
+  // callback / error (e.g. a data: url) settles against an already assigned timeout - otherwise
+  // clearTimeout would no-op and this timer would still fire a false timeout warning.
+  timeout = setTimeout(() => {
+    withScope(scope => {
+      scope.setLevel(SentrySeverity.Warning);
+      scope.setExtra('settingsUrl', url);
+      scope.setExtra('timeout', REQUEST_TIMEOUT);
+      captureMessage(`Fetching settings took too long: ${id}`);
+    });
+    settle();
+  }, REQUEST_TIMEOUT);
+
+  // Registered before the script is injected, since the JSONP files guard their call with
+  // `window.setX && window.setX(...)` - a callback assigned too late is a silent no-op.
+  // Deliberately never removed: the timeout may settle while the script is still in flight,
+  // and a payload arriving after that should still hydrate the store.
+  window[callbackName] = settings => {
+    onReceive(settings);
+    settle();
+  };
+  injectScript(id, url, error => {
+    withScope(scope => {
+      scope.setLevel(SentrySeverity.Error);
+      scope.setExtra('settingsUrl', url);
+      captureMessage(`Fetching settings failed: ${id}`);
+    });
+    onError?.(error);
+    settle();
+  });
+});
+
+/**
+ * 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 const fetchSettings = async store => {
+  const {
+    settingsUrl,
+    merchantSettingsUrl,
+    appSettingsUrl
+  } = appConfig;
+  const loaders = [];
+  if (settingsUrl) {
+    loaders.push(loadJsonpSettings({
+      id: 'shop-settings-jsonp',
+      url: settingsUrl,
+      callbackName: 'setShopSettings',
+      onReceive: settings => store.dispatch(receiveShopSettings(settings)),
+      onError: error => store.dispatch(errorShopSettings(error))
+    }));
+  }
+  if (merchantSettingsUrl) {
+    loaders.push(loadJsonpSettings({
+      id: 'merchant-settings-jsonp',
+      url: merchantSettingsUrl,
+      callbackName: 'setMerchantSettings',
+      onReceive: settings => store.dispatch(receiveMerchantSettings(settings))
+    }));
+  }
+  if (appSettingsUrl) {
+    loaders.push(loadJsonpSettings({
+      id: 'app-settings-jsonp',
+      url: appSettingsUrl,
+      callbackName: 'setAppSettings',
+      onReceive: settings => store.dispatch(receiveAppSettings(settings))
+    }));
+  }
+  await Promise.all(loaders);
+};

package/core/initialization/index.d.ts

@@ -1,4 +1,35 @@
-export function initialize(locales: Object, reducers: Function, subscribers: any[]): Promise<{
-    store: Object;
+import type { Store as ReduxStore, UnknownAction } from 'redux';
+import { configureStore } from '@shopgate/pwa-common/store';
+declare global {
+    interface Window {
+        SGConnectDev?: {
+            isDevBrowser: boolean;
+            isDev: boolean;
+        };
+    }
+}
+/**
+ * The app's redux store. Assembled here because configureStore is untyped JS whose JSDoc widens
+ * the return value to `Object`.
+ *
+ * dispatch stays permissive rather than using redux-thunk's ThunkDispatch: the action creators
+ * this module dispatches are untyped JS annotated `@returns {Object}` / `{Function}`, which match
+ * neither UnknownAction nor ThunkAction. Tightening it here would only force casts at every call
+ * site - it needs the JSDoc on those action creators to be fixed first.
+ */
+type Store = Omit<ReduxStore<unknown, UnknownAction>, 'dispatch'> & {
+    dispatch: (action: unknown) => unknown;
+};
+/**
+ * Initializes the app: sets up i18n, creates the store, fetches the client information and the
+ * dynamic settings, and runs all registered app initialization handlers.
+ * @param locales An object with locales.
+ * @param reducers The reducers from the theme.
+ * @param subscribers The subscribers to the streams middleware.
+ * @returns The initialized store.
+ */
+export declare const initialize: (locales: Record<string, unknown>, reducers: Parameters<typeof configureStore>[0], subscribers: Parameters<typeof configureStore>[1]) => Promise<{
+    store: Store;
 }>;
+export {};
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../core/initialization/index.js"],"names":[],"mappings":"AAuIO,oCAJI,MAAM;;GAuDhB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../core/initialization/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,IAAI,UAAU,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAChE,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAqB5D,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,YAAY,CAAC,EAAE;YACb,YAAY,EAAE,OAAO,CAAC;YACtB,KAAK,EAAE,OAAO,CAAC;SAChB,CAAC;KACH;CACF;AAED;;;;;;;;GAQG;AACH,KAAK,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,aAAa,CAAC,EAAE,UAAU,CAAC,GAAG;IAClE,QAAQ,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,OAAO,CAAC;CACxC,CAAC;AAMF;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU,GACrB,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAChC,UAAU,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC,CAAC,CAAC,EAC9C,aAAa,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC,CAAC,CAAC;;EA4ElD,CAAC"}

package/core/initialization/index.js

@@ -1,118 +1,41 @@
-import { withScope, captureMessage, Severity as SentrySeverity } from '@sentry/browser';
 import moment from 'moment';
 import { configureStore } from '@shopgate/pwa-common/store';
 import { appWillInit, appWillStart } from '@shopgate/pwa-common/action-creators/app';
 import { i18n, getAppBaseUrl, isDev, hasSGJavaScriptBridge, hasWebBridge } from '@shopgate/engage/core/helpers';
 import fetchClientInformation from '@shopgate/pwa-common/actions/client/fetchClientInformation';
-import appConfig from '@shopgate/pwa-common/helpers/config';
+import { appConfig } from '@shopgate/engage';
 import { appInitialization, configuration } from '@shopgate/engage/core/collections';
 import { CONFIGURATION_COLLECTION_KEY_BASE_URL } from '@shopgate/engage/core/constants';
-import { loadCustomStyles } from '@shopgate/engage/styles';
-import { receiveShopSettings, errorShopSettings } from '@shopgate/engage/settings/action-creators/shopSettings';
-import { receiveMerchantSettings } from '@shopgate/engage/settings/action-creators/merchantSettings';
-const {
-  locales: {
-    currency: currencyLocale = null
-  } = {},
-  settingsUrl,
-  merchantSettingsUrl
-} = appConfig;
-const REQUEST_TIMEOUT = 3000;
-/**
- * Injects a script tag to fetch the shop settings JSONP.
- * @param {string} id The script id
- * @param {string} src The script url
- * @param {Function} onError Callback for error situations.
- */
-const injectScript = (id, src, onError) => {
-  let scriptTag = document.querySelector(`#${id}`);
-  if (scriptTag) {
-    scriptTag.remove();
-  }
-  scriptTag = document.createElement('script');
-  scriptTag.setAttribute('src', src);
-  scriptTag.setAttribute('id', id);
-  scriptTag.onerror = onError;
-  document.querySelector('head').appendChild(scriptTag);
-};
+import { loadCustomStyles, loadThemeCss, loadFontCss } from '@shopgate/engage/styles';
+import { getTypographyFontCssUrls } from '@shopgate/engage/settings/selectors/appSettings';
+// Imported via its module path rather than the admin-preview helpers barrel, which ThemeProvider
+// and loadThemeCss already import - this module reaches into the settings action creators.
+import { awaitInitialFrontendSettings } from '@shopgate/engage/admin-preview/initialization/awaitInitialFrontendSettings';
+import { fetchSettings } from "./fetchSettings";
 
 /**
- * Fetches settings
- * @param {Object} store Reference to the store
- * @returns {Promise}
+ * The app's redux store. Assembled here because configureStore is untyped JS whose JSDoc widens
+ * the return value to `Object`.
+ *
+ * dispatch stays permissive rather than using redux-thunk's ThunkDispatch: the action creators
+ * this module dispatches are untyped JS annotated `@returns {Object}` / `{Function}`, which match
+ * neither UnknownAction nor ThunkAction. Tightening it here would only force casts at every call
+ * site - it needs the JSDoc on those action creators to be fixed first.
  */
-const fetchSettings = store => new Promise((resolve, reject) => {
-  if (!settingsUrl) {
-    reject();
-    return;
-  }
-  let timeout;
-  let merchantReceived = null;
-  let shopReceived = null;
 
-  /**
-   * Evaluates if completed.
-   */
-  const evaluateEnd = () => {
-    if (!merchantReceived && merchantSettingsUrl || !shopReceived) {
-      return;
-    }
-    clearTimeout(timeout);
-    timeout = null;
-    resolve();
-  };
-
-  // Add the callbacks for the JSONP
-  window.setShopSettings = settings => {
-    store.dispatch(receiveShopSettings(settings));
-    shopReceived = true;
-    evaluateEnd();
-  };
-  window.setMerchantSettings = settings => {
-    store.dispatch(receiveMerchantSettings(settings));
-    merchantReceived = true;
-    evaluateEnd();
-  };
-
-  // Error handling
-  injectScript('shop-settings-jsonp', settingsUrl, error => {
-    withScope(scope => {
-      scope.setLevel(SentrySeverity.Error);
-      scope.setExtra('settingsUrl', settingsUrl);
-      captureMessage('Fetching shop settings failed');
-    });
-    clearTimeout(timeout);
-    timeout = null;
-    store.dispatch(errorShopSettings(error));
-    reject();
-  });
-  if (merchantSettingsUrl) {
-    injectScript('merchant-settings-jsonp', merchantSettingsUrl, () => {
-      withScope(scope => {
-        scope.setLevel(SentrySeverity.Error);
-        scope.setExtra('settingsUrl', merchantSettingsUrl);
-        captureMessage('Fetching merchant settings failed');
-      });
-      clearTimeout(timeout);
-      timeout = null;
-      reject();
-    });
-  }
-  timeout = setTimeout(() => {
-    withScope(scope => {
-      scope.setLevel(SentrySeverity.Warning);
-      scope.setExtra('settingsUrl', settingsUrl);
-      scope.setExtra('timeout', REQUEST_TIMEOUT);
-      captureMessage('Fetching shop settings took too long');
-    });
-  }, REQUEST_TIMEOUT);
-});
+const {
+  locales: {
+    currency: currencyLocale = null
+  } = {}
+} = appConfig;
 
 /**
- *
- * @param {Object} locales An object with locales.
- * @param {Function} reducers The reducers from the theme.
- * @param {Array} subscribers The subscribers to the streams middleware.
+ * Initializes the app: sets up i18n, creates the store, fetches the client information and the
+ * dynamic settings, and runs all registered app initialization handlers.
+ * @param locales An object with locales.
+ * @param reducers The reducers from the theme.
+ * @param subscribers The subscribers to the streams middleware.
+ * @returns The initialized store.
  */
 export const initialize = async (locales, reducers, subscribers) => {
   moment.locale(process.env.LOCALE);
@@ -142,12 +65,30 @@ export const initialize = async (locales, reducers, subscribers) => {
   configuration.set(CONFIGURATION_COLLECTION_KEY_BASE_URL, getAppBaseUrl());
   store.dispatch(appWillInit(`${window.location.pathname}${window.location.search}`));
   try {
-    const promises = [fetchSettings(store), loadCustomStyles()];
+    // The order of the style loaders does not affect the cascade: loadThemeCss and loadFontCss pin
+    // their links to their insertion points in the html template, while loadCustomStyles appends
+    // its link to the end of the head.
+    //
+    // The font css urls come from the app settings, so that loader is chained onto fetchSettings
+    // rather than started alongside it. Chaining keeps the other two running in parallel with the
+    // settings request instead of serializing everything behind it.
+    const promises = [fetchSettings(store).then(() => loadFontCss(getTypographyFontCssUrls(store.getState()))), loadCustomStyles(), loadThemeCss()];
     await Promise.all(promises);
   } catch (e) {
     // Nothing to see here.
   }
 
+  // Resolves at once outside the admin preview. Inside it, this holds app start until the admin
+  // sent its first settings payload, so the preview renders styled instead of painting the theme
+  // defaults first. Runs after fetchSettings, since the reducer merges and the preview has to be
+  // the later write.
+  await awaitInitialFrontendSettings(store);
+
+  // That payload can replace the configured font files, which were loaded above from whatever the
+  // jsonp settings carried, so they are synced again before anything renders. Outside the preview
+  // the urls are unchanged, and loadFontCss leaves the existing tags alone and resolves at once.
+  await loadFontCss(getTypographyFontCssUrls(store.getState()));
+
   // Execute all registered handlers from the AppInitialization collection
   await appInitialization.initialize({
     dispatch: store.dispatch,

package/core/router/conductor.d.ts

@@ -0,0 +1,9 @@
+import { Router } from '@virtuous/conductor';
+
+/**
+ * `@virtuous/conductor` ships types for the `Router` class but not for the singleton instance it
+ * exports at runtime. Declared here so that TypeScript consumers can use it.
+ */
+declare module '@virtuous/conductor' {
+  export const router: Router;
+}

package/core/router/helpers.d.ts

@@ -1,30 +1,43 @@
+export interface NavigationState {
+    target?: string;
+    [key: string]: unknown;
+}
+export interface NavigationParams {
+    pathname: string;
+    state?: NavigationState;
+    silent?: boolean;
+}
+export interface PopParams {
+    steps?: number;
+    state?: NavigationState;
+}
+export declare const NAVIGATION_PUSH = "navigation.push";
+export declare const NAVIGATION_POP = "navigation.pop";
+export declare const NAVIGATION_REPLACE = "navigation.replace";
+export declare const NAVIGATION_RESET = "navigation.reset";
 /**
  * Performs the PUSH navigation action.
- * @param {Object} params The history params.
+ * @param params The history params.
  */
-export function push(params: Object): void;
+export declare function push(params: NavigationParams): void;
 /**
  * Performs the POP navigation action.
+ * @param params The history params. Pass `steps` to pop more than one route.
  */
-export function pop(): void;
+export declare function pop(params?: PopParams): void;
 /**
  * Performs the REPLACE navigation action.
- * @param {Object} params The history params.
+ * @param params The history params.
  */
-export function replace(params: Object): void;
+export declare function replace(params: NavigationParams): void;
 /**
  * Performs the RESET navigation action.
- * @param {Object} params The history params.
  */
-export function reset(): void;
+export declare function reset(): void;
 /**
- * Performs the UPDATE navigation action.
- * @param {Object} state The meta state to add to a existing route.
- * @param {string} [routeId] The ID of the route to update.
+ * Adds meta state to an existing route.
+ * @param state The meta state to merge into the route.
+ * @param routeId The ID of the route to update. Defaults to the current route.
  */
-export function update(state: Object, routeId?: string): void;
-export const NAVIGATION_PUSH: "navigation.push";
-export const NAVIGATION_POP: "navigation.pop";
-export const NAVIGATION_REPLACE: "navigation.replace";
-export const NAVIGATION_RESET: "navigation.reset";
+export declare function update(state: NavigationState, routeId?: string): void;
 //# sourceMappingURL=helpers.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../core/router/helpers.js"],"names":[],"mappings":"AAQA;;;GAGG;AACH,6BAFW,MAAM,QAIhB;AAED;;GAEG;AACH,4BAEC;AAED;;;GAGG;AACH,gCAFW,MAAM,QAIhB;AAED;;;GAGG;AACH,8BAEC;AAED;;;;GAIG;AACH,8BAHW,MAAM,YACN,MAAM,QAIhB;AA3CD,8BAA+B,iBAAiB,CAAC;AACjD,6BAA8B,gBAAgB,CAAC;AAC/C,iCAAkC,oBAAoB,CAAC;AACvD,+BAAgC,kBAAkB,CAAC"}
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../core/router/helpers.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,eAAe;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,SAAS;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,eAAe,CAAC;CACzB;AAED,eAAO,MAAM,eAAe,oBAAoB,CAAC;AACjD,eAAO,MAAM,cAAc,mBAAmB,CAAC;AAC/C,eAAO,MAAM,kBAAkB,uBAAuB,CAAC;AACvD,eAAO,MAAM,gBAAgB,qBAAqB,CAAC;AAEnD;;;GAGG;AACH,wBAAgB,IAAI,CAAC,MAAM,EAAE,gBAAgB,GAAG,IAAI,CAEnD;AAED;;;GAGG;AACH,wBAAgB,GAAG,CAAC,MAAM,CAAC,EAAE,SAAS,GAAG,IAAI,CAE5C;AAED;;;GAGG;AACH,wBAAgB,OAAO,CAAC,MAAM,EAAE,gBAAgB,GAAG,IAAI,CAEtD;AAED;;GAEG;AACH,wBAAgB,KAAK,IAAI,IAAI,CAE5B;AAED;;;;GAIG;AACH,wBAAgB,MAAM,CACpB,KAAK,EAAE,eAAe,EACtB,OAAO,GAAE,MAAoC,GAC5C,IAAI,CAEN"}

package/core/router/helpers.js

@@ -7,7 +7,7 @@ export const NAVIGATION_RESET = 'navigation.reset';
 
 /**
  * Performs the PUSH navigation action.
- * @param {Object} params The history params.
+ * @param params The history params.
  */
 export function push(params) {
   UIEvents.emit(NAVIGATION_PUSH, params);
@@ -15,14 +15,15 @@ export function push(params) {
 
 /**
  * Performs the POP navigation action.
+ * @param params The history params. Pass `steps` to pop more than one route.
  */
-export function pop() {
-  UIEvents.emit(NAVIGATION_POP);
+export function pop(params) {
+  UIEvents.emit(NAVIGATION_POP, params);
 }
 
 /**
  * Performs the REPLACE navigation action.
- * @param {Object} params The history params.
+ * @param params The history params.
  */
 export function replace(params) {
   UIEvents.emit(NAVIGATION_REPLACE, params);
@@ -30,16 +31,15 @@ export function replace(params) {
 
 /**
  * Performs the RESET navigation action.
- * @param {Object} params The history params.
  */
 export function reset() {
   UIEvents.emit(NAVIGATION_RESET);
 }
 
 /**
- * Performs the UPDATE navigation action.
- * @param {Object} state The meta state to add to a existing route.
- * @param {string} [routeId] The ID of the route to update.
+ * Adds meta state to an existing route.
+ * @param state The meta state to merge into the route.
+ * @param routeId The ID of the route to update. Defaults to the current route.
  */
 export function update(state, routeId = router.getCurrentRoute().id) {
   router.update(routeId, state);

package/development/action-creators/index.d.ts

@@ -0,0 +1,3 @@
+export * from './settings';
+export * from './storage';
+//# sourceMappingURL=index.d.ts.map

package/development/action-creators/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../development/action-creators/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC"}

package/development/action-creators/settings.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Toggles the simulation of iOS safe area insets.
+ * @param visible Whether the insets should be visible or not.
+ * @returns The action object.
+ */
+export declare const toggleInsets: (visible?: boolean) => {
+    readonly type: "DEVELOPMENT_TOOLS_TOGGLE_INSETS";
+    readonly visible: boolean;
+};
+export type ToggleInsetsAction = ReturnType<typeof toggleInsets>;
+/**
+ * Toggles the highlighting of the simulated iOS safe area insets.
+ * @param visible Whether the insets should be visible or not.
+ * @returns The action object.
+ */
+export declare const toggleInsetHighlight: (visible?: boolean) => {
+    readonly type: "DEVELOPMENT_TOOLS_TOGGLE_INSET_HIGHLIGHT";
+    readonly visible: boolean;
+};
+export type ToggleInsetHighlightAction = ReturnType<typeof toggleInsetHighlight>;
+/**
+ * Toggles the CMS 2.0 preview mode.
+ * @param enabled Whether the CMS 2.0 preview should be enabled or not.
+ * @returns The action object.
+ */
+export declare const toggleCms2Preview: (enabled?: boolean) => {
+    readonly type: "DEVELOPMENT_TOOLS_TOGGLE_CMS2_PREVIEW";
+    readonly enabled: boolean;
+};
+export type ToggleCms2PreviewAction = ReturnType<typeof toggleCms2Preview>;
+/**
+ * Toggles whether a color scheme can be selected without the app settings allowing it.
+ * @param enabled Whether the selection should be enabled or not.
+ * @returns The action object.
+ */
+export declare const toggleColorSchemeSelection: (enabled?: boolean) => {
+    readonly type: "DEVELOPMENT_TOOLS_TOGGLE_COLOR_SCHEME_SELECTION";
+    readonly enabled: boolean;
+};
+export type ToggleColorSchemeSelectionAction = ReturnType<typeof toggleColorSchemeSelection>;
+/**
+ * Every action the development settings reducer handles.
+ */
+export type DevelopmentSettingsAction = ToggleInsetsAction | ToggleInsetHighlightAction | ToggleCms2PreviewAction | ToggleColorSchemeSelectionAction;
+//# sourceMappingURL=settings.d.ts.map

package/development/action-creators/settings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"settings.d.ts","sourceRoot":"","sources":["../../../development/action-creators/settings.ts"],"names":[],"mappings":"AAOA;;;;GAIG;AACH,eAAO,MAAM,YAAY,GAAI,iBAAc;;;CAGhC,CAAC;AAEZ,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC;AAEjE;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,GAAI,iBAAc;;;CAGxC,CAAC;AAEZ,MAAM,MAAM,0BAA0B,GAAG,UAAU,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAEjF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,GAAI,iBAAc;;;CAGrC,CAAC;AAEZ,MAAM,MAAM,uBAAuB,GAAG,UAAU,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE3E;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,GAAI,iBAAc;;;CAG9C,CAAC;AAEZ,MAAM,MAAM,gCAAgC,GAAG,UAAU,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE7F;;GAEG;AACH,MAAM,MAAM,yBAAyB,GACjC,kBAAkB,GAClB,0BAA0B,GAC1B,uBAAuB,GACvB,gCAAgC,CAAC"}