@shopgate/pwa-common 7.30.1-beta.2 → 7.30.1-beta.4

package/collections/Redirects.d.ts

@@ -0,0 +1,84 @@
+export type RedirectHandler =
+  | string
+  | Promise<string>
+  | ((...args: any[]) => string | Promise<string>);
+
+export type RedirectOptions = {
+  /**
+   * Whether to show a loading indicator while the redirect is being processed.
+   * @default true
+   */
+  showLoading?: boolean;
+  /**
+   * Whether to override an existing redirect.
+   * @default false
+   */
+  override?: boolean;
+};
+
+export interface RedirectExtendedData {
+  /**
+   * The value passed as "from" to set()
+   */
+  matcher?: string;
+  /**
+   * The value passed as "to" to set()
+   */
+  handler: RedirectHandler;
+  /**
+   * Decoded params from the pathname - defined within the matcher
+   */
+  pathParams?: Record<string, any> | null;
+  /**
+   * Decoded query params from the pathname
+   */
+  queryParams: Record<string, any>;
+  /**
+   * Additional options for the redirect, passed as the third argument to set()
+   */
+  options?: RedirectOptions | null;
+}
+
+export class Redirects {
+  /**
+   * Returns a specified element from the internal "redirects" Map object.
+   * @param pathname The pathname to lookup.
+   */
+  get(pathname: string): RedirectHandler | null;
+  /**
+   * Returns the redirect for a passed pathname.
+   * @param {string} pathname The pathname to check.
+   */
+  getRedirect(pathname: string): RedirectHandler | null;
+  /**
+   * Unlike "getRedirect" which only returns a matching handler for a passed pathname, this method
+   * returns an object that contains some extended data.
+   * @param pathname The pathname to check.
+   */
+  getRedirectExtended(pathname: string): RedirectExtendedData | null;
+  /**
+   * Adds a redirect handler to the collection.
+   * @param from The link to redirect from. Route patterns are also supported.
+   * @param to redirect / handle to create a dynamic link
+   * @param force Whether or not to forcefully set the redirect.
+   */
+  set(from?: string | null, to?: RedirectHandler | null, force?: boolean): void;
+
+  /**
+   * Adds a redirect handler to the collection.
+   * @param from The link to redirect from. Route patterns are also supported.
+   * @param to redirect / handle to create a dynamic link
+   * @param options Additional options for the redirect.
+   * @param force Whether or not to forcefully set the redirect.
+   */
+  set(from?: string | null, to?: RedirectHandler | null, options?: RedirectOptions, force?: boolean): void;
+
+  /**
+   * Removes a specified element from the internal "redirects" Map object.
+   * @param pathname The pathname to remove.
+   */
+  unset(pathname: string): void;
+}
+
+declare const redirects: Redirects;
+export default redirects;

package/collections/Redirects.js

@@ -10,6 +10,7 @@ let Redirects = /*#__PURE__*/function () {
    */
   function Redirects() {
     this.redirects = new Map();
+    this.redirectOptions = new Map();
     this.matcher = pathMatch({
       sensitive: false,
       strict: false,
@@ -99,6 +100,11 @@ let Redirects = /*#__PURE__*/function () {
       result.matcher = patternMatch;
       result.pathParams = matcherResult;
     }
+    const options = {
+      showLoading: true,
+      ...this.redirectOptions.get(pathname)
+    };
+    result.options = options;
     return result;
   }
 
@@ -106,29 +112,31 @@ let Redirects = /*#__PURE__*/function () {
    * Adds a redirect handler to the collection.
    * @param {string} from The link to redirect from. Route patterns are also supported.
    * @param {string|Function|Promise} to redirect / handle to create a dynamic link.
-   * @param {boolean} force Whether or not to forcefully set the redirect.
+   * @param {Object} forceOrOptions Additional options for the redirect.
    */;
-  _proto.set = function set(from = null, to = null, force = false) {
+  _proto.set = function set(from = null, to = null, forceOrOptions = false) {
     if (!from || !to) {
       return;
     }
-    if (!force && this.redirects.has(from)) {
+    const options = typeof forceOrOptions === 'object' ? forceOrOptions : null;
+    const forceFlag = typeof forceOrOptions === 'boolean' ? forceOrOptions : forceOrOptions?.override;
+    if (!forceFlag && this.redirects.has(from)) {
       return;
     }
     this.redirects.set(from, to);
+    if (options) {
+      this.redirectOptions.set(from, options);
+    }
   }
 
-  /* eslint-disable extra-rules/potential-point-free */
-
   /**
    * Removes a specified element from the internal "redirects" Map object.
    * @param {string} pathname The pathname to remove.
    */;
   _proto.unset = function unset(pathname) {
     this.redirects.delete(pathname);
-  }
-
-  /* eslint-enable extra-rules/potential-point-free */;
+    this.redirectOptions.delete(pathname);
+  };
   return Redirects;
 }();
 export default new Redirects();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shopgate/pwa-common",
-  "version": "7.30.1-beta.2",
+  "version": "7.30.1-beta.4",
   "description": "Common library for the Shopgate Connect PWA.",
   "license": "Apache-2.0",
   "author": "Shopgate <support@shopgate.com>",
@@ -17,7 +17,7 @@
   "dependencies": {
     "@redux-devtools/extension": "^3.3.0",
     "@sentry/browser": "6.0.1",
-    "@shopgate/pwa-benchmark": "7.30.1-beta.2",
+    "@shopgate/pwa-benchmark": "7.30.1-beta.4",
     "@virtuous/conductor": "~2.5.0",
     "@virtuous/react-conductor": "~2.5.0",
     "@virtuous/redux-persister": "1.1.0-beta.7",
@@ -40,7 +40,7 @@
     "swiper": "12.1.0"
   },
   "devDependencies": {
-    "@shopgate/pwa-core": "7.30.1-beta.2",
+    "@shopgate/pwa-core": "7.30.1-beta.4",
     "@types/react-portal": "^3.0.9",
     "lodash": "^4.17.23",
     "prop-types": "~15.8.1",

package/subscriptions/router.js

@@ -172,7 +172,8 @@ export default function routerSubscriptions(subscribe) {
       handler: redirect,
       matcher,
       pathParams,
-      queryParams
+      queryParams,
+      options
     } = redirects.getRedirectExtended(location) || {};
     /* eslint-enable prefer-const */
 
@@ -181,7 +182,9 @@ export default function routerSubscriptions(subscribe) {
         const {
           pathname
         } = getCurrentRoute(state);
-        LoadingProvider.setLoading(pathname);
+        if (options.showLoading) {
+          LoadingProvider.setLoading(pathname);
+        }
         const pattern = router.findPattern(location.split('?')[0]);
         const {
           transform
@@ -215,7 +218,9 @@ export default function routerSubscriptions(subscribe) {
           redirect = null;
           logger.error(e);
         }
-        LoadingProvider.unsetLoading(pathname);
+        if (options.showLoading) {
+          LoadingProvider.unsetLoading(pathname);
+        }
         if (!redirect) {
           return;
         }