@genesislcap/foundation-auth 14.136.0 → 14.137.0

package/dist/foundation-auth.d.ts

@@ -12,6 +12,8 @@ import { ComposableStyles } from '@microsoft/fast-element';
 import { Constructable } from '@microsoft/fast-element';
 import { Container } from '@microsoft/fast-foundation';
 import { Controller } from '@microsoft/fast-element';
+import { DefaultUser } from '@genesislcap/foundation-user';
+import { defaultUserConfig } from '@genesislcap/foundation-user';
 import { DoneInvokeEvent } from 'xstate';
 import { ElementStyles } from '@microsoft/fast-element';
 import { EmitOptions } from '@genesislcap/foundation-events';
@@ -20,23 +22,32 @@ import type { ErrorEvent as ErrorEvent_2 } from 'xstate';
 import { EventObject } from 'xstate';
 import { FetchMachine } from '@genesislcap/foundation-state-machine';
 import { FetchMachineEvent } from '@genesislcap/foundation-state-machine';
+import { getUser } from '@genesislcap/foundation-user';
 import { InterfaceSymbol } from '@microsoft/fast-foundation';
 import type { InterpreterOptions } from 'xstate';
-import { Listener } from '@genesislcap/foundation-utils';
 import { Logger } from '@genesislcap/foundation-logger';
 import { Machine } from '@genesislcap/foundation-state-machine';
 import type { MachineContext } from '@genesislcap/foundation-state-machine';
 import { MachineContext as MachineContext_2 } from 'xstate';
-import { Observer } from '@genesislcap/foundation-utils';
 import { ParameterizedObject } from 'xstate';
 import { PartialFASTElementDefinition } from '@microsoft/fast-element';
 import { PropertyAssigner } from 'xstate';
 import { RouterConfiguration } from '@microsoft/fast-router';
+import type { SetUserProperties } from '@genesislcap/foundation-user';
 import { Store } from '@genesislcap/foundation-store';
 import { StoreRoot } from '@genesislcap/foundation-store';
 import { StoreRootEventDetailMap } from '@genesislcap/foundation-store';
 import { SyntheticViewTemplate } from '@microsoft/fast-element';
 import { TemplateElementDependency } from '@genesislcap/foundation-ui';
+import { User } from '@genesislcap/foundation-user';
+import { UserActionHistory } from '@genesislcap/foundation-user';
+import { UserAuthenticationChangeEvent } from '@genesislcap/foundation-user';
+import { UserAuthenticationChangeType } from '@genesislcap/foundation-user';
+import { UserConfig } from '@genesislcap/foundation-user';
+import type { UserDetailsProductProperty } from '@genesislcap/foundation-user';
+import type { UserDetailsProperty } from '@genesislcap/foundation-user';
+import type { UserDetailsSystemProperty } from '@genesislcap/foundation-user';
+import { UserPathHistory } from '@genesislcap/foundation-user';
 import { UUID } from '@genesislcap/foundation-utils';
 import { ViewTemplate } from '@microsoft/fast-element';
 
@@ -1083,92 +1094,19 @@ export declare class DefaultPasswordManagementMapper implements PasswordManageme
     toDTO: (entity: PasswordManagementEntity) => PasswordManagementDTO;
 }
 
-/**
- * Default User implementation.
- * @public
- */
-export declare class DefaultUser implements User {
-    /** @internal */
-    protected config: UserConfig;
-    /** {@inheritDoc UserPathHistory.pathHistory} */
-    pathHistory: string[];
-    /** {@inheritDoc UserActionHistory.actionHistory} */
-    actionHistory: unknown[];
-    /** {@inheritDoc User.isAuthenticated} */
-    isAuthenticated: boolean;
-    /** {@inheritDoc User.userKVs} */
-    userKVs: {
-        [key: string]: any;
-    };
-    /** {@inheritDoc User.details} */
-    details: Details;
-    /** {@inheritDoc User.permission} */
-    permission: string[];
-    /** {@inheritDoc User.profile} */
-    profile: string[];
-    /** {@inheritDoc User.sourceRef} */
-    sourceRef: string;
-    /** {@inheritDoc User.userName} */
-    userName: string;
-    /** {@inheritDoc User.set} */
-    set(entity: Partial<LoginAck>): this;
-    /** {@inheritDoc User.unset} */
-    unset(): this;
-    /** @internal */
-    protected userNameChanged(): void;
-    /** {@inheritDoc User.username} */
-    get username(): string;
-    /** {@inheritDoc User.isAnonymous} */
-    get isAnonymous(): boolean;
-    /** {@inheritDoc User.isAdmin} */
-    isAdmin(): boolean;
-    /** {@inheritDoc User.isBanned} */
-    isBanned(): boolean;
-    /** {@inheritDoc User.hasPermission} */
-    hasPermission(permission: string | string[]): boolean;
-    /** {@inheritDoc User.hasProfile} */
-    hasProfile(profile: string | string[]): boolean;
-    /** {@inheritDoc UserPathHistory.trackPath} */
-    trackPath(): string;
-    /** {@inheritDoc UserPathHistory.clearPaths} */
-    clearPaths(): void;
-    /** {@inheritDoc UserPathHistory.lastPath} */
-    lastPath(): string;
-    /** {@inheritDoc UserActionHistory.trackAction} */
-    trackAction<TDetails = unknown>(details: TDetails): void;
-    /** {@inheritDoc UserActionHistory.clearActions} */
-    clearActions(): void;
-    /** {@inheritDoc UserActionHistory.lastAction} */
-    lastAction(): unknown;
-    /** {@inheritDoc User.clearTrackingHistory} */
-    clearTrackingHistory(): void;
-    /** @internal */
-    protected hasKey(keys: string[], key: string | string[]): boolean;
-    /** @internal */
-    protected authenticationChangeListeners: Observer<UserAuthenticationChangeEvent>;
-    /** {@inheritDoc User.addAuthenticationChangeListener} */
-    addAuthenticationChangeListener(listener: Listener<UserAuthenticationChangeEvent>): () => void;
-    /** @internal */
-    protected isAuthenticatedChanged(): void;
-}
+export { DefaultUser }
 
-/**
- * Default UserConfig DI implementation.
- * @public
- */
-export declare const defaultUserConfig: UserConfig;
+export { defaultUserConfig }
 
 /**
+ * @privateRemarks
+ * Export retained for backwards compatibility.
+ *
+ * @deprecated - Use {@link @genesislcap/foundation-user#UserDetailsProperty} instead.
+ *
  * @public
  */
-export declare interface Details {
-    readonly system: System | null;
-    readonly heartbeatIntervalSecs: number;
-    readonly failedLoginAttempts: number;
-    readonly rejectedLoginAttempts: number;
-    readonly lastLoginDatetime: number;
-    readonly daysToPasswordExpiry: number;
-    readonly product: Product[];
+export declare interface Details extends UserDetailsProperty {
 }
 
 /**
@@ -1797,7 +1735,7 @@ export declare const fromIDPDTO: (dto: IDENTITY_PROVIDER) => IdentityProvider;
  * @example
  * ```ts
  * import { getAuthMachine } from '@genesislcap/foundation-auth/machine';
- * import { getUser, UserAuthenticationChangeEvent } from '@genesislcap/foundation-auth/user';
+ * import { getUser, UserAuthenticationChangeEvent } from '@genesislcap/foundation-user';
  * ...
  * private authMachine = getAuthMachine();
  * ...
@@ -1861,22 +1799,7 @@ export declare const getNormalisedText: (arr: NackErrorWarning[]) => string;
  */
 export declare function getRoutePath(route: AuthRoutes | string, hostPath?: string): string;
 
-/**
- * Gets User from the DI container.
- *
- * @remarks
- * A utility method for host applications that are not using decorators or the DI container.
- *
- * @example
- * ```ts
- * import { getUser, User } from '@genesislcap/foundation-auth/user';
- * ...
- * private user: User = getUser();
- * ```
- *
- * @public
- */
-export declare function getUser(): User;
+export { getUser }
 
 /**
  * hasDTOErrorWarningCode
@@ -2117,18 +2040,7 @@ export declare let LOGIN_URL: string;
 /**
  * @public
  */
-export declare interface LoginAck extends Ack {
-    readonly userName: string;
-    readonly updateQueue: string;
-    readonly zeroMqProxyModeEnabled: boolean;
-    readonly zeroMqProxyInboundPort: number;
-    readonly zeroMqProxyOutboundPort: number;
-    readonly userKVs: {
-        [key: string]: any;
-    };
-    readonly details: Details;
-    readonly permission: string[];
-    readonly profile: string[];
+export declare interface LoginAck extends SetUserProperties, Ack {
 }
 
 /**
@@ -2455,11 +2367,14 @@ export declare interface PasswordManagementMapper extends Mapper<PasswordManagem
 export declare const PasswordManagementMapper: InterfaceSymbol<PasswordManagementMapper>;
 
 /**
+ * @privateRemarks
+ * Export retained for backwards compatibility.
+ *
+ * @deprecated - Use {@link @genesislcap/foundation-user#UserDetailsProductProperty} instead.
+ *
  * @public
  */
-export declare interface Product {
-    readonly name: string;
-    readonly version: string;
+export declare interface Product extends UserDetailsProductProperty {
 }
 
 /**
@@ -2562,10 +2477,14 @@ export declare type SSOCredentials = {
 export declare const styles: ElementStyles;
 
 /**
+ * @privateRemarks
+ * Export retained for backwards compatibility.
+ *
+ * @deprecated - Use {@link @genesislcap/foundation-user#UserDetailsSystemProperty} instead.
+ *
  * @public
  */
-export declare interface System {
-    readonly date: string;
+export declare interface System extends UserDetailsSystemProperty {
 }
 
 /**
@@ -2610,181 +2529,17 @@ declare type TemplateOptions = Partial<TemplateComponents> & {
     somePartial?: string | SyntheticViewTemplate;
 };
 
-/**
- * User interface.
- *
- * @remarks
- * The user singleton, which always exists in either an anonymous or authenticated mode.
- *
- * @privateRemarks
- * Providing `username` and `userName` for backwards compatability.
- *
- * @example
- * ```ts
- * import { User } from '@genesislcap/foundation-auth/user';
- * ...
- * @User private user: User
- * ```
- *
- * @public
- */
-export declare interface User extends UserPathHistory, UserActionHistory {
-    readonly isAuthenticated: boolean;
-    readonly isAnonymous: boolean;
-    readonly userKVs: {
-        [key: string]: any;
-    };
-    readonly details: Details;
-    readonly permission: string[];
-    readonly profile: string[];
-    readonly sourceRef: string;
-    readonly userName: string;
-    readonly username: string;
-    /**
-     * @param entity - The LoginAck used to populate the User.
-     */
-    set(entity: Partial<LoginAck>): this;
-    unset(): this;
-    isAdmin(): boolean;
-    isBanned(): boolean;
-    /**
-     * @param permission - A permission string or an array of permission strings to check.
-     */
-    hasPermission(permission: string | string[]): boolean;
-    /**
-     * @param profile - A profile string or an array of profile strings to check.
-     */
-    hasProfile(profile: string | string[]): boolean;
-    /**
-     * @example
-     * ```ts
-     * import type { UserAuthenticationChangeEvent } from '@genesislcap/foundation-auth/user';
-     * ...
-     * const unsubscribe = this.user.addAuthenticationChangeListener((event: UserAuthenticationChangeEvent) => {
-     *   console.log('User authenticated?', event.detail);
-     * });
-     * ```
-     *
-     * @param listener - A listener function.
-     */
-    addAuthenticationChangeListener(listener: Listener<UserAuthenticationChangeEvent>): () => void;
-    clearTrackingHistory(): void;
-}
-
-/**
- * User DI key.
- *
- * @privateRemarks
- * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
- *
- * @internal
- */
-export declare const User: InterfaceSymbol<User>;
-
-/**
- * UserActionHistory.
- *
- * @remarks
- * APIs to track a user's action history.
- *
- * @privateRemarks
- * Integrate with foundation analytics? Users could then simply call `user.trackAction` and we could engage analytics.
- * We should move analytics out of comms first.
- *
- * @public
- */
-export declare interface UserActionHistory {
-    /**
-     * Array of actions that have been tracked.
-     */
-    readonly actionHistory: unknown[];
-    /**
-     * Track an action.
-     */
-    trackAction<TDetails = unknown>(details: TDetails): void;
-    /**
-     * Clears action history.
-     */
-    clearActions(): void;
-    /**
-     * @returns The last stored action.
-     */
-    lastAction(): unknown;
-}
+export { User }
 
-/**
- * UserAuthenticationChangeEvent.
- *
- * @remarks
- * Detail will either be `true` or `false` to indicate authentication status.
- *
- * @public
- */
-export declare type UserAuthenticationChangeEvent = CustomEvent<boolean>;
+export { UserActionHistory }
 
-/**
- * UserAuthenticationChangeType.
- * @public
- */
-export declare const UserAuthenticationChangeType = "user-authentication-change";
+export { UserAuthenticationChangeEvent }
 
-/**
- * UserConfig DI interface.
- *
- * @public
- */
-export declare interface UserConfig {
-    /**
-     * Exclude certain actions from tracking.
-     */
-    trackActionExclusions: unknown[];
-    /**
-     * Exclude certain paths from tracking.
-     */
-    trackPathExclusions: string[];
-}
+export { UserAuthenticationChangeType }
 
-/**
- * UserConfig DI key.
- *
- * @internal
- * @privateRemarks
- * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
- */
-export declare const UserConfig: InterfaceSymbol<UserConfig>;
+export { UserConfig }
 
-/**
- * UserPathHistory.
- *
- * @remarks
- * APIs to track a user's path history. Includes the pathname, search and hash only.
- * This is not intended proxy or replace the History API.
- *
- * @privateRemarks
- * Integrate with foundation analytics? Users could then simply call `user.trackPath` and we could engage analytics.
- * We should move analytics out of comms first.
- *
- * @public
- */
-export declare interface UserPathHistory {
-    /**
-     * Array of paths that have been tracked.
-     */
-    readonly pathHistory: string[];
-    /**
-     * Track current path.
-     */
-    trackPath(): string;
-    /**
-     * Clears path history.
-     */
-    clearPaths(): void;
-    /**
-     * May be used to return to a target path after authentication.
-     * @returns The last stored path.
-     */
-    lastPath(): string | undefined;
-}
+export { UserPathHistory }
 
 /**
  * ZeroAuth.

package/docs/api/foundation-auth.authmachinecontext.md

@@ -24,5 +24,5 @@ Transient state during the machine's execution.
 |  [dto](./foundation-auth.authmachinecontext.dto.md) |  | [AuthDTO](./foundation-auth.authdto.md) | The login/login DTO from the fetch machine. |
 |  [entity](./foundation-auth.authmachinecontext.entity.md) |  | [AuthEntity](./foundation-auth.authentity.md) | The login/login Entity mapped from the DTO. |
 |  [params?](./foundation-auth.authmachinecontext.params.md) |  | [AuthMachineEventParams](./foundation-auth.authmachineeventparams.md) | _(Optional)_ Authentication event params. |
-|  [user](./foundation-auth.authmachinecontext.user.md) |  | [User](./foundation-auth.user.md) | The user, either authenticated or anonymous. |
+|  [user](./foundation-auth.authmachinecontext.user.md) |  | User | The user, either authenticated or anonymous. |
 

package/docs/api/foundation-auth.defaultauthmachine._constructor_.md

@@ -16,7 +16,7 @@ constructor(user: User, fetchMachine: FetchMachine, cm: CredentialManager, uuid:
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  user | [User](./foundation-auth.user.md) |  |
+|  user | User |  |
 |  fetchMachine | FetchMachine |  |
 |  cm | [CredentialManager](./foundation-auth.credentialmanager.md) |  |
 |  uuid | UUID |  |

package/docs/api/foundation-auth.details.md

@@ -4,22 +4,15 @@
 
 ## Details interface
 
+> Warning: This API is now obsolete.
+> 
+> - Use  instead.
+> 
 
 **Signature:**
 
 ```typescript
-export interface Details 
+export interface Details extends UserDetailsProperty 
 ```
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [daysToPasswordExpiry](./foundation-auth.details.daystopasswordexpiry.md) | <code>readonly</code> | number |  |
-|  [failedLoginAttempts](./foundation-auth.details.failedloginattempts.md) | <code>readonly</code> | number |  |
-|  [heartbeatIntervalSecs](./foundation-auth.details.heartbeatintervalsecs.md) | <code>readonly</code> | number |  |
-|  [lastLoginDatetime](./foundation-auth.details.lastlogindatetime.md) | <code>readonly</code> | number |  |
-|  [product](./foundation-auth.details.product.md) | <code>readonly</code> | [Product](./foundation-auth.product.md)<!-- -->\[\] |  |
-|  [rejectedLoginAttempts](./foundation-auth.details.rejectedloginattempts.md) | <code>readonly</code> | number |  |
-|  [system](./foundation-auth.details.system.md) | <code>readonly</code> | [System](./foundation-auth.system.md) \| null |  |
+**Extends:** UserDetailsProperty
 

package/docs/api/foundation-auth.getauthmachine.md

@@ -24,7 +24,7 @@ A utility method for host applications that are not using decorators or the DI c
 
 ```ts
 import { getAuthMachine } from '@genesislcap/foundation-auth/machine';
-import { getUser, UserAuthenticationChangeEvent } from '@genesislcap/foundation-auth/user';
+import { getUser, UserAuthenticationChangeEvent } from '@genesislcap/foundation-user';
 ...
 private authMachine = getAuthMachine();
 ...

package/docs/api/foundation-auth.loginack.md

@@ -8,21 +8,7 @@
 **Signature:**
 
 ```typescript
-export interface LoginAck extends Ack 
+export interface LoginAck extends SetUserProperties, Ack 
 ```
-**Extends:** Ack
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [details](./foundation-auth.loginack.details.md) | <code>readonly</code> | [Details](./foundation-auth.details.md) |  |
-|  [permission](./foundation-auth.loginack.permission.md) | <code>readonly</code> | string\[\] |  |
-|  [profile](./foundation-auth.loginack.profile.md) | <code>readonly</code> | string\[\] |  |
-|  [updateQueue](./foundation-auth.loginack.updatequeue.md) | <code>readonly</code> | string |  |
-|  [userKVs](./foundation-auth.loginack.userkvs.md) | <code>readonly</code> | { \[key: string\]: any; } |  |
-|  [userName](./foundation-auth.loginack.username.md) | <code>readonly</code> | string |  |
-|  [zeroMqProxyInboundPort](./foundation-auth.loginack.zeromqproxyinboundport.md) | <code>readonly</code> | number |  |
-|  [zeroMqProxyModeEnabled](./foundation-auth.loginack.zeromqproxymodeenabled.md) | <code>readonly</code> | boolean |  |
-|  [zeroMqProxyOutboundPort](./foundation-auth.loginack.zeromqproxyoutboundport.md) | <code>readonly</code> | number |  |
+**Extends:** SetUserProperties, Ack
 

package/docs/api/foundation-auth.md

@@ -17,7 +17,6 @@
 |  [DefaultLogoutMapper](./foundation-auth.defaultlogoutmapper.md) | Default LogoutMapper. |
 |  [DefaultMessageMapper](./foundation-auth.defaultmessagemapper.md) |  |
 |  [DefaultPasswordManagementMapper](./foundation-auth.defaultpasswordmanagementmapper.md) | Default PasswordManagementMapper. |
-|  [DefaultUser](./foundation-auth.defaultuser.md) | Default User implementation. |
 |  [FoundationAuth](./foundation-auth.foundationauth.md) | FoundationAuth. |
 |  [MappingError](./foundation-auth.mappingerror.md) | MappingError. |
 |  [ZeroAuth](./foundation-auth.zeroauth.md) | ZeroAuth. |
@@ -37,7 +36,6 @@
 |  [getAuthMachine()](./foundation-auth.getauthmachine.md) | Get AuthMachine from the DI container. |
 |  [getAuthStore()](./foundation-auth.getauthstore.md) | Get AuthStore from the DI container. |
 |  [getRoutePath(route, hostPath)](./foundation-auth.getroutepath.md) | A utility to get a sub route path taking the host path into account. |
-|  [getUser()](./foundation-auth.getuser.md) | Gets User from the DI container. |
 |  [isChangePasswordParams(params)](./foundation-auth.ischangepasswordparams.md) | isChangePasswordParams. |
 |  [isForgotPasswordParams(params)](./foundation-auth.isforgotpasswordparams.md) | isForgotPasswordParams. |
 |  [isLoginAckDTO(dto)](./foundation-auth.isloginackdto.md) | isLoginAckDTO. |
@@ -94,10 +92,6 @@
 |  [PasswordManagementMapper](./foundation-auth.passwordmanagementmapper.md) | PasswordManagementMapper interface. |
 |  [Product](./foundation-auth.product.md) |  |
 |  [System](./foundation-auth.system.md) |  |
-|  [User](./foundation-auth.user.md) | User interface. |
-|  [UserActionHistory](./foundation-auth.useractionhistory.md) | UserActionHistory. |
-|  [UserConfig](./foundation-auth.userconfig.md) | UserConfig DI interface. |
-|  [UserPathHistory](./foundation-auth.userpathhistory.md) | UserPathHistory. |
 
 ## Variables
 
@@ -111,7 +105,6 @@
 |  [defaultAuthMachineContext](./foundation-auth.defaultauthmachinecontext.md) | Default AuthMachineContext. |
 |  [defaultCredentialManagerConfig](./foundation-auth.defaultcredentialmanagerconfig.md) | The default configuration for the CredentialManager service. |
 |  [defaultCredentialRequestOptions](./foundation-auth.defaultcredentialrequestoptions.md) | The default request options for the CredentialManager service. |
-|  [defaultUserConfig](./foundation-auth.defaultuserconfig.md) | Default UserConfig DI implementation. |
 |  [FORGOT\_PASSWORD\_URL](./foundation-auth.forgot_password_url.md) |  |
 |  [fromDTOAck](./foundation-auth.fromdtoack.md) | fromDTOAck |
 |  [fromDTONack](./foundation-auth.fromdtonack.md) | fromDTONack |
@@ -131,7 +124,6 @@
 |  [SSO\_LOGIN\_URL](./foundation-auth.sso_login_url.md) |  |
 |  [styles](./foundation-auth.styles.md) |  |
 |  [template](./foundation-auth.template.md) |  |
-|  [UserAuthenticationChangeType](./foundation-auth.userauthenticationchangetype.md) | UserAuthenticationChangeType. |
 
 ## Type Aliases
 
@@ -170,5 +162,4 @@
 |  [Settings](./foundation-auth.settings.md) | Defines the parameters you may set on the routes. |
 |  [SSOConfig](./foundation-auth.ssoconfig.md) |  |
 |  [SSOCredentials](./foundation-auth.ssocredentials.md) |  |
-|  [UserAuthenticationChangeEvent](./foundation-auth.userauthenticationchangeevent.md) | UserAuthenticationChangeEvent. |
 

package/docs/api/foundation-auth.product.md

@@ -4,17 +4,15 @@
 
 ## Product interface
 
+> Warning: This API is now obsolete.
+> 
+> - Use  instead.
+> 
 
 **Signature:**
 
 ```typescript
-export interface Product 
+export interface Product extends UserDetailsProductProperty 
 ```
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [name](./foundation-auth.product.name.md) | <code>readonly</code> | string |  |
-|  [version](./foundation-auth.product.version.md) | <code>readonly</code> | string |  |
+**Extends:** UserDetailsProductProperty
 

package/docs/api/foundation-auth.system.md

@@ -4,16 +4,15 @@
 
 ## System interface
 
+> Warning: This API is now obsolete.
+> 
+> - Use  instead.
+> 
 
 **Signature:**
 
 ```typescript
-export interface System 
+export interface System extends UserDetailsSystemProperty 
 ```
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [date](./foundation-auth.system.date.md) | <code>readonly</code> | string |  |
+**Extends:** UserDetailsSystemProperty