@genesislcap/foundation-user 14.408.0 → 14.409.0

package/README.md

@@ -1,63 +1,25 @@
-# Genesis User
+# @genesislcap/foundation-user
 
-[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)
-[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](https://www.typescriptlang.org/)
+Documentation for this package is published on the Genesis docs site:
 
-`foundation-user` provides the [User](./docs/api/foundation-user.user.md) singleton, which always exists in either an
-anonymous or authenticated mode.
-
-### Get User reference
-User is a singleton. You can access it via the DI container.
-```ts
-import { User } from '@genesislcap/foundation-user';
-...
-@User private user: User
-```
-
-...or via a utility if your app is not using decorators or the DI container.
-```ts
-import { getUser } from '@genesislcap/foundation-user';
-...
-private user = getUser();
-```
-
-User properties are decorated with `@observable`, meaning in FAST terms it's reactive, and you can bind to properties
-directly. For example, `this.user.isAuthenticated`. However, you can also monitor the user's authentication status using
-an event listener.
-
-```ts
-import type { UserAuthenticationChangeEvent } from '@genesislcap/foundation-user';
-...
-const unsubscribeUser = this.user.addAuthenticationChangeListener((event: UserAuthenticationChangeEvent) => {
-  console.log('User authenticated?', event.detail); // < boolean === this.user.isAuthenticated
-});
-```
-
-See the [User API Docs](./docs/api/foundation-user.user.md) for more information.
+**Docs: [Login](https://docs.genesis.global/docs/develop/client-capabilities/login/)**
 
 ## Installation
 
-To enable this module in your application, follow the steps below.
-
-1. Add `@genesislcap/foundation-user` as a dependency in your `package.json` file. Whenever you change the dependencies of your project, ensure you run the `$ npm run bootstrap` command again. You can find more information in the [package.json basics](https://learn.genesis.global/secure/web/basics/package-json-basics/) page.
+Add the package to your `package.json` dependencies. After changing dependencies, run `npm run bootstrap` (or your project's equivalent). See [package.json basics](https://learn.genesis.global/secure/web/basics/package-json-basics/) for more information.
 
 ```json
 {
-  ...
   "dependencies": {
-    ...
     "@genesislcap/foundation-user": "latest"
-    ...
-  },
-  ...
+  }
 }
 ```
 
-## [API Docs](./docs/api/index.md)
-
 ## License
 
 Note: this project provides front-end dependencies and uses licensed components listed in the next section; thus, licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details.
 
 ### Licensed components
+
 Genesis low-code platform

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-user",
   "description": "Genesis User",
-  "version": "14.408.0",
+  "version": "14.409.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -37,18 +37,18 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.408.0",
-    "@genesislcap/genx": "14.408.0",
-    "@genesislcap/rollup-builder": "14.408.0",
-    "@genesislcap/ts-builder": "14.408.0",
-    "@genesislcap/uvu-playwright-builder": "14.408.0",
-    "@genesislcap/vite-builder": "14.408.0",
-    "@genesislcap/webpack-builder": "14.408.0"
+    "@genesislcap/foundation-testing": "14.409.0",
+    "@genesislcap/genx": "14.409.0",
+    "@genesislcap/rollup-builder": "14.409.0",
+    "@genesislcap/ts-builder": "14.409.0",
+    "@genesislcap/uvu-playwright-builder": "14.409.0",
+    "@genesislcap/vite-builder": "14.409.0",
+    "@genesislcap/webpack-builder": "14.409.0"
   },
   "dependencies": {
-    "@genesislcap/foundation-broadcast-channel": "14.408.0",
-    "@genesislcap/foundation-logger": "14.408.0",
-    "@genesislcap/foundation-utils": "14.408.0",
+    "@genesislcap/foundation-broadcast-channel": "14.409.0",
+    "@genesislcap/foundation-logger": "14.409.0",
+    "@genesislcap/foundation-utils": "14.409.0",
     "@microsoft/fast-element": "1.14.0",
     "@microsoft/fast-foundation": "2.50.0"
   },
@@ -60,5 +60,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "26b08831fd001b4ee95c8a0d3364a18c0ec4005b"
+  "gitHead": "cbe0459d170f27c35a7de18cec415947aedf4da5"
 }

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

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

@@ -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; [DefaultUser](./foundation-user.defaultuser.md) &gt; [addAuthenticationChangeListener](./foundation-user.defaultuser.addauthenticationchangelistener.md)
-
-## DefaultUser.addAuthenticationChangeListener() method
-
-**Signature:**
-
-```typescript
-addAuthenticationChangeListener(listener: Listener<UserAuthenticationChangeEvent>): () => void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-listener
-
-
-</td><td>
-
-Listener&lt;[UserAuthenticationChangeEvent](./foundation-user.userauthenticationchangeevent.md)<!-- -->&gt;
-
-
-</td><td>
-
-A listener function.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-() =&gt; void
-

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

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

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

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

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

@@ -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; [DefaultUser](./foundation-user.defaultuser.md) &gt; [hasAdminProfile](./foundation-user.defaultuser.hasadminprofile.md)
-
-## DefaultUser.hasAdminProfile() method
-
-**Signature:**
-
-```typescript
-hasAdminProfile(): boolean;
-```
-**Returns:**
-
-boolean
-

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

@@ -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; [DefaultUser](./foundation-user.defaultuser.md) &gt; [hasPermission](./foundation-user.defaultuser.haspermission.md)
-
-## DefaultUser.hasPermission() method
-
-**Signature:**
-
-```typescript
-hasPermission(permission: string | string[]): boolean;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-permission
-
-
-</td><td>
-
-string \| string\[\]
-
-
-</td><td>
-
-A permission string or an array of permission strings to check.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-boolean
-

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

@@ -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; [DefaultUser](./foundation-user.defaultuser.md) &gt; [hasProfile](./foundation-user.defaultuser.hasprofile.md)
-
-## DefaultUser.hasProfile() method
-
-**Signature:**
-
-```typescript
-hasProfile(profile: string | string[]): boolean;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-profile
-
-
-</td><td>
-
-string \| string\[\]
-
-
-</td><td>
-
-A profile string or an array of profile strings to check.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-boolean
-

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

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

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

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

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

package/docs/api/foundation-user.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-user](./foundation-user.md) &gt; [DefaultUser](./foundation-user.defaultuser.md) &gt; [lastPath](./foundation-user.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.
-