@genesislcap/foundation-auth 15.14.0 → 15.14.2-FUI-2603.1

package/dist/esm/mapper/utils.test.js

@@ -0,0 +1,56 @@
+import { APIError } from '@genesislcap/foundation-state-machine';
+import { assert, createLogicSuite } from '@genesislcap/foundation-testing';
+import { StatusCodes } from 'http-status-codes';
+import { nackErrorFromUnknown } from '../machine/errors';
+import { hasDTOErrors, isFailedAuthDTO, isNackDTO } from './utils';
+const Suite = createLogicSuite('password-reset response handling');
+const passwordValidationNack = {
+    WARNING: [],
+    ERROR: [
+        {
+            '@type': 'StandardError',
+            CODE: 'INTERNAL_ERROR',
+            TEXT: 'Password validation failed Password must be 8 or more characters in length.\nPassword must contain 1 or more special characters.',
+            STATUS_CODE: '500 Internal Server Error',
+        },
+    ],
+    MESSAGE_TYPE: 'EVENT_NACK',
+    SOURCE_REF: '17605761-55cb-4b5a-a1ec-7235d3cae393',
+};
+const eventAck = {
+    MESSAGE_TYPE: 'EVENT_ACK',
+    SOURCE_REF: 'ack-ref',
+};
+Suite('detects EVENT_NACK as failure', () => {
+    assert.ok(isNackDTO(passwordValidationNack));
+    assert.ok(isFailedAuthDTO(passwordValidationNack));
+    assert.ok(hasDTOErrors(passwordValidationNack));
+});
+Suite('detects ERROR payload as failure even without NACK suffix', () => {
+    const ackWithErrors = Object.assign(Object.assign({}, eventAck), { ERROR: passwordValidationNack.ERROR });
+    assert.not.ok(isNackDTO(ackWithErrors));
+    assert.ok(hasDTOErrors(ackWithErrors));
+    assert.ok(isFailedAuthDTO(ackWithErrors));
+});
+Suite('treats EVENT_ACK without ERROR as success', () => {
+    assert.not.ok(isNackDTO(eventAck));
+    assert.not.ok(hasDTOErrors(eventAck));
+    assert.not.ok(isFailedAuthDTO(eventAck));
+});
+Suite('extracts strong-password error text from EVENT_NACK', () => {
+    const error = nackErrorFromUnknown(passwordValidationNack);
+    assert.ok(error);
+    assert.ok(error.message.includes('Password validation failed'));
+    assert.is(error.status, StatusCodes.INTERNAL_SERVER_ERROR);
+});
+Suite('extracts NACK from FetchMachineOutput and APIError wrappers', () => {
+    const fromFetch = nackErrorFromUnknown({ data: passwordValidationNack, response: { ok: true } });
+    assert.ok(fromFetch === null || fromFetch === void 0 ? void 0 : fromFetch.message.includes('Password validation failed'));
+    const fromApiError = nackErrorFromUnknown(new APIError(StatusCodes.INTERNAL_SERVER_ERROR, passwordValidationNack));
+    assert.ok(fromApiError === null || fromApiError === void 0 ? void 0 : fromApiError.message.includes('Password validation failed'));
+});
+Suite('does not treat EVENT_ACK as an error', () => {
+    assert.is(nackErrorFromUnknown(eventAck), null);
+    assert.is(nackErrorFromUnknown({ data: eventAck }), null);
+});
+Suite.run();

package/dist/esm/routes/base.js

@@ -53,6 +53,12 @@ export class BaseRoute extends ConfigHostElement {
         super(...arguments);
         this.onBack = () => this.routing.navigateTo('/');
     }
+    connectedCallback() {
+        var _a, _b, _c, _d, _e;
+        super.connectedCallback();
+        (_c = (_b = (_a = this.store) === null || _a === void 0 ? void 0 : _a.formEntry) === null || _b === void 0 ? void 0 : _b.errors) === null || _c === void 0 ? void 0 : _c.clear();
+        (_e = (_d = this.store) === null || _d === void 0 ? void 0 : _d.authMachine) === null || _e === void 0 ? void 0 : _e.send({ type: 'dismiss' });
+    }
     toLocalisedText(text) {
         return this.i18next.t(`${defaultAuthConfig.name}:${text}`, { lng: this.i18next.language });
     }
@@ -372,7 +378,7 @@ let MessageElement = class MessageElement extends FASTElement {
         const translateHelper = (metaMessage) => this.i18next.t(`${defaultAuthConfig.name}:${metaMessage}`, { lng: this.i18next.language });
         const meta = this.store.metaMessages.map(translateHelper).join('\n');
         const error = this.store.errorMessages.map(translateHelper).join('\n');
-        return !error ? meta : `${meta} ${error}.`;
+        return error || meta;
     }
     get hasError() {
         return this.store.errorMessages.length > 0;

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

@@ -3,6 +3,7 @@ import { customElement } from '@microsoft/fast-element';
 import { commonStyles } from '../../styles';
 import { logger } from '../../utils';
 import { BaseRoute } from '../base';
+import { persistResetIdentity } from '../reset-password/reset-identity';
 import { ForgotPasswordTemplate as template } from './forgot-password.template';
 /**
  * ForgotPassword
@@ -20,6 +21,10 @@ let ForgotPassword = class ForgotPassword extends BaseRoute {
             /**
              * Example url from email: https://public-foundation.genesislab.global/reset-password?password=nc_cbGrlgCkZeJHAF043oqEidnk
              */
+            persistResetIdentity({
+                username: this.store.formEntry.username,
+                organisation: this.store.formEntry.organisation,
+            });
             this.$emit('auth-forgot-password', {
                 username: this.store.formEntry.orgUsername,
                 returnUrl: this.routing.getForgotPasswordReturnUrl(),

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

@@ -0,0 +1,99 @@
+/**
+ * Identity captured during forgot-password so the token reset screen can
+ * submit USER_NAME without asking the user to type it again.
+ */
+export const RESET_IDENTITY_STORAGE_KEY = 'foundation-auth:password-reset-identity';
+const getStorage = (storage) => {
+    if (storage) {
+        return storage;
+    }
+    try {
+        return globalThis.localStorage;
+    }
+    catch (_a) {
+        return undefined;
+    }
+};
+/**
+ * @public
+ */
+export function persistResetIdentity(identity, storage) {
+    var _a, _b;
+    if (!((_a = identity === null || identity === void 0 ? void 0 : identity.username) === null || _a === void 0 ? void 0 : _a.trim())) {
+        return;
+    }
+    const target = getStorage(storage);
+    if (!target) {
+        return;
+    }
+    try {
+        target.setItem(RESET_IDENTITY_STORAGE_KEY, JSON.stringify({
+            username: identity.username.trim(),
+            organisation: ((_b = identity.organisation) === null || _b === void 0 ? void 0 : _b.trim()) || undefined,
+        }));
+    }
+    catch (_c) {
+        // Storage may be unavailable (private mode, SSR).
+    }
+}
+/**
+ * @public
+ */
+export function readResetIdentity(storage) {
+    var _a, _b;
+    const target = getStorage(storage);
+    if (!target) {
+        return undefined;
+    }
+    try {
+        const raw = target.getItem(RESET_IDENTITY_STORAGE_KEY);
+        if (!raw) {
+            return undefined;
+        }
+        const parsed = JSON.parse(raw);
+        if ((_a = parsed === null || parsed === void 0 ? void 0 : parsed.username) === null || _a === void 0 ? void 0 : _a.trim()) {
+            return {
+                username: parsed.username.trim(),
+                organisation: ((_b = parsed.organisation) === null || _b === void 0 ? void 0 : _b.trim()) || undefined,
+            };
+        }
+    }
+    catch (_c) {
+        // Ignore malformed payloads.
+    }
+    return undefined;
+}
+/**
+ * @public
+ */
+export function clearResetIdentity(storage) {
+    const target = getStorage(storage);
+    if (!target) {
+        return;
+    }
+    try {
+        target.removeItem(RESET_IDENTITY_STORAGE_KEY);
+    }
+    catch (_a) {
+        // Storage may be unavailable.
+    }
+}
+/**
+ * @public
+ */
+export function resolveResetUsername(queryParams = {}, stored) {
+    return (queryParams.username ||
+        queryParams.user ||
+        queryParams.USER_NAME ||
+        (stored === null || stored === void 0 ? void 0 : stored.username) ||
+        '').trim();
+}
+/**
+ * Username is required by EVENT_PASSWORD_RESET_ACTION. Hide it only when a
+ * reset token is present and the username is already known.
+ *
+ * @public
+ */
+export function shouldShowIdentityFields(passwordResetToken, username) {
+    return !passwordResetToken || !username.trim();
+}

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

@@ -0,0 +1,55 @@
+import { assert, createLogicSuite } from '@genesislcap/foundation-testing';
+import { clearResetIdentity, persistResetIdentity, readResetIdentity, resolveResetUsername, RESET_IDENTITY_STORAGE_KEY, shouldShowIdentityFields, } from './reset-identity';
+const Suite = createLogicSuite('reset-identity');
+const createMemoryStorage = () => {
+    const map = new Map();
+    return {
+        get length() {
+            return map.size;
+        },
+        clear: () => map.clear(),
+        getItem: (key) => { var _a; return (_a = map.get(key)) !== null && _a !== void 0 ? _a : null; },
+        key: (index) => { var _a; return (_a = [...map.keys()][index]) !== null && _a !== void 0 ? _a : null; },
+        removeItem: (key) => {
+            map.delete(key);
+        },
+        setItem: (key, value) => {
+            map.set(key, value);
+        },
+    };
+};
+Suite('hides username when token is present and username is known', () => {
+    assert.not.ok(shouldShowIdentityFields('reset-token', 'JaneDee'));
+});
+Suite('shows username when token is present but username is missing', () => {
+    assert.ok(shouldShowIdentityFields('reset-token', ''));
+    assert.ok(shouldShowIdentityFields('reset-token', '   '));
+});
+Suite('shows username when token is absent', () => {
+    assert.ok(shouldShowIdentityFields('', 'JaneDee'));
+    assert.ok(shouldShowIdentityFields(undefined, ''));
+});
+Suite('resolves username from query params before stored identity', () => {
+    const stored = { username: 'stored-user' };
+    assert.is(resolveResetUsername({ username: 'query-user' }, stored), 'query-user');
+    assert.is(resolveResetUsername({ user: 'alias-user' }, stored), 'alias-user');
+    assert.is(resolveResetUsername({ USER_NAME: 'legacy-user' }, stored), 'legacy-user');
+});
+Suite('resolves username from stored identity when query has no username', () => {
+    assert.is(resolveResetUsername({ password: 'token' }, { username: 'stored-user' }), 'stored-user');
+    assert.is(resolveResetUsername({ password: 'token' }), '');
+});
+Suite('persists, reads and clears reset identity', () => {
+    const storage = createMemoryStorage();
+    persistResetIdentity({ username: ' JaneDee ', organisation: ' FBN ' }, storage);
+    assert.equal(readResetIdentity(storage), { username: 'JaneDee', organisation: 'FBN' });
+    assert.ok(storage.getItem(RESET_IDENTITY_STORAGE_KEY));
+    clearResetIdentity(storage);
+    assert.is(readResetIdentity(storage), undefined);
+});
+Suite('does not persist empty username', () => {
+    const storage = createMemoryStorage();
+    persistResetIdentity({ username: '  ' }, storage);
+    assert.is(readResetIdentity(storage), undefined);
+});
+Suite.run();

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

@@ -2,6 +2,7 @@ import { __awaiter, __decorate } from "tslib";
 import { customElement, observable, volatile } from '@microsoft/fast-element';
 import { commonStyles } from '../../styles';
 import { BaseRoute } from '../base';
+import { readResetIdentity, resolveResetUsername, shouldShowIdentityFields, } from './reset-identity';
 import { ResetPasswordTemplate as template } from './reset-password.template';
 /**
  * ResetPassword
@@ -26,6 +27,21 @@ let ResetPassword = class ResetPassword extends BaseRoute {
     enter(phase) {
         this.hasPasswordExpired = !!phase.route.queryParams.expired;
         this.passwordResetToken = phase.route.queryParams.password;
+        this.applyResetIdentity(phase.route.queryParams);
+    }
+    applyResetIdentity(queryParams) {
+        if (!this.passwordResetToken) {
+            return;
+        }
+        const stored = readResetIdentity();
+        const username = resolveResetUsername(queryParams, stored);
+        if (username) {
+            this.store.formEntry.onUsernameChanged(new CustomEvent('auth-username-changed', { detail: username }));
+        }
+        const organisation = queryParams.organisation || (stored === null || stored === void 0 ? void 0 : stored.organisation);
+        if (organisation) {
+            this.store.formEntry.onOrganisationChanged(new CustomEvent('auth-organisation-changed', { detail: organisation }));
+        }
     }
     onSubmit() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -53,6 +69,9 @@ let ResetPassword = class ResetPassword extends BaseRoute {
     get headingText() {
         return this.hasPasswordExpired ? 'You are required to change your password' : 'Change Password';
     }
+    get showIdentityFields() {
+        return shouldShowIdentityFields(this.passwordResetToken, this.store.formEntry.username);
+    }
 };
 __decorate([
     observable
@@ -63,6 +82,9 @@ __decorate([
 __decorate([
     volatile
 ], ResetPassword.prototype, "headingText", null);
+__decorate([
+    volatile
+], ResetPassword.prototype, "showIdentityFields", null);
 ResetPassword = __decorate([
     customElement({
         name: 'foundation-auth-reset-password',

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

@@ -12,10 +12,14 @@ export const ResetPasswordTemplate = html `
           <auth-logo></auth-logo>
           ${showEnvironmentIndicator()}
           <div class="heading2" data-test-id="heading">${(x) => x.headingText}</div>
-          <div class="heading3">${(x) => x.toLocalisedText('RESET_PASSWORD_SUBTITLE')}</div>
+          <div class="heading3">
+            ${(x) => x.toLocalisedText(x.showIdentityFields ? 'RESET_PASSWORD_SUBTITLE' : 'RESET_PASSWORD_TOKEN_SUBTITLE')}
+          </div>
         </div>
         <form @submit=${(x) => x.onSubmit()} autocomplete="on" data-test-id="form">
-          ${organisationField()} ${usernameField()}
+          ${when((x) => x.showIdentityFields, html `
+              ${organisationField()} ${usernameField()}
+            `)}
           ${when((x) => !x.passwordResetToken, html `
               ${(x) => passwordField(x.toLocalisedText(x.hasPasswordExpired
     ? 'RESET_PASSWORD_CURRENT_PASSWORD_FIELD'

package/dist/esm/translation.json

@@ -26,6 +26,7 @@
             "REQUEST_ACCOUNT_SUBMIT_BUTTON": "Request Account",
             "REQUEST_ACCOUNT_BUTTON_BACK": "Back",
             "RESET_PASSWORD_SUBTITLE": "Enter the username registered to your account",
+            "RESET_PASSWORD_TOKEN_SUBTITLE": "Enter a new password for your account",
             "RESET_PASSWORD_OLD_PASSWORD_FIELD": "Old Password",
             "RESET_PASSWORD_CURRENT_PASSWORD_FIELD": "Current Password",
             "RESET_PASSWORD_SUBMIT_BUTTON": "Change Password",

package/dist/foundation-auth.api.json

@@ -2179,7 +2179,7 @@
             },
             {
               "kind": "Content",
-              "text": ";\n} | {\n    type: 'logout';\n} | {\n    type: 'cancel-mfa';\n} | {\n    type: 'change-password';\n    params: "
+              "text": ";\n} | {\n    type: 'logout';\n} | {\n    type: 'cancel-mfa';\n} | {\n    type: 'dismiss';\n} | {\n    type: 'change-password';\n    params: "
             },
             {
               "kind": "Reference",
@@ -3283,6 +3283,89 @@
             "endIndex": 2
           }
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@genesislcap/foundation-auth!clearAuthErrorState:function(1)",
+          "docComment": "/**\n * Drop accumulated machine errors. `ErrorMap` is shared with `startingContext`, so reset must clear it in place rather than replacing the context object.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function clearAuthErrorState<T extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "ErrorState",
+              "canonicalReference": "@genesislcap/foundation-auth!~ErrorState:type"
+            },
+            {
+              "kind": "Content",
+              "text": ">(context: "
+            },
+            {
+              "kind": "Content",
+              "text": "T"
+            },
+            {
+              "kind": "Content",
+              "text": ", starting?: "
+            },
+            {
+              "kind": "Content",
+              "text": "T"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "T"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/machine/actions.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 7,
+            "endIndex": 8
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "context",
+              "parameterTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "starting",
+              "parameterTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 6
+              },
+              "isOptional": true
+            }
+          ],
+          "typeParameters": [
+            {
+              "typeParameterName": "T",
+              "constraintTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              }
+            }
+          ],
+          "name": "clearAuthErrorState"
+        },
         {
           "kind": "Function",
           "canonicalReference": "@genesislcap/foundation-auth!configure:function(1)",
@@ -6068,7 +6151,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "() => {\n        login: {\n            actions: string[];\n            target: string;\n        };\n        \"terms-and-conditions\": {\n            actions: string[];\n            target: string;\n        };\n        \"forgot-password\": {\n            actions: string[];\n            target: string;\n        };\n        \"change-password\": {\n            actions: string[];\n            target: string;\n        };\n        \"reset-password\": {\n            actions: string[];\n            target: string;\n        };\n    }"
+                  "text": "() => {\n        login: {\n            actions: string[];\n            target: string;\n        };\n        \"terms-and-conditions\": {\n            actions: string[];\n            target: string;\n        };\n        \"forgot-password\": {\n            actions: string[];\n            target: string;\n        };\n        \"change-password\": {\n            actions: string[];\n            target: string;\n        };\n        \"reset-password\": {\n            actions: string[];\n            target: string;\n        };\n        dismiss: {\n            actions: string[];\n            target: string;\n        };\n    }"
                 },
                 {
                   "kind": "Content",
@@ -10006,6 +10089,51 @@
           ],
           "name": "getRoutePath"
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@genesislcap/foundation-auth!hasDTOErrors:function(1)",
+          "docComment": "/**\n * True when a Genesis payload contains at least one ERROR item.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function hasDTOErrors(dto: "
+            },
+            {
+              "kind": "Content",
+              "text": "unknown"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "boolean"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/mapper/utils.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 4
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "dto",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "hasDTOErrors"
+        },
         {
           "kind": "Function",
           "canonicalReference": "@genesislcap/foundation-auth!hasDTOErrorWarningCode:function(1)",
@@ -10408,6 +10536,51 @@
           ],
           "name": "isChangePasswordParams"
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@genesislcap/foundation-auth!isFailedAuthDTO:function(1)",
+          "docComment": "/**\n * True when a Genesis payload must be treated as failure. HTTP status is intentionally ignored; MESSAGE_TYPE and ERROR are the contract.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function isFailedAuthDTO(dto: "
+            },
+            {
+              "kind": "Content",
+              "text": "unknown"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Content",
+              "text": "boolean"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/mapper/utils.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 4
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "dto",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "isFailedAuthDTO"
+        },
         {
           "kind": "Function",
           "canonicalReference": "@genesislcap/foundation-auth!isForgotPasswordParams:function(1)",

package/dist/foundation-auth.d.ts

@@ -438,6 +438,8 @@ export declare type AuthMachineEvent = {
     type: 'logout';
 } | {
     type: 'cancel-mfa';
+} | {
+    type: 'dismiss';
 } | {
     type: 'change-password';
     params: ChangePasswordParams;
@@ -639,6 +641,13 @@ export declare type ChangePasswordParams = {
     requester?: string;
 };
 
+/**
+ * Drop accumulated machine errors. `ErrorMap` is shared with `startingContext`, so
+ * reset must clear it in place rather than replacing the context object.
+ * @public
+ */
+export declare function clearAuthErrorState<T extends ErrorState>(context: T, starting?: T): T;
+
 /**
  * configure.
  *
@@ -1031,6 +1040,10 @@ export declare class DefaultAuthMachine extends AbstractMachine<AuthMachineConte
             actions: string[];
             target: string;
         };
+        dismiss: {
+            actions: string[];
+            target: string;
+        };
     };
     protected dtoTransition: () => {
         actions: string[];
@@ -1237,6 +1250,13 @@ declare interface Details_2 {
     readonly PRODUCT: Product_2[];
 }
 
+declare type ErrorState = {
+    error?: unknown;
+    errors?: {
+        clear(): void;
+    };
+};
+
 /**
  * @public
  */
@@ -1951,6 +1971,12 @@ export declare function getRoutePath(route: AuthRoutes | string, hostPath?: stri
 
 export { getUser }
 
+/**
+ * True when a Genesis payload contains at least one ERROR item.
+ * @public
+ */
+export declare function hasDTOErrors(dto: unknown): boolean;
+
 /**
  * hasDTOErrorWarningCode
  * @remarks
@@ -2012,7 +2038,8 @@ declare type InternalEventMap = {
 /**
  * is200Nack.
  * @privateRemarks
- * Required until http status codes are aligned on backend.
+ * Required until http status codes are aligned on backend. HTTP status is ignored;
+ * Genesis MESSAGE_TYPE / ERROR determine failure.
  * @public
  */
 export declare const is200Nack: <TOutput = any>(event: EventObject | DoneInvokeEvent<TOutput>) => event is DoneInvokeEvent<TOutput>;
@@ -2026,6 +2053,13 @@ export declare const is200Nack: <TOutput = any>(event: EventObject | DoneInvokeE
  */
 export declare function isChangePasswordParams(params: AuthMachineEventParams): params is ChangePasswordParams;
 
+/**
+ * True when a Genesis payload must be treated as failure.
+ * HTTP status is intentionally ignored; MESSAGE_TYPE and ERROR are the contract.
+ * @public
+ */
+export declare function isFailedAuthDTO(dto: unknown): boolean;
+
 /**
  * isForgotPasswordParams.
  * @remarks