@genesislcap/foundation-auth 14.71.1-auth-mf.16 → 14.71.1-auth-mf.18

package/dist/esm/routes/base.js

@@ -3,13 +3,13 @@ import { createInputEmitter, createSelectEmitter, EventEmitter, targetChecked, }
 import { SecondaryRapidColorHEX } from '@genesislcap/foundation-zero';
 import { attr, css, customElement, FASTElement, html, observable, when, } from '@microsoft/fast-element';
 import { Container } from '@microsoft/fast-foundation';
-import { Route } from '@microsoft/fast-router';
 import { classNames } from '@microsoft/fast-web-utilities';
 import { CredentialManager } from '../credential';
 import { AuthConfig, defaultAuthConfig } from '../main/config';
 import { AuthStore } from '../store';
 import { User } from '../user';
 import { logger } from '../utils';
+import { AuthRouting } from './routing';
 /**
  * @internal
  */
@@ -49,8 +49,7 @@ export class BaseRoute extends ConfigHostElement {
          */
         this.message = '';
         this.hasErrors = false;
-        this.onBack = () => this.onNavigate('/');
-        this.onNavigate = (path) => Route.path.push(path);
+        this.onBack = () => this.routing.navigateTo('/');
     }
     connectedCallback() {
         super.connectedCallback();
@@ -64,9 +63,6 @@ export class BaseRoute extends ConfigHostElement {
     clearError() {
         logger.warn('base clearError callers need updating...');
     }
-    getSubRoutePath(routeName) {
-        return this.config.hostPath !== '' ? `${this.config.hostPath}/${routeName}` : routeName;
-    }
     attemptAutofill() {
         if (!this.store.formEntry.ssoToggled &&
             !this.store.formEntry.username &&
@@ -78,6 +74,9 @@ export class BaseRoute extends ConfigHostElement {
 __decorate([
     AuthStore
 ], BaseRoute.prototype, "store", void 0);
+__decorate([
+    AuthRouting
+], BaseRoute.prototype, "routing", void 0);
 __decorate([
     User
 ], BaseRoute.prototype, "user", void 0);

package/dist/esm/routes/index.js

@@ -1,3 +1,5 @@
 export * from './base';
 export * from './config';
+export * from './routing';
 export * from './types';
+export * from './utils';

package/dist/esm/routes/login/login.template.js

@@ -13,7 +13,7 @@ const regularLogin = html `
             ${when((x) => !x.config.omitRoutes.includes('forgot-password'), html `
                 <a
                   class="link-url"
-                  @click=${(x) => x.onNavigate(x.getSubRoutePath(`forgot-password`))}
+                  @click=${(x) => x.routing.navigateTo(`forgot-password`)}
                   data-test-id="forgot-password"
                 >
                   Forgot Password?
@@ -22,7 +22,7 @@ const regularLogin = html `
             ${when((x) => !x.config.omitRoutes.includes('reset-password'), html `
                 <a
                   class="link-url"
-                  @click=${(x) => x.onNavigate(x.getSubRoutePath(`reset-password`))}
+                  @click=${(x) => x.routing.navigateTo(`reset-password`)}
                   data-test-id="reset-password"
                 >
                   Change Password
@@ -33,7 +33,7 @@ const regularLogin = html `
             ${when((x) => !x.config.omitRoutes.includes('request-account'), html `
                 <a
                   class="link-url"
-                  @click=${(x) => x.onNavigate(x.getSubRoutePath(`request-account`))}
+                  @click=${(x) => x.routing.navigateTo(`request-account`)}
                   data-test-id="request-account"
                 >
                   Request Account

package/dist/esm/routes/logout/logout.js

@@ -5,9 +5,7 @@ import { LogoutStyles as styles } from './logout.styles';
 import { LogoutTemplate as template } from './logout.template';
 let Logout = class Logout extends BaseRoute {
     enter() {
-        if (this.user.isAuthenticated) {
-            this.logout();
-        }
+        this.logout();
     }
     logout() {
         this.$emit('auth-logout');

package/dist/esm/routes/protected/protected.js

@@ -7,7 +7,7 @@ import { BaseRoute } from '../base';
 import { ProtectedTemplate as template } from './protected.template';
 let Protected = class Protected extends BaseRoute {
     onLogout() {
-        this.$emit('auth-logout');
+        this.routing.navigateTo('logout');
     }
     onOpenSocketTest() {
         this.connect.connect(SOCKET_URL);

package/dist/esm/routes/routing.js

@@ -0,0 +1,51 @@
+import { __decorate } from "tslib";
+import { DI } from '@microsoft/fast-foundation';
+import { AuthConfig } from '../main/config';
+import { getRoutePath, navigateTo } from './utils';
+/**
+ * Default AuthRouting.
+ *
+ * @public
+ */
+export class DefaultAuthRouting {
+    /** {@inheritDoc AuthRouting.navigateTo} */
+    navigateTo(route) {
+        navigateTo(this.getRoutePath(route));
+    }
+    /** {@inheritDoc AuthRouting.getRoutePath} */
+    getRoutePath(route) {
+        return getRoutePath(route, this.config.hostPath);
+    }
+}
+__decorate([
+    AuthConfig
+], DefaultAuthRouting.prototype, "config", void 0);
+/**
+ * AuthRouting DI key.
+ *
+ * @privateRemarks
+ * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
+ *
+ * @internal
+ */
+export const AuthRouting = DI.createInterface((x) => x.singleton(DefaultAuthRouting));
+/**
+ * Gets AuthRouting from the DI container.
+ *
+ * @remarks
+ * A utility method for host applications that are not using decorators or the DI container.
+ *
+ * @example
+ * ```ts
+ * import { getAuthRouting } from '@genesislcap/foundation-auth';
+ * ...
+ * private authRouting = getAuthRouting();
+ * ...
+ * this.authRouting.navigateTo('logout');
+ * ```
+ *
+ * @public
+ */
+export function getAuthRouting() {
+    return DI.getOrCreateDOMContainer().get(AuthRouting);
+}

package/dist/esm/routes/types.js

@@ -1 +1,13 @@
-export {};
+/**
+ * @public
+ */
+export const AuthRoutes = {
+    login: 'login',
+    logout: 'logout',
+    'request-account': 'request-account',
+    'reset-password': 'reset-password',
+    'forgot-password': 'forgot-password',
+    verify: 'verify',
+    protected: 'protected',
+    'not-found': 'not-found',
+};

package/dist/esm/routes/utils.js

@@ -0,0 +1,39 @@
+import { Route } from '@microsoft/fast-router';
+import { AuthRoutes } from './types';
+/**
+ * A utility to check if a pathname is a route of this micro frontend.
+ *
+ * @param pathname - A pathname string to check, typically location.pathname, which is used when a value is omitted.
+ *
+ * @public
+ * @privateRemarks
+ * I've just put this util in for now given there's some app level direction code in place which needs review.
+ */
+export function isMFRoute(pathname = location.pathname) {
+    const valueParts = pathname.split('/');
+    const routeIdx = pathname.charAt(0) === '/' ? 1 : 0;
+    const route = valueParts[routeIdx];
+    return !!AuthRoutes[route];
+}
+/**
+ * @remarks
+ * Uses the `FASTRouter`.
+ *
+ * @param route - An auth route including query params if required, ie. `reset-password?expired`.
+ *
+ * @internal
+ */
+export function navigateTo(route) {
+    Route.path.push(route);
+}
+/**
+ * A utility to get a sub route path taking the host path into account.
+ *
+ * @param route - An auth route.
+ * @param hostPath - The host path.
+ *
+ * @public
+ */
+export function getRoutePath(route, hostPath = '') {
+    return hostPath ? `${hostPath}/${route}` : route;
+}