@genesislcap/foundation-user 14.176.1-alpha-ed9e3d4.0 → 14.177.1

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

@@ -0,0 +1,11 @@
+<!-- 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; [permissions](./foundation-user.defaultuser.permissions.md)
+
+## DefaultUser.permissions property
+
+**Signature:**
+
+```typescript
+get permissions(): string[];
+```

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

@@ -0,0 +1,11 @@
+<!-- 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; [profiles](./foundation-user.defaultuser.profiles.md)
+
+## DefaultUser.profiles property
+
+**Signature:**
+
+```typescript
+get profiles(): string[];
+```

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

@@ -0,0 +1,39 @@
+<!-- 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

@@ -0,0 +1,20 @@
+<!-- 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

@@ -0,0 +1,30 @@
+<!-- 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
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [permissions](./foundation-user.legacyuserapi.permissions.md) | <code>readonly</code> | string\[\] |  |
+|  [profiles](./foundation-user.legacyuserapi.profiles.md) | <code>readonly</code> | string\[\] |  |
+|  [username](./foundation-user.legacyuserapi.username.md) | <code>readonly</code> | string |  |
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [hasAdminProfile()](./foundation-user.legacyuserapi.hasadminprofile.md) |  |
+

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

@@ -0,0 +1,16 @@
+<!-- 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

@@ -0,0 +1,16 @@
+<!-- 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

@@ -0,0 +1,16 @@
+<!-- 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.md

@@ -15,14 +15,17 @@
 |  Function | Description |
 |  --- | --- |
 |  [getUser()](./foundation-user.getuser.md) | Gets User from the DI container. |
+|  [getUserChannel()](./foundation-user.getuserchannel.md) | Gets UserChannel from the DI container. |
 
 ## Interfaces
 
 |  Interface | Description |
 |  --- | --- |
+|  [LegacyUserAPI](./foundation-user.legacyuserapi.md) |  |
 |  [SetUserProperties](./foundation-user.setuserproperties.md) | SetUserProperties is a partial match of <code>LoginAck</code> from <code>@genesislcap/foundation-auth</code>. |
 |  [User](./foundation-user.user.md) | User interface. |
 |  [UserActionHistory](./foundation-user.useractionhistory.md) | UserActionHistory. |
+|  [UserChannel](./foundation-user.userchannel.md) | UserChannel DI interface. |
 |  [UserConfig](./foundation-user.userconfig.md) | UserConfig DI interface. |
 |  [UserDetailsProductProperty](./foundation-user.userdetailsproductproperty.md) |  |
 |  [UserDetailsProperty](./foundation-user.userdetailsproperty.md) |  |
@@ -38,10 +41,12 @@
 |  [defaultUserConfig](./foundation-user.defaultuserconfig.md) | Default UserConfig DI implementation. |
 |  [logger](./foundation-user.logger.md) |  |
 |  [UserAuthenticationChangeType](./foundation-user.userauthenticationchangetype.md) | UserAuthenticationChangeType. |
+|  [UserChannelId](./foundation-user.userchannelid.md) | UserChannelId. |
 
 ## Type Aliases
 
 |  Type Alias | Description |
 |  --- | --- |
 |  [UserAuthenticationChangeEvent](./foundation-user.userauthenticationchangeevent.md) | UserAuthenticationChangeEvent. |
+|  [UserChannelEvents](./foundation-user.userchannelevents.md) | UserChannelEvents. |
 

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

@@ -24,9 +24,7 @@ addAuthenticationChangeListener(listener: Listener<UserAuthenticationChangeEvent
 
 
 ```ts
-import type { UserAuthenticationChangeEvent } from '@genesislcap/foundation-user';
-...
-const unsubscribe = this.user.addAuthenticationChangeListener((event: UserAuthenticationChangeEvent) => {
+const unsubscribe = this.user.addAuthenticationChangeListener((event) => {
   console.log('User authenticated?', event.detail);
 });
 ```

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

@@ -9,9 +9,9 @@ User interface.
 **Signature:**
 
 ```typescript
-export interface User extends UserPathHistory, UserActionHistory 
+export interface User extends UserPathHistory, UserActionHistory, LegacyUserAPI 
 ```
-**Extends:** [UserPathHistory](./foundation-user.userpathhistory.md)<!-- -->, [UserActionHistory](./foundation-user.useractionhistory.md)
+**Extends:** [UserPathHistory](./foundation-user.userpathhistory.md)<!-- -->, [UserActionHistory](./foundation-user.useractionhistory.md)<!-- -->, [LegacyUserAPI](./foundation-user.legacyuserapi.md)
 
 ## Remarks
 
@@ -38,7 +38,6 @@ import { User } from '@genesislcap/foundation-user';
 |  [rawProperties](./foundation-user.user.rawproperties.md) | <code>readonly</code> | Partial&lt;[SetUserProperties](./foundation-user.setuserproperties.md)<!-- -->&gt; | A structuredClone of the raw unmanaged properties used to set the user. |
 |  [sourceRef](./foundation-user.user.sourceref.md) | <code>readonly</code> | string |  |
 |  [userKVs](./foundation-user.user.userkvs.md) | <code>readonly</code> | { \[key: string\]: any; } |  |
-|  [username](./foundation-user.user.username.md) | <code>readonly</code> | string |  |
 |  [userName](./foundation-user.user.username.md) | <code>readonly</code> | string |  |
 
 ## Methods

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

@@ -0,0 +1,33 @@
+<!-- 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

@@ -0,0 +1,17 @@
+<!-- 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

@@ -0,0 +1,13 @@
+<!-- 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-report.md

@@ -8,6 +8,7 @@ import { InterfaceSymbol } from '@microsoft/fast-foundation';
 import { Listener } from '@genesislcap/foundation-utils';
 import { Logger } from '@genesislcap/foundation-logger';
 import { Observer } from '@genesislcap/foundation-utils';
+import { TypedBroadcastChannel } from '@genesislcap/foundation-broadcast-channel';
 
 // @public
 export class DefaultUser implements User {
@@ -30,6 +31,8 @@ export class DefaultUser implements User {
     //
     // (undocumented)
     details: SetUserProperties['details'];
+    // (undocumented)
+    hasAdminProfile(): boolean;
     // @internal (undocumented)
     protected hasKey(keys: string[], key: string | string[]): boolean;
     // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "User" has more than one declaration; you need to add a TSDoc member reference selector
@@ -66,10 +69,18 @@ export class DefaultUser implements User {
     //
     // (undocumented)
     permission: string[];
+    // @internal (undocumented)
+    protected permissionChanged(): void;
+    // (undocumented)
+    get permissions(): string[];
     // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "User" has more than one declaration; you need to add a TSDoc member reference selector
     //
     // (undocumented)
     profile: string[];
+    // @internal (undocumented)
+    protected profileChanged(): void;
+    // (undocumented)
+    get profiles(): string[];
     // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "User" has more than one declaration; you need to add a TSDoc member reference selector
     //
     // (undocumented)
@@ -98,8 +109,6 @@ export class DefaultUser implements User {
     //
     // (undocumented)
     userName: string;
-    // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "User" has more than one declaration; you need to add a TSDoc member reference selector
-    //
     // (undocumented)
     get username(): string;
     // @internal (undocumented)
@@ -112,6 +121,21 @@ export const defaultUserConfig: UserConfig;
 // @public
 export function getUser(): User;
 
+// @public
+export function getUserChannel(): UserChannel;
+
+// @public (undocumented)
+export interface LegacyUserAPI {
+    // @deprecated (undocumented)
+    hasAdminProfile(): boolean;
+    // @deprecated (undocumented)
+    readonly permissions: string[];
+    // @deprecated (undocumented)
+    readonly profiles: string[];
+    // @deprecated (undocumented)
+    readonly username: string;
+}
+
 // @public (undocumented)
 export const logger: Logger;
 
@@ -136,7 +160,7 @@ export interface SetUserProperties extends Partial<UserQueueProperties> {
 // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "User" because one of its declarations is marked as @internal
 //
 // @public
-export interface User extends UserPathHistory, UserActionHistory {
+export interface User extends UserPathHistory, UserActionHistory, LegacyUserAPI {
     // (undocumented)
     addAuthenticationChangeListener(listener: Listener<UserAuthenticationChangeEvent>): () => void;
     // (undocumented)
@@ -172,8 +196,6 @@ export interface User extends UserPathHistory, UserActionHistory {
     };
     // (undocumented)
     readonly userName: string;
-    // (undocumented)
-    readonly username: string;
 }
 
 // @internal
@@ -194,6 +216,23 @@ export type UserAuthenticationChangeEvent = CustomEvent<boolean>;
 // @public
 export const UserAuthenticationChangeType = "user-authentication-change";
 
+// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "UserChannel" because one of its declarations is marked as @internal
+//
+// @public
+export interface UserChannel extends TypedBroadcastChannel<UserChannelEvents> {
+}
+
+// @internal
+export const UserChannel: InterfaceSymbol<TypedBroadcastChannel<UserChannelEvents>>;
+
+// @public
+export type UserChannelEvents = {
+    [UserAuthenticationChangeType]: boolean;
+};
+
+// @public
+export const UserChannelId = "genesis-user";
+
 // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "UserConfig" because one of its declarations is marked as @internal
 //
 // @public

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-user",
   "description": "Genesis User",
-  "version": "14.176.1-alpha-ed9e3d4.0",
+  "version": "14.177.1",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -26,18 +26,19 @@
     "test": "genx test"
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.176.1-alpha-ed9e3d4.0",
-    "@genesislcap/genx": "14.176.1-alpha-ed9e3d4.0",
-    "@genesislcap/rollup-builder": "14.176.1-alpha-ed9e3d4.0",
-    "@genesislcap/ts-builder": "14.176.1-alpha-ed9e3d4.0",
-    "@genesislcap/uvu-playwright-builder": "14.176.1-alpha-ed9e3d4.0",
-    "@genesislcap/vite-builder": "14.176.1-alpha-ed9e3d4.0",
-    "@genesislcap/webpack-builder": "14.176.1-alpha-ed9e3d4.0",
+    "@genesislcap/foundation-testing": "14.177.1",
+    "@genesislcap/genx": "14.177.1",
+    "@genesislcap/rollup-builder": "14.177.1",
+    "@genesislcap/ts-builder": "14.177.1",
+    "@genesislcap/uvu-playwright-builder": "14.177.1",
+    "@genesislcap/vite-builder": "14.177.1",
+    "@genesislcap/webpack-builder": "14.177.1",
     "rimraf": "^3.0.2"
   },
   "dependencies": {
-    "@genesislcap/foundation-logger": "14.176.1-alpha-ed9e3d4.0",
-    "@genesislcap/foundation-utils": "14.176.1-alpha-ed9e3d4.0",
+    "@genesislcap/foundation-broadcast-channel": "14.177.1",
+    "@genesislcap/foundation-logger": "14.177.1",
+    "@genesislcap/foundation-utils": "14.177.1",
     "@microsoft/fast-element": "^1.12.0",
     "@microsoft/fast-foundation": "^2.49.4"
   },
@@ -49,5 +50,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "6445272a68d360b0f5bb97adc641df806470957e"
+  "gitHead": "c07c95144c7ef605e038161300877aea756dcc28"
 }