@genesislcap/foundation-user 14.408.0 → 14.409.0

package/docs/api/foundation-user.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-user](./foundation-user.md) &gt; [DefaultUser](./foundation-user.defaultuser.md) &gt; [trackPath](./foundation-user.defaultuser.trackpath.md)
-
-## DefaultUser.trackPath() method
-
-Track current path.
-
-**Signature:**
-
-```typescript
-trackPath(): string;
-```
-**Returns:**
-
-string
-

package/docs/api/foundation-user.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-user](./foundation-user.md) &gt; [DefaultUser](./foundation-user.defaultuser.md) &gt; [unset](./foundation-user.defaultuser.unset.md)
-
-## DefaultUser.unset() method
-
-
-**Signature:**
-
-```typescript
-unset(): User;
-```
-**Returns:**
-
-[User](./foundation-user.user.md)
-

package/docs/api/foundation-user.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-user](./foundation-user.md) &gt; [DefaultUser](./foundation-user.defaultuser.md) &gt; [userKVs](./foundation-user.defaultuser.userkvs.md)
-
-## DefaultUser.userKVs property
-
-
-**Signature:**
-
-```typescript
-userKVs: {
-        [key: string]: any;
-    };
-```

package/docs/api/foundation-user.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-user](./foundation-user.md) &gt; [DefaultUser](./foundation-user.defaultuser.md) &gt; [userName](./foundation-user.defaultuser.username.md)
-
-## DefaultUser.userName property
-
-
-**Signature:**
-
-```typescript
-userName: string;
-```

package/docs/api/foundation-user.defaultuserconfig.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [defaultUserConfig](./foundation-user.defaultuserconfig.md)
-
-## defaultUserConfig variable
-
-Default UserConfig DI implementation.
-
-**Signature:**
-
-```typescript
-defaultUserConfig: UserConfig
-```

package/docs/api/foundation-user.getuser.md

@@ -1,30 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [getUser](./foundation-user.getuser.md)
-
-## getUser() function
-
-Gets User from the DI container.
-
-**Signature:**
-
-```typescript
-export declare function getUser(): User;
-```
-**Returns:**
-
-[User](./foundation-user.user.md)
-
-## Remarks
-
-A utility method for host applications that are not using decorators or the DI container.
-
-## Example
-
-
-```ts
-import { getUser, User } from '@genesislcap/foundation-user';
-...
-private user: User = getUser();
-```
-

package/docs/api/foundation-user.getuserchannel.md

@@ -1,39 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [getUserChannel](./foundation-user.getuserchannel.md)
-
-## getUserChannel() function
-
-Gets UserChannel from the DI container.
-
-**Signature:**
-
-```typescript
-export declare function getUserChannel(): UserChannel;
-```
-**Returns:**
-
-[UserChannel](./foundation-user.userchannel.md)
-
-## Remarks
-
-A utility method for host applications that are not using decorators or the DI container.
-
-## Example
-
-
-```ts
-import { getUserChannel } from '@genesislcap/foundation-user';
-...
-const channel = getUserChannel();
-...
-channel.onmessage = (e) => {
- if (channel.isMessageType('user-authentication-change', e)) {
-   logger.debug('user-authentication-change', e.data.detail);
-   return;
- }
-}
-...
-channel.close();
-```
-

package/docs/api/foundation-user.legacyuserapi.hasadminprofile.md

@@ -1,20 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [LegacyUserAPI](./foundation-user.legacyuserapi.md) &gt; [hasAdminProfile](./foundation-user.legacyuserapi.hasadminprofile.md)
-
-## LegacyUserAPI.hasAdminProfile() method
-
-> Warning: This API is now obsolete.
-> 
-> - Use `isAdmin` instead.
-> 
-
-**Signature:**
-
-```typescript
-hasAdminProfile(): boolean;
-```
-**Returns:**
-
-boolean
-

package/docs/api/foundation-user.legacyuserapi.md

@@ -1,122 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [LegacyUserAPI](./foundation-user.legacyuserapi.md)
-
-## LegacyUserAPI interface
-
-**Signature:**
-
-```typescript
-export interface LegacyUserAPI 
-```
-
-## Remarks
-
-For backwards compatibility, will be removed in a future major release, likely v15.
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[permissions](./foundation-user.legacyuserapi.permissions.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string\[\]
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[profiles](./foundation-user.legacyuserapi.profiles.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string\[\]
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[username](./foundation-user.legacyuserapi.username.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[hasAdminProfile()](./foundation-user.legacyuserapi.hasadminprofile.md)
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-user.legacyuserapi.permissions.md

@@ -1,16 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [LegacyUserAPI](./foundation-user.legacyuserapi.md) &gt; [permissions](./foundation-user.legacyuserapi.permissions.md)
-
-## LegacyUserAPI.permissions property
-
-> Warning: This API is now obsolete.
-> 
-> - Use `permission` instead.
-> 
-
-**Signature:**
-
-```typescript
-readonly permissions: string[];
-```

package/docs/api/foundation-user.legacyuserapi.profiles.md

@@ -1,16 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [LegacyUserAPI](./foundation-user.legacyuserapi.md) &gt; [profiles](./foundation-user.legacyuserapi.profiles.md)
-
-## LegacyUserAPI.profiles property
-
-> Warning: This API is now obsolete.
-> 
-> - Use `profile` instead.
-> 
-
-**Signature:**
-
-```typescript
-readonly profiles: string[];
-```

package/docs/api/foundation-user.legacyuserapi.username.md

@@ -1,16 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [LegacyUserAPI](./foundation-user.legacyuserapi.md) &gt; [username](./foundation-user.legacyuserapi.username.md)
-
-## LegacyUserAPI.username property
-
-> Warning: This API is now obsolete.
-> 
-> - Use `userName` instead.
-> 
-
-**Signature:**
-
-```typescript
-readonly username: string;
-```

package/docs/api/foundation-user.logger.md

@@ -1,12 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [logger](./foundation-user.logger.md)
-
-## logger variable
-
-
-**Signature:**
-
-```typescript
-logger: import("@genesislcap/foundation-logger").Logger
-```

package/docs/api/foundation-user.md

@@ -1,304 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md)
-
-## foundation-user package
-
-## Classes
-
-<table><thead><tr><th>
-
-Class
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[DefaultUser](./foundation-user.defaultuser.md)
-
-
-</td><td>
-
-Default User implementation.
-
-
-</td></tr>
-</tbody></table>
-
-## Functions
-
-<table><thead><tr><th>
-
-Function
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[getUser()](./foundation-user.getuser.md)
-
-
-</td><td>
-
-Gets User from the DI container.
-
-
-</td></tr>
-<tr><td>
-
-[getUserChannel()](./foundation-user.getuserchannel.md)
-
-
-</td><td>
-
-Gets UserChannel from the DI container.
-
-
-</td></tr>
-</tbody></table>
-
-## Interfaces
-
-<table><thead><tr><th>
-
-Interface
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[LegacyUserAPI](./foundation-user.legacyuserapi.md)
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[SetUserProperties](./foundation-user.setuserproperties.md)
-
-
-</td><td>
-
-SetUserProperties is a partial match of `LoginAck` from `@genesislcap/foundation-auth`<!-- -->.
-
-
-</td></tr>
-<tr><td>
-
-[User](./foundation-user.user.md)
-
-
-</td><td>
-
-User interface.
-
-
-</td></tr>
-<tr><td>
-
-[UserActionHistory](./foundation-user.useractionhistory.md)
-
-
-</td><td>
-
-UserActionHistory.
-
-
-</td></tr>
-<tr><td>
-
-[UserChannel](./foundation-user.userchannel.md)
-
-
-</td><td>
-
-UserChannel DI interface.
-
-
-</td></tr>
-<tr><td>
-
-[UserConfig](./foundation-user.userconfig.md)
-
-
-</td><td>
-
-UserConfig DI interface.
-
-
-</td></tr>
-<tr><td>
-
-[UserDetailsProductProperty](./foundation-user.userdetailsproductproperty.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[UserDetailsProperty](./foundation-user.userdetailsproperty.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[UserDetailsSystemProperty](./foundation-user.userdetailssystemproperty.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[UserKVsProperty](./foundation-user.userkvsproperty.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[UserPathHistory](./foundation-user.userpathhistory.md)
-
-
-</td><td>
-
-UserPathHistory.
-
-
-</td></tr>
-<tr><td>
-
-[UserQueueProperties](./foundation-user.userqueueproperties.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-</tbody></table>
-
-## Variables
-
-<table><thead><tr><th>
-
-Variable
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[defaultUserConfig](./foundation-user.defaultuserconfig.md)
-
-
-</td><td>
-
-Default UserConfig DI implementation.
-
-
-</td></tr>
-<tr><td>
-
-[logger](./foundation-user.logger.md)
-
-
-</td><td>
-
-
-
-</td></tr>
-<tr><td>
-
-[UserAuthenticationChangeType](./foundation-user.userauthenticationchangetype.md)
-
-
-</td><td>
-
-UserAuthenticationChangeType.
-
-
-</td></tr>
-<tr><td>
-
-[UserChannelId](./foundation-user.userchannelid.md)
-
-
-</td><td>
-
-UserChannelId.
-
-
-</td></tr>
-</tbody></table>
-
-## Type Aliases
-
-<table><thead><tr><th>
-
-Type Alias
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[UserAuthenticationChangeEvent](./foundation-user.userauthenticationchangeevent.md)
-
-
-</td><td>
-
-UserAuthenticationChangeEvent.
-
-
-</td></tr>
-<tr><td>
-
-[UserChannelEvents](./foundation-user.userchannelevents.md)
-
-
-</td><td>
-
-UserChannelEvents.
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-user.setuserproperties.details.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [SetUserProperties](./foundation-user.setuserproperties.md) &gt; [details](./foundation-user.setuserproperties.details.md)
-
-## SetUserProperties.details property
-
-**Signature:**
-
-```typescript
-readonly details: UserDetailsProperty;
-```