@genesislcap/foundation-user 14.176.1-alpha-6ef4895.0 → 14.177.0-raise-intent.1

package/dist/foundation-user.api.json

@@ -417,6 +417,37 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/foundation-user!DefaultUser#hasAdminProfile:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "hasAdminProfile(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "hasAdminProfile"
+            },
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-user!DefaultUser#hasPermission:member(1)",
@@ -757,6 +788,36 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-user!DefaultUser#permissions:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get permissions(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "permissions",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-user!DefaultUser#profile:member",
@@ -787,6 +848,36 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-user!DefaultUser#profiles:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get profiles(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "profiles",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-user!DefaultUser#rawProperties:member",
@@ -1089,7 +1180,7 @@
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-user!DefaultUser#username:member",
-              "docComment": "/**\n * {@inheritDoc User.username}\n */\n",
+              "docComment": "",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -1207,6 +1298,162 @@
           "parameters": [],
           "name": "getUser"
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@genesislcap/foundation-user!getUserChannel:function(1)",
+          "docComment": "/**\n * Gets UserChannel from the DI container.\n *\n * @remarks\n *\n * A utility method for host applications that are not using decorators or the DI container.\n *\n * @example\n * ```ts\n * import { getUserChannel } from '@genesislcap/foundation-user';\n * ...\n * const channel = getUserChannel();\n * ...\n * channel.onmessage = (e) => {\n *  if (channel.isMessageType('user-authentication-change', e)) {\n *    logger.debug('user-authentication-change', e.data.detail);\n *    return;\n *  }\n * }\n * ...\n * channel.close();\n * ```\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function getUserChannel(): "
+            },
+            {
+              "kind": "Reference",
+              "text": "UserChannel",
+              "canonicalReference": "@genesislcap/foundation-user!UserChannel:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/config.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [],
+          "name": "getUserChannel"
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@genesislcap/foundation-user!LegacyUserAPI:interface",
+          "docComment": "/**\n * @remarks\n *\n * For backwards compatibility, will be removed in a future major release, likely v15.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface LegacyUserAPI "
+            }
+          ],
+          "fileUrlPath": "src/user.ts",
+          "releaseTag": "Public",
+          "name": "LegacyUserAPI",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@genesislcap/foundation-user!LegacyUserAPI#hasAdminProfile:member(1)",
+              "docComment": "/**\n * @deprecated\n *\n * - Use `isAdmin` instead.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "hasAdminProfile(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [],
+              "name": "hasAdminProfile"
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/foundation-user!LegacyUserAPI#permissions:member",
+              "docComment": "/**\n * @deprecated\n *\n * - Use `permission` instead.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly permissions: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "permissions",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/foundation-user!LegacyUserAPI#profiles:member",
+              "docComment": "/**\n * @deprecated\n *\n * - Use `profile` instead.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly profiles: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "profiles",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/foundation-user!LegacyUserAPI#username:member",
+              "docComment": "/**\n * @deprecated\n *\n * - Use `userName` instead.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly username: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "username",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-user!logger:var",
@@ -1511,6 +1758,15 @@
               "text": "UserActionHistory",
               "canonicalReference": "@genesislcap/foundation-user!UserActionHistory:interface"
             },
+            {
+              "kind": "Content",
+              "text": ", "
+            },
+            {
+              "kind": "Reference",
+              "text": "LegacyUserAPI",
+              "canonicalReference": "@genesislcap/foundation-user!LegacyUserAPI:interface"
+            },
             {
               "kind": "Content",
               "text": " "
@@ -1524,7 +1780,7 @@
             {
               "kind": "MethodSignature",
               "canonicalReference": "@genesislcap/foundation-user!User#addAuthenticationChangeListener:member(1)",
-              "docComment": "/**\n * @param listener - A listener function.\n *\n * @example\n * ```ts\n * import type { UserAuthenticationChangeEvent } from '@genesislcap/foundation-user';\n * ...\n * const unsubscribe = this.user.addAuthenticationChangeListener((event: UserAuthenticationChangeEvent) => {\n *   console.log('User authenticated?', event.detail);\n * });\n * ```\n *\n */\n",
+              "docComment": "/**\n * @param listener - A listener function.\n *\n * @example\n * ```ts\n * const unsubscribe = this.user.addAuthenticationChangeListener((event) => {\n *   console.log('User authenticated?', event.detail);\n * });\n * ```\n *\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -2078,33 +2334,6 @@
                 "endIndex": 2
               }
             },
-            {
-              "kind": "PropertySignature",
-              "canonicalReference": "@genesislcap/foundation-user!User#username:member",
-              "docComment": "",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "readonly username: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "string"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": true,
-              "isOptional": false,
-              "releaseTag": "Public",
-              "name": "username",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              }
-            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@genesislcap/foundation-user!User#userName:member",
@@ -2141,6 +2370,10 @@
             {
               "startIndex": 3,
               "endIndex": 4
+            },
+            {
+              "startIndex": 5,
+              "endIndex": 6
             }
           ]
         },
@@ -2369,6 +2602,112 @@
             "endIndex": 0
           }
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@genesislcap/foundation-user!UserChannel:interface",
+          "docComment": "/**\n * UserChannel DI interface.\n *\n * @example\n * ```ts\n * import { UserChannel } from '@genesislcap/foundation-user';\n * ...\n * @UserChannel protected channel: UserChannel;\n * ...\n * this.channel.onmessage = (e) => {\n *  if (this.channel.isMessageType('user-authentication-change', e)) {\n *    logger.debug('user-authentication-change', e.data.detail);\n *    return;\n *  }\n * }\n * ...\n * this.channel.close();\n * ```\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface UserChannel extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "TypedBroadcastChannel",
+              "canonicalReference": "@genesislcap/foundation-broadcast-channel!TypedBroadcastChannel:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "UserChannelEvents",
+              "canonicalReference": "@genesislcap/foundation-user!UserChannelEvents:type"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "fileUrlPath": "src/config.ts",
+          "releaseTag": "Public",
+          "name": "UserChannel",
+          "preserveMemberOrder": false,
+          "members": [],
+          "extendsTokenRanges": [
+            {
+              "startIndex": 1,
+              "endIndex": 5
+            }
+          ]
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-user!UserChannelEvents:type",
+          "docComment": "/**\n * UserChannelEvents.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type UserChannelEvents = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    ["
+            },
+            {
+              "kind": "Reference",
+              "text": "UserAuthenticationChangeType",
+              "canonicalReference": "@genesislcap/foundation-user!UserAuthenticationChangeType:var"
+            },
+            {
+              "kind": "Content",
+              "text": "]: boolean;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/types.ts",
+          "releaseTag": "Public",
+          "name": "UserChannelEvents",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 4
+          }
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@genesislcap/foundation-user!UserChannelId:var",
+          "docComment": "/**\n * UserChannelId.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "UserChannelId = "
+            },
+            {
+              "kind": "Content",
+              "text": "\"genesis-user\""
+            }
+          ],
+          "fileUrlPath": "src/types.ts",
+          "initializerTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          },
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "UserChannelId",
+          "variableTypeTokenRange": {
+            "startIndex": 0,
+            "endIndex": 0
+          }
+        },
         {
           "kind": "Interface",
           "canonicalReference": "@genesislcap/foundation-user!UserConfig:interface",

package/dist/foundation-user.d.ts

@@ -2,6 +2,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';
 
 /**
  * Default User implementation.
@@ -36,10 +37,6 @@ export declare class DefaultUser implements User {
     set(properties: Partial<SetUserProperties>): User;
     /** {@inheritDoc User.unset} */
     unset(): User;
-    /** @internal */
-    protected userNameChanged(): void;
-    /** {@inheritDoc User.username} */
-    get username(): string;
     /** {@inheritDoc User.isAnonymous} */
     get isAnonymous(): boolean;
     /** {@inheritDoc User.isAdmin} */
@@ -72,6 +69,23 @@ export declare class DefaultUser implements User {
     addAuthenticationChangeListener(listener: Listener<UserAuthenticationChangeEvent>): () => void;
     /** @internal */
     protected isAuthenticatedChanged(): void;
+    /**
+     * Bridge legacy user apis below
+     */
+    /** @internal */
+    protected userNameChanged(): void;
+    /** {@inheritDoc LegacyUserAPI.username} */
+    get username(): string;
+    /** @internal */
+    protected permissionChanged(): void;
+    /** {@inheritDoc LegacyUserAPI.permissions} */
+    get permissions(): string[];
+    /** @internal */
+    protected profileChanged(): void;
+    /** {@inheritDoc LegacyUserAPI.profiles} */
+    get profiles(): string[];
+    /** {@inheritDoc LegacyUserAPI.hasAdminProfile} */
+    hasAdminProfile(): boolean;
 }
 
 /**
@@ -97,6 +111,56 @@ export declare const defaultUserConfig: UserConfig;
  */
 export declare function getUser(): User;
 
+/**
+ * Gets UserChannel from the DI container.
+ *
+ * @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();
+ * ```
+ * @public
+ */
+export declare function getUserChannel(): UserChannel;
+
+/**
+ * @remarks
+ * For backwards compatibility, will be removed in a future major release, likely v15.
+ *
+ * @public
+ */
+export declare interface LegacyUserAPI {
+    /**
+     * @deprecated - Use `userName` instead.
+     */
+    readonly username: string;
+    /**
+     * @deprecated - Use `permission` instead.
+     */
+    readonly permissions: string[];
+    /**
+     * @deprecated - Use `profile` instead.
+     */
+    readonly profiles: string[];
+    /**
+     * @deprecated - Use `isAdmin` instead.
+     */
+    hasAdminProfile(): boolean;
+}
+
 /**
  * @public
  */
@@ -123,9 +187,6 @@ export declare interface SetUserProperties extends Partial<UserQueueProperties>
  * @remarks
  * The user singleton, which always exists in either an anonymous or authenticated mode.
  *
- * @privateRemarks
- * Provides `username` and `userName` for backwards compatability.
- *
  * @example
  * ```ts
  * import { User } from '@genesislcap/foundation-user';
@@ -135,7 +196,7 @@ export declare interface SetUserProperties extends Partial<UserQueueProperties>
  *
  * @public
  */
-export declare interface User extends UserPathHistory, UserActionHistory {
+export declare interface User extends UserPathHistory, UserActionHistory, LegacyUserAPI {
     readonly isAuthenticated: boolean;
     readonly isAnonymous: boolean;
     readonly userKVs: {
@@ -146,7 +207,6 @@ export declare interface User extends UserPathHistory, UserActionHistory {
     readonly profile: string[];
     readonly sourceRef: string;
     readonly userName: string;
-    readonly username: string;
     /**
      * A structuredClone of the raw unmanaged properties used to set the user.
      *
@@ -173,9 +233,7 @@ export declare interface User extends UserPathHistory, UserActionHistory {
     /**
      * @example
      * ```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);
      * });
      * ```
@@ -243,6 +301,50 @@ export declare type UserAuthenticationChangeEvent = CustomEvent<boolean>;
  */
 export declare const UserAuthenticationChangeType = "user-authentication-change";
 
+/**
+ * UserChannel DI interface.
+ * @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();
+ * ```
+ * @public
+ */
+export declare interface UserChannel extends TypedBroadcastChannel<UserChannelEvents> {
+}
+
+/**
+ * UserChannel DI key.
+ * @internal
+ * @privateRemarks
+ * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
+ */
+export declare const UserChannel: InterfaceSymbol<TypedBroadcastChannel<UserChannelEvents>>;
+
+/**
+ * UserChannelEvents.
+ * @public
+ */
+export declare type UserChannelEvents = {
+    [UserAuthenticationChangeType]: boolean;
+};
+
+/**
+ * UserChannelId.
+ * @public
+ */
+export declare const UserChannelId = "genesis-user";
+
 /**
  * UserConfig DI interface.
  *

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

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

@@ -23,7 +23,9 @@ export declare class DefaultUser implements User
 |  [isAuthenticated](./foundation-user.defaultuser.isauthenticated.md) |  | boolean |  |
 |  [pathHistory](./foundation-user.defaultuser.pathhistory.md) |  | string\[\] | Array of paths that have been tracked. |
 |  [permission](./foundation-user.defaultuser.permission.md) |  | string\[\] |  |
+|  [permissions](./foundation-user.defaultuser.permissions.md) | <code>readonly</code> | string\[\] |  |
 |  [profile](./foundation-user.defaultuser.profile.md) |  | string\[\] |  |
+|  [profiles](./foundation-user.defaultuser.profiles.md) | <code>readonly</code> | string\[\] |  |
 |  [rawProperties](./foundation-user.defaultuser.rawproperties.md) |  | Partial&lt;[SetUserProperties](./foundation-user.setuserproperties.md)<!-- -->&gt; | A structuredClone of the raw unmanaged properties used to set the user. |
 |  [sourceRef](./foundation-user.defaultuser.sourceref.md) |  | string |  |
 |  [userKVs](./foundation-user.defaultuser.userkvs.md) |  | { \[key: string\]: any; } |  |
@@ -38,6 +40,7 @@ export declare class DefaultUser implements User
 |  [clearActions()](./foundation-user.defaultuser.clearactions.md) |  | Clears action history. |
 |  [clearPaths()](./foundation-user.defaultuser.clearpaths.md) |  | Clears path history. |
 |  [clearTrackingHistory()](./foundation-user.defaultuser.cleartrackinghistory.md) |  |  |
+|  [hasAdminProfile()](./foundation-user.defaultuser.hasadminprofile.md) |  |  |
 |  [hasPermission(permission)](./foundation-user.defaultuser.haspermission.md) |  |  |
 |  [hasProfile(profile)](./foundation-user.defaultuser.hasprofile.md) |  |  |
 |  [isAdmin()](./foundation-user.defaultuser.isadmin.md) |  |  |