@genesislcap/foundation-auth 14.107.0-auth-mf.27 → 14.121.0

package/dist/esm/routes/request-account/request-account.template.js

@@ -2,6 +2,10 @@ import { sync } from '@genesislcap/foundation-utils';
 import { html } from '@microsoft/fast-element';
 import { cardTag, checkboxTag } from '../../tags';
 import { backButton, emailField, organisationField, password2Field, passwordField, submitButton, usernameField, } from '../base';
+/**
+ * RequestAccountTemplate
+ * @public
+ */
 export const RequestAccountTemplate = html `
   <auth-background>
     <div class="container">

package/dist/esm/routes/reset-password/reset-password.js

@@ -3,6 +3,19 @@ import { customElement, observable, volatile } from '@microsoft/fast-element';
 import { commonStyles } from '../../styles';
 import { BaseRoute } from '../base';
 import { ResetPasswordTemplate as template } from './reset-password.template';
+/**
+ * ResetPassword
+ *
+ * @fires auth-reset-password - Fires a custom 'auth-reset-password' event.
+ * @fires auth-change-password - Fires a custom 'auth-change-password' event.
+ * @fires auth-organisation-changed - Fires a custom 'auth-organisation-changed' event.
+ * @fires auth-username-changed - Fires a custom 'auth-username-changed' event.
+ * @fires auth-password-changed - Fires a custom 'auth-password-changed' event.
+ * @fires auth-password2-changed - Fires a custom 'auth-password2-changed' event.
+ * @fires auth-showPasswords-changed - Fires a custom 'auth-showPasswords-changed' event.
+ *
+ * @public
+ */
 let ResetPassword = class ResetPassword extends BaseRoute {
     constructor() {
         super(...arguments);

package/dist/esm/routes/reset-password/reset-password.template.js

@@ -1,6 +1,10 @@
 import { html, when } from '@microsoft/fast-element';
 import { cardTag } from '../../tags';
 import { backButton, organisationField, password2Field, passwordField, showPasswordsCheckbox, submitButton, usernameField, } from '../base';
+/**
+ * ResetPasswordTemplate
+ * @public
+ */
 export const ResetPasswordTemplate = html `
   <auth-background>
     <div class="container">

package/dist/esm/routes/verify/verify.js

@@ -4,6 +4,10 @@ import { commonStyles } from '../../styles';
 import { logger } from '../../utils';
 import { BaseRoute } from '../base';
 import { VerifyTemplate as template } from './verify.template';
+/**
+ * Verify
+ * @public
+ */
 let Verify = class Verify extends BaseRoute {
     constructor() {
         super(...arguments);

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

@@ -2,6 +2,10 @@ import { sync } from '@genesislcap/foundation-utils';
 import { html } from '@microsoft/fast-element';
 import { cardTag, textFieldTag } from '../../tags';
 import { backButton, submitButton } from '../base';
+/**
+ * VerifyTemplate
+ * @public
+ */
 export const VerifyTemplate = html `
   <auth-background>
     <div class="container">

package/dist/esm/services/idp.js

@@ -24,7 +24,7 @@ export class DefaultIDPService {
                             const { data } = context;
                             /**
                              * Format reference:
-                             * const IDPS: IDP[] = [
+                             * const IDPS: IDENTITY_PROVIDER[] = [
                              *   { ID: 'hsbc', DESCRIPTION: 'hsbc', TYPE: 'saml' },
                              *   { ID: 'mufg', DESCRIPTION: 'mufg', TYPE: 'saml' },
                              * ];
@@ -55,7 +55,7 @@ export class DefaultIDPService {
         /** {@inheritDoc IDPService.getLoginUrl} */
         this.getLoginUrl = (idp, urlTemplate = SSO_LOGIN_URL) => {
             if (!idp || !idp.type || !idp.id) {
-                throw new Error(`Invalid IDP: ${JSON.stringify(idp)}`);
+                throw new Error(`Invalid Identity Provider: ${JSON.stringify(idp)}`);
             }
             return urlTemplate.replace(this.loginUrlReplacePattern, (_, token) => idp[token] || '');
         };

package/dist/esm/store/authFormEntry.js

@@ -125,9 +125,30 @@ export class DefaultAuthFormEntryStore extends AbstractStore {
                     this.username = (_a = passwordCredentials.name) !== null && _a !== void 0 ? _a : '';
                     this.password = (_b = passwordCredentials.password) !== null && _b !== void 0 ? _b : '';
                     if (this.config.fields.organisation) {
+                        /**
+                         * Credential data examples:
+                         *
+                         * ```
+                         * id: JohnDoe:OrgX
+                         * password: ************
+                         *
+                         * id: JJaneDee:OrgY
+                         * password: **************
+                         *
+                         * id: JBob
+                         * password: *******
+                         * ```
+                         *
+                         * `valueParts` below is the id split by the `credentialSeparator`:
+                         *
+                         * ```
+                         * ['JohnDoe', 'OrgX'], ['JaneDee', 'OrgY'], ['Bob']
+                         * ```
+                         */
                         const combinedCompIdUsername = (_c = passwordCredentials.id) !== null && _c !== void 0 ? _c : '';
                         const valueParts = combinedCompIdUsername.split(credentialSeparator);
-                        const orgIdx = valueParts.length === 2 ? 1 : 0;
+                        const hasOrg = valueParts.length === 2;
+                        const orgIdx = hasOrg ? 1 : 0;
                         const proposedOrganisation = valueParts[orgIdx];
                         if (proposedOrganisation !== this.username) {
                             this.organisation = proposedOrganisation;

package/dist/foundation-auth.api.json

@@ -125,6 +125,16 @@
         {
           "tagName": "@preapproved",
           "syntaxKind": "modifier"
+        },
+        {
+          "tagName": "@tagname",
+          "syntaxKind": "block",
+          "allowMultiple": true
+        },
+        {
+          "tagName": "@fires",
+          "syntaxKind": "block",
+          "allowMultiple": true
         }
       ],
       "supportForTags": {
@@ -155,7 +165,9 @@
         "@virtual": true,
         "@betaDocumentation": true,
         "@internalRemarks": true,
-        "@preapproved": true
+        "@preapproved": true,
+        "@tagname": true,
+        "@fires": true
       },
       "reportUnsupportedHtmlElements": false
     }
@@ -912,8 +924,8 @@
                 },
                 {
                   "kind": "Reference",
-                  "text": "Idp",
-                  "canonicalReference": "@genesislcap/foundation-auth!Idp:interface"
+                  "text": "IdentityProvider",
+                  "canonicalReference": "@genesislcap/foundation-auth!IdentityProvider:interface"
                 },
                 {
                   "kind": "Content",
@@ -1556,8 +1568,8 @@
                 },
                 {
                   "kind": "Reference",
-                  "text": "Idp",
-                  "canonicalReference": "@genesislcap/foundation-auth!Idp:interface"
+                  "text": "IdentityProvider",
+                  "canonicalReference": "@genesislcap/foundation-auth!IdentityProvider:interface"
                 },
                 {
                   "kind": "Content",
@@ -4607,8 +4619,8 @@
                 },
                 {
                   "kind": "Reference",
-                  "text": "Idp",
-                  "canonicalReference": "@genesislcap/foundation-auth!Idp:interface"
+                  "text": "IdentityProvider",
+                  "canonicalReference": "@genesislcap/foundation-auth!IdentityProvider:interface"
                 },
                 {
                   "kind": "Content",
@@ -5132,8 +5144,8 @@
                 },
                 {
                   "kind": "Reference",
-                  "text": "Idp",
-                  "canonicalReference": "@genesislcap/foundation-auth!Idp:interface"
+                  "text": "IdentityProvider",
+                  "canonicalReference": "@genesislcap/foundation-auth!IdentityProvider:interface"
                 },
                 {
                   "kind": "Content",
@@ -9881,6 +9893,33 @@
                 "startIndex": 1,
                 "endIndex": 2
               }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/foundation-auth!EVENT_LOGIN_AUTH_NACK#REFRESH_TOKEN_EXPIRATION_MINS:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly REFRESH_TOKEN_EXPIRATION_MINS: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "REFRESH_TOKEN_EXPIRATION_MINS",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
             }
           ],
           "extendsTokenRanges": [
@@ -10323,7 +10362,7 @@
         {
           "kind": "Class",
           "canonicalReference": "@genesislcap/foundation-auth!FoundationAuth:class",
-          "docComment": "/**\n * FoundationAuth.\n *\n * @remarks\n *\n * Base MF export used by host application `configure` calls. It does not set up a design system or components. Both are expected to be registered in the host application, which should provide the details of which to the MF via TemplateOptions.\n *\n * See the {@link configure} hook for more information on how to set up and use this micro frontend in your application.\n *\n * @public\n */\n",
+          "docComment": "/**\n * FoundationAuth.\n *\n * @remarks\n *\n * Base MF export used by host application `configure` calls. It does not set up a design system or components. Both are expected to be registered in the host application, which should provide the details of which to the MF via TemplateOptions.\n *\n * See the {@link configure} hook for more information on how to set up and use this micro frontend in your application.\n *\n * @fires\n *\n * store-connected - Fires a custom 'store-connected' event after connection to connect the store.\n *\n * @fires\n *\n * store-ready - Fires a custom 'store-ready' event after connection to ready the store.\n *\n * @fires\n *\n * store-disconnected - Fires a custom 'store-disconnected' event after disconnection to unbind the store.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -10451,7 +10490,7 @@
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-auth!fromIDPDTO:var",
-          "docComment": "/**\n * fromIDPDTO\n *\n * @param dto - IDP.\n *\n * @public\n */\n",
+          "docComment": "/**\n * fromIDPDTO\n *\n * @param dto - IDENTITY_PROVIDER.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -10463,8 +10502,8 @@
             },
             {
               "kind": "Reference",
-              "text": "IDP",
-              "canonicalReference": "@genesislcap/foundation-auth!IDP:interface"
+              "text": "IDENTITY_PROVIDER",
+              "canonicalReference": "@genesislcap/foundation-auth!IDENTITY_PROVIDER:interface"
             },
             {
               "kind": "Content",
@@ -10472,8 +10511,8 @@
             },
             {
               "kind": "Reference",
-              "text": "Idp",
-              "canonicalReference": "@genesislcap/foundation-auth!Idp:interface"
+              "text": "IdentityProvider",
+              "canonicalReference": "@genesislcap/foundation-auth!IdentityProvider:interface"
             }
           ],
           "fileUrlPath": "src/mapper/utils.ts",
@@ -10645,27 +10684,27 @@
         },
         {
           "kind": "Interface",
-          "canonicalReference": "@genesislcap/foundation-auth!Idp:interface",
+          "canonicalReference": "@genesislcap/foundation-auth!IDENTITY_PROVIDER:interface",
           "docComment": "/**\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export interface Idp "
+              "text": "export interface IDENTITY_PROVIDER "
             }
           ],
-          "fileUrlPath": "src/entity/idp.ts",
+          "fileUrlPath": "src/dto/IDENTITY_PROVIDER.ts",
           "releaseTag": "Public",
-          "name": "Idp",
+          "name": "IDENTITY_PROVIDER",
           "preserveMemberOrder": false,
           "members": [
             {
               "kind": "PropertySignature",
-              "canonicalReference": "@genesislcap/foundation-auth!Idp#description:member",
+              "canonicalReference": "@genesislcap/foundation-auth!IDENTITY_PROVIDER#DESCRIPTION:member",
               "docComment": "",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "readonly description: "
+                  "text": "readonly DESCRIPTION: "
                 },
                 {
                   "kind": "Content",
@@ -10679,7 +10718,7 @@
               "isReadonly": true,
               "isOptional": false,
               "releaseTag": "Public",
-              "name": "description",
+              "name": "DESCRIPTION",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
                 "endIndex": 2
@@ -10687,12 +10726,12 @@
             },
             {
               "kind": "PropertySignature",
-              "canonicalReference": "@genesislcap/foundation-auth!Idp#id:member",
+              "canonicalReference": "@genesislcap/foundation-auth!IDENTITY_PROVIDER#ID:member",
               "docComment": "",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "readonly id: "
+                  "text": "readonly ID: "
                 },
                 {
                   "kind": "Content",
@@ -10706,7 +10745,7 @@
               "isReadonly": true,
               "isOptional": false,
               "releaseTag": "Public",
-              "name": "id",
+              "name": "ID",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
                 "endIndex": 2
@@ -10714,12 +10753,12 @@
             },
             {
               "kind": "PropertySignature",
-              "canonicalReference": "@genesislcap/foundation-auth!Idp#type:member",
+              "canonicalReference": "@genesislcap/foundation-auth!IDENTITY_PROVIDER#TYPE:member",
               "docComment": "",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "readonly type: "
+                  "text": "readonly TYPE: "
                 },
                 {
                   "kind": "Content",
@@ -10733,7 +10772,7 @@
               "isReadonly": true,
               "isOptional": false,
               "releaseTag": "Public",
-              "name": "type",
+              "name": "TYPE",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
                 "endIndex": 2
@@ -10744,27 +10783,27 @@
         },
         {
           "kind": "Interface",
-          "canonicalReference": "@genesislcap/foundation-auth!IDP:interface",
+          "canonicalReference": "@genesislcap/foundation-auth!IdentityProvider:interface",
           "docComment": "/**\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export interface IDP "
+              "text": "export interface IdentityProvider "
             }
           ],
-          "fileUrlPath": "src/dto/IDP.ts",
+          "fileUrlPath": "src/entity/identityProvider.ts",
           "releaseTag": "Public",
-          "name": "IDP",
+          "name": "IdentityProvider",
           "preserveMemberOrder": false,
           "members": [
             {
               "kind": "PropertySignature",
-              "canonicalReference": "@genesislcap/foundation-auth!IDP#DESCRIPTION:member",
+              "canonicalReference": "@genesislcap/foundation-auth!IdentityProvider#description:member",
               "docComment": "",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "readonly DESCRIPTION: "
+                  "text": "readonly description: "
                 },
                 {
                   "kind": "Content",
@@ -10778,7 +10817,7 @@
               "isReadonly": true,
               "isOptional": false,
               "releaseTag": "Public",
-              "name": "DESCRIPTION",
+              "name": "description",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
                 "endIndex": 2
@@ -10786,12 +10825,12 @@
             },
             {
               "kind": "PropertySignature",
-              "canonicalReference": "@genesislcap/foundation-auth!IDP#ID:member",
+              "canonicalReference": "@genesislcap/foundation-auth!IdentityProvider#id:member",
               "docComment": "",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "readonly ID: "
+                  "text": "readonly id: "
                 },
                 {
                   "kind": "Content",
@@ -10805,7 +10844,7 @@
               "isReadonly": true,
               "isOptional": false,
               "releaseTag": "Public",
-              "name": "ID",
+              "name": "id",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
                 "endIndex": 2
@@ -10813,12 +10852,12 @@
             },
             {
               "kind": "PropertySignature",
-              "canonicalReference": "@genesislcap/foundation-auth!IDP#TYPE:member",
+              "canonicalReference": "@genesislcap/foundation-auth!IdentityProvider#type:member",
               "docComment": "",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "readonly TYPE: "
+                  "text": "readonly type: "
                 },
                 {
                   "kind": "Content",
@@ -10832,7 +10871,7 @@
               "isReadonly": true,
               "isOptional": false,
               "releaseTag": "Public",
-              "name": "TYPE",
+              "name": "type",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
                 "endIndex": 2
@@ -12699,6 +12738,33 @@
                 "startIndex": 1,
                 "endIndex": 2
               }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/foundation-auth!LoginNack#refreshTokenExpirationMins:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly refreshTokenExpirationMins: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "refreshTokenExpirationMins",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
             }
           ],
           "extendsTokenRanges": [
@@ -14022,29 +14088,6 @@
             "endIndex": 2
           }
         },
-        {
-          "kind": "Variable",
-          "canonicalReference": "@genesislcap/foundation-auth!SOCKET_URL:var",
-          "docComment": "/**\n * @public\n */\n",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "SOCKET_URL: "
-            },
-            {
-              "kind": "Content",
-              "text": "string"
-            }
-          ],
-          "fileUrlPath": "src/env.ts",
-          "isReadonly": false,
-          "releaseTag": "Public",
-          "name": "SOCKET_URL",
-          "variableTypeTokenRange": {
-            "startIndex": 1,
-            "endIndex": 2
-          }
-        },
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-auth!SSO_LIST_URL:var",

package/dist/foundation-auth.d.ts

@@ -253,8 +253,8 @@ export declare interface AuthFormEntryStore extends Store {
     readonly hasPasswordExpired: boolean;
     readonly passwordResetToken: string;
     readonly mfaCode: string;
-    readonly idps: Idp[];
-    readonly selectedIdp: Idp;
+    readonly idps: IdentityProvider[];
+    readonly selectedIdp: IdentityProvider;
     readonly ssoLoginUrl: string;
     readonly ssoToggled: boolean;
     readonly termsAgreed: boolean;
@@ -824,9 +824,9 @@ export declare class DefaultAuthFormEntryStore extends AbstractStore<AuthFormEnt
     /** {@inheritDoc AuthFormEntryStore.mfaCode} */
     mfaCode: string;
     /** {@inheritDoc AuthFormEntryStore.idps} */
-    idps: Idp[];
+    idps: IdentityProvider[];
     /** {@inheritDoc AuthFormEntryStore.selectedIdp} */
-    selectedIdp: Idp;
+    selectedIdp: IdentityProvider;
     /** {@inheritDoc AuthFormEntryStore.ssoToggled} */
     ssoToggled: boolean;
     /** {@inheritDoc AuthFormEntryStore.termsAgreed} */
@@ -1260,6 +1260,7 @@ export declare interface EVENT_LOGIN_AUTH_NACK extends NACK {
      * A refresh token may be returned in a NACK on MFA_REQUIRED or similar.
      */
     readonly REFRESH_AUTH_TOKEN: string;
+    readonly REFRESH_TOKEN_EXPIRATION_MINS: number;
 }
 
 /**
@@ -1369,6 +1370,10 @@ export declare type ForgotPasswordParams = {
  *
  * See the {@link configure} hook for more information on how to set up and use this micro frontend in your application.
  *
+ * @fires store-connected - Fires a custom 'store-connected' event after connection to connect the store.
+ * @fires store-ready - Fires a custom 'store-ready' event after connection to ready the store.
+ * @fires store-disconnected - Fires a custom 'store-disconnected' event after disconnection to unbind the store.
+ *
  * @public
  */
 export declare class FoundationAuth extends FoundationAuth_base {
@@ -1421,6 +1426,10 @@ export declare class FoundationAuth extends FoundationAuth_base {
      * @internal
      */
     protected readyStore(): void;
+    /**
+     * @internal
+     */
+    protected disconnectStore(): void;
     /**
      * @internal
      */
@@ -1446,7 +1455,9 @@ declare const FoundationAuth_base: abstract new (...args: any[]) => {
     inert: boolean;
     innerText: string;
     lang: string;
-    readonly offsetHeight: number;
+    readonly offsetHeight: number; /**
+    * @internal
+    */
     readonly offsetLeft: number;
     readonly offsetParent: Element;
     readonly offsetTop: number;
@@ -1476,9 +1487,7 @@ declare const FoundationAuth_base: abstract new (...args: any[]) => {
     outerHTML: string;
     readonly ownerDocument: Document;
     readonly part: DOMTokenList;
-    readonly prefix: string; /**
-    * @internal
-    */
+    readonly prefix: string;
     readonly scrollHeight: number;
     scrollLeft: number;
     scrollTop: number;
@@ -1774,10 +1783,10 @@ export declare const fromDTOStringArray: (arr: string[]) => string[];
 
 /**
  * fromIDPDTO
- * @param dto - IDP.
+ * @param dto - IDENTITY_PROVIDER.
  * @public
  */
-export declare const fromIDPDTO: (dto: IDP) => Idp;
+export declare const fromIDPDTO: (dto: IDENTITY_PROVIDER) => IdentityProvider;
 
 /**
  * Represents options for retrieving credentials.
@@ -1833,7 +1842,7 @@ export declare const hasDTOErrorWarningCode: (dto: NACK, code: string) => boolea
 /**
  * @public
  */
-export declare interface IDP {
+export declare interface IDENTITY_PROVIDER {
     readonly ID: string;
     readonly TYPE: string;
     readonly DESCRIPTION: string;
@@ -1842,7 +1851,7 @@ export declare interface IDP {
 /**
  * @public
  */
-export declare interface Idp {
+export declare interface IdentityProvider {
     readonly id: string;
     readonly type: string;
     readonly description: string;
@@ -1856,11 +1865,11 @@ declare interface IDPService {
     /**
      * @param url - Defaults to `SSO_LIST_URL`.
      */
-    getList(url?: string): Promise<Idp[]>;
+    getList(url?: string): Promise<IdentityProvider[]>;
     /**
-     * @param idp - An idp entity.
+     * @param idp - An IdentityProvider entity.
      */
-    getLoginUrl(idp: Idp): string;
+    getLoginUrl(idp: IdentityProvider): string;
 }
 
 /**
@@ -1873,7 +1882,7 @@ declare type InternalAuthEventMap = {};
 
 declare type InternalEventMap = {
     'auth-fetch-idps': void;
-    'auth-fetch-idps-success': Idp[];
+    'auth-fetch-idps-success': IdentityProvider[];
     'auth-fetch-idps-error': Error;
 };
 
@@ -2136,6 +2145,7 @@ export declare const LoginMapper: InterfaceSymbol<LoginMapper>;
  */
 export declare interface LoginNack extends Nack {
     readonly refreshAuthToken: string;
+    readonly refreshTokenExpirationMins: number;
     readonly hasIncorrectCredentials: boolean;
     readonly maxTriesReached: boolean;
     readonly isMFARequired: boolean;
@@ -2469,11 +2479,6 @@ export declare type Settings = {
     public?: boolean;
 };
 
-/**
- * @public
- */
-export declare let SOCKET_URL: string;
-
 /**
  * @public
  */

package/docs/api/foundation-auth.authformentrystore.idps.md

@@ -7,5 +7,5 @@
 **Signature:**
 
 ```typescript
-readonly idps: Idp[];
+readonly idps: IdentityProvider[];
 ```