@genesislcap/foundation-header 14.103.0-auth-mf.23 → 14.103.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 +9 -19
- package/dist/dts/main/main.d.ts +28 -7
- package/dist/dts/main/main.d.ts.map +1 -1
- package/dist/esm/main/main.js +25 -15
- package/dist/foundation-header.api.json +11 -68
- package/dist/foundation-header.d.ts +28 -7
- package/docs/api/foundation-header.navigation.logout.md +3 -3
- package/docs/api/foundation-header.navigation.md +1 -3
- package/docs/api/foundation-header.navigation.username.md +3 -1
- package/docs/api-report.md +2 -9
- package/package.json +8 -10
- package/docs/api/foundation-header.navigation.authrouting.md +0 -11
- package/docs/api/foundation-header.navigation.user.md +0 -11
|
@@ -167,20 +167,6 @@
|
|
|
167
167
|
"description": "Navigation micro-frontend includes navigation bar and flyout menu",
|
|
168
168
|
"name": "Navigation",
|
|
169
169
|
"members": [
|
|
170
|
-
{
|
|
171
|
-
"kind": "field",
|
|
172
|
-
"name": "authRouting",
|
|
173
|
-
"type": {
|
|
174
|
-
"text": "AuthRouting"
|
|
175
|
-
}
|
|
176
|
-
},
|
|
177
|
-
{
|
|
178
|
-
"kind": "field",
|
|
179
|
-
"name": "user",
|
|
180
|
-
"type": {
|
|
181
|
-
"text": "User"
|
|
182
|
-
}
|
|
183
|
-
},
|
|
184
170
|
{
|
|
185
171
|
"kind": "field",
|
|
186
172
|
"name": "auth",
|
|
@@ -205,16 +191,20 @@
|
|
|
205
191
|
},
|
|
206
192
|
{
|
|
207
193
|
"kind": "field",
|
|
208
|
-
"name": "
|
|
194
|
+
"name": "userName",
|
|
209
195
|
"type": {
|
|
210
|
-
"text": "
|
|
196
|
+
"text": "string"
|
|
211
197
|
},
|
|
212
|
-
"
|
|
198
|
+
"privacy": "public",
|
|
199
|
+
"description": "Username of the logged in user"
|
|
213
200
|
},
|
|
214
201
|
{
|
|
215
202
|
"kind": "field",
|
|
216
|
-
"name": "
|
|
217
|
-
"
|
|
203
|
+
"name": "sideNavOpen",
|
|
204
|
+
"type": {
|
|
205
|
+
"text": "boolean"
|
|
206
|
+
},
|
|
207
|
+
"default": "false"
|
|
218
208
|
},
|
|
219
209
|
{
|
|
220
210
|
"kind": "field",
|
package/dist/dts/main/main.d.ts
CHANGED
|
@@ -1,5 +1,3 @@
|
|
|
1
|
-
import { AuthRouting } from '@genesislcap/foundation-auth/routing';
|
|
2
|
-
import { User } from '@genesislcap/foundation-auth/user';
|
|
3
1
|
import { Auth, CredentialManager } from '@genesislcap/foundation-comms';
|
|
4
2
|
/**
|
|
5
3
|
* Events dispatched by the navigation control buttons
|
|
@@ -96,7 +94,27 @@ declare const Navigation_base: abstract new (...args: any[]) => {
|
|
|
96
94
|
scrollBy(options?: ScrollToOptions): void;
|
|
97
95
|
scrollBy(x: number, y: number): void;
|
|
98
96
|
scrollIntoView(arg?: boolean | ScrollIntoViewOptions): void;
|
|
97
|
+
/**
|
|
98
|
+
* Emits the event corresponding to the luminance icon being clicked
|
|
99
|
+
*
|
|
100
|
+
* @remarks
|
|
101
|
+
*
|
|
102
|
+
* Activated when the user clicks on the moon icon on the navigation
|
|
103
|
+
* bar right hand side
|
|
104
|
+
*
|
|
105
|
+
* @internal
|
|
106
|
+
*/
|
|
99
107
|
scrollTo(options?: ScrollToOptions): void;
|
|
108
|
+
/**
|
|
109
|
+
* Emits the event corresponding to the luminance icon being clicked
|
|
110
|
+
*
|
|
111
|
+
* @remarks
|
|
112
|
+
*
|
|
113
|
+
* Activated when the user clicks on the moon icon on the navigation
|
|
114
|
+
* bar right hand side
|
|
115
|
+
*
|
|
116
|
+
* @internal
|
|
117
|
+
*/
|
|
100
118
|
scrollTo(x: number, y: number): void;
|
|
101
119
|
setAttribute(qualifiedName: string, value: string): void;
|
|
102
120
|
setAttributeNS(namespace: string, qualifiedName: string, value: string): void;
|
|
@@ -350,14 +368,15 @@ declare const Navigation_base: abstract new (...args: any[]) => {
|
|
|
350
368
|
*
|
|
351
369
|
*/
|
|
352
370
|
export declare class Navigation extends Navigation_base {
|
|
353
|
-
authRouting: AuthRouting;
|
|
354
|
-
user: User;
|
|
355
371
|
auth: Auth;
|
|
356
372
|
credentialManager: CredentialManager;
|
|
357
373
|
ready: boolean;
|
|
374
|
+
/**
|
|
375
|
+
* Username of the logged in user
|
|
376
|
+
*/
|
|
377
|
+
userName: string;
|
|
358
378
|
sideNavOpen: boolean;
|
|
359
379
|
connectedCallback(): Promise<void>;
|
|
360
|
-
get userName(): string;
|
|
361
380
|
/**
|
|
362
381
|
* Optional attribute which controls the icon to show on the navigation bar and flyout
|
|
363
382
|
* Control via `logo-src`
|
|
@@ -431,11 +450,13 @@ export declare class Navigation extends Navigation_base {
|
|
|
431
450
|
* Logs the user out of their session
|
|
432
451
|
*
|
|
433
452
|
* @remarks
|
|
434
|
-
*
|
|
453
|
+
*
|
|
454
|
+
* Activated when the user clicks on the logout button on the right hand side of the navigation bar. Requires
|
|
455
|
+
* the usage of the auth functionality from {@link @genesislcap/foundation-comms#Auth}.
|
|
435
456
|
*
|
|
436
457
|
* @public
|
|
437
458
|
*/
|
|
438
|
-
logout(): void
|
|
459
|
+
logout(): Promise<void>;
|
|
439
460
|
/**
|
|
440
461
|
* Changes the route of the current page
|
|
441
462
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../../src/main/main.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../../src/main/main.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,iBAAiB,EAAgB,MAAM,+BAA+B,CAAC;AAUtF;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,wBAAwB,EAAE,IAAI,CAAC;IAC/B,mBAAmB,EAAE,IAAI,CAAC;IAC1B,2BAA2B,EAAE,IAAI,CAAC;CACnC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA2MA;;;;;;;;;OASG;;IATH;;;;;;;;;OASG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA/ML;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAKa,UAAW,SAAQ,eAAmC;IAC3D,IAAI,EAAG,IAAI,CAAC;IACC,iBAAiB,EAAG,iBAAiB,CAAC;IAC7C,KAAK,EAAE,OAAO,CAAS;IAEnC;;OAEG;IACgB,QAAQ,EAAE,MAAM,CAAC;IAExB,WAAW,UAAS;IAEnB,iBAAiB;IAU9B;;;;;;;OAOG;IAC8B,OAAO,EAAE,GAAG,CAAQ;IAErD;;;;;;;OAOG;IAEH,yBAAyB,EAAE,OAAO,CAAC;IAEnC;;;;;;;OAOG;IAC8D,oBAAoB,EAAE,OAAO,CAAC;IAE/F;;;;;;;OAOG;IAEH,uBAAuB,EAAE,OAAO,CAAC;IAEjC;;;;OAIG;IAEH,uBAAuB,EAAE,OAAO,CAAQ;IAExC;;;;OAIG;IAEH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACS,YAAY,EAAE,KAAK,CAAC;QAC9B,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC,CAAC;IAEH;;;;;;;;OAQG;IACG,WAAW;IAKjB,cAAc;IAId;;;;;;;;;OASG;IACU,MAAM;IAgBnB;;;;;;;;;;OAUG;IACI,UAAU,CAAC,IAAI,EAAE,MAAM;IAS9B;;;;;;;;;OASG;IACH,mBAAmB;IAInB;;;;;;;;;OASG;IACH,kBAAkB;IAIlB;;;;;;;;;OASG;IACH,aAAa;IAIb;;;;;;;;;OASG;IACH,qBAAqB;CAGtB"}
|
package/dist/esm/main/main.js
CHANGED
|
@@ -1,6 +1,4 @@
|
|
|
1
1
|
import { __awaiter, __decorate } from "tslib";
|
|
2
|
-
import { AuthRouting } from '@genesislcap/foundation-auth/routing';
|
|
3
|
-
import { User } from '@genesislcap/foundation-auth/user';
|
|
4
2
|
import { Auth, CredentialManager } from '@genesislcap/foundation-comms';
|
|
5
3
|
import { EventEmitter } from '@genesislcap/foundation-events';
|
|
6
4
|
import { FASTElement, customElement, observable, attr } from '@microsoft/fast-element';
|
|
@@ -63,12 +61,11 @@ let Navigation = class Navigation extends EventEmitter(FASTElement) {
|
|
|
63
61
|
_super.connectedCallback.call(this);
|
|
64
62
|
logger.debug(`foundation-header is now connected to the DOM`);
|
|
65
63
|
yield this.loadRemotes();
|
|
64
|
+
this.userName = this.auth.loggedUserResult
|
|
65
|
+
? this.auth.loggedUserResult.username
|
|
66
|
+
: 'Genesis User';
|
|
66
67
|
});
|
|
67
68
|
}
|
|
68
|
-
get userName() {
|
|
69
|
-
var _a;
|
|
70
|
-
return (_a = this.user.userName) !== null && _a !== void 0 ? _a : 'Genesis User';
|
|
71
|
-
}
|
|
72
69
|
/**
|
|
73
70
|
* Load remote components
|
|
74
71
|
*
|
|
@@ -91,13 +88,29 @@ let Navigation = class Navigation extends EventEmitter(FASTElement) {
|
|
|
91
88
|
* Logs the user out of their session
|
|
92
89
|
*
|
|
93
90
|
* @remarks
|
|
94
|
-
*
|
|
91
|
+
*
|
|
92
|
+
* Activated when the user clicks on the logout button on the right hand side of the navigation bar. Requires
|
|
93
|
+
* the usage of the auth functionality from {@link @genesislcap/foundation-comms#Auth}.
|
|
95
94
|
*
|
|
96
95
|
* @public
|
|
97
96
|
*/
|
|
98
97
|
logout() {
|
|
99
|
-
|
|
100
|
-
|
|
98
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
99
|
+
logger.debug('logout submission');
|
|
100
|
+
try {
|
|
101
|
+
const result = yield this.auth.logout();
|
|
102
|
+
if (!result.success) {
|
|
103
|
+
logger.error(`Couldn't log out`, result);
|
|
104
|
+
return;
|
|
105
|
+
}
|
|
106
|
+
logger.debug('logged out', result);
|
|
107
|
+
yield this.credentialManager.preventSilentAccess();
|
|
108
|
+
this.navigateTo('/');
|
|
109
|
+
}
|
|
110
|
+
catch (err) {
|
|
111
|
+
logger.error(`Error: ${err.message}`);
|
|
112
|
+
}
|
|
113
|
+
});
|
|
101
114
|
}
|
|
102
115
|
/**
|
|
103
116
|
* Changes the route of the current page
|
|
@@ -172,12 +185,6 @@ let Navigation = class Navigation extends EventEmitter(FASTElement) {
|
|
|
172
185
|
this.$emit('notification-icon-clicked');
|
|
173
186
|
}
|
|
174
187
|
};
|
|
175
|
-
__decorate([
|
|
176
|
-
AuthRouting
|
|
177
|
-
], Navigation.prototype, "authRouting", void 0);
|
|
178
|
-
__decorate([
|
|
179
|
-
User
|
|
180
|
-
], Navigation.prototype, "user", void 0);
|
|
181
188
|
__decorate([
|
|
182
189
|
Auth
|
|
183
190
|
], Navigation.prototype, "auth", void 0);
|
|
@@ -187,6 +194,9 @@ __decorate([
|
|
|
187
194
|
__decorate([
|
|
188
195
|
observable
|
|
189
196
|
], Navigation.prototype, "ready", void 0);
|
|
197
|
+
__decorate([
|
|
198
|
+
observable
|
|
199
|
+
], Navigation.prototype, "userName", void 0);
|
|
190
200
|
__decorate([
|
|
191
201
|
observable
|
|
192
202
|
], Navigation.prototype, "sideNavOpen", void 0);
|
|
@@ -294,37 +294,6 @@
|
|
|
294
294
|
"isProtected": false,
|
|
295
295
|
"isAbstract": false
|
|
296
296
|
},
|
|
297
|
-
{
|
|
298
|
-
"kind": "Property",
|
|
299
|
-
"canonicalReference": "@genesislcap/foundation-header!Navigation#authRouting:member",
|
|
300
|
-
"docComment": "",
|
|
301
|
-
"excerptTokens": [
|
|
302
|
-
{
|
|
303
|
-
"kind": "Content",
|
|
304
|
-
"text": "authRouting: "
|
|
305
|
-
},
|
|
306
|
-
{
|
|
307
|
-
"kind": "Reference",
|
|
308
|
-
"text": "AuthRouting",
|
|
309
|
-
"canonicalReference": "@genesislcap/foundation-auth!AuthRouting:interface"
|
|
310
|
-
},
|
|
311
|
-
{
|
|
312
|
-
"kind": "Content",
|
|
313
|
-
"text": ";"
|
|
314
|
-
}
|
|
315
|
-
],
|
|
316
|
-
"isReadonly": false,
|
|
317
|
-
"isOptional": false,
|
|
318
|
-
"releaseTag": "Public",
|
|
319
|
-
"name": "authRouting",
|
|
320
|
-
"propertyTypeTokenRange": {
|
|
321
|
-
"startIndex": 1,
|
|
322
|
-
"endIndex": 2
|
|
323
|
-
},
|
|
324
|
-
"isStatic": false,
|
|
325
|
-
"isProtected": false,
|
|
326
|
-
"isAbstract": false
|
|
327
|
-
},
|
|
328
297
|
{
|
|
329
298
|
"kind": "Method",
|
|
330
299
|
"canonicalReference": "@genesislcap/foundation-header!Navigation#connectedCallback:member(1)",
|
|
@@ -455,15 +424,20 @@
|
|
|
455
424
|
{
|
|
456
425
|
"kind": "Method",
|
|
457
426
|
"canonicalReference": "@genesislcap/foundation-header!Navigation#logout:member(1)",
|
|
458
|
-
"docComment": "/**\n * Logs the user out of their session\n *\n * @remarks\n *\n * Activated when the user clicks on the logout button on the right hand side of the navigation bar.\n *\n * @public\n */\n",
|
|
427
|
+
"docComment": "/**\n * Logs the user out of their session\n *\n * @remarks\n *\n * Activated when the user clicks on the logout button on the right hand side of the navigation bar. Requires the usage of the auth functionality from {@link @genesislcap/foundation-comms#Auth}.\n *\n * @public\n */\n",
|
|
459
428
|
"excerptTokens": [
|
|
460
429
|
{
|
|
461
430
|
"kind": "Content",
|
|
462
431
|
"text": "logout(): "
|
|
463
432
|
},
|
|
433
|
+
{
|
|
434
|
+
"kind": "Reference",
|
|
435
|
+
"text": "Promise",
|
|
436
|
+
"canonicalReference": "!Promise:interface"
|
|
437
|
+
},
|
|
464
438
|
{
|
|
465
439
|
"kind": "Content",
|
|
466
|
-
"text": "void"
|
|
440
|
+
"text": "<void>"
|
|
467
441
|
},
|
|
468
442
|
{
|
|
469
443
|
"kind": "Content",
|
|
@@ -473,7 +447,7 @@
|
|
|
473
447
|
"isStatic": false,
|
|
474
448
|
"returnTypeTokenRange": {
|
|
475
449
|
"startIndex": 1,
|
|
476
|
-
"endIndex":
|
|
450
|
+
"endIndex": 3
|
|
477
451
|
},
|
|
478
452
|
"releaseTag": "Public",
|
|
479
453
|
"isProtected": false,
|
|
@@ -795,45 +769,14 @@
|
|
|
795
769
|
"isProtected": false,
|
|
796
770
|
"isAbstract": false
|
|
797
771
|
},
|
|
798
|
-
{
|
|
799
|
-
"kind": "Property",
|
|
800
|
-
"canonicalReference": "@genesislcap/foundation-header!Navigation#user:member",
|
|
801
|
-
"docComment": "",
|
|
802
|
-
"excerptTokens": [
|
|
803
|
-
{
|
|
804
|
-
"kind": "Content",
|
|
805
|
-
"text": "user: "
|
|
806
|
-
},
|
|
807
|
-
{
|
|
808
|
-
"kind": "Reference",
|
|
809
|
-
"text": "User",
|
|
810
|
-
"canonicalReference": "@genesislcap/foundation-auth!User:interface"
|
|
811
|
-
},
|
|
812
|
-
{
|
|
813
|
-
"kind": "Content",
|
|
814
|
-
"text": ";"
|
|
815
|
-
}
|
|
816
|
-
],
|
|
817
|
-
"isReadonly": false,
|
|
818
|
-
"isOptional": false,
|
|
819
|
-
"releaseTag": "Public",
|
|
820
|
-
"name": "user",
|
|
821
|
-
"propertyTypeTokenRange": {
|
|
822
|
-
"startIndex": 1,
|
|
823
|
-
"endIndex": 2
|
|
824
|
-
},
|
|
825
|
-
"isStatic": false,
|
|
826
|
-
"isProtected": false,
|
|
827
|
-
"isAbstract": false
|
|
828
|
-
},
|
|
829
772
|
{
|
|
830
773
|
"kind": "Property",
|
|
831
774
|
"canonicalReference": "@genesislcap/foundation-header!Navigation#userName:member",
|
|
832
|
-
"docComment": "",
|
|
775
|
+
"docComment": "/**\n * Username of the logged in user\n */\n",
|
|
833
776
|
"excerptTokens": [
|
|
834
777
|
{
|
|
835
778
|
"kind": "Content",
|
|
836
|
-
"text": "
|
|
779
|
+
"text": "userName: "
|
|
837
780
|
},
|
|
838
781
|
{
|
|
839
782
|
"kind": "Content",
|
|
@@ -844,7 +787,7 @@
|
|
|
844
787
|
"text": ";"
|
|
845
788
|
}
|
|
846
789
|
],
|
|
847
|
-
"isReadonly":
|
|
790
|
+
"isReadonly": false,
|
|
848
791
|
"isOptional": false,
|
|
849
792
|
"releaseTag": "Public",
|
|
850
793
|
"name": "userName",
|
|
@@ -1,11 +1,9 @@
|
|
|
1
1
|
import { Auth } from '@genesislcap/foundation-comms';
|
|
2
|
-
import { AuthRouting } from '@genesislcap/foundation-auth/routing';
|
|
3
2
|
import { Controller } from '@microsoft/fast-element';
|
|
4
3
|
import { CredentialManager } from '@genesislcap/foundation-comms';
|
|
5
4
|
import { ElementStyles } from '@microsoft/fast-element';
|
|
6
5
|
import { EmitOptions } from '@genesislcap/foundation-events';
|
|
7
6
|
import { EmitReturn } from '@genesislcap/foundation-events';
|
|
8
|
-
import { User } from '@genesislcap/foundation-auth/user';
|
|
9
7
|
import { ViewTemplate } from '@microsoft/fast-element';
|
|
10
8
|
|
|
11
9
|
/**
|
|
@@ -52,14 +50,15 @@ export declare type NavEventDetailMap = {
|
|
|
52
50
|
*
|
|
53
51
|
*/
|
|
54
52
|
export declare class Navigation extends Navigation_base {
|
|
55
|
-
authRouting: AuthRouting;
|
|
56
|
-
user: User;
|
|
57
53
|
auth: Auth;
|
|
58
54
|
credentialManager: CredentialManager;
|
|
59
55
|
ready: boolean;
|
|
56
|
+
/**
|
|
57
|
+
* Username of the logged in user
|
|
58
|
+
*/
|
|
59
|
+
userName: string;
|
|
60
60
|
sideNavOpen: boolean;
|
|
61
61
|
connectedCallback(): Promise<void>;
|
|
62
|
-
get userName(): string;
|
|
63
62
|
/**
|
|
64
63
|
* Optional attribute which controls the icon to show on the navigation bar and flyout
|
|
65
64
|
* Control via `logo-src`
|
|
@@ -133,11 +132,13 @@ export declare class Navigation extends Navigation_base {
|
|
|
133
132
|
* Logs the user out of their session
|
|
134
133
|
*
|
|
135
134
|
* @remarks
|
|
136
|
-
*
|
|
135
|
+
*
|
|
136
|
+
* Activated when the user clicks on the logout button on the right hand side of the navigation bar. Requires
|
|
137
|
+
* the usage of the auth functionality from {@link @genesislcap/foundation-comms#Auth}.
|
|
137
138
|
*
|
|
138
139
|
* @public
|
|
139
140
|
*/
|
|
140
|
-
logout(): void
|
|
141
|
+
logout(): Promise<void>;
|
|
141
142
|
/**
|
|
142
143
|
* Changes the route of the current page
|
|
143
144
|
*
|
|
@@ -282,7 +283,27 @@ declare const Navigation_base: abstract new (...args: any[]) => {
|
|
|
282
283
|
scrollBy(options?: ScrollToOptions): void;
|
|
283
284
|
scrollBy(x: number, y: number): void;
|
|
284
285
|
scrollIntoView(arg?: boolean | ScrollIntoViewOptions): void;
|
|
286
|
+
/**
|
|
287
|
+
* Emits the event corresponding to the luminance icon being clicked
|
|
288
|
+
*
|
|
289
|
+
* @remarks
|
|
290
|
+
*
|
|
291
|
+
* Activated when the user clicks on the moon icon on the navigation
|
|
292
|
+
* bar right hand side
|
|
293
|
+
*
|
|
294
|
+
* @internal
|
|
295
|
+
*/
|
|
285
296
|
scrollTo(options?: ScrollToOptions): void;
|
|
297
|
+
/**
|
|
298
|
+
* Emits the event corresponding to the luminance icon being clicked
|
|
299
|
+
*
|
|
300
|
+
* @remarks
|
|
301
|
+
*
|
|
302
|
+
* Activated when the user clicks on the moon icon on the navigation
|
|
303
|
+
* bar right hand side
|
|
304
|
+
*
|
|
305
|
+
* @internal
|
|
306
|
+
*/
|
|
286
307
|
scrollTo(x: number, y: number): void;
|
|
287
308
|
setAttribute(qualifiedName: string, value: string): void;
|
|
288
309
|
setAttributeNS(namespace: string, qualifiedName: string, value: string): void;
|
|
@@ -9,13 +9,13 @@ Logs the user out of their session
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
logout(): void
|
|
12
|
+
logout(): Promise<void>;
|
|
13
13
|
```
|
|
14
14
|
**Returns:**
|
|
15
15
|
|
|
16
|
-
void
|
|
16
|
+
Promise<void>
|
|
17
17
|
|
|
18
18
|
## Remarks
|
|
19
19
|
|
|
20
|
-
Activated when the user clicks on the logout button on the right hand side of the navigation bar.
|
|
20
|
+
Activated when the user clicks on the logout button on the right hand side of the navigation bar. Requires the usage of the auth functionality from .
|
|
21
21
|
|
|
@@ -22,7 +22,6 @@ export declare class Navigation extends Navigation_base
|
|
|
22
22
|
| Property | Modifiers | Type | Description |
|
|
23
23
|
| --- | --- | --- | --- |
|
|
24
24
|
| [auth](./foundation-header.navigation.auth.md) | | Auth | |
|
|
25
|
-
| [authRouting](./foundation-header.navigation.authrouting.md) | | AuthRouting | |
|
|
26
25
|
| [credentialManager](./foundation-header.navigation.credentialmanager.md) | | CredentialManager | |
|
|
27
26
|
| [hideSideBar](./foundation-header.navigation.hidesidebar.md) | | boolean | Boolean attribute which controls whether to include the sideNav component Control via<code>hide-side-bar</code> |
|
|
28
27
|
| [logoSrc](./foundation-header.navigation.logosrc.md) | | any | Optional attribute which controls the icon to show on the navigation bar and flyout Control via <code>logo-src</code> |
|
|
@@ -33,8 +32,7 @@ export declare class Navigation extends Navigation_base
|
|
|
33
32
|
| [showMiscToggleButton](./foundation-header.navigation.showmisctogglebutton.md) | | boolean | Boolean attribute which controls whether to show the miscellaneous (menu) icon on the navigation bar Control via <code>show-luminance-toggle-button</code> |
|
|
34
33
|
| [showNotificationsButton](./foundation-header.navigation.shownotificationsbutton.md) | | boolean | Boolean attribute which controls whether to show the notification (bell) icon on the navigation bar Control via <code>show-notification-button</code> |
|
|
35
34
|
| [sideNavOpen](./foundation-header.navigation.sidenavopen.md) | | boolean | |
|
|
36
|
-
| [
|
|
37
|
-
| [userName](./foundation-header.navigation.username.md) | <code>readonly</code> | string | |
|
|
35
|
+
| [userName](./foundation-header.navigation.username.md) | | string | Username of the logged in user |
|
|
38
36
|
|
|
39
37
|
## Methods
|
|
40
38
|
|
package/docs/api-report.md
CHANGED
|
@@ -5,13 +5,11 @@
|
|
|
5
5
|
```ts
|
|
6
6
|
|
|
7
7
|
import { Auth } from '@genesislcap/foundation-comms';
|
|
8
|
-
import { AuthRouting } from '@genesislcap/foundation-auth/routing';
|
|
9
8
|
import { Controller } from '@microsoft/fast-element';
|
|
10
9
|
import { CredentialManager } from '@genesislcap/foundation-comms';
|
|
11
10
|
import { ElementStyles } from '@microsoft/fast-element';
|
|
12
11
|
import { EmitOptions } from '@genesislcap/foundation-events';
|
|
13
12
|
import { EmitReturn } from '@genesislcap/foundation-events';
|
|
14
|
-
import { User } from '@genesislcap/foundation-auth/user';
|
|
15
13
|
import { ViewTemplate } from '@microsoft/fast-element';
|
|
16
14
|
|
|
17
15
|
// @public
|
|
@@ -31,8 +29,6 @@ export class Navigation extends Navigation_base {
|
|
|
31
29
|
// (undocumented)
|
|
32
30
|
auth: Auth;
|
|
33
31
|
// (undocumented)
|
|
34
|
-
authRouting: AuthRouting;
|
|
35
|
-
// (undocumented)
|
|
36
32
|
connectedCallback(): Promise<void>;
|
|
37
33
|
// (undocumented)
|
|
38
34
|
credentialManager: CredentialManager;
|
|
@@ -40,7 +36,7 @@ export class Navigation extends Navigation_base {
|
|
|
40
36
|
// @internal
|
|
41
37
|
loadRemotes(): Promise<void>;
|
|
42
38
|
logoSrc: any;
|
|
43
|
-
logout(): void
|
|
39
|
+
logout(): Promise<void>;
|
|
44
40
|
// @internal
|
|
45
41
|
luminanceIconEvent(): void;
|
|
46
42
|
// @internal
|
|
@@ -67,10 +63,7 @@ export class Navigation extends Navigation_base {
|
|
|
67
63
|
sideNavOpen: boolean;
|
|
68
64
|
// @internal
|
|
69
65
|
toggleNavVisibility(): void;
|
|
70
|
-
|
|
71
|
-
user: User;
|
|
72
|
-
// (undocumented)
|
|
73
|
-
get userName(): string;
|
|
66
|
+
userName: string;
|
|
74
67
|
}
|
|
75
68
|
|
|
76
69
|
// @public
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@genesislcap/foundation-header",
|
|
3
3
|
"description": "Genesis Foundation Header",
|
|
4
|
-
"version": "14.103.0
|
|
4
|
+
"version": "14.103.0",
|
|
5
5
|
"license": "SEE LICENSE IN license.txt",
|
|
6
6
|
"main": "dist/esm/index.js",
|
|
7
7
|
"types": "dist/foundation-header.d.ts",
|
|
@@ -47,7 +47,6 @@
|
|
|
47
47
|
"dev:no-open": "genx dev --no-open -b webpack",
|
|
48
48
|
"dev:webpack": "genx dev -b webpack",
|
|
49
49
|
"dev:webpack:https": "genx dev --https -b webpack",
|
|
50
|
-
"dev:tsc": "genx dev -b ts",
|
|
51
50
|
"serve": "genx serve",
|
|
52
51
|
"test": "genx test",
|
|
53
52
|
"test:coverage": "genx test --coverage",
|
|
@@ -61,16 +60,15 @@
|
|
|
61
60
|
"test:debug": "genx test --debug"
|
|
62
61
|
},
|
|
63
62
|
"devDependencies": {
|
|
64
|
-
"@genesislcap/foundation-testing": "14.103.0
|
|
65
|
-
"@genesislcap/genx": "14.103.0
|
|
63
|
+
"@genesislcap/foundation-testing": "14.103.0",
|
|
64
|
+
"@genesislcap/genx": "14.103.0",
|
|
66
65
|
"rimraf": "^3.0.2"
|
|
67
66
|
},
|
|
68
67
|
"dependencies": {
|
|
69
|
-
"@genesislcap/foundation-
|
|
70
|
-
"@genesislcap/foundation-
|
|
71
|
-
"@genesislcap/foundation-
|
|
72
|
-
"@genesislcap/foundation-
|
|
73
|
-
"@genesislcap/foundation-zero": "14.103.0-auth-mf.23",
|
|
68
|
+
"@genesislcap/foundation-comms": "14.103.0",
|
|
69
|
+
"@genesislcap/foundation-events": "14.103.0",
|
|
70
|
+
"@genesislcap/foundation-logger": "14.103.0",
|
|
71
|
+
"@genesislcap/foundation-zero": "14.103.0",
|
|
74
72
|
"@microsoft/fast-colors": "^5.1.4",
|
|
75
73
|
"@microsoft/fast-components": "^2.21.3",
|
|
76
74
|
"@microsoft/fast-element": "^1.7.0",
|
|
@@ -86,5 +84,5 @@
|
|
|
86
84
|
"access": "public"
|
|
87
85
|
},
|
|
88
86
|
"customElements": "dist/custom-elements.json",
|
|
89
|
-
"gitHead": "
|
|
87
|
+
"gitHead": "a2f0a1825fe66db9433563c30c256414762f4155"
|
|
90
88
|
}
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-header](./foundation-header.md) > [Navigation](./foundation-header.navigation.md) > [authRouting](./foundation-header.navigation.authrouting.md)
|
|
4
|
-
|
|
5
|
-
## Navigation.authRouting property
|
|
6
|
-
|
|
7
|
-
**Signature:**
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
authRouting: AuthRouting;
|
|
11
|
-
```
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-header](./foundation-header.md) > [Navigation](./foundation-header.navigation.md) > [user](./foundation-header.navigation.user.md)
|
|
4
|
-
|
|
5
|
-
## Navigation.user property
|
|
6
|
-
|
|
7
|
-
**Signature:**
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
user: User;
|
|
11
|
-
```
|