@genesislcap/foundation-auth 14.136.0 → 14.137.0

package/dist/esm/user/user.js

@@ -1,200 +0,0 @@
-import { __decorate } from "tslib";
-import { createObserver } from '@genesislcap/foundation-utils';
-import { Observable, observable } from '@microsoft/fast-element';
-import { DI } from '@microsoft/fast-foundation';
-import { UserConfig } from './config';
-/**
- * UserAuthenticationChangeType.
- * @public
- */
-export const UserAuthenticationChangeType = 'user-authentication-change';
-/**
- * Default User implementation.
- * @public
- */
-export class DefaultUser {
-    constructor() {
-        /** {@inheritDoc UserPathHistory.pathHistory} */
-        this.pathHistory = [];
-        /** {@inheritDoc UserActionHistory.actionHistory} */
-        this.actionHistory = [];
-        /** {@inheritDoc User.isAuthenticated} */
-        this.isAuthenticated = false;
-        /** @internal */
-        this.authenticationChangeListeners = createObserver();
-    }
-    /** {@inheritDoc User.set} */
-    set(entity) {
-        if (this.isAuthenticated) {
-            throw new Error(`Only AuthMachine should call User.set. If this is intentional, please call User.unset first.`);
-        }
-        this.userKVs = entity.userKVs;
-        this.details = entity.details;
-        this.permission = entity.permission;
-        this.profile = entity.profile;
-        this.sourceRef = entity.sourceRef;
-        this.userName = entity.userName;
-        this.isAuthenticated = true;
-        return this;
-    }
-    /** {@inheritDoc User.unset} */
-    unset() {
-        this.userKVs = undefined;
-        this.details = undefined;
-        this.permission = undefined;
-        this.profile = undefined;
-        this.sourceRef = undefined;
-        this.userName = undefined;
-        this.isAuthenticated = false;
-        return this;
-    }
-    /** @internal */
-    userNameChanged() {
-        Observable.notify(this, 'username');
-    }
-    /** {@inheritDoc User.username} */
-    get username() {
-        Observable.track(this, 'username');
-        return this.userName;
-    }
-    /** {@inheritDoc User.isAnonymous} */
-    get isAnonymous() {
-        return !this.isAuthenticated;
-    }
-    /** {@inheritDoc User.isAdmin} */
-    isAdmin() {
-        return this.hasProfile('ADMIN');
-    }
-    /** {@inheritDoc User.isBanned} */
-    isBanned() {
-        return this.hasProfile('BANNED');
-    }
-    /** {@inheritDoc User.hasPermission} */
-    hasPermission(permission) {
-        return this.hasKey(this.permission, permission);
-    }
-    /** {@inheritDoc User.hasProfile} */
-    hasProfile(profile) {
-        return this.hasKey(this.profile, profile);
-    }
-    /** {@inheritDoc UserPathHistory.trackPath} */
-    trackPath() {
-        const { pathname, search, hash } = location;
-        const path = `${pathname !== '/' ? pathname : ''}`;
-        const urlPath = `${path}${search}${hash}`;
-        if (this.config.trackPathExclusions.includes(urlPath)) {
-            return;
-        }
-        this.pathHistory.push(urlPath);
-        return urlPath;
-    }
-    /** {@inheritDoc UserPathHistory.clearPaths} */
-    clearPaths() {
-        this.pathHistory = [];
-    }
-    /** {@inheritDoc UserPathHistory.lastPath} */
-    lastPath() {
-        const length = this.pathHistory.length;
-        return length > 0 ? this.pathHistory[length - 1] : undefined;
-    }
-    /** {@inheritDoc UserActionHistory.trackAction} */
-    trackAction(details) {
-        if (this.config.trackActionExclusions.includes(details)) {
-            return;
-        }
-        this.actionHistory.push(details);
-    }
-    /** {@inheritDoc UserActionHistory.clearActions} */
-    clearActions() {
-        this.actionHistory = [];
-    }
-    /** {@inheritDoc UserActionHistory.lastAction} */
-    lastAction() {
-        const length = this.actionHistory.length;
-        return length > 0 ? this.actionHistory[length - 1] : undefined;
-    }
-    /** {@inheritDoc User.clearTrackingHistory} */
-    clearTrackingHistory() {
-        this.clearPaths();
-        this.clearActions();
-    }
-    /** @internal */
-    hasKey(keys, key) {
-        if (!keys || !keys.length || !key) {
-            return false;
-        }
-        if (!Array.isArray(key)) {
-            key = [key];
-        }
-        return key.some((k) => keys.includes(k));
-    }
-    /** {@inheritDoc User.addAuthenticationChangeListener} */
-    addAuthenticationChangeListener(listener) {
-        var _a;
-        return (_a = this.authenticationChangeListeners) === null || _a === void 0 ? void 0 : _a.subscribe(listener);
-    }
-    /** @internal */
-    isAuthenticatedChanged() {
-        var _a;
-        (_a = this.authenticationChangeListeners) === null || _a === void 0 ? void 0 : _a.publish(new CustomEvent(UserAuthenticationChangeType, {
-            detail: this.isAuthenticated,
-        }));
-    }
-}
-__decorate([
-    UserConfig
-], DefaultUser.prototype, "config", void 0);
-__decorate([
-    observable
-], DefaultUser.prototype, "pathHistory", void 0);
-__decorate([
-    observable
-], DefaultUser.prototype, "actionHistory", void 0);
-__decorate([
-    observable
-], DefaultUser.prototype, "isAuthenticated", void 0);
-__decorate([
-    observable
-], DefaultUser.prototype, "userKVs", void 0);
-__decorate([
-    observable
-], DefaultUser.prototype, "details", void 0);
-__decorate([
-    observable
-], DefaultUser.prototype, "permission", void 0);
-__decorate([
-    observable
-], DefaultUser.prototype, "profile", void 0);
-__decorate([
-    observable
-], DefaultUser.prototype, "sourceRef", void 0);
-__decorate([
-    observable
-], DefaultUser.prototype, "userName", void 0);
-/**
- * User DI key.
- *
- * @privateRemarks
- * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
- *
- * @internal
- */
-export const User = DI.createInterface((x) => x.singleton(DefaultUser));
-/**
- * Gets User from the DI container.
- *
- * @remarks
- * A utility method for host applications that are not using decorators or the DI container.
- *
- * @example
- * ```ts
- * import { getUser, User } from '@genesislcap/foundation-auth/user';
- * ...
- * private user: User = getUser();
- * ```
- *
- * @public
- */
-export function getUser() {
-    return DI.getOrCreateDOMContainer().get(User);
-}

package/docs/api/foundation-auth.defaultuser.actionhistory.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [DefaultUser](./foundation-auth.defaultuser.md) &gt; [actionHistory](./foundation-auth.defaultuser.actionhistory.md)
-
-## DefaultUser.actionHistory property
-
-Array of actions that have been tracked.
-
-**Signature:**
-
-```typescript
-actionHistory: unknown[];
-```

package/docs/api/foundation-auth.defaultuser.addauthenticationchangelistener.md

@@ -1,22 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [DefaultUser](./foundation-auth.defaultuser.md) &gt; [addAuthenticationChangeListener](./foundation-auth.defaultuser.addauthenticationchangelistener.md)
-
-## DefaultUser.addAuthenticationChangeListener() method
-
-**Signature:**
-
-```typescript
-addAuthenticationChangeListener(listener: Listener<UserAuthenticationChangeEvent>): () => void;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  listener | Listener&lt;[UserAuthenticationChangeEvent](./foundation-auth.userauthenticationchangeevent.md)<!-- -->&gt; | A listener function. |
-
-**Returns:**
-
-() =&gt; void
-

package/docs/api/foundation-auth.defaultuser.clearactions.md

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [DefaultUser](./foundation-auth.defaultuser.md) &gt; [clearActions](./foundation-auth.defaultuser.clearactions.md)
-
-## DefaultUser.clearActions() method
-
-Clears action history.
-
-**Signature:**
-
-```typescript
-clearActions(): void;
-```
-**Returns:**
-
-void
-

package/docs/api/foundation-auth.defaultuser.clearpaths.md

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [DefaultUser](./foundation-auth.defaultuser.md) &gt; [clearPaths](./foundation-auth.defaultuser.clearpaths.md)
-
-## DefaultUser.clearPaths() method
-
-Clears path history.
-
-**Signature:**
-
-```typescript
-clearPaths(): void;
-```
-**Returns:**
-
-void
-

package/docs/api/foundation-auth.defaultuser.cleartrackinghistory.md

@@ -1,16 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [DefaultUser](./foundation-auth.defaultuser.md) &gt; [clearTrackingHistory](./foundation-auth.defaultuser.cleartrackinghistory.md)
-
-## DefaultUser.clearTrackingHistory() method
-
-
-**Signature:**
-
-```typescript
-clearTrackingHistory(): void;
-```
-**Returns:**
-
-void
-

package/docs/api/foundation-auth.defaultuser.details.md

@@ -1,12 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [DefaultUser](./foundation-auth.defaultuser.md) &gt; [details](./foundation-auth.defaultuser.details.md)
-
-## DefaultUser.details property
-
-
-**Signature:**
-
-```typescript
-details: Details;
-```

package/docs/api/foundation-auth.defaultuser.haspermission.md

@@ -1,22 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [DefaultUser](./foundation-auth.defaultuser.md) &gt; [hasPermission](./foundation-auth.defaultuser.haspermission.md)
-
-## DefaultUser.hasPermission() method
-
-**Signature:**
-
-```typescript
-hasPermission(permission: string | string[]): boolean;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  permission | string \| string\[\] | A permission string or an array of permission strings to check. |
-
-**Returns:**
-
-boolean
-

package/docs/api/foundation-auth.defaultuser.hasprofile.md

@@ -1,22 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [DefaultUser](./foundation-auth.defaultuser.md) &gt; [hasProfile](./foundation-auth.defaultuser.hasprofile.md)
-
-## DefaultUser.hasProfile() method
-
-**Signature:**
-
-```typescript
-hasProfile(profile: string | string[]): boolean;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  profile | string \| string\[\] | A profile string or an array of profile strings to check. |
-
-**Returns:**
-
-boolean
-

package/docs/api/foundation-auth.defaultuser.isadmin.md

@@ -1,16 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [DefaultUser](./foundation-auth.defaultuser.md) &gt; [isAdmin](./foundation-auth.defaultuser.isadmin.md)
-
-## DefaultUser.isAdmin() method
-
-
-**Signature:**
-
-```typescript
-isAdmin(): boolean;
-```
-**Returns:**
-
-boolean
-

package/docs/api/foundation-auth.defaultuser.isanonymous.md

@@ -1,12 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [DefaultUser](./foundation-auth.defaultuser.md) &gt; [isAnonymous](./foundation-auth.defaultuser.isanonymous.md)
-
-## DefaultUser.isAnonymous property
-
-
-**Signature:**
-
-```typescript
-get isAnonymous(): boolean;
-```

package/docs/api/foundation-auth.defaultuser.isauthenticated.md

@@ -1,12 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [DefaultUser](./foundation-auth.defaultuser.md) &gt; [isAuthenticated](./foundation-auth.defaultuser.isauthenticated.md)
-
-## DefaultUser.isAuthenticated property
-
-
-**Signature:**
-
-```typescript
-isAuthenticated: boolean;
-```

package/docs/api/foundation-auth.defaultuser.isbanned.md

@@ -1,16 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [DefaultUser](./foundation-auth.defaultuser.md) &gt; [isBanned](./foundation-auth.defaultuser.isbanned.md)
-
-## DefaultUser.isBanned() method
-
-
-**Signature:**
-
-```typescript
-isBanned(): boolean;
-```
-**Returns:**
-
-boolean
-

package/docs/api/foundation-auth.defaultuser.lastaction.md

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [DefaultUser](./foundation-auth.defaultuser.md) &gt; [lastAction](./foundation-auth.defaultuser.lastaction.md)
-
-## DefaultUser.lastAction() method
-
-**Signature:**
-
-```typescript
-lastAction(): unknown;
-```
-**Returns:**
-
-unknown
-
-The last stored action.
-

package/docs/api/foundation-auth.defaultuser.lastpath.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [DefaultUser](./foundation-auth.defaultuser.md) &gt; [lastPath](./foundation-auth.defaultuser.lastpath.md)
-
-## DefaultUser.lastPath() method
-
-May be used to return to a target path after authentication.
-
-**Signature:**
-
-```typescript
-lastPath(): string;
-```
-**Returns:**
-
-string
-
-The last stored path.
-

package/docs/api/foundation-auth.defaultuser.md

@@ -1,50 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [DefaultUser](./foundation-auth.defaultuser.md)
-
-## DefaultUser class
-
-Default User implementation.
-
-**Signature:**
-
-```typescript
-export declare class DefaultUser implements User 
-```
-**Implements:** [User](./foundation-auth.user.md)
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [actionHistory](./foundation-auth.defaultuser.actionhistory.md) |  | unknown\[\] | Array of actions that have been tracked. |
-|  [details](./foundation-auth.defaultuser.details.md) |  | [Details](./foundation-auth.details.md) |  |
-|  [isAnonymous](./foundation-auth.defaultuser.isanonymous.md) | <code>readonly</code> | boolean |  |
-|  [isAuthenticated](./foundation-auth.defaultuser.isauthenticated.md) |  | boolean |  |
-|  [pathHistory](./foundation-auth.defaultuser.pathhistory.md) |  | string\[\] | Array of paths that have been tracked. |
-|  [permission](./foundation-auth.defaultuser.permission.md) |  | string\[\] |  |
-|  [profile](./foundation-auth.defaultuser.profile.md) |  | string\[\] |  |
-|  [sourceRef](./foundation-auth.defaultuser.sourceref.md) |  | string |  |
-|  [userKVs](./foundation-auth.defaultuser.userkvs.md) |  | { \[key: string\]: any; } |  |
-|  [username](./foundation-auth.defaultuser.username.md) | <code>readonly</code> | string |  |
-|  [userName](./foundation-auth.defaultuser.username.md) |  | string |  |
-
-## Methods
-
-|  Method | Modifiers | Description |
-|  --- | --- | --- |
-|  [addAuthenticationChangeListener(listener)](./foundation-auth.defaultuser.addauthenticationchangelistener.md) |  |  |
-|  [clearActions()](./foundation-auth.defaultuser.clearactions.md) |  | Clears action history. |
-|  [clearPaths()](./foundation-auth.defaultuser.clearpaths.md) |  | Clears path history. |
-|  [clearTrackingHistory()](./foundation-auth.defaultuser.cleartrackinghistory.md) |  |  |
-|  [hasPermission(permission)](./foundation-auth.defaultuser.haspermission.md) |  |  |
-|  [hasProfile(profile)](./foundation-auth.defaultuser.hasprofile.md) |  |  |
-|  [isAdmin()](./foundation-auth.defaultuser.isadmin.md) |  |  |
-|  [isBanned()](./foundation-auth.defaultuser.isbanned.md) |  |  |
-|  [lastAction()](./foundation-auth.defaultuser.lastaction.md) |  |  |
-|  [lastPath()](./foundation-auth.defaultuser.lastpath.md) |  | May be used to return to a target path after authentication. |
-|  [set(entity)](./foundation-auth.defaultuser.set.md) |  |  |
-|  [trackAction(details)](./foundation-auth.defaultuser.trackaction.md) |  | Track an action. |
-|  [trackPath()](./foundation-auth.defaultuser.trackpath.md) |  | Track current path. |
-|  [unset()](./foundation-auth.defaultuser.unset.md) |  |  |
-

package/docs/api/foundation-auth.defaultuser.pathhistory.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [DefaultUser](./foundation-auth.defaultuser.md) &gt; [pathHistory](./foundation-auth.defaultuser.pathhistory.md)
-
-## DefaultUser.pathHistory property
-
-Array of paths that have been tracked.
-
-**Signature:**
-
-```typescript
-pathHistory: string[];
-```

package/docs/api/foundation-auth.defaultuser.permission.md

@@ -1,12 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [DefaultUser](./foundation-auth.defaultuser.md) &gt; [permission](./foundation-auth.defaultuser.permission.md)
-
-## DefaultUser.permission property
-
-
-**Signature:**
-
-```typescript
-permission: string[];
-```

package/docs/api/foundation-auth.defaultuser.profile.md

@@ -1,12 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [DefaultUser](./foundation-auth.defaultuser.md) &gt; [profile](./foundation-auth.defaultuser.profile.md)
-
-## DefaultUser.profile property
-
-
-**Signature:**
-
-```typescript
-profile: string[];
-```

package/docs/api/foundation-auth.defaultuser.set.md

@@ -1,22 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [DefaultUser](./foundation-auth.defaultuser.md) &gt; [set](./foundation-auth.defaultuser.set.md)
-
-## DefaultUser.set() method
-
-**Signature:**
-
-```typescript
-set(entity: Partial<LoginAck>): this;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  entity | Partial&lt;[LoginAck](./foundation-auth.loginack.md)<!-- -->&gt; | The LoginAck used to populate the User. |
-
-**Returns:**
-
-this
-

package/docs/api/foundation-auth.defaultuser.sourceref.md

@@ -1,12 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [DefaultUser](./foundation-auth.defaultuser.md) &gt; [sourceRef](./foundation-auth.defaultuser.sourceref.md)
-
-## DefaultUser.sourceRef property
-
-
-**Signature:**
-
-```typescript
-sourceRef: string;
-```

package/docs/api/foundation-auth.defaultuser.trackaction.md

@@ -1,24 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [DefaultUser](./foundation-auth.defaultuser.md) &gt; [trackAction](./foundation-auth.defaultuser.trackaction.md)
-
-## DefaultUser.trackAction() method
-
-Track an action.
-
-**Signature:**
-
-```typescript
-trackAction<TDetails = unknown>(details: TDetails): void;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  details | TDetails |  |
-
-**Returns:**
-
-void
-

package/docs/api/foundation-auth.defaultuser.trackpath.md

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [DefaultUser](./foundation-auth.defaultuser.md) &gt; [trackPath](./foundation-auth.defaultuser.trackpath.md)
-
-## DefaultUser.trackPath() method
-
-Track current path.
-
-**Signature:**
-
-```typescript
-trackPath(): string;
-```
-**Returns:**
-
-string
-

package/docs/api/foundation-auth.defaultuser.unset.md

@@ -1,16 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [DefaultUser](./foundation-auth.defaultuser.md) &gt; [unset](./foundation-auth.defaultuser.unset.md)
-
-## DefaultUser.unset() method
-
-
-**Signature:**
-
-```typescript
-unset(): this;
-```
-**Returns:**
-
-this
-

package/docs/api/foundation-auth.defaultuser.userkvs.md

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [DefaultUser](./foundation-auth.defaultuser.md) &gt; [userKVs](./foundation-auth.defaultuser.userkvs.md)
-
-## DefaultUser.userKVs property
-
-
-**Signature:**
-
-```typescript
-userKVs: {
-        [key: string]: any;
-    };
-```

package/docs/api/foundation-auth.defaultuser.username.md

@@ -1,12 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [DefaultUser](./foundation-auth.defaultuser.md) &gt; [userName](./foundation-auth.defaultuser.username.md)
-
-## DefaultUser.userName property
-
-
-**Signature:**
-
-```typescript
-userName: string;
-```