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

@genesislcap/foundation-user 14.408.0 → 14.409.0

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.user.md DELETED Viewed

@@ -1,313 +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; [User](./foundation-user.user.md)
-## User interface
-User interface.
-**Signature:**
-```typescript
-export interface User extends UserPathHistory, UserActionHistory, LegacyUserAPI
-```
-**Extends:** [UserPathHistory](./foundation-user.userpathhistory.md)<!-- -->, [UserActionHistory](./foundation-user.useractionhistory.md)<!-- -->, [LegacyUserAPI](./foundation-user.legacyuserapi.md)
-## Remarks
-The user singleton, which always exists in either an anonymous or authenticated mode.
-## Example
-```ts
-import { User } from '@genesislcap/foundation-user';
-...
-@User private user: User
-```
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[details](./foundation-user.user.details.md)
-</td><td>
-`readonly`
-</td><td>
-[SetUserProperties](./foundation-user.setuserproperties.md)<!-- -->\['details'\]
-</td><td>
-</td></tr>
-<tr><td>
-[isAnonymous](./foundation-user.user.isanonymous.md)
-</td><td>
-`readonly`
-</td><td>
-boolean
-</td><td>
-</td></tr>
-<tr><td>
-[isAuthenticated](./foundation-user.user.isauthenticated.md)
-</td><td>
-`readonly`
-</td><td>
-boolean
-</td><td>
-</td></tr>
-<tr><td>
-[permission](./foundation-user.user.permission.md)
-</td><td>
-`readonly`
-</td><td>
-string\[\]
-</td><td>
-</td></tr>
-<tr><td>
-[profile](./foundation-user.user.profile.md)
-</td><td>
-`readonly`
-</td><td>
-string\[\]
-</td><td>
-</td></tr>
-<tr><td>
-[rawProperties](./foundation-user.user.rawproperties.md)
-</td><td>
-`readonly`
-</td><td>
-Partial&lt;[SetUserProperties](./foundation-user.setuserproperties.md)<!-- -->&gt;
-</td><td>
-A structuredClone of the raw unmanaged properties used to set the user.
-</td></tr>
-<tr><td>
-[sourceRef](./foundation-user.user.sourceref.md)
-</td><td>
-`readonly`
-</td><td>
-string
-</td><td>
-</td></tr>
-<tr><td>
-[userKVs](./foundation-user.user.userkvs.md)
-</td><td>
-`readonly`
-</td><td>
-{ \[key: string\]: any; }
-</td><td>
-</td></tr>
-<tr><td>
-[userName](./foundation-user.user.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>
-[addAuthenticationChangeListener(listener)](./foundation-user.user.addauthenticationchangelistener.md)
-</td><td>
-</td></tr>
-<tr><td>
-[clearTrackingHistory()](./foundation-user.user.cleartrackinghistory.md)
-</td><td>
-</td></tr>
-<tr><td>
-[hasPermission(permission)](./foundation-user.user.haspermission.md)
-</td><td>
-</td></tr>
-<tr><td>
-[hasProfile(profile)](./foundation-user.user.hasprofile.md)
-</td><td>
-</td></tr>
-<tr><td>
-[isAdmin()](./foundation-user.user.isadmin.md)
-</td><td>
-</td></tr>
-<tr><td>
-[isBanned()](./foundation-user.user.isbanned.md)
-</td><td>
-</td></tr>
-<tr><td>
-[set(properties)](./foundation-user.user.set.md)
-</td><td>
-</td></tr>
-<tr><td>
-[unset()](./foundation-user.user.unset.md)
-</td><td>
-</td></tr>
-</tbody></table>

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

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

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

@@ -1,18 +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; [User](./foundation-user.user.md) &gt; [rawProperties](./foundation-user.user.rawproperties.md)
-## User.rawProperties property
-A structuredClone of the raw unmanaged properties used to set the user.
-**Signature:**
-```typescript
-readonly rawProperties: Partial<SetUserProperties>;
-```
-## Remarks
-This offers developers an escape hatch to the raw properties. If you feel there's a gap in the User interface based on your application requirements, please raise a request for such properties to be moved onto the interface.

package/docs/api/foundation-user.user.set.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; [User](./foundation-user.user.md) &gt; [set](./foundation-user.user.set.md)
-## User.set() method
-**Signature:**
-```typescript
-set(properties: Partial<SetUserProperties>): User;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-properties
-</td><td>
-Partial&lt;[SetUserProperties](./foundation-user.setuserproperties.md)<!-- -->&gt;
-</td><td>
-The UserProperties used to populate the User.
-</td></tr>
-</tbody></table>
-**Returns:**
-[User](./foundation-user.user.md)

package/docs/api/foundation-user.user.sourceref.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; [User](./foundation-user.user.md) &gt; [sourceRef](./foundation-user.user.sourceref.md)
-## User.sourceRef property
-**Signature:**
-```typescript
-readonly sourceRef: string;
-```

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

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

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

package/docs/api/foundation-user.useractionhistory.actionhistory.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; [UserActionHistory](./foundation-user.useractionhistory.md) &gt; [actionHistory](./foundation-user.useractionhistory.actionhistory.md)
-## UserActionHistory.actionHistory property
-Array of actions that have been tracked.
-**Signature:**
-```typescript
-readonly actionHistory: unknown[];
-```

package/docs/api/foundation-user.useractionhistory.clearactions.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; [UserActionHistory](./foundation-user.useractionhistory.md) &gt; [clearActions](./foundation-user.useractionhistory.clearactions.md)
-## UserActionHistory.clearActions() method
-Clears action history.
-**Signature:**
-```typescript
-clearActions(): void;
-```
-**Returns:**
-void

package/docs/api/foundation-user.useractionhistory.lastaction.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; [UserActionHistory](./foundation-user.useractionhistory.md) &gt; [lastAction](./foundation-user.useractionhistory.lastaction.md)
-## UserActionHistory.lastAction() method
-**Signature:**
-```typescript
-lastAction(): unknown;
-```
-**Returns:**
-unknown
-The last stored action.

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

@@ -1,110 +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; [UserActionHistory](./foundation-user.useractionhistory.md)
-## UserActionHistory interface
-UserActionHistory.
-**Signature:**
-```typescript
-export interface UserActionHistory
-```
-## Remarks
-APIs to track a user's action history.
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[actionHistory](./foundation-user.useractionhistory.actionhistory.md)
-</td><td>
-`readonly`
-</td><td>
-unknown\[\]
-</td><td>
-Array of actions that have been tracked.
-</td></tr>
-</tbody></table>
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[clearActions()](./foundation-user.useractionhistory.clearactions.md)
-</td><td>
-Clears action history.
-</td></tr>
-<tr><td>
-[lastAction()](./foundation-user.useractionhistory.lastaction.md)
-</td><td>
-</td></tr>
-<tr><td>
-[trackAction(details)](./foundation-user.useractionhistory.trackaction.md)
-</td><td>
-Track an action.
-</td></tr>
-</tbody></table>

package/docs/api/foundation-user.useractionhistory.trackaction.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; [UserActionHistory](./foundation-user.useractionhistory.md) &gt; [trackAction](./foundation-user.useractionhistory.trackaction.md)
-## UserActionHistory.trackAction() method
-Track an action.
-**Signature:**
-```typescript
-trackAction<TDetails = unknown>(details: TDetails): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-details
-</td><td>
-TDetails
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-void

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

@@ -1,18 +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; [UserAuthenticationChangeEvent](./foundation-user.userauthenticationchangeevent.md)
-## UserAuthenticationChangeEvent type
-UserAuthenticationChangeEvent.
-**Signature:**
-```typescript
-export type UserAuthenticationChangeEvent = CustomEvent<boolean>;
-```
-## Remarks
-Detail will either be `true` or `false` to indicate authentication status.

package/docs/api/foundation-user.userauthenticationchangetype.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; [UserAuthenticationChangeType](./foundation-user.userauthenticationchangetype.md)
-## UserAuthenticationChangeType variable
-UserAuthenticationChangeType.
-**Signature:**
-```typescript
-UserAuthenticationChangeType = "user-authentication-change"
-```