npm - @genesislcap/foundation-user - Versions diffs - 14.408.0 → 14.409.0-FUI-2495.2 - Mend

@genesislcap/foundation-user 14.408.0 → 14.409.0-FUI-2495.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (107) hide show

package/docs/api/foundation-user.userchannel.md DELETED Viewed

@@ -1,33 +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; [UserChannel](./foundation-user.userchannel.md)
-## UserChannel interface
-UserChannel DI interface.
-**Signature:**
-```typescript
-export interface UserChannel extends TypedBroadcastChannel<UserChannelEvents>
-```
-**Extends:** TypedBroadcastChannel&lt;[UserChannelEvents](./foundation-user.userchannelevents.md)<!-- -->&gt;
-## Example
-```ts
-import { UserChannel } from '@genesislcap/foundation-user';
-...
-@UserChannel protected channel: UserChannel;
-...
-this.channel.onmessage = (e) => {
- if (this.channel.isMessageType('user-authentication-change', e)) {
-   logger.debug('user-authentication-change', e.data.detail);
-   return;
- }
-}
-...
-this.channel.close();
-```

package/docs/api/foundation-user.userchannelevents.md DELETED Viewed

@@ -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; [UserChannelEvents](./foundation-user.userchannelevents.md)
-## UserChannelEvents type
-UserChannelEvents.
-**Signature:**
-```typescript
-export type UserChannelEvents = {
-    [UserAuthenticationChangeType]: boolean;
-};
-```
-**References:** [UserAuthenticationChangeType](./foundation-user.userauthenticationchangetype.md)

package/docs/api/foundation-user.userchannelid.md DELETED Viewed

@@ -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; [UserChannelId](./foundation-user.userchannelid.md)
-## UserChannelId variable
-UserChannelId.
-**Signature:**
-```typescript
-UserChannelId = "genesis-user"
-```

package/docs/api/foundation-user.userconfig.md DELETED Viewed

@@ -1,118 +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; [UserConfig](./foundation-user.userconfig.md)
-## UserConfig interface
-UserConfig DI interface.
-**Signature:**
-```typescript
-export interface UserConfig
-```
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[trackActionExclusions](./foundation-user.userconfig.trackactionexclusions.md)
-</td><td>
-</td><td>
-unknown\[\]
-</td><td>
-Exclude certain actions from tracking.
-See [UserPathHistory](./foundation-user.userpathhistory.md)
-</td></tr>
-<tr><td>
-[trackPathExclusions](./foundation-user.userconfig.trackpathexclusions.md)
-</td><td>
-</td><td>
-string\[\]
-</td><td>
-Exclude certain paths from tracking.
-See [UserActionHistory](./foundation-user.useractionhistory.md)
-</td></tr>
-</tbody></table>
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[setUser(user, properties)](./foundation-user.userconfig.setuser.md)
-</td><td>
-User property setter.
-</td></tr>
-<tr><td>
-[unsetUser(user)](./foundation-user.userconfig.unsetuser.md)
-</td><td>
-User property un-setter.
-</td></tr>
-</tbody></table>

package/docs/api/foundation-user.userconfig.setuser.md DELETED Viewed

@@ -1,70 +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; [UserConfig](./foundation-user.userconfig.md) &gt; [setUser](./foundation-user.userconfig.setuser.md)
-## UserConfig.setUser() method
-User property setter.
-**Signature:**
-```typescript
-setUser(user: WriteableUser, properties: Partial<SetUserProperties>): User;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-user
-</td><td>
-WriteableUser
-</td><td>
-</td></tr>
-<tr><td>
-properties
-</td><td>
-Partial&lt;[SetUserProperties](./foundation-user.setuserproperties.md)<!-- -->&gt;
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-[User](./foundation-user.user.md)
-## Remarks
-The user is typically set from the result of a LoginAck.

package/docs/api/foundation-user.userconfig.trackactionexclusions.md DELETED Viewed

@@ -1,15 +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; [UserConfig](./foundation-user.userconfig.md) &gt; [trackActionExclusions](./foundation-user.userconfig.trackactionexclusions.md)
-## UserConfig.trackActionExclusions property
-Exclude certain actions from tracking.
-See [UserPathHistory](./foundation-user.userpathhistory.md)
-**Signature:**
-```typescript
-trackActionExclusions: unknown[];
-```

package/docs/api/foundation-user.userconfig.trackpathexclusions.md DELETED Viewed

@@ -1,15 +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; [UserConfig](./foundation-user.userconfig.md) &gt; [trackPathExclusions](./foundation-user.userconfig.trackpathexclusions.md)
-## UserConfig.trackPathExclusions property
-Exclude certain paths from tracking.
-See [UserActionHistory](./foundation-user.useractionhistory.md)
-**Signature:**
-```typescript
-trackPathExclusions: string[];
-```

package/docs/api/foundation-user.userconfig.unsetuser.md DELETED Viewed

@@ -1,52 +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; [UserConfig](./foundation-user.userconfig.md) &gt; [unsetUser](./foundation-user.userconfig.unsetuser.md)
-## UserConfig.unsetUser() method
-User property un-setter.
-**Signature:**
-```typescript
-unsetUser(user: WriteableUser): User;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-user
-</td><td>
-WriteableUser
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-[User](./foundation-user.user.md)

package/docs/api/foundation-user.userdetailsproductproperty.md DELETED Viewed

@@ -1,76 +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; [UserDetailsProductProperty](./foundation-user.userdetailsproductproperty.md)
-## UserDetailsProductProperty interface
-**Signature:**
-```typescript
-export interface UserDetailsProductProperty
-```
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[name](./foundation-user.userdetailsproductproperty.name.md)
-</td><td>
-`readonly`
-</td><td>
-string
-</td><td>
-</td></tr>
-<tr><td>
-[version](./foundation-user.userdetailsproductproperty.version.md)
-</td><td>
-`readonly`
-</td><td>
-string
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/api/foundation-user.userdetailsproductproperty.name.md DELETED Viewed

@@ -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; [UserDetailsProductProperty](./foundation-user.userdetailsproductproperty.md) &gt; [name](./foundation-user.userdetailsproductproperty.name.md)
-## UserDetailsProductProperty.name property
-**Signature:**
-```typescript
-readonly name: string;
-```

package/docs/api/foundation-user.userdetailsproductproperty.version.md DELETED Viewed

@@ -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; [UserDetailsProductProperty](./foundation-user.userdetailsproductproperty.md) &gt; [version](./foundation-user.userdetailsproductproperty.version.md)
-## UserDetailsProductProperty.version property
-**Signature:**
-```typescript
-readonly version: string;
-```

package/docs/api/foundation-user.userdetailsproperty.daystopasswordexpiry.md DELETED Viewed

@@ -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; [UserDetailsProperty](./foundation-user.userdetailsproperty.md) &gt; [daysToPasswordExpiry](./foundation-user.userdetailsproperty.daystopasswordexpiry.md)
-## UserDetailsProperty.daysToPasswordExpiry property
-**Signature:**
-```typescript
-readonly daysToPasswordExpiry: number;
-```

package/docs/api/foundation-user.userdetailsproperty.failedloginattempts.md DELETED Viewed

@@ -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; [UserDetailsProperty](./foundation-user.userdetailsproperty.md) &gt; [failedLoginAttempts](./foundation-user.userdetailsproperty.failedloginattempts.md)
-## UserDetailsProperty.failedLoginAttempts property
-**Signature:**
-```typescript
-readonly failedLoginAttempts: number;
-```

package/docs/api/foundation-user.userdetailsproperty.heartbeatintervalsecs.md DELETED Viewed

@@ -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; [UserDetailsProperty](./foundation-user.userdetailsproperty.md) &gt; [heartbeatIntervalSecs](./foundation-user.userdetailsproperty.heartbeatintervalsecs.md)
-## UserDetailsProperty.heartbeatIntervalSecs property
-**Signature:**
-```typescript
-readonly heartbeatIntervalSecs: number;
-```

package/docs/api/foundation-user.userdetailsproperty.lastlogindatetime.md DELETED Viewed

@@ -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; [UserDetailsProperty](./foundation-user.userdetailsproperty.md) &gt; [lastLoginDatetime](./foundation-user.userdetailsproperty.lastlogindatetime.md)
-## UserDetailsProperty.lastLoginDatetime property
-**Signature:**
-```typescript
-readonly lastLoginDatetime: number;
-```

package/docs/api/foundation-user.userdetailsproperty.md DELETED Viewed

@@ -1,171 +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; [UserDetailsProperty](./foundation-user.userdetailsproperty.md)
-## UserDetailsProperty interface
-**Signature:**
-```typescript
-export interface UserDetailsProperty
-```
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[daysToPasswordExpiry](./foundation-user.userdetailsproperty.daystopasswordexpiry.md)
-</td><td>
-`readonly`
-</td><td>
-number
-</td><td>
-</td></tr>
-<tr><td>
-[failedLoginAttempts](./foundation-user.userdetailsproperty.failedloginattempts.md)
-</td><td>
-`readonly`
-</td><td>
-number
-</td><td>
-</td></tr>
-<tr><td>
-[heartbeatIntervalSecs](./foundation-user.userdetailsproperty.heartbeatintervalsecs.md)
-</td><td>
-`readonly`
-</td><td>
-number
-</td><td>
-</td></tr>
-<tr><td>
-[lastLoginDatetime](./foundation-user.userdetailsproperty.lastlogindatetime.md)
-</td><td>
-`readonly`
-</td><td>
-number
-</td><td>
-</td></tr>
-<tr><td>
-[product](./foundation-user.userdetailsproperty.product.md)
-</td><td>
-`readonly`
-</td><td>
-[UserDetailsProductProperty](./foundation-user.userdetailsproductproperty.md)<!-- -->\[\]
-</td><td>
-</td></tr>
-<tr><td>
-[rejectedLoginAttempts](./foundation-user.userdetailsproperty.rejectedloginattempts.md)
-</td><td>
-`readonly`
-</td><td>
-number
-</td><td>
-</td></tr>
-<tr><td>
-[system](./foundation-user.userdetailsproperty.system.md)
-</td><td>
-`readonly`
-</td><td>
-[UserDetailsSystemProperty](./foundation-user.userdetailssystemproperty.md)
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/api/foundation-user.userdetailsproperty.product.md DELETED Viewed

@@ -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; [UserDetailsProperty](./foundation-user.userdetailsproperty.md) &gt; [product](./foundation-user.userdetailsproperty.product.md)
-## UserDetailsProperty.product property
-**Signature:**
-```typescript
-readonly product: UserDetailsProductProperty[];
-```

package/docs/api/foundation-user.userdetailsproperty.rejectedloginattempts.md DELETED Viewed

@@ -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; [UserDetailsProperty](./foundation-user.userdetailsproperty.md) &gt; [rejectedLoginAttempts](./foundation-user.userdetailsproperty.rejectedloginattempts.md)
-## UserDetailsProperty.rejectedLoginAttempts property
-**Signature:**
-```typescript
-readonly rejectedLoginAttempts: number;
-```

package/docs/api/foundation-user.userdetailsproperty.system.md DELETED Viewed

@@ -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; [UserDetailsProperty](./foundation-user.userdetailsproperty.md) &gt; [system](./foundation-user.userdetailsproperty.system.md)
-## UserDetailsProperty.system property
-**Signature:**
-```typescript
-readonly system: UserDetailsSystemProperty;
-```