@genesislcap/foundation-utils 14.310.2-alpha-956f0b8.0 → 14.310.2-alpha-64966a4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/custom-elements.json +696 -78
- package/dist/dts/inactivity/inactivity-dialog.d.ts +23 -0
- package/dist/dts/inactivity/inactivity-dialog.d.ts.map +1 -0
- package/dist/dts/inactivity/inactivity-manager.d.ts +24 -0
- package/dist/dts/inactivity/inactivity-manager.d.ts.map +1 -0
- package/dist/dts/inactivity/inactivity-service.d.ts +34 -0
- package/dist/dts/inactivity/inactivity-service.d.ts.map +1 -0
- package/dist/dts/inactivity/index.d.ts +4 -0
- package/dist/dts/inactivity/index.d.ts.map +1 -0
- package/dist/dts/index.d.ts +1 -0
- package/dist/dts/index.d.ts.map +1 -1
- package/dist/esm/inactivity/inactivity-dialog.js +209 -0
- package/dist/esm/inactivity/inactivity-manager.js +83 -0
- package/dist/esm/inactivity/inactivity-service.js +128 -0
- package/dist/esm/inactivity/index.js +3 -0
- package/dist/esm/index.js +1 -0
- package/dist/foundation-utils.api.json +1155 -0
- package/dist/foundation-utils.d.ts +84 -0
- package/docs/api/foundation-utils.inactivityconfig.md +71 -0
- package/docs/api/foundation-utils.inactivityconfig.timeoutminutes.md +11 -0
- package/docs/api/foundation-utils.inactivityconfig.warningminutes.md +11 -0
- package/docs/api/foundation-utils.inactivitydialog.disconnectedcallback.md +15 -0
- package/docs/api/foundation-utils.inactivitydialog.hide.md +15 -0
- package/docs/api/foundation-utils.inactivitydialog.isvisible.md +11 -0
- package/docs/api/foundation-utils.inactivitydialog.md +128 -0
- package/docs/api/foundation-utils.inactivitydialog.remainingseconds.md +11 -0
- package/docs/api/foundation-utils.inactivitydialog.show.md +50 -0
- package/docs/api/foundation-utils.inactivitydialogoptions.md +88 -0
- package/docs/api/foundation-utils.inactivitydialogoptions.oncontinue.md +11 -0
- package/docs/api/foundation-utils.inactivitydialogoptions.onlogout.md +11 -0
- package/docs/api/foundation-utils.inactivitydialogoptions.remainingseconds.md +11 -0
- package/docs/api/foundation-utils.inactivityevents._inactivity-reset_.md +11 -0
- package/docs/api/foundation-utils.inactivityevents._inactivity-timeout_.md +11 -0
- package/docs/api/foundation-utils.inactivityevents._inactivity-warning_.md +13 -0
- package/docs/api/foundation-utils.inactivityevents.md +88 -0
- package/docs/api/foundation-utils.inactivitymanager._constructor_.md +48 -0
- package/docs/api/foundation-utils.inactivitymanager.destroy.md +15 -0
- package/docs/api/foundation-utils.inactivitymanager.getservice.md +15 -0
- package/docs/api/foundation-utils.inactivitymanager.iswarningvisible.md +15 -0
- package/docs/api/foundation-utils.inactivitymanager.md +138 -0
- package/docs/api/foundation-utils.inactivitymanager.reset.md +15 -0
- package/docs/api/foundation-utils.inactivitymanager.start.md +15 -0
- package/docs/api/foundation-utils.inactivitymanager.stop.md +15 -0
- package/docs/api/foundation-utils.inactivitymanagerconfig.md +55 -0
- package/docs/api/foundation-utils.inactivitymanagerconfig.onlogout.md +11 -0
- package/docs/api/foundation-utils.inactivityservice._constructor_.md +48 -0
- package/docs/api/foundation-utils.inactivityservice.destroy.md +15 -0
- package/docs/api/foundation-utils.inactivityservice.md +138 -0
- package/docs/api/foundation-utils.inactivityservice.off.md +64 -0
- package/docs/api/foundation-utils.inactivityservice.on.md +64 -0
- package/docs/api/foundation-utils.inactivityservice.resettimer.md +15 -0
- package/docs/api/foundation-utils.inactivityservice.start.md +15 -0
- package/docs/api/foundation-utils.inactivityservice.stop.md +15 -0
- package/docs/api/foundation-utils.md +63 -0
- package/docs/api-report.md.api.md +87 -0
- package/package.json +12 -11
@@ -0,0 +1,15 @@
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
+
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [InactivityService](./foundation-utils.inactivityservice.md) > [start](./foundation-utils.inactivityservice.start.md)
|
4
|
+
|
5
|
+
## InactivityService.start() method
|
6
|
+
|
7
|
+
**Signature:**
|
8
|
+
|
9
|
+
```typescript
|
10
|
+
start(): void;
|
11
|
+
```
|
12
|
+
**Returns:**
|
13
|
+
|
14
|
+
void
|
15
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
+
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [InactivityService](./foundation-utils.inactivityservice.md) > [stop](./foundation-utils.inactivityservice.stop.md)
|
4
|
+
|
5
|
+
## InactivityService.stop() method
|
6
|
+
|
7
|
+
**Signature:**
|
8
|
+
|
9
|
+
```typescript
|
10
|
+
stop(): void;
|
11
|
+
```
|
12
|
+
**Returns:**
|
13
|
+
|
14
|
+
void
|
15
|
+
|
@@ -37,6 +37,33 @@ Description
|
|
37
37
|
The default `ServerRowDTOMapper`<!-- -->.
|
38
38
|
|
39
39
|
|
40
|
+
</td></tr>
|
41
|
+
<tr><td>
|
42
|
+
|
43
|
+
[InactivityDialog](./foundation-utils.inactivitydialog.md)
|
44
|
+
|
45
|
+
|
46
|
+
</td><td>
|
47
|
+
|
48
|
+
|
49
|
+
</td></tr>
|
50
|
+
<tr><td>
|
51
|
+
|
52
|
+
[InactivityManager](./foundation-utils.inactivitymanager.md)
|
53
|
+
|
54
|
+
|
55
|
+
</td><td>
|
56
|
+
|
57
|
+
|
58
|
+
</td></tr>
|
59
|
+
<tr><td>
|
60
|
+
|
61
|
+
[InactivityService](./foundation-utils.inactivityservice.md)
|
62
|
+
|
63
|
+
|
64
|
+
</td><td>
|
65
|
+
|
66
|
+
|
40
67
|
</td></tr>
|
41
68
|
<tr><td>
|
42
69
|
|
@@ -651,6 +678,42 @@ DesignSystemModule.
|
|
651
678
|
|
652
679
|
|
653
680
|
|
681
|
+
</td></tr>
|
682
|
+
<tr><td>
|
683
|
+
|
684
|
+
[InactivityConfig](./foundation-utils.inactivityconfig.md)
|
685
|
+
|
686
|
+
|
687
|
+
</td><td>
|
688
|
+
|
689
|
+
|
690
|
+
</td></tr>
|
691
|
+
<tr><td>
|
692
|
+
|
693
|
+
[InactivityDialogOptions](./foundation-utils.inactivitydialogoptions.md)
|
694
|
+
|
695
|
+
|
696
|
+
</td><td>
|
697
|
+
|
698
|
+
|
699
|
+
</td></tr>
|
700
|
+
<tr><td>
|
701
|
+
|
702
|
+
[InactivityEvents](./foundation-utils.inactivityevents.md)
|
703
|
+
|
704
|
+
|
705
|
+
</td><td>
|
706
|
+
|
707
|
+
|
708
|
+
</td></tr>
|
709
|
+
<tr><td>
|
710
|
+
|
711
|
+
[InactivityManagerConfig](./foundation-utils.inactivitymanagerconfig.md)
|
712
|
+
|
713
|
+
|
714
|
+
</td><td>
|
715
|
+
|
716
|
+
|
654
717
|
</td></tr>
|
655
718
|
<tr><td>
|
656
719
|
|
@@ -13,6 +13,7 @@ import { CSSDesignToken } from '@microsoft/fast-foundation';
|
|
13
13
|
import { DesignSystem } from '@microsoft/fast-foundation';
|
14
14
|
import { ElementStyles } from '@microsoft/fast-element';
|
15
15
|
import { FASTElement } from '@microsoft/fast-element';
|
16
|
+
import { GenesisElement } from '@genesislcap/web-core';
|
16
17
|
import { InterfaceSymbol } from '@microsoft/fast-foundation';
|
17
18
|
import type { JSONSchema7 } from 'json-schema';
|
18
19
|
import { Logger as Logger_2 } from '@genesislcap/foundation-logger';
|
@@ -330,6 +331,92 @@ export function getNumberFormatter(format: string, locale?: string | null): (par
|
|
330
331
|
// @public
|
331
332
|
export let HTTP_CONFIG: string;
|
332
333
|
|
334
|
+
// @public (undocumented)
|
335
|
+
export interface InactivityConfig {
|
336
|
+
// (undocumented)
|
337
|
+
timeoutMinutes: number;
|
338
|
+
// (undocumented)
|
339
|
+
warningMinutes: number;
|
340
|
+
}
|
341
|
+
|
342
|
+
// @public (undocumented)
|
343
|
+
export class InactivityDialog extends GenesisElement {
|
344
|
+
// (undocumented)
|
345
|
+
disconnectedCallback(): void;
|
346
|
+
// (undocumented)
|
347
|
+
hide(): void;
|
348
|
+
// (undocumented)
|
349
|
+
isVisible: boolean;
|
350
|
+
// (undocumented)
|
351
|
+
remainingSeconds: number;
|
352
|
+
// (undocumented)
|
353
|
+
show(options: InactivityDialogOptions): void;
|
354
|
+
}
|
355
|
+
|
356
|
+
// @public (undocumented)
|
357
|
+
export interface InactivityDialogOptions {
|
358
|
+
// (undocumented)
|
359
|
+
onContinue: () => void;
|
360
|
+
// (undocumented)
|
361
|
+
onLogout: () => void;
|
362
|
+
// (undocumented)
|
363
|
+
remainingSeconds: number;
|
364
|
+
}
|
365
|
+
|
366
|
+
// @public (undocumented)
|
367
|
+
export interface InactivityEvents {
|
368
|
+
// (undocumented)
|
369
|
+
'inactivity-reset': void;
|
370
|
+
// (undocumented)
|
371
|
+
'inactivity-timeout': void;
|
372
|
+
// (undocumented)
|
373
|
+
'inactivity-warning': {
|
374
|
+
remainingSeconds: number;
|
375
|
+
};
|
376
|
+
}
|
377
|
+
|
378
|
+
// @public (undocumented)
|
379
|
+
export class InactivityManager {
|
380
|
+
constructor(config: InactivityManagerConfig);
|
381
|
+
// (undocumented)
|
382
|
+
destroy(): void;
|
383
|
+
// (undocumented)
|
384
|
+
getService(): InactivityService;
|
385
|
+
// (undocumented)
|
386
|
+
isWarningVisible(): boolean;
|
387
|
+
// (undocumented)
|
388
|
+
reset(): void;
|
389
|
+
// (undocumented)
|
390
|
+
start(): void;
|
391
|
+
// (undocumented)
|
392
|
+
stop(): void;
|
393
|
+
}
|
394
|
+
|
395
|
+
// @public (undocumented)
|
396
|
+
export interface InactivityManagerConfig extends InactivityConfig {
|
397
|
+
// (undocumented)
|
398
|
+
onLogout: () => void;
|
399
|
+
}
|
400
|
+
|
401
|
+
// @public (undocumented)
|
402
|
+
export class InactivityService {
|
403
|
+
constructor(config: InactivityConfig);
|
404
|
+
// (undocumented)
|
405
|
+
destroy(): void;
|
406
|
+
// (undocumented)
|
407
|
+
off<K extends keyof InactivityEvents>(event: K, listener: EventListener_2<InactivityEvents[K]>): void;
|
408
|
+
// Warning: (ae-forgotten-export) The symbol "EventListener_2" needs to be exported by the entry point index.d.ts
|
409
|
+
//
|
410
|
+
// (undocumented)
|
411
|
+
on<K extends keyof InactivityEvents>(event: K, listener: EventListener_2<InactivityEvents[K]>): void;
|
412
|
+
// (undocumented)
|
413
|
+
resetTimer(): void;
|
414
|
+
// (undocumented)
|
415
|
+
start(): void;
|
416
|
+
// (undocumented)
|
417
|
+
stop(): void;
|
418
|
+
}
|
419
|
+
|
333
420
|
// @public
|
334
421
|
export const inIFrame: () => boolean;
|
335
422
|
|
package/package.json
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
{
|
2
2
|
"name": "@genesislcap/foundation-utils",
|
3
3
|
"description": "Genesis Foundation Utils",
|
4
|
-
"version": "14.310.2-alpha-
|
4
|
+
"version": "14.310.2-alpha-64966a4.0",
|
5
5
|
"sideEffects": false,
|
6
6
|
"license": "SEE LICENSE IN license.txt",
|
7
7
|
"main": "dist/esm/index.js",
|
@@ -27,18 +27,19 @@
|
|
27
27
|
}
|
28
28
|
},
|
29
29
|
"devDependencies": {
|
30
|
-
"@genesislcap/foundation-testing": "14.310.2-alpha-
|
31
|
-
"@genesislcap/genx": "14.310.2-alpha-
|
32
|
-
"@genesislcap/rollup-builder": "14.310.2-alpha-
|
33
|
-
"@genesislcap/ts-builder": "14.310.2-alpha-
|
34
|
-
"@genesislcap/uvu-playwright-builder": "14.310.2-alpha-
|
35
|
-
"@genesislcap/vite-builder": "14.310.2-alpha-
|
36
|
-
"@genesislcap/webpack-builder": "14.310.2-alpha-
|
30
|
+
"@genesislcap/foundation-testing": "14.310.2-alpha-64966a4.0",
|
31
|
+
"@genesislcap/genx": "14.310.2-alpha-64966a4.0",
|
32
|
+
"@genesislcap/rollup-builder": "14.310.2-alpha-64966a4.0",
|
33
|
+
"@genesislcap/ts-builder": "14.310.2-alpha-64966a4.0",
|
34
|
+
"@genesislcap/uvu-playwright-builder": "14.310.2-alpha-64966a4.0",
|
35
|
+
"@genesislcap/vite-builder": "14.310.2-alpha-64966a4.0",
|
36
|
+
"@genesislcap/webpack-builder": "14.310.2-alpha-64966a4.0",
|
37
37
|
"@types/json-schema": "^7.0.11"
|
38
38
|
},
|
39
39
|
"dependencies": {
|
40
|
-
"@genesislcap/expression-builder": "14.310.2-alpha-
|
41
|
-
"@genesislcap/foundation-logger": "14.310.2-alpha-
|
40
|
+
"@genesislcap/expression-builder": "14.310.2-alpha-64966a4.0",
|
41
|
+
"@genesislcap/foundation-logger": "14.310.2-alpha-64966a4.0",
|
42
|
+
"@genesislcap/web-core": "14.310.2-alpha-64966a4.0",
|
42
43
|
"@microsoft/fast-components": "2.30.6",
|
43
44
|
"@microsoft/fast-element": "1.14.0",
|
44
45
|
"@microsoft/fast-foundation": "2.49.6",
|
@@ -55,5 +56,5 @@
|
|
55
56
|
"access": "public"
|
56
57
|
},
|
57
58
|
"customElements": "dist/custom-elements.json",
|
58
|
-
"gitHead": "
|
59
|
+
"gitHead": "0b4ac0e7e669a9dda296582caf23fd624b7faab0"
|
59
60
|
}
|