@genesislcap/foundation-utils 14.310.2-alpha-956f0b8.0 → 14.310.2-alpha-64966a4.0

package/dist/foundation-utils.d.ts

@@ -7,6 +7,7 @@ import { CSSDesignToken } from '@microsoft/fast-foundation';
 import { DesignSystem } from '@microsoft/fast-foundation';
 import { ElementStyles } from '@microsoft/fast-element';
 import { FASTElement } from '@microsoft/fast-element';
+import { GenesisElement } from '@genesislcap/web-core';
 import { InterfaceSymbol } from '@microsoft/fast-foundation';
 import type { JSONSchema7 } from 'json-schema';
 import { Logger as Logger_2 } from '@genesislcap/foundation-logger';
@@ -441,6 +442,8 @@ export declare interface ErrorMap<TErrorDetailMap extends ErrorDetailMap> extend
  */
 export declare type ErrorMapLogger = (...args: any[]) => void;
 
+declare type EventListener_2<T = any> = (data: T) => void;
+
 /**
  * Represents the possible event names for data synchronization.
  * @public
@@ -614,6 +617,87 @@ export declare function getNumberFormatter(format: string, locale?: string | nul
  */
 export declare let HTTP_CONFIG: string;
 
+export declare interface InactivityConfig {
+    timeoutMinutes: number;
+    warningMinutes: number;
+}
+
+export declare class InactivityDialog extends GenesisElement {
+    isVisible: boolean;
+    remainingSeconds: number;
+    private onContinue?;
+    private onLogout?;
+    private countdownInterval?;
+    private startTime;
+    private totalSeconds;
+    show(options: InactivityDialogOptions): void;
+    hide(): void;
+    private startCountdown;
+    private stopCountdown;
+    private handleContinue;
+    private handleLogout;
+    disconnectedCallback(): void;
+}
+
+export declare interface InactivityDialogOptions {
+    remainingSeconds: number;
+    onContinue: () => void;
+    onLogout: () => void;
+}
+
+export declare interface InactivityEvents {
+    'inactivity-warning': {
+        remainingSeconds: number;
+    };
+    'inactivity-timeout': void;
+    'inactivity-reset': void;
+}
+
+export declare class InactivityManager {
+    private service;
+    private dialog;
+    private config;
+    private isDialogVisible;
+    constructor(config: InactivityManagerConfig);
+    private setupEventListeners;
+    private showWarningDialog;
+    private hideWarningDialog;
+    private handleContinue;
+    private handleLogout;
+    private handleTimeout;
+    start(): void;
+    stop(): void;
+    reset(): void;
+    destroy(): void;
+    getService(): InactivityService;
+    isWarningVisible(): boolean;
+}
+
+export declare interface InactivityManagerConfig extends InactivityConfig {
+    onLogout: () => void;
+}
+
+export declare class InactivityService {
+    private config;
+    private warningId;
+    private timeoutId;
+    private lastActivity;
+    private isActive;
+    private eventListeners;
+    constructor(config: InactivityConfig);
+    private setupActivityListeners;
+    private checkTimeout;
+    on<K extends keyof InactivityEvents>(event: K, listener: EventListener_2<InactivityEvents[K]>): void;
+    off<K extends keyof InactivityEvents>(event: K, listener: EventListener_2<InactivityEvents[K]>): void;
+    private emit;
+    start(): void;
+    stop(): void;
+    resetTimer(): void;
+    private scheduleTimers;
+    private clearTimers;
+    destroy(): void;
+}
+
 /**
  * Returns a boolean value indicating whether the current window is inside an iframe.
  * @returns true if the window is inside an iframe, false otherwise.

package/docs/api/foundation-utils.inactivityconfig.md

@@ -0,0 +1,71 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [InactivityConfig](./foundation-utils.inactivityconfig.md)
+
+## InactivityConfig interface
+
+**Signature:**
+
+```typescript
+export interface InactivityConfig 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[timeoutMinutes](./foundation-utils.inactivityconfig.timeoutminutes.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[warningMinutes](./foundation-utils.inactivityconfig.warningminutes.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-utils.inactivityconfig.timeoutminutes.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [InactivityConfig](./foundation-utils.inactivityconfig.md) &gt; [timeoutMinutes](./foundation-utils.inactivityconfig.timeoutminutes.md)
+
+## InactivityConfig.timeoutMinutes property
+
+**Signature:**
+
+```typescript
+timeoutMinutes: number;
+```

package/docs/api/foundation-utils.inactivityconfig.warningminutes.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [InactivityConfig](./foundation-utils.inactivityconfig.md) &gt; [warningMinutes](./foundation-utils.inactivityconfig.warningminutes.md)
+
+## InactivityConfig.warningMinutes property
+
+**Signature:**
+
+```typescript
+warningMinutes: number;
+```

package/docs/api/foundation-utils.inactivitydialog.disconnectedcallback.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [InactivityDialog](./foundation-utils.inactivitydialog.md) &gt; [disconnectedCallback](./foundation-utils.inactivitydialog.disconnectedcallback.md)
+
+## InactivityDialog.disconnectedCallback() method
+
+**Signature:**
+
+```typescript
+disconnectedCallback(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/foundation-utils.inactivitydialog.hide.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [InactivityDialog](./foundation-utils.inactivitydialog.md) &gt; [hide](./foundation-utils.inactivitydialog.hide.md)
+
+## InactivityDialog.hide() method
+
+**Signature:**
+
+```typescript
+hide(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/foundation-utils.inactivitydialog.isvisible.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [InactivityDialog](./foundation-utils.inactivitydialog.md) &gt; [isVisible](./foundation-utils.inactivitydialog.isvisible.md)
+
+## InactivityDialog.isVisible property
+
+**Signature:**
+
+```typescript
+isVisible: boolean;
+```

package/docs/api/foundation-utils.inactivitydialog.md

@@ -0,0 +1,128 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [InactivityDialog](./foundation-utils.inactivitydialog.md)
+
+## InactivityDialog class
+
+**Signature:**
+
+```typescript
+export declare class InactivityDialog extends GenesisElement 
+```
+**Extends:** GenesisElement
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[isVisible](./foundation-utils.inactivitydialog.isvisible.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[remainingSeconds](./foundation-utils.inactivitydialog.remainingseconds.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[disconnectedCallback()](./foundation-utils.inactivitydialog.disconnectedcallback.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[hide()](./foundation-utils.inactivitydialog.hide.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[show(options)](./foundation-utils.inactivitydialog.show.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-utils.inactivitydialog.remainingseconds.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [InactivityDialog](./foundation-utils.inactivitydialog.md) &gt; [remainingSeconds](./foundation-utils.inactivitydialog.remainingseconds.md)
+
+## InactivityDialog.remainingSeconds property
+
+**Signature:**
+
+```typescript
+remainingSeconds: number;
+```

package/docs/api/foundation-utils.inactivitydialog.show.md

@@ -0,0 +1,50 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [InactivityDialog](./foundation-utils.inactivitydialog.md) &gt; [show](./foundation-utils.inactivitydialog.show.md)
+
+## InactivityDialog.show() method
+
+**Signature:**
+
+```typescript
+show(options: InactivityDialogOptions): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+options
+
+
+</td><td>
+
+[InactivityDialogOptions](./foundation-utils.inactivitydialogoptions.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+

package/docs/api/foundation-utils.inactivitydialogoptions.md

@@ -0,0 +1,88 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [InactivityDialogOptions](./foundation-utils.inactivitydialogoptions.md)
+
+## InactivityDialogOptions interface
+
+**Signature:**
+
+```typescript
+export interface InactivityDialogOptions 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[onContinue](./foundation-utils.inactivitydialogoptions.oncontinue.md)
+
+
+</td><td>
+
+
+</td><td>
+
+() =&gt; void
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[onLogout](./foundation-utils.inactivitydialogoptions.onlogout.md)
+
+
+</td><td>
+
+
+</td><td>
+
+() =&gt; void
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[remainingSeconds](./foundation-utils.inactivitydialogoptions.remainingseconds.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-utils.inactivitydialogoptions.oncontinue.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [InactivityDialogOptions](./foundation-utils.inactivitydialogoptions.md) &gt; [onContinue](./foundation-utils.inactivitydialogoptions.oncontinue.md)
+
+## InactivityDialogOptions.onContinue property
+
+**Signature:**
+
+```typescript
+onContinue: () => void;
+```

package/docs/api/foundation-utils.inactivitydialogoptions.onlogout.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [InactivityDialogOptions](./foundation-utils.inactivitydialogoptions.md) &gt; [onLogout](./foundation-utils.inactivitydialogoptions.onlogout.md)
+
+## InactivityDialogOptions.onLogout property
+
+**Signature:**
+
+```typescript
+onLogout: () => void;
+```

package/docs/api/foundation-utils.inactivitydialogoptions.remainingseconds.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [InactivityDialogOptions](./foundation-utils.inactivitydialogoptions.md) &gt; [remainingSeconds](./foundation-utils.inactivitydialogoptions.remainingseconds.md)
+
+## InactivityDialogOptions.remainingSeconds property
+
+**Signature:**
+
+```typescript
+remainingSeconds: number;
+```

package/docs/api/foundation-utils.inactivityevents._inactivity-reset_.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [InactivityEvents](./foundation-utils.inactivityevents.md) &gt; ["inactivity-reset"](./foundation-utils.inactivityevents._inactivity-reset_.md)
+
+## InactivityEvents."inactivity-reset" property
+
+**Signature:**
+
+```typescript
+'inactivity-reset': void;
+```

package/docs/api/foundation-utils.inactivityevents._inactivity-timeout_.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [InactivityEvents](./foundation-utils.inactivityevents.md) &gt; ["inactivity-timeout"](./foundation-utils.inactivityevents._inactivity-timeout_.md)
+
+## InactivityEvents."inactivity-timeout" property
+
+**Signature:**
+
+```typescript
+'inactivity-timeout': void;
+```

package/docs/api/foundation-utils.inactivityevents._inactivity-warning_.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [InactivityEvents](./foundation-utils.inactivityevents.md) &gt; ["inactivity-warning"](./foundation-utils.inactivityevents._inactivity-warning_.md)
+
+## InactivityEvents."inactivity-warning" property
+
+**Signature:**
+
+```typescript
+'inactivity-warning': {
+        remainingSeconds: number;
+    };
+```

package/docs/api/foundation-utils.inactivityevents.md

@@ -0,0 +1,88 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [InactivityEvents](./foundation-utils.inactivityevents.md)
+
+## InactivityEvents interface
+
+**Signature:**
+
+```typescript
+export interface InactivityEvents 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+["inactivity-reset"](./foundation-utils.inactivityevents._inactivity-reset_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+void
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+["inactivity-timeout"](./foundation-utils.inactivityevents._inactivity-timeout_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+void
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+["inactivity-warning"](./foundation-utils.inactivityevents._inactivity-warning_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ remainingSeconds: number; }
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+