@genesislcap/foundation-utils 14.320.0 → 14.320.1-alpha-9a9ec86.0

package/docs/api/foundation-utils.inactivityservice.on.md

@@ -0,0 +1,64 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [InactivityService](./foundation-utils.inactivityservice.md) &gt; [on](./foundation-utils.inactivityservice.on.md)
+
+## InactivityService.on() method
+
+**Signature:**
+
+```typescript
+on<K extends keyof InactivityEvents>(event: K, listener: EventListener<InactivityEvents[K]>): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+event
+
+
+</td><td>
+
+K
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+listener
+
+
+</td><td>
+
+EventListener&lt;[InactivityEvents](./foundation-utils.inactivityevents.md)<!-- -->\[K\]&gt;
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+

package/docs/api/foundation-utils.inactivityservice.resettimer.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; [InactivityService](./foundation-utils.inactivityservice.md) &gt; [resetTimer](./foundation-utils.inactivityservice.resettimer.md)
+
+## InactivityService.resetTimer() method
+
+**Signature:**
+
+```typescript
+resetTimer(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/foundation-utils.inactivityservice.start.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; [InactivityService](./foundation-utils.inactivityservice.md) &gt; [start](./foundation-utils.inactivityservice.start.md)
+
+## InactivityService.start() method
+
+**Signature:**
+
+```typescript
+start(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/foundation-utils.inactivityservice.stop.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; [InactivityService](./foundation-utils.inactivityservice.md) &gt; [stop](./foundation-utils.inactivityservice.stop.md)
+
+## InactivityService.stop() method
+
+**Signature:**
+
+```typescript
+stop(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/foundation-utils.md

@@ -59,6 +59,33 @@ Default implementation of the ShortcutManager interface
 A custom element that listens for keyboard shortcuts.
 
 
+</td></tr>
+<tr><td>
+
+[InactivityDialog](./foundation-utils.inactivitydialog.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[InactivityManager](./foundation-utils.inactivitymanager.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[InactivityService](./foundation-utils.inactivityservice.md)
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 
@@ -673,6 +700,42 @@ DesignSystemModule.
 
 
 
+</td></tr>
+<tr><td>
+
+[InactivityConfig](./foundation-utils.inactivityconfig.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[InactivityDialogOptions](./foundation-utils.inactivitydialogoptions.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[InactivityEvents](./foundation-utils.inactivityevents.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[InactivityManagerConfig](./foundation-utils.inactivitymanagerconfig.md)
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 

package/docs/api-report.md.api.md

@@ -389,6 +389,96 @@ export function getNumberFormatter(format: string, locale?: string | null): (par
 // @public
 export let HTTP_CONFIG: string;
 
+// @public (undocumented)
+export interface InactivityConfig {
+    // (undocumented)
+    timeoutMinutes: number;
+    // (undocumented)
+    warningMinutes: number;
+}
+
+// @public (undocumented)
+export class InactivityDialog extends FASTElement {
+    // (undocumented)
+    disconnectedCallback(): void;
+    // (undocumented)
+    handleContinue(): void;
+    // (undocumented)
+    handleLogout(): void;
+    // (undocumented)
+    hide(): void;
+    // (undocumented)
+    isVisible: boolean;
+    // (undocumented)
+    remainingSeconds: number;
+    // (undocumented)
+    show(options: InactivityDialogOptions): void;
+}
+
+// @public (undocumented)
+export interface InactivityDialogOptions {
+    // (undocumented)
+    onContinue: () => void;
+    // (undocumented)
+    onLogout: () => void;
+    // (undocumented)
+    remainingSeconds: number;
+}
+
+// @public (undocumented)
+export interface InactivityEvents {
+    // (undocumented)
+    'inactivity-reset': void;
+    // (undocumented)
+    'inactivity-timeout': void;
+    // (undocumented)
+    'inactivity-warning': {
+        remainingSeconds: number;
+    };
+}
+
+// @public (undocumented)
+export class InactivityManager {
+    constructor(config: InactivityManagerConfig);
+    // (undocumented)
+    destroy(): void;
+    // (undocumented)
+    getService(): InactivityService;
+    // (undocumented)
+    isWarningVisible(): boolean;
+    // (undocumented)
+    reset(): void;
+    // (undocumented)
+    start(): void;
+    // (undocumented)
+    stop(): void;
+}
+
+// @public (undocumented)
+export interface InactivityManagerConfig extends InactivityConfig {
+    // (undocumented)
+    onLogout: () => void;
+}
+
+// @public (undocumented)
+export class InactivityService {
+    constructor(config: InactivityConfig);
+    // (undocumented)
+    destroy(): void;
+    // (undocumented)
+    off<K extends keyof InactivityEvents>(event: K, listener: EventListener_2<InactivityEvents[K]>): void;
+    // Warning: (ae-forgotten-export) The symbol "EventListener_2" needs to be exported by the entry point index.d.ts
+    //
+    // (undocumented)
+    on<K extends keyof InactivityEvents>(event: K, listener: EventListener_2<InactivityEvents[K]>): void;
+    // (undocumented)
+    resetTimer(): void;
+    // (undocumented)
+    start(): void;
+    // (undocumented)
+    stop(): void;
+}
+
 // @public
 export const inIFrame: () => boolean;
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-utils",
   "description": "Genesis Foundation Utils",
-  "version": "14.320.0",
+  "version": "14.320.1-alpha-9a9ec86.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -27,18 +27,18 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.320.0",
-    "@genesislcap/genx": "14.320.0",
-    "@genesislcap/rollup-builder": "14.320.0",
-    "@genesislcap/ts-builder": "14.320.0",
-    "@genesislcap/uvu-playwright-builder": "14.320.0",
-    "@genesislcap/vite-builder": "14.320.0",
-    "@genesislcap/webpack-builder": "14.320.0",
+    "@genesislcap/foundation-testing": "14.320.1-alpha-9a9ec86.0",
+    "@genesislcap/genx": "14.320.1-alpha-9a9ec86.0",
+    "@genesislcap/rollup-builder": "14.320.1-alpha-9a9ec86.0",
+    "@genesislcap/ts-builder": "14.320.1-alpha-9a9ec86.0",
+    "@genesislcap/uvu-playwright-builder": "14.320.1-alpha-9a9ec86.0",
+    "@genesislcap/vite-builder": "14.320.1-alpha-9a9ec86.0",
+    "@genesislcap/webpack-builder": "14.320.1-alpha-9a9ec86.0",
     "@types/json-schema": "^7.0.11"
   },
   "dependencies": {
-    "@genesislcap/expression-builder": "14.320.0",
-    "@genesislcap/foundation-logger": "14.320.0",
+    "@genesislcap/expression-builder": "14.320.1-alpha-9a9ec86.0",
+    "@genesislcap/foundation-logger": "14.320.1-alpha-9a9ec86.0",
     "@microsoft/fast-components": "2.30.6",
     "@microsoft/fast-element": "1.14.0",
     "@microsoft/fast-foundation": "2.49.6",
@@ -56,5 +56,5 @@
     "access": "public"
   },
   "customElements": "dist/custom-elements.json",
-  "gitHead": "957aa7b2e81fa3c2915d5154be42c0500790127f"
+  "gitHead": "5efbc8d6545051c94d93ac60563fd36efcc96972"
 }