@genesislcap/foundation-user 14.137.0

package/README.md

@@ -0,0 +1,43 @@
+# Genesis 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/)
+
+`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.
+
+## 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/dist/dts/config.d.ts

@@ -0,0 +1,53 @@
+import { SetUserProperties } from './types';
+import type { User } from './user';
+/**
+ * @internal
+ */
+type WriteableUser = {
+    -readonly [P in keyof User]: User[P];
+};
+/**
+ * UserConfig DI interface.
+ *
+ * @public
+ */
+export interface UserConfig {
+    /**
+     * Exclude certain actions from tracking.
+     *
+     * See {@link UserPathHistory}
+     */
+    trackActionExclusions: unknown[];
+    /**
+     * Exclude certain paths from tracking.
+     *
+     * See {@link UserActionHistory}
+     */
+    trackPathExclusions: string[];
+    /**
+     * User property setter.
+     *
+     * @remarks
+     * The user is typically set from the result of a LoginAck.
+     */
+    setUser(user: WriteableUser, properties: Partial<SetUserProperties>): User;
+    /**
+     * User property un-setter.
+     */
+    unsetUser(user: WriteableUser): User;
+}
+/**
+ * Default UserConfig DI implementation.
+ * @public
+ */
+export declare const defaultUserConfig: UserConfig;
+/**
+ * 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: import("@microsoft/fast-foundation").InterfaceSymbol<UserConfig>;
+export {};
+//# sourceMappingURL=config.d.ts.map

package/dist/dts/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/config.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAC5C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEnC;;GAEG;AACH,KAAK,aAAa,GAAG;IAAE,CAAC,UAAU,CAAC,IAAI,MAAM,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC;CAAE,CAAC;AAE9D;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACzB;;;;OAIG;IACH,qBAAqB,EAAE,OAAO,EAAE,CAAC;IAEjC;;;;OAIG;IACH,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAE9B;;;;;OAKG;IACH,OAAO,CAAC,IAAI,EAAE,aAAa,EAAE,UAAU,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC;IAE3E;;OAEG;IACH,SAAS,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI,CAAC;CACtC;AAED;;;GAGG;AACH,eAAO,MAAM,iBAAiB,EAAE,UA0C/B,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,kEAAuE,CAAC"}

package/dist/dts/index.d.ts

@@ -0,0 +1,5 @@
+export * from './config';
+export * from './types';
+export * from './user';
+export * from './logger';
+//# sourceMappingURL=index.d.ts.map

package/dist/dts/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC"}

package/dist/dts/index.federated.d.ts

@@ -0,0 +1 @@
+//# sourceMappingURL=index.federated.d.ts.map

package/dist/dts/index.federated.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.federated.d.ts","sourceRoot":"","sources":["../../src/index.federated.ts"],"names":[],"mappings":""}

package/dist/dts/logger.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @public
+ */
+export declare const logger: import("@genesislcap/foundation-logger").Logger;
+//# sourceMappingURL=logger.d.ts.map

package/dist/dts/logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/logger.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,eAAO,MAAM,MAAM,iDAAkC,CAAC"}

package/dist/dts/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.34.9"
+    }
+  ]
+}

package/dist/dts/types.d.ts

@@ -0,0 +1,134 @@
+/**
+ * UserAuthenticationChangeType.
+ * @public
+ */
+export declare const UserAuthenticationChangeType = "user-authentication-change";
+/**
+ * UserAuthenticationChangeEvent.
+ *
+ * @remarks
+ * Detail will either be `true` or `false` to indicate authentication status.
+ *
+ * @public
+ */
+export type UserAuthenticationChangeEvent = CustomEvent<boolean>;
+/**
+ * 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 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;
+}
+/**
+ * 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 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;
+}
+/**
+ * @public
+ */
+export interface UserKVsProperty {
+    readonly [key: string]: any;
+}
+/**
+ * @public
+ */
+export interface UserDetailsSystemProperty {
+    readonly date: string;
+    readonly [key: string]: any;
+}
+/**
+ * @public
+ */
+export interface UserDetailsProductProperty {
+    readonly name: string;
+    readonly version: string;
+    readonly [key: string]: any;
+}
+/**
+ * @public
+ */
+export interface UserQueueProperties {
+    readonly updateQueue: string;
+    readonly zeroMqProxyModeEnabled: boolean;
+    readonly zeroMqProxyInboundPort: number;
+    readonly zeroMqProxyOutboundPort: number;
+}
+/**
+ * @public
+ */
+export interface UserDetailsProperty {
+    readonly system: UserDetailsSystemProperty;
+    readonly product: UserDetailsProductProperty[];
+    readonly heartbeatIntervalSecs: number;
+    readonly failedLoginAttempts: number;
+    readonly rejectedLoginAttempts: number;
+    readonly lastLoginDatetime: number;
+    readonly daysToPasswordExpiry: number;
+    readonly [key: string]: any;
+}
+/**
+ * SetUserProperties is a partial match of `LoginAck` from `@genesislcap/foundation-auth`.
+ *
+ * @public
+ */
+export interface SetUserProperties extends Partial<UserQueueProperties> {
+    readonly sourceRef: string;
+    readonly userName: string;
+    readonly userKVs: UserKVsProperty;
+    readonly details: UserDetailsProperty;
+    readonly permission: string[];
+    readonly profile: string[];
+    readonly [key: string]: any;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/dts/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,4BAA4B,+BAA+B,CAAC;AAEzE;;;;;;;GAOG;AACH,MAAM,MAAM,6BAA6B,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;AAEjE;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,EAAE,CAAC;IAE/B;;OAEG;IACH,SAAS,IAAI,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,IAAI,IAAI,CAAC;IAEnB;;;OAGG;IACH,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAC;CAChC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,OAAO,EAAE,CAAC;IAElC;;OAEG;IACH,WAAW,CAAC,QAAQ,GAAG,OAAO,EAAE,OAAO,EAAE,QAAQ,GAAG,IAAI,CAAC;IAEzD;;OAEG;IACH,YAAY,IAAI,IAAI,CAAC;IAErB;;OAEG;IACH,UAAU,IAAI,OAAO,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,sBAAsB,EAAE,OAAO,CAAC;IACzC,QAAQ,CAAC,sBAAsB,EAAE,MAAM,CAAC;IACxC,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,MAAM,EAAE,yBAAyB,CAAC;IAC3C,QAAQ,CAAC,OAAO,EAAE,0BAA0B,EAAE,CAAC;IAC/C,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;IACvC,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC;IACrC,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;IACvC,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,oBAAoB,EAAE,MAAM,CAAC;IACtC,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CAC7B;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAkB,SAAQ,OAAO,CAAC,mBAAmB,CAAC;IACrE,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC;IAClC,QAAQ,CAAC,OAAO,EAAE,mBAAmB,CAAC;IACtC,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;IAC9B,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;IAC3B,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CAC7B"}

package/dist/dts/user.d.ts

@@ -0,0 +1,167 @@
+import { Listener } from '@genesislcap/foundation-utils';
+import { UserConfig } from './config';
+import type { SetUserProperties, UserActionHistory, UserAuthenticationChangeEvent, UserPathHistory } from './types';
+/**
+ * User interface.
+ *
+ * @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';
+ * ...
+ * @User private user: User
+ * ```
+ *
+ * @public
+ */
+export interface User extends UserPathHistory, UserActionHistory {
+    readonly isAuthenticated: boolean;
+    readonly isAnonymous: boolean;
+    readonly userKVs: {
+        [key: string]: any;
+    };
+    readonly details: SetUserProperties['details'];
+    readonly permission: string[];
+    readonly profile: string[];
+    readonly sourceRef: string;
+    readonly userName: string;
+    readonly username: string;
+    /**
+     * A structuredClone of the raw unmanaged properties used to set the user.
+     *
+     * @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.
+     */
+    readonly rawProperties: Partial<SetUserProperties>;
+    /**
+     * @param properties - The UserProperties used to populate the User.
+     */
+    set(properties: Partial<SetUserProperties>): User;
+    unset(): User;
+    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-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;
+}
+/**
+ * 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: SetUserProperties['details'];
+    /** {@inheritDoc User.permission} */
+    permission: string[];
+    /** {@inheritDoc User.profile} */
+    profile: string[];
+    /** {@inheritDoc User.sourceRef} */
+    sourceRef: string;
+    /** {@inheritDoc User.userName} */
+    userName: string;
+    /** {@inheritDoc User.rawProperties} */
+    rawProperties: Partial<SetUserProperties>;
+    /** {@inheritDoc User.set} */
+    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} */
+    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: import("@genesislcap/foundation-utils").Observer<UserAuthenticationChangeEvent>;
+    /** {@inheritDoc User.addAuthenticationChangeListener} */
+    addAuthenticationChangeListener(listener: Listener<UserAuthenticationChangeEvent>): () => void;
+    /** @internal */
+    protected isAuthenticatedChanged(): 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: import("@microsoft/fast-foundation").InterfaceSymbol<User>;
+/**
+ * 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-user';
+ * ...
+ * private user: User = getUser();
+ * ```
+ *
+ * @public
+ */
+export declare function getUser(): User;
+//# sourceMappingURL=user.d.ts.map

package/dist/dts/user.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../src/user.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AAGzE,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,KAAK,EACV,iBAAiB,EACjB,iBAAiB,EACjB,6BAA6B,EAC7B,eAAe,EAChB,MAAM,SAAS,CAAC;AAGjB;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,WAAW,IAAK,SAAQ,eAAe,EAAE,iBAAiB;IAC9D,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC;IAClC,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;IAC9B,QAAQ,CAAC,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IACzC,QAAQ,CAAC,OAAO,EAAE,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAC/C,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;IAC9B,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;IAC3B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B;;;;;;OAMG;IACH,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACnD;;OAEG;IACH,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC;IAClD,KAAK,IAAI,IAAI,CAAC;IACd,OAAO,IAAI,OAAO,CAAC;IACnB,QAAQ,IAAI,OAAO,CAAC;IACpB;;OAEG;IACH,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC;IACtD;;OAEG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC;IAChD;;;;;;;;;;;OAWG;IACH,+BAA+B,CAAC,QAAQ,EAAE,QAAQ,CAAC,6BAA6B,CAAC,GAAG,MAAM,IAAI,CAAC;IAC/F,oBAAoB,IAAI,IAAI,CAAC;CAC9B;AAED;;;GAGG;AACH,qBAAa,WAAY,YAAW,IAAI;IACtC,gBAAgB;IACJ,SAAS,CAAC,MAAM,EAAE,UAAU,CAAC;IAEzC,gDAAgD;IACpC,WAAW,EAAE,MAAM,EAAE,CAAM;IAEvC,oDAAoD;IACxC,aAAa,EAAE,OAAO,EAAE,CAAM;IAE1C,yCAAyC;IAC7B,eAAe,EAAE,OAAO,CAAS;IAE7C,iCAAiC;IACrB,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAE5C,iCAAiC;IACrB,OAAO,EAAE,iBAAiB,CAAC,SAAS,CAAC,CAAC;IAElD,oCAAoC;IACxB,UAAU,EAAE,MAAM,EAAE,CAAC;IAEjC,iCAAiC;IACrB,OAAO,EAAE,MAAM,EAAE,CAAC;IAE9B,mCAAmC;IACvB,SAAS,EAAE,MAAM,CAAC;IAE9B,kCAAkC;IACtB,QAAQ,EAAE,MAAM,CAAC;IAE7B,uCAAuC;IAC3B,aAAa,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAEtD,6BAA6B;IAC7B,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,IAAI;IAIjD,+BAA+B;IAC/B,KAAK,IAAI,IAAI;IAIb,gBAAgB;IAChB,SAAS,CAAC,eAAe;IAIzB,kCAAkC;IAClC,IAAI,QAAQ,WAGX;IAED,qCAAqC;IACrC,IAAI,WAAW,YAEd;IAED,iCAAiC;IACjC,OAAO;IAIP,kCAAkC;IAClC,QAAQ;IAIR,uCAAuC;IACvC,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE;IAI3C,oCAAoC;IACpC,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE;IAIrC,8CAA8C;IAC9C,SAAS;IAWT,+CAA+C;IAC/C,UAAU;IAIV,6CAA6C;IAC7C,QAAQ;IAKR,kDAAkD;IAClD,WAAW,CAAC,QAAQ,GAAG,OAAO,EAAE,OAAO,EAAE,QAAQ;IAOjD,mDAAmD;IACnD,YAAY;IAIZ,iDAAiD;IACjD,UAAU;IAKV,8CAA8C;IAC9C,oBAAoB;IAKpB,gBAAgB;IAChB,SAAS,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE;IAUvD,gBAAgB;IAChB,SAAS,CAAC,6BAA6B,kFAAmD;IAE1F,yDAAyD;IACzD,+BAA+B,CAAC,QAAQ,EAAE,QAAQ,CAAC,6BAA6B,CAAC;IAIjF,gBAAgB;IAChB,SAAS,CAAC,sBAAsB;CAOjC;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,IAAI,4DAA4D,CAAC;AAE9E;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,OAAO,IAAI,IAAI,CAE9B"}

package/dist/esm/config.js

@@ -0,0 +1,57 @@
+import { DI } from '@microsoft/fast-foundation';
+import { logger } from './logger';
+/**
+ * Default UserConfig DI implementation.
+ * @public
+ */
+export const defaultUserConfig = {
+    trackActionExclusions: [],
+    trackPathExclusions: [''],
+    setUser(user, properties) {
+        if (user.isAuthenticated) {
+            throw new Error(`User already set. If this is intentional, please call User.unset first.`);
+        }
+        logger.debug('setUser', properties);
+        /**
+         * Create a clone of the raw properties.
+         */
+        user.rawProperties = structuredClone(properties);
+        /**
+         * Set managed properties
+         */
+        user.userKVs = properties.userKVs;
+        user.details = properties.details;
+        user.permission = properties.permission;
+        user.profile = properties.profile;
+        user.sourceRef = properties.sourceRef;
+        user.userName = properties.userName;
+        user.isAuthenticated = true;
+        return user;
+    },
+    unsetUser(user) {
+        logger.debug('unsetUser');
+        /**
+         * Unset raw properties ref
+         */
+        user.rawProperties = undefined;
+        /**
+         * Unset managed properties
+         */
+        user.userKVs = undefined;
+        user.details = undefined;
+        user.permission = undefined;
+        user.profile = undefined;
+        user.sourceRef = undefined;
+        user.userName = undefined;
+        user.isAuthenticated = false;
+        return user;
+    },
+};
+/**
+ * UserConfig DI key.
+ *
+ * @internal
+ * @privateRemarks
+ * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
+ */
+export const UserConfig = DI.createInterface((x) => x.instance(defaultUserConfig));

package/dist/esm/index.federated.js

@@ -0,0 +1 @@
+import('./index');

package/dist/esm/index.js

@@ -0,0 +1,4 @@
+export * from './config';
+export * from './types';
+export * from './user';
+export * from './logger';

package/dist/esm/logger.js

@@ -0,0 +1,5 @@
+import { createLogger } from '@genesislcap/foundation-logger';
+/**
+ * @public
+ */
+export const logger = createLogger('foundation-user');

package/dist/esm/types.js

@@ -0,0 +1,5 @@
+/**
+ * UserAuthenticationChangeType.
+ * @public
+ */
+export const UserAuthenticationChangeType = 'user-authentication-change';