@hichchi/ngx-auth 0.0.3 → 0.0.5
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/README.md +168 -105
- package/fesm2022/hichchi-ngx-auth.mjs +38 -7
- package/fesm2022/hichchi-ngx-auth.mjs.map +1 -1
- package/package.json +5 -5
- package/types/hichchi-ngx-auth.d.ts +36 -4
package/README.md
CHANGED
|
@@ -50,7 +50,7 @@ This library provides a collection of utilities for Angular applications, includ
|
|
|
50
50
|
import { NgModule } from "@angular/core";
|
|
51
51
|
import { HTTP_INTERCEPTORS } from "@angular/common/http";
|
|
52
52
|
import {
|
|
53
|
-
|
|
53
|
+
apiInterceptor,
|
|
54
54
|
AuthInterceptor,
|
|
55
55
|
ErrorInterceptor,
|
|
56
56
|
ResponseInterceptor,
|
|
@@ -58,7 +58,7 @@ import {
|
|
|
58
58
|
|
|
59
59
|
@NgModule({
|
|
60
60
|
providers: [
|
|
61
|
-
{ provide: HTTP_INTERCEPTORS, useClass:
|
|
61
|
+
{ provide: HTTP_INTERCEPTORS, useClass: apiInterceptor, multi: true },
|
|
62
62
|
{ provide: HTTP_INTERCEPTORS, useClass: AuthInterceptor, multi: true },
|
|
63
63
|
{ provide: HTTP_INTERCEPTORS, useClass: ErrorInterceptor, multi: true },
|
|
64
64
|
{ provide: HTTP_INTERCEPTORS, useClass: ResponseInterceptor, multi: true },
|
|
@@ -213,7 +213,7 @@ Complete technical reference for all classes, interfaces, methods, and types in
|
|
|
213
213
|
|
|
214
214
|
### AuthFormComponent
|
|
215
215
|
|
|
216
|
-
Defined in: [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:97](https://github.com/hichchidev/hichchi/blob/
|
|
216
|
+
Defined in: [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:97](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L97)
|
|
217
217
|
|
|
218
218
|
#### Constructors
|
|
219
219
|
|
|
@@ -223,7 +223,7 @@ Defined in: [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:9
|
|
|
223
223
|
new AuthFormComponent(): AuthFormComponent;
|
|
224
224
|
```
|
|
225
225
|
|
|
226
|
-
Defined in: [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:146](https://github.com/hichchidev/hichchi/blob/
|
|
226
|
+
Defined in: [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:146](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L146)
|
|
227
227
|
|
|
228
228
|
###### Returns
|
|
229
229
|
|
|
@@ -237,7 +237,7 @@ Defined in: [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:1
|
|
|
237
237
|
handleError(error): void;
|
|
238
238
|
```
|
|
239
239
|
|
|
240
|
-
Defined in: [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:318](https://github.com/hichchidev/hichchi/blob/
|
|
240
|
+
Defined in: [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:318](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L318)
|
|
241
241
|
|
|
242
242
|
Handles authentication errors and updates component state
|
|
243
243
|
|
|
@@ -295,7 +295,7 @@ this.handleError(customError);
|
|
|
295
295
|
handleGoogleSignIn(): Promise<void>;
|
|
296
296
|
```
|
|
297
297
|
|
|
298
|
-
Defined in: [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:183](https://github.com/hichchidev/hichchi/blob/
|
|
298
|
+
Defined in: [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:183](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L183)
|
|
299
299
|
|
|
300
300
|
Handles Google OAuth sign-in authentication
|
|
301
301
|
|
|
@@ -322,7 +322,7 @@ await this.handleGoogleSignIn();
|
|
|
322
322
|
handleLocalAuth(signInBody): void;
|
|
323
323
|
```
|
|
324
324
|
|
|
325
|
-
Defined in: [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:213](https://github.com/hichchidev/hichchi/blob/
|
|
325
|
+
Defined in: [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:213](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L213)
|
|
326
326
|
|
|
327
327
|
Handles local authentication sign-in process
|
|
328
328
|
|
|
@@ -381,7 +381,7 @@ this.handleLocalAuth(signInData);
|
|
|
381
381
|
handleSignUp(signUpBody): void;
|
|
382
382
|
```
|
|
383
383
|
|
|
384
|
-
Defined in: [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:248](https://github.com/hichchidev/hichchi/blob/
|
|
384
|
+
Defined in: [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:248](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L248)
|
|
385
385
|
|
|
386
386
|
Handles user registration (sign-up) process
|
|
387
387
|
|
|
@@ -442,7 +442,7 @@ this.handleSignUp(signUpData);
|
|
|
442
442
|
handleSubmit(e): void;
|
|
443
443
|
```
|
|
444
444
|
|
|
445
|
-
Defined in: [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:278](https://github.com/hichchidev/hichchi/blob/
|
|
445
|
+
Defined in: [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:278](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L278)
|
|
446
446
|
|
|
447
447
|
Handles form submission for both sign-in and sign-up modes
|
|
448
448
|
|
|
@@ -524,7 +524,7 @@ Writable signal containing the current authentication field type (EMAIL or USERN
|
|
|
524
524
|
</td>
|
|
525
525
|
<td>
|
|
526
526
|
|
|
527
|
-
[libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:132](https://github.com/hichchidev/hichchi/blob/
|
|
527
|
+
[libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:132](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L132)
|
|
528
528
|
|
|
529
529
|
</td>
|
|
530
530
|
</tr>
|
|
@@ -546,7 +546,7 @@ Writable signal containing the display label for the authentication field
|
|
|
546
546
|
</td>
|
|
547
547
|
<td>
|
|
548
548
|
|
|
549
|
-
[libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:135](https://github.com/hichchidev/hichchi/blob/
|
|
549
|
+
[libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:135](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L135)
|
|
550
550
|
|
|
551
551
|
</td>
|
|
552
552
|
</tr>
|
|
@@ -568,7 +568,7 @@ Reactive form group for handling authentication form data
|
|
|
568
568
|
</td>
|
|
569
569
|
<td>
|
|
570
570
|
|
|
571
|
-
[libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:144](https://github.com/hichchidev/hichchi/blob/
|
|
571
|
+
[libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:144](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L144)
|
|
572
572
|
|
|
573
573
|
</td>
|
|
574
574
|
</tr>
|
|
@@ -590,7 +590,7 @@ Injected AuthState service for managing authentication state
|
|
|
590
590
|
</td>
|
|
591
591
|
<td>
|
|
592
592
|
|
|
593
|
-
[libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:141](https://github.com/hichchidev/hichchi/blob/
|
|
593
|
+
[libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:141](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L141)
|
|
594
594
|
|
|
595
595
|
</td>
|
|
596
596
|
</tr>
|
|
@@ -612,7 +612,7 @@ Writable signal containing the current error object, if any
|
|
|
612
612
|
</td>
|
|
613
613
|
<td>
|
|
614
614
|
|
|
615
|
-
[libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:138](https://github.com/hichchidev/hichchi/blob/
|
|
615
|
+
[libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:138](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L138)
|
|
616
616
|
|
|
617
617
|
</td>
|
|
618
618
|
</tr>
|
|
@@ -634,7 +634,7 @@ Input signal to control whether Facebook authentication is enabled
|
|
|
634
634
|
</td>
|
|
635
635
|
<td>
|
|
636
636
|
|
|
637
|
-
[libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:111](https://github.com/hichchidev/hichchi/blob/
|
|
637
|
+
[libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:111](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L111)
|
|
638
638
|
|
|
639
639
|
</td>
|
|
640
640
|
</tr>
|
|
@@ -656,7 +656,7 @@ Input signal to control whether Google OAuth authentication is enabled
|
|
|
656
656
|
</td>
|
|
657
657
|
<td>
|
|
658
658
|
|
|
659
|
-
[libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:108](https://github.com/hichchidev/hichchi/blob/
|
|
659
|
+
[libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:108](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L108)
|
|
660
660
|
|
|
661
661
|
</td>
|
|
662
662
|
</tr>
|
|
@@ -678,7 +678,7 @@ Writable signal indicating whether an error state is currently active
|
|
|
678
678
|
</td>
|
|
679
679
|
<td>
|
|
680
680
|
|
|
681
|
-
[libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:129](https://github.com/hichchidev/hichchi/blob/
|
|
681
|
+
[libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:129](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L129)
|
|
682
682
|
|
|
683
683
|
</td>
|
|
684
684
|
</tr>
|
|
@@ -700,7 +700,7 @@ Writable signal indicating whether an authentication operation is in progress
|
|
|
700
700
|
</td>
|
|
701
701
|
<td>
|
|
702
702
|
|
|
703
|
-
[libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:123](https://github.com/hichchidev/hichchi/blob/
|
|
703
|
+
[libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:123](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L123)
|
|
704
704
|
|
|
705
705
|
</td>
|
|
706
706
|
</tr>
|
|
@@ -722,7 +722,7 @@ Writable signal indicating whether the form is in sign-up mode (true) or sign-in
|
|
|
722
722
|
</td>
|
|
723
723
|
<td>
|
|
724
724
|
|
|
725
|
-
[libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:126](https://github.com/hichchidev/hichchi/blob/
|
|
725
|
+
[libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:126](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L126)
|
|
726
726
|
|
|
727
727
|
</td>
|
|
728
728
|
</tr>
|
|
@@ -744,7 +744,7 @@ Input signal to control whether local authentication (username/email + password)
|
|
|
744
744
|
</td>
|
|
745
745
|
<td>
|
|
746
746
|
|
|
747
|
-
[libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:105](https://github.com/hichchidev/hichchi/blob/
|
|
747
|
+
[libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:105](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L105)
|
|
748
748
|
|
|
749
749
|
</td>
|
|
750
750
|
</tr>
|
|
@@ -766,7 +766,7 @@ Output emitter that fires when an authentication error occurs
|
|
|
766
766
|
</td>
|
|
767
767
|
<td>
|
|
768
768
|
|
|
769
|
-
[libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:114](https://github.com/hichchidev/hichchi/blob/
|
|
769
|
+
[libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:114](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L114)
|
|
770
770
|
|
|
771
771
|
</td>
|
|
772
772
|
</tr>
|
|
@@ -788,7 +788,7 @@ Output emitter that fires when a user successfully signs in
|
|
|
788
788
|
</td>
|
|
789
789
|
<td>
|
|
790
790
|
|
|
791
|
-
[libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:117](https://github.com/hichchidev/hichchi/blob/
|
|
791
|
+
[libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:117](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L117)
|
|
792
792
|
|
|
793
793
|
</td>
|
|
794
794
|
</tr>
|
|
@@ -810,7 +810,7 @@ Output emitter that fires when a user successfully signs up
|
|
|
810
810
|
</td>
|
|
811
811
|
<td>
|
|
812
812
|
|
|
813
|
-
[libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:120](https://github.com/hichchidev/hichchi/blob/
|
|
813
|
+
[libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:120](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L120)
|
|
814
814
|
|
|
815
815
|
</td>
|
|
816
816
|
</tr>
|
|
@@ -821,7 +821,7 @@ Output emitter that fires when a user successfully signs up
|
|
|
821
821
|
|
|
822
822
|
### AuthService
|
|
823
823
|
|
|
824
|
-
Defined in: [libs/ngx-auth/src/lib/services/auth.service.ts:72](https://github.com/hichchidev/hichchi/blob/
|
|
824
|
+
Defined in: [libs/ngx-auth/src/lib/services/auth.service.ts:72](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/services/auth.service.ts#L72)
|
|
825
825
|
|
|
826
826
|
Angular authentication service for client-side authentication operations
|
|
827
827
|
|
|
@@ -885,7 +885,7 @@ export class LoginComponent {
|
|
|
885
885
|
new AuthService(config): AuthService;
|
|
886
886
|
```
|
|
887
887
|
|
|
888
|
-
Defined in: [libs/ngx-auth/src/lib/services/auth.service.ts:82](https://github.com/hichchidev/hichchi/blob/
|
|
888
|
+
Defined in: [libs/ngx-auth/src/lib/services/auth.service.ts:82](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/services/auth.service.ts#L82)
|
|
889
889
|
|
|
890
890
|
Creates an instance of AuthService
|
|
891
891
|
|
|
@@ -945,7 +945,7 @@ CrudHttpService.constructor;
|
|
|
945
945
|
delete<Res>(url, options?): Observable<Res>;
|
|
946
946
|
```
|
|
947
947
|
|
|
948
|
-
Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:
|
|
948
|
+
Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:95](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-utils/src/lib/services/crud-http.service.ts#L95)
|
|
949
949
|
|
|
950
950
|
###### Type Parameters
|
|
951
951
|
|
|
@@ -1025,7 +1025,7 @@ CrudHttpService.delete;
|
|
|
1025
1025
|
delete<Res>(url, options?): Promise<Res>;
|
|
1026
1026
|
```
|
|
1027
1027
|
|
|
1028
|
-
Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:
|
|
1028
|
+
Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:97](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-utils/src/lib/services/crud-http.service.ts#L97)
|
|
1029
1029
|
|
|
1030
1030
|
###### Type Parameters
|
|
1031
1031
|
|
|
@@ -1107,7 +1107,7 @@ CrudHttpService.delete;
|
|
|
1107
1107
|
get<Res>(url, options?): Observable<Res>;
|
|
1108
1108
|
```
|
|
1109
1109
|
|
|
1110
|
-
Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:
|
|
1110
|
+
Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:48](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-utils/src/lib/services/crud-http.service.ts#L48)
|
|
1111
1111
|
|
|
1112
1112
|
###### Type Parameters
|
|
1113
1113
|
|
|
@@ -1187,7 +1187,7 @@ CrudHttpService.get;
|
|
|
1187
1187
|
get<Res>(url, options?): Promise<Res>;
|
|
1188
1188
|
```
|
|
1189
1189
|
|
|
1190
|
-
Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:
|
|
1190
|
+
Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:50](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-utils/src/lib/services/crud-http.service.ts#L50)
|
|
1191
1191
|
|
|
1192
1192
|
###### Type Parameters
|
|
1193
1193
|
|
|
@@ -1267,7 +1267,7 @@ CrudHttpService.get;
|
|
|
1267
1267
|
getAuthResponse(accessToken, skipNotify?): Observable<AuthResponse>;
|
|
1268
1268
|
```
|
|
1269
1269
|
|
|
1270
|
-
Defined in: [libs/ngx-auth/src/lib/services/auth.service.ts:
|
|
1270
|
+
Defined in: [libs/ngx-auth/src/lib/services/auth.service.ts:265](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/services/auth.service.ts#L265)
|
|
1271
1271
|
|
|
1272
1272
|
Retrieves the complete authentication response using an access token
|
|
1273
1273
|
|
|
@@ -1364,7 +1364,7 @@ this.authService.getAuthResponse(accessToken).subscribe({
|
|
|
1364
1364
|
googleSignIn(): Promise<AccessToken>;
|
|
1365
1365
|
```
|
|
1366
1366
|
|
|
1367
|
-
Defined in: [libs/ngx-auth/src/lib/services/auth.service.ts:183](https://github.com/hichchidev/hichchi/blob/
|
|
1367
|
+
Defined in: [libs/ngx-auth/src/lib/services/auth.service.ts:183](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/services/auth.service.ts#L183)
|
|
1368
1368
|
|
|
1369
1369
|
Initiates Google OAuth authentication using a popup window
|
|
1370
1370
|
|
|
@@ -1440,7 +1440,7 @@ patch<Res, B>(
|
|
|
1440
1440
|
options?): Observable<Res>;
|
|
1441
1441
|
```
|
|
1442
1442
|
|
|
1443
|
-
Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:
|
|
1443
|
+
Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:83](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-utils/src/lib/services/crud-http.service.ts#L83)
|
|
1444
1444
|
|
|
1445
1445
|
###### Type Parameters
|
|
1446
1446
|
|
|
@@ -1547,7 +1547,7 @@ patch<Res, B>(
|
|
|
1547
1547
|
options?): Promise<Res>;
|
|
1548
1548
|
```
|
|
1549
1549
|
|
|
1550
|
-
Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:
|
|
1550
|
+
Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:85](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-utils/src/lib/services/crud-http.service.ts#L85)
|
|
1551
1551
|
|
|
1552
1552
|
###### Type Parameters
|
|
1553
1553
|
|
|
@@ -1656,7 +1656,7 @@ post<Res, B>(
|
|
|
1656
1656
|
options?): Observable<Res>;
|
|
1657
1657
|
```
|
|
1658
1658
|
|
|
1659
|
-
Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:
|
|
1659
|
+
Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:59](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-utils/src/lib/services/crud-http.service.ts#L59)
|
|
1660
1660
|
|
|
1661
1661
|
###### Type Parameters
|
|
1662
1662
|
|
|
@@ -1763,7 +1763,7 @@ post<Res, B>(
|
|
|
1763
1763
|
options?): Promise<Res>;
|
|
1764
1764
|
```
|
|
1765
1765
|
|
|
1766
|
-
Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:
|
|
1766
|
+
Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:61](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-utils/src/lib/services/crud-http.service.ts#L61)
|
|
1767
1767
|
|
|
1768
1768
|
###### Type Parameters
|
|
1769
1769
|
|
|
@@ -1872,7 +1872,7 @@ put<Res, B>(
|
|
|
1872
1872
|
options?): Observable<Res>;
|
|
1873
1873
|
```
|
|
1874
1874
|
|
|
1875
|
-
Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:
|
|
1875
|
+
Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:71](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-utils/src/lib/services/crud-http.service.ts#L71)
|
|
1876
1876
|
|
|
1877
1877
|
###### Type Parameters
|
|
1878
1878
|
|
|
@@ -1979,7 +1979,7 @@ put<Res, B>(
|
|
|
1979
1979
|
options?): Promise<Res>;
|
|
1980
1980
|
```
|
|
1981
1981
|
|
|
1982
|
-
Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:
|
|
1982
|
+
Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:73](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-utils/src/lib/services/crud-http.service.ts#L73)
|
|
1983
1983
|
|
|
1984
1984
|
###### Type Parameters
|
|
1985
1985
|
|
|
@@ -2083,7 +2083,7 @@ CrudHttpService.put;
|
|
|
2083
2083
|
refreshToken(refreshToken, skipNotify?): Observable<TokenResponse>;
|
|
2084
2084
|
```
|
|
2085
2085
|
|
|
2086
|
-
Defined in: [libs/ngx-auth/src/lib/services/auth.service.ts:
|
|
2086
|
+
Defined in: [libs/ngx-auth/src/lib/services/auth.service.ts:371](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/services/auth.service.ts#L371)
|
|
2087
2087
|
|
|
2088
2088
|
Refreshes an expired access token using a refresh token
|
|
2089
2089
|
|
|
@@ -2187,7 +2187,7 @@ protected request<Res, Body>(
|
|
|
2187
2187
|
options?): Promise<Res> | Observable<Res>;
|
|
2188
2188
|
```
|
|
2189
2189
|
|
|
2190
|
-
Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:
|
|
2190
|
+
Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:23](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-utils/src/lib/services/crud-http.service.ts#L23)
|
|
2191
2191
|
|
|
2192
2192
|
###### Type Parameters
|
|
2193
2193
|
|
|
@@ -2303,7 +2303,7 @@ CrudHttpService.request;
|
|
|
2303
2303
|
signIn(dto, skipNotify?): Observable<AuthResponse>;
|
|
2304
2304
|
```
|
|
2305
2305
|
|
|
2306
|
-
Defined in: [libs/ngx-auth/src/lib/services/auth.service.ts:118](https://github.com/hichchidev/hichchi/blob/
|
|
2306
|
+
Defined in: [libs/ngx-auth/src/lib/services/auth.service.ts:118](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/services/auth.service.ts#L118)
|
|
2307
2307
|
|
|
2308
2308
|
Authenticates a user with email/username and password
|
|
2309
2309
|
|
|
@@ -2397,7 +2397,7 @@ this.authService
|
|
|
2397
2397
|
signOut(skipNotify?): Observable<SuccessResponse | null>;
|
|
2398
2398
|
```
|
|
2399
2399
|
|
|
2400
|
-
Defined in: [libs/ngx-auth/src/lib/services/auth.service.ts:
|
|
2400
|
+
Defined in: [libs/ngx-auth/src/lib/services/auth.service.ts:439](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/services/auth.service.ts#L439)
|
|
2401
2401
|
|
|
2402
2402
|
Signs out the current user and invalidates their session
|
|
2403
2403
|
|
|
@@ -2496,7 +2496,7 @@ async signOut() {
|
|
|
2496
2496
|
signUp(dto, skipNotify?): Observable<User<string, string>>;
|
|
2497
2497
|
```
|
|
2498
2498
|
|
|
2499
|
-
Defined in: [libs/ngx-auth/src/lib/services/auth.service.ts:
|
|
2499
|
+
Defined in: [libs/ngx-auth/src/lib/services/auth.service.ts:325](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/services/auth.service.ts#L325)
|
|
2500
2500
|
|
|
2501
2501
|
Registers a new user account
|
|
2502
2502
|
|
|
@@ -2599,7 +2599,7 @@ this.authService
|
|
|
2599
2599
|
static parseQuery<T>(options?): HttpQuery<Model>;
|
|
2600
2600
|
```
|
|
2601
2601
|
|
|
2602
|
-
Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:
|
|
2602
|
+
Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:106](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-utils/src/lib/services/crud-http.service.ts#L106)
|
|
2603
2603
|
|
|
2604
2604
|
###### Type Parameters
|
|
2605
2605
|
|
|
@@ -2693,7 +2693,7 @@ CrudHttpService.http;
|
|
|
2693
2693
|
</td>
|
|
2694
2694
|
<td>
|
|
2695
2695
|
|
|
2696
|
-
[libs/ngx-utils/src/lib/services/crud-http.service.ts:
|
|
2696
|
+
[libs/ngx-utils/src/lib/services/crud-http.service.ts:21](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-utils/src/lib/services/crud-http.service.ts#L21)
|
|
2697
2697
|
|
|
2698
2698
|
</td>
|
|
2699
2699
|
</tr>
|
|
@@ -2704,7 +2704,7 @@ CrudHttpService.http;
|
|
|
2704
2704
|
|
|
2705
2705
|
### NgxHichchiAuthModule
|
|
2706
2706
|
|
|
2707
|
-
Defined in: [libs/ngx-auth/src/lib/auth.module.ts:
|
|
2707
|
+
Defined in: [libs/ngx-auth/src/lib/auth.module.ts:93](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/auth.module.ts#L93)
|
|
2708
2708
|
|
|
2709
2709
|
Angular module for authentication functionality
|
|
2710
2710
|
|
|
@@ -2721,6 +2721,12 @@ The module exports:
|
|
|
2721
2721
|
The module must be configured using the forRoot() method to provide the necessary
|
|
2722
2722
|
authentication configuration.
|
|
2723
2723
|
|
|
2724
|
+
Tenant handling:
|
|
2725
|
+
|
|
2726
|
+
- `tenant` can be provided in the configuration or dynamically set in requests
|
|
2727
|
+
via a custom HTTP header (`x-tenant`, controlled by `TENANT_HEADER_KEY`).
|
|
2728
|
+
- This approach replaces previous subdomain-based tenant resolution.
|
|
2729
|
+
|
|
2724
2730
|
#### Examples
|
|
2725
2731
|
|
|
2726
2732
|
```typescript
|
|
@@ -2748,6 +2754,19 @@ export class AppModule {}
|
|
|
2748
2754
|
export class AppModule {}
|
|
2749
2755
|
```
|
|
2750
2756
|
|
|
2757
|
+
```typescript
|
|
2758
|
+
// Optional static tenant header
|
|
2759
|
+
@NgModule({
|
|
2760
|
+
imports: [
|
|
2761
|
+
NgxHichchiAuthModule.forRoot({
|
|
2762
|
+
apiBaseURL: "https://api.example.com",
|
|
2763
|
+
tenant: "tenant-a",
|
|
2764
|
+
}),
|
|
2765
|
+
],
|
|
2766
|
+
})
|
|
2767
|
+
export class AppModule {}
|
|
2768
|
+
```
|
|
2769
|
+
|
|
2751
2770
|
#### See
|
|
2752
2771
|
|
|
2753
2772
|
- [AuthConfig](#authconfig) Configuration interface for the authentication module
|
|
@@ -2775,13 +2794,14 @@ new NgxHichchiAuthModule(): NgxHichchiAuthModule;
|
|
|
2775
2794
|
static forRoot(config): ModuleWithProviders<NgxHichchiAuthModule>;
|
|
2776
2795
|
```
|
|
2777
2796
|
|
|
2778
|
-
Defined in: [libs/ngx-auth/src/lib/auth.module.ts:
|
|
2797
|
+
Defined in: [libs/ngx-auth/src/lib/auth.module.ts:136](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/auth.module.ts#L136)
|
|
2779
2798
|
|
|
2780
2799
|
Configures the NgxHichchiAuthModule with the provided authentication configuration
|
|
2781
2800
|
|
|
2782
2801
|
This static method sets up the module with the necessary providers and configuration
|
|
2783
|
-
for authentication functionality.
|
|
2784
|
-
authentication
|
|
2802
|
+
for authentication functionality. The configuration includes the `apiBaseURL` for
|
|
2803
|
+
all authentication requests, and optionally a `tenant` string that is attached
|
|
2804
|
+
to requests via the `TENANT_HEADER_KEY` header.
|
|
2785
2805
|
|
|
2786
2806
|
###### Parameters
|
|
2787
2807
|
|
|
@@ -2807,7 +2827,7 @@ authentication configuration token that are required for the module to function
|
|
|
2807
2827
|
</td>
|
|
2808
2828
|
<td>
|
|
2809
2829
|
|
|
2810
|
-
The authentication configuration object containing API endpoints and settings
|
|
2830
|
+
The authentication configuration object containing API endpoints, tenant, and other settings
|
|
2811
2831
|
|
|
2812
2832
|
</td>
|
|
2813
2833
|
</tr>
|
|
@@ -2837,17 +2857,26 @@ NgxHichchiAuthModule.forRoot({
|
|
|
2837
2857
|
});
|
|
2838
2858
|
```
|
|
2839
2859
|
|
|
2860
|
+
```typescript
|
|
2861
|
+
// Configuration with static tenant
|
|
2862
|
+
NgxHichchiAuthModule.forRoot({
|
|
2863
|
+
apiBaseURL: "https://api.example.com",
|
|
2864
|
+
tenant: "tenant-a",
|
|
2865
|
+
});
|
|
2866
|
+
```
|
|
2867
|
+
|
|
2840
2868
|
###### See
|
|
2841
2869
|
|
|
2842
2870
|
- [AuthConfig](#authconfig) Interface defining the configuration structure
|
|
2843
2871
|
- AUTH_CONFIG Injection token for the authentication configuration
|
|
2844
2872
|
- [AuthService](#authservice) Service that uses the provided configuration
|
|
2873
|
+
- TENANT_HEADER_KEY Constant used to attach tenant header to requests
|
|
2845
2874
|
|
|
2846
2875
|
---
|
|
2847
2876
|
|
|
2848
2877
|
### PermissionDirective
|
|
2849
2878
|
|
|
2850
|
-
Defined in: [libs/ngx-auth/src/lib/directives/permission.directive.ts:67](https://github.com/hichchidev/hichchi/blob/
|
|
2879
|
+
Defined in: [libs/ngx-auth/src/lib/directives/permission.directive.ts:67](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/directives/permission.directive.ts#L67)
|
|
2851
2880
|
|
|
2852
2881
|
Angular structural directive for permission-based conditional rendering
|
|
2853
2882
|
|
|
@@ -2914,7 +2943,7 @@ export class UserListComponent {
|
|
|
2914
2943
|
new PermissionDirective(): PermissionDirective;
|
|
2915
2944
|
```
|
|
2916
2945
|
|
|
2917
|
-
Defined in: [libs/ngx-auth/src/lib/directives/permission.directive.ts:114](https://github.com/hichchidev/hichchi/blob/
|
|
2946
|
+
Defined in: [libs/ngx-auth/src/lib/directives/permission.directive.ts:114](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/directives/permission.directive.ts#L114)
|
|
2918
2947
|
|
|
2919
2948
|
Constructor that sets up the permission checking effect
|
|
2920
2949
|
|
|
@@ -2973,7 +3002,7 @@ the specified permissions (OR logic).
|
|
|
2973
3002
|
</td>
|
|
2974
3003
|
<td>
|
|
2975
3004
|
|
|
2976
|
-
[libs/ngx-auth/src/lib/directives/permission.directive.ts:105](https://github.com/hichchidev/hichchi/blob/
|
|
3005
|
+
[libs/ngx-auth/src/lib/directives/permission.directive.ts:105](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/directives/permission.directive.ts#L105)
|
|
2977
3006
|
|
|
2978
3007
|
</td>
|
|
2979
3008
|
</tr>
|
|
@@ -2984,7 +3013,7 @@ the specified permissions (OR logic).
|
|
|
2984
3013
|
|
|
2985
3014
|
### AuthGuardCondition
|
|
2986
3015
|
|
|
2987
|
-
Defined in: [libs/ngx-auth/src/lib/enums/auth-guard-condition.enum.ts:33](https://github.com/hichchidev/hichchi/blob/
|
|
3016
|
+
Defined in: [libs/ngx-auth/src/lib/enums/auth-guard-condition.enum.ts:33](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/enums/auth-guard-condition.enum.ts#L33)
|
|
2988
3017
|
|
|
2989
3018
|
Enumeration of authentication guard conditions
|
|
2990
3019
|
|
|
@@ -3049,7 +3078,7 @@ Check if the user has a valid access token
|
|
|
3049
3078
|
</td>
|
|
3050
3079
|
<td>
|
|
3051
3080
|
|
|
3052
|
-
[libs/ngx-auth/src/lib/enums/auth-guard-condition.enum.ts:37](https://github.com/hichchidev/hichchi/blob/
|
|
3081
|
+
[libs/ngx-auth/src/lib/enums/auth-guard-condition.enum.ts:37](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/enums/auth-guard-condition.enum.ts#L37)
|
|
3053
3082
|
|
|
3054
3083
|
</td>
|
|
3055
3084
|
</tr>
|
|
@@ -3071,7 +3100,7 @@ Check if the user is signed in to the application
|
|
|
3071
3100
|
</td>
|
|
3072
3101
|
<td>
|
|
3073
3102
|
|
|
3074
|
-
[libs/ngx-auth/src/lib/enums/auth-guard-condition.enum.ts:35](https://github.com/hichchidev/hichchi/blob/
|
|
3103
|
+
[libs/ngx-auth/src/lib/enums/auth-guard-condition.enum.ts:35](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/enums/auth-guard-condition.enum.ts#L35)
|
|
3075
3104
|
|
|
3076
3105
|
</td>
|
|
3077
3106
|
</tr>
|
|
@@ -3174,7 +3203,7 @@ const routes: Routes = [
|
|
|
3174
3203
|
function authGuard(options): CanActivateFn;
|
|
3175
3204
|
```
|
|
3176
3205
|
|
|
3177
|
-
Defined in: [libs/ngx-auth/src/lib/guards/auth.guard.ts:37](https://github.com/hichchidev/hichchi/blob/
|
|
3206
|
+
Defined in: [libs/ngx-auth/src/lib/guards/auth.guard.ts:37](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/guards/auth.guard.ts#L37)
|
|
3178
3207
|
|
|
3179
3208
|
Creates an authentication guard function with multiple configuration options
|
|
3180
3209
|
|
|
@@ -3256,7 +3285,7 @@ const routes: Routes = [
|
|
|
3256
3285
|
function authGuard(condition, state, fallbackRedirect): CanActivateFn;
|
|
3257
3286
|
```
|
|
3258
3287
|
|
|
3259
|
-
Defined in: [libs/ngx-auth/src/lib/guards/auth.guard.ts:77](https://github.com/hichchidev/hichchi/blob/
|
|
3288
|
+
Defined in: [libs/ngx-auth/src/lib/guards/auth.guard.ts:77](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/guards/auth.guard.ts#L77)
|
|
3260
3289
|
|
|
3261
3290
|
Creates an authentication guard function with a single condition
|
|
3262
3291
|
|
|
@@ -3371,7 +3400,7 @@ const routes: Routes = [
|
|
|
3371
3400
|
function authInterceptor(redirect, onRedirect?): HttpInterceptorFn;
|
|
3372
3401
|
```
|
|
3373
3402
|
|
|
3374
|
-
Defined in: [libs/ngx-auth/src/lib/interceptors/auth.interceptor.ts:167](https://github.com/hichchidev/hichchi/blob/
|
|
3403
|
+
Defined in: [libs/ngx-auth/src/lib/interceptors/auth.interceptor.ts:167](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/interceptors/auth.interceptor.ts#L167)
|
|
3375
3404
|
|
|
3376
3405
|
Creates an HTTP interceptor for handling authentication tokens and automatic token refresh
|
|
3377
3406
|
|
|
@@ -3505,7 +3534,7 @@ export class AppModule {}
|
|
|
3505
3534
|
function roleGuard(role, options): CanActivateFn;
|
|
3506
3535
|
```
|
|
3507
3536
|
|
|
3508
|
-
Defined in: [libs/ngx-auth/src/lib/guards/role.guard.ts:76](https://github.com/hichchidev/hichchi/blob/
|
|
3537
|
+
Defined in: [libs/ngx-auth/src/lib/guards/role.guard.ts:76](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/guards/role.guard.ts#L76)
|
|
3509
3538
|
|
|
3510
3539
|
Creates a role-based authorization guard function for Angular route protection
|
|
3511
3540
|
|
|
@@ -3634,7 +3663,7 @@ const routes: Routes = [
|
|
|
3634
3663
|
|
|
3635
3664
|
### AuthConfig
|
|
3636
3665
|
|
|
3637
|
-
Defined in: [libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:3](https://github.com/hichchidev/hichchi/blob/
|
|
3666
|
+
Defined in: [libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:3](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts#L3)
|
|
3638
3667
|
|
|
3639
3668
|
#### Properties
|
|
3640
3669
|
|
|
@@ -3660,7 +3689,7 @@ Defined in: [libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:3](https:
|
|
|
3660
3689
|
</td>
|
|
3661
3690
|
<td>
|
|
3662
3691
|
|
|
3663
|
-
[libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:5](https://github.com/hichchidev/hichchi/blob/
|
|
3692
|
+
[libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:5](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts#L5)
|
|
3664
3693
|
|
|
3665
3694
|
</td>
|
|
3666
3695
|
</tr>
|
|
@@ -3677,7 +3706,41 @@ Defined in: [libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:3](https:
|
|
|
3677
3706
|
</td>
|
|
3678
3707
|
<td>
|
|
3679
3708
|
|
|
3680
|
-
[libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:4](https://github.com/hichchidev/hichchi/blob/
|
|
3709
|
+
[libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:4](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts#L4)
|
|
3710
|
+
|
|
3711
|
+
</td>
|
|
3712
|
+
</tr>
|
|
3713
|
+
<tr>
|
|
3714
|
+
<td>
|
|
3715
|
+
|
|
3716
|
+
<a id="property-splitdomain"></a> `splitDomain?`
|
|
3717
|
+
|
|
3718
|
+
</td>
|
|
3719
|
+
<td>
|
|
3720
|
+
|
|
3721
|
+
`string`
|
|
3722
|
+
|
|
3723
|
+
</td>
|
|
3724
|
+
<td>
|
|
3725
|
+
|
|
3726
|
+
[libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:6](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts#L6)
|
|
3727
|
+
|
|
3728
|
+
</td>
|
|
3729
|
+
</tr>
|
|
3730
|
+
<tr>
|
|
3731
|
+
<td>
|
|
3732
|
+
|
|
3733
|
+
<a id="property-tenant"></a> `tenant?`
|
|
3734
|
+
|
|
3735
|
+
</td>
|
|
3736
|
+
<td>
|
|
3737
|
+
|
|
3738
|
+
`TenantSlug`
|
|
3739
|
+
|
|
3740
|
+
</td>
|
|
3741
|
+
<td>
|
|
3742
|
+
|
|
3743
|
+
[libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:7](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts#L7)
|
|
3681
3744
|
|
|
3682
3745
|
</td>
|
|
3683
3746
|
</tr>
|
|
@@ -3688,7 +3751,7 @@ Defined in: [libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:3](https:
|
|
|
3688
3751
|
|
|
3689
3752
|
### AuthFormData
|
|
3690
3753
|
|
|
3691
|
-
Defined in: [libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts:52](https://github.com/hichchidev/hichchi/blob/
|
|
3754
|
+
Defined in: [libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts:52](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts#L52)
|
|
3692
3755
|
|
|
3693
3756
|
Interface for authentication form data
|
|
3694
3757
|
|
|
@@ -3773,7 +3836,7 @@ Authentication field value (email, username, etc.)
|
|
|
3773
3836
|
</td>
|
|
3774
3837
|
<td>
|
|
3775
3838
|
|
|
3776
|
-
[libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts:58](https://github.com/hichchidev/hichchi/blob/
|
|
3839
|
+
[libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts:58](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts#L58)
|
|
3777
3840
|
|
|
3778
3841
|
</td>
|
|
3779
3842
|
</tr>
|
|
@@ -3795,7 +3858,7 @@ User's first name
|
|
|
3795
3858
|
</td>
|
|
3796
3859
|
<td>
|
|
3797
3860
|
|
|
3798
|
-
[libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts:54](https://github.com/hichchidev/hichchi/blob/
|
|
3861
|
+
[libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts:54](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts#L54)
|
|
3799
3862
|
|
|
3800
3863
|
</td>
|
|
3801
3864
|
</tr>
|
|
@@ -3817,7 +3880,7 @@ User's last name
|
|
|
3817
3880
|
</td>
|
|
3818
3881
|
<td>
|
|
3819
3882
|
|
|
3820
|
-
[libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts:56](https://github.com/hichchidev/hichchi/blob/
|
|
3883
|
+
[libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts:56](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts#L56)
|
|
3821
3884
|
|
|
3822
3885
|
</td>
|
|
3823
3886
|
</tr>
|
|
@@ -3839,7 +3902,7 @@ User's password
|
|
|
3839
3902
|
</td>
|
|
3840
3903
|
<td>
|
|
3841
3904
|
|
|
3842
|
-
[libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts:60](https://github.com/hichchidev/hichchi/blob/
|
|
3905
|
+
[libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts:60](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts#L60)
|
|
3843
3906
|
|
|
3844
3907
|
</td>
|
|
3845
3908
|
</tr>
|
|
@@ -3850,7 +3913,7 @@ User's password
|
|
|
3850
3913
|
|
|
3851
3914
|
### AuthGuardOption
|
|
3852
3915
|
|
|
3853
|
-
Defined in: [libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts:66](https://github.com/hichchidev/hichchi/blob/
|
|
3916
|
+
Defined in: [libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts:66](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts#L66)
|
|
3854
3917
|
|
|
3855
3918
|
Interface for configuring authentication guard behavior
|
|
3856
3919
|
|
|
@@ -3944,7 +4007,7 @@ The authentication condition to check
|
|
|
3944
4007
|
</td>
|
|
3945
4008
|
<td>
|
|
3946
4009
|
|
|
3947
|
-
[libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts:68](https://github.com/hichchidev/hichchi/blob/
|
|
4010
|
+
[libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts:68](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts#L68)
|
|
3948
4011
|
|
|
3949
4012
|
</td>
|
|
3950
4013
|
</tr>
|
|
@@ -3966,7 +4029,7 @@ The route to redirect to if the condition is not met
|
|
|
3966
4029
|
</td>
|
|
3967
4030
|
<td>
|
|
3968
4031
|
|
|
3969
|
-
[libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts:72](https://github.com/hichchidev/hichchi/blob/
|
|
4032
|
+
[libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts:72](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts#L72)
|
|
3970
4033
|
|
|
3971
4034
|
</td>
|
|
3972
4035
|
</tr>
|
|
@@ -3988,7 +4051,7 @@ The required state of the condition (true/false)
|
|
|
3988
4051
|
</td>
|
|
3989
4052
|
<td>
|
|
3990
4053
|
|
|
3991
|
-
[libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts:70](https://github.com/hichchidev/hichchi/blob/
|
|
4054
|
+
[libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts:70](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts#L70)
|
|
3992
4055
|
|
|
3993
4056
|
</td>
|
|
3994
4057
|
</tr>
|
|
@@ -3999,7 +4062,7 @@ The required state of the condition (true/false)
|
|
|
3999
4062
|
|
|
4000
4063
|
### AuthStateModel
|
|
4001
4064
|
|
|
4002
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:57](https://github.com/hichchidev/hichchi/blob/
|
|
4065
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:57](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/state/auth.state.ts#L57)
|
|
4003
4066
|
|
|
4004
4067
|
Interface defining the authentication state model
|
|
4005
4068
|
|
|
@@ -4089,7 +4152,7 @@ JWT access token for API authentication
|
|
|
4089
4152
|
</td>
|
|
4090
4153
|
<td>
|
|
4091
4154
|
|
|
4092
|
-
[libs/ngx-auth/src/lib/state/auth.state.ts:65](https://github.com/hichchidev/hichchi/blob/
|
|
4155
|
+
[libs/ngx-auth/src/lib/state/auth.state.ts:65](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/state/auth.state.ts#L65)
|
|
4093
4156
|
|
|
4094
4157
|
</td>
|
|
4095
4158
|
</tr>
|
|
@@ -4111,7 +4174,7 @@ Expiration date of the access token
|
|
|
4111
4174
|
</td>
|
|
4112
4175
|
<td>
|
|
4113
4176
|
|
|
4114
|
-
[libs/ngx-auth/src/lib/state/auth.state.ts:69](https://github.com/hichchidev/hichchi/blob/
|
|
4177
|
+
[libs/ngx-auth/src/lib/state/auth.state.ts:69](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/state/auth.state.ts#L69)
|
|
4115
4178
|
|
|
4116
4179
|
</td>
|
|
4117
4180
|
</tr>
|
|
@@ -4133,7 +4196,7 @@ Expiration date of the access token
|
|
|
4133
4196
|
</td>
|
|
4134
4197
|
<td>
|
|
4135
4198
|
|
|
4136
|
-
[libs/ngx-auth/src/lib/state/auth.state.ts:73](https://github.com/hichchidev/hichchi/blob/
|
|
4199
|
+
[libs/ngx-auth/src/lib/state/auth.state.ts:73](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/state/auth.state.ts#L73)
|
|
4137
4200
|
|
|
4138
4201
|
</td>
|
|
4139
4202
|
</tr>
|
|
@@ -4155,7 +4218,7 @@ JWT refresh token for obtaining new access tokens
|
|
|
4155
4218
|
</td>
|
|
4156
4219
|
<td>
|
|
4157
4220
|
|
|
4158
|
-
[libs/ngx-auth/src/lib/state/auth.state.ts:67](https://github.com/hichchidev/hichchi/blob/
|
|
4221
|
+
[libs/ngx-auth/src/lib/state/auth.state.ts:67](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/state/auth.state.ts#L67)
|
|
4159
4222
|
|
|
4160
4223
|
</td>
|
|
4161
4224
|
</tr>
|
|
@@ -4177,7 +4240,7 @@ Expiration date of the refresh token
|
|
|
4177
4240
|
</td>
|
|
4178
4241
|
<td>
|
|
4179
4242
|
|
|
4180
|
-
[libs/ngx-auth/src/lib/state/auth.state.ts:71](https://github.com/hichchidev/hichchi/blob/
|
|
4243
|
+
[libs/ngx-auth/src/lib/state/auth.state.ts:71](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/state/auth.state.ts#L71)
|
|
4181
4244
|
|
|
4182
4245
|
</td>
|
|
4183
4246
|
</tr>
|
|
@@ -4199,7 +4262,7 @@ Unique identifier for the current session
|
|
|
4199
4262
|
</td>
|
|
4200
4263
|
<td>
|
|
4201
4264
|
|
|
4202
|
-
[libs/ngx-auth/src/lib/state/auth.state.ts:61](https://github.com/hichchidev/hichchi/blob/
|
|
4265
|
+
[libs/ngx-auth/src/lib/state/auth.state.ts:61](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/state/auth.state.ts#L61)
|
|
4203
4266
|
|
|
4204
4267
|
</td>
|
|
4205
4268
|
</tr>
|
|
@@ -4221,7 +4284,7 @@ Whether the user is currently signed in
|
|
|
4221
4284
|
</td>
|
|
4222
4285
|
<td>
|
|
4223
4286
|
|
|
4224
|
-
[libs/ngx-auth/src/lib/state/auth.state.ts:59](https://github.com/hichchidev/hichchi/blob/
|
|
4287
|
+
[libs/ngx-auth/src/lib/state/auth.state.ts:59](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/state/auth.state.ts#L59)
|
|
4225
4288
|
|
|
4226
4289
|
</td>
|
|
4227
4290
|
</tr>
|
|
@@ -4243,7 +4306,7 @@ Current authenticated user information
|
|
|
4243
4306
|
</td>
|
|
4244
4307
|
<td>
|
|
4245
4308
|
|
|
4246
|
-
[libs/ngx-auth/src/lib/state/auth.state.ts:63](https://github.com/hichchidev/hichchi/blob/
|
|
4309
|
+
[libs/ngx-auth/src/lib/state/auth.state.ts:63](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/state/auth.state.ts#L63)
|
|
4247
4310
|
|
|
4248
4311
|
</td>
|
|
4249
4312
|
</tr>
|
|
@@ -4254,7 +4317,7 @@ Current authenticated user information
|
|
|
4254
4317
|
|
|
4255
4318
|
### RoleGuardOption
|
|
4256
4319
|
|
|
4257
|
-
Defined in: [libs/ngx-auth/src/lib/interfaces/role-guard-option.interface.ts:1](https://github.com/hichchidev/hichchi/blob/
|
|
4320
|
+
Defined in: [libs/ngx-auth/src/lib/interfaces/role-guard-option.interface.ts:1](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/interfaces/role-guard-option.interface.ts#L1)
|
|
4258
4321
|
|
|
4259
4322
|
#### Properties
|
|
4260
4323
|
|
|
@@ -4286,7 +4349,7 @@ The route to redirect to if the role exist
|
|
|
4286
4349
|
</td>
|
|
4287
4350
|
<td>
|
|
4288
4351
|
|
|
4289
|
-
[libs/ngx-auth/src/lib/interfaces/role-guard-option.interface.ts:5](https://github.com/hichchidev/hichchi/blob/
|
|
4352
|
+
[libs/ngx-auth/src/lib/interfaces/role-guard-option.interface.ts:5](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/interfaces/role-guard-option.interface.ts#L5)
|
|
4290
4353
|
|
|
4291
4354
|
</td>
|
|
4292
4355
|
</tr>
|
|
@@ -4308,7 +4371,7 @@ The required state of the role
|
|
|
4308
4371
|
</td>
|
|
4309
4372
|
<td>
|
|
4310
4373
|
|
|
4311
|
-
[libs/ngx-auth/src/lib/interfaces/role-guard-option.interface.ts:3](https://github.com/hichchidev/hichchi/blob/
|
|
4374
|
+
[libs/ngx-auth/src/lib/interfaces/role-guard-option.interface.ts:3](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/interfaces/role-guard-option.interface.ts#L3)
|
|
4312
4375
|
|
|
4313
4376
|
</td>
|
|
4314
4377
|
</tr>
|
|
@@ -4323,7 +4386,7 @@ The required state of the role
|
|
|
4323
4386
|
type AuthState<D, R, P, U> = object;
|
|
4324
4387
|
```
|
|
4325
4388
|
|
|
4326
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:164](https://github.com/hichchidev/hichchi/blob/
|
|
4389
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:164](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/state/auth.state.ts#L164)
|
|
4327
4390
|
|
|
4328
4391
|
Public typed shape of the `AuthState` signal store.
|
|
4329
4392
|
|
|
@@ -4396,7 +4459,7 @@ Public typed shape of the `AuthState` signal store.
|
|
|
4396
4459
|
accessToken: Signal<AccessToken | null>;
|
|
4397
4460
|
```
|
|
4398
4461
|
|
|
4399
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:760](https://github.com/hichchidev/hichchi/blob/
|
|
4462
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:760](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/state/auth.state.ts#L760)
|
|
4400
4463
|
|
|
4401
4464
|
##### accessTokenExpiresOn
|
|
4402
4465
|
|
|
@@ -4404,7 +4467,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:760](https://github.com/h
|
|
|
4404
4467
|
accessTokenExpiresOn: Signal<Date | null>;
|
|
4405
4468
|
```
|
|
4406
4469
|
|
|
4407
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:762](https://github.com/hichchidev/hichchi/blob/
|
|
4470
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:762](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/state/auth.state.ts#L762)
|
|
4408
4471
|
|
|
4409
4472
|
##### authenticateWithToken()
|
|
4410
4473
|
|
|
@@ -4412,7 +4475,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:762](https://github.com/h
|
|
|
4412
4475
|
authenticateWithToken: <AsPromise>(accessToken, redirect?, asPromise?, showError?) => AsPromise extends true ? Promise<AuthResponse> : Observable<AuthResponse>;
|
|
4413
4476
|
```
|
|
4414
4477
|
|
|
4415
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:780](https://github.com/hichchidev/hichchi/blob/
|
|
4478
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:780](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/state/auth.state.ts#L780)
|
|
4416
4479
|
|
|
4417
4480
|
###### Type Parameters
|
|
4418
4481
|
|
|
@@ -4510,7 +4573,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:780](https://github.com/h
|
|
|
4510
4573
|
data: Signal<D>;
|
|
4511
4574
|
```
|
|
4512
4575
|
|
|
4513
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:764](https://github.com/hichchidev/hichchi/blob/
|
|
4576
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:764](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/state/auth.state.ts#L764)
|
|
4514
4577
|
|
|
4515
4578
|
##### emailVerified
|
|
4516
4579
|
|
|
@@ -4518,7 +4581,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:764](https://github.com/h
|
|
|
4518
4581
|
emailVerified: Signal<boolean>;
|
|
4519
4582
|
```
|
|
4520
4583
|
|
|
4521
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:770](https://github.com/hichchidev/hichchi/blob/
|
|
4584
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:770](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/state/auth.state.ts#L770)
|
|
4522
4585
|
|
|
4523
4586
|
##### hasAccessToken
|
|
4524
4587
|
|
|
@@ -4526,7 +4589,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:770](https://github.com/h
|
|
|
4526
4589
|
hasAccessToken: Signal<boolean>;
|
|
4527
4590
|
```
|
|
4528
4591
|
|
|
4529
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:766](https://github.com/hichchidev/hichchi/blob/
|
|
4592
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:766](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/state/auth.state.ts#L766)
|
|
4530
4593
|
|
|
4531
4594
|
##### permissions
|
|
4532
4595
|
|
|
@@ -4534,7 +4597,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:766](https://github.com/h
|
|
|
4534
4597
|
permissions: Signal<P[]>;
|
|
4535
4598
|
```
|
|
4536
4599
|
|
|
4537
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:769](https://github.com/hichchidev/hichchi/blob/
|
|
4600
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:769](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/state/auth.state.ts#L769)
|
|
4538
4601
|
|
|
4539
4602
|
##### refreshToken
|
|
4540
4603
|
|
|
@@ -4542,7 +4605,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:769](https://github.com/h
|
|
|
4542
4605
|
refreshToken: Signal<RefreshToken | null>;
|
|
4543
4606
|
```
|
|
4544
4607
|
|
|
4545
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:761](https://github.com/hichchidev/hichchi/blob/
|
|
4608
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:761](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/state/auth.state.ts#L761)
|
|
4546
4609
|
|
|
4547
4610
|
##### refreshTokenExpiresOn
|
|
4548
4611
|
|
|
@@ -4550,7 +4613,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:761](https://github.com/h
|
|
|
4550
4613
|
refreshTokenExpiresOn: Signal<Date | null>;
|
|
4551
4614
|
```
|
|
4552
4615
|
|
|
4553
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:763](https://github.com/hichchidev/hichchi/blob/
|
|
4616
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:763](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/state/auth.state.ts#L763)
|
|
4554
4617
|
|
|
4555
4618
|
##### reset()
|
|
4556
4619
|
|
|
@@ -4558,7 +4621,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:763](https://github.com/h
|
|
|
4558
4621
|
reset: () => void;
|
|
4559
4622
|
```
|
|
4560
4623
|
|
|
4561
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:772](https://github.com/hichchidev/hichchi/blob/
|
|
4624
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:772](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/state/auth.state.ts#L772)
|
|
4562
4625
|
|
|
4563
4626
|
###### Returns
|
|
4564
4627
|
|
|
@@ -4570,7 +4633,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:772](https://github.com/h
|
|
|
4570
4633
|
role: Signal<U["role"] | null | undefined>;
|
|
4571
4634
|
```
|
|
4572
4635
|
|
|
4573
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:767](https://github.com/hichchidev/hichchi/blob/
|
|
4636
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:767](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/state/auth.state.ts#L767)
|
|
4574
4637
|
|
|
4575
4638
|
##### roleName
|
|
4576
4639
|
|
|
@@ -4578,7 +4641,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:767](https://github.com/h
|
|
|
4578
4641
|
roleName: Signal<R | null | undefined>;
|
|
4579
4642
|
```
|
|
4580
4643
|
|
|
4581
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:768](https://github.com/hichchidev/hichchi/blob/
|
|
4644
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:768](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/state/auth.state.ts#L768)
|
|
4582
4645
|
|
|
4583
4646
|
##### sessionId
|
|
4584
4647
|
|
|
@@ -4586,7 +4649,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:768](https://github.com/h
|
|
|
4586
4649
|
sessionId: Signal<string | null>;
|
|
4587
4650
|
```
|
|
4588
4651
|
|
|
4589
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:758](https://github.com/hichchidev/hichchi/blob/
|
|
4652
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:758](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/state/auth.state.ts#L758)
|
|
4590
4653
|
|
|
4591
4654
|
##### setData()
|
|
4592
4655
|
|
|
@@ -4594,7 +4657,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:758](https://github.com/h
|
|
|
4594
4657
|
setData: (stateData) => void;
|
|
4595
4658
|
```
|
|
4596
4659
|
|
|
4597
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:791](https://github.com/hichchidev/hichchi/blob/
|
|
4660
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:791](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/state/auth.state.ts#L791)
|
|
4598
4661
|
|
|
4599
4662
|
###### Parameters
|
|
4600
4663
|
|
|
@@ -4631,7 +4694,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:791](https://github.com/h
|
|
|
4631
4694
|
setTokens: (tokenResponse) => void;
|
|
4632
4695
|
```
|
|
4633
4696
|
|
|
4634
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:773](https://github.com/hichchidev/hichchi/blob/
|
|
4697
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:773](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/state/auth.state.ts#L773)
|
|
4635
4698
|
|
|
4636
4699
|
###### Parameters
|
|
4637
4700
|
|
|
@@ -4668,7 +4731,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:773](https://github.com/h
|
|
|
4668
4731
|
signedIn: Signal<boolean>;
|
|
4669
4732
|
```
|
|
4670
4733
|
|
|
4671
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:757](https://github.com/hichchidev/hichchi/blob/
|
|
4734
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:757](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/state/auth.state.ts#L757)
|
|
4672
4735
|
|
|
4673
4736
|
##### signIn()
|
|
4674
4737
|
|
|
@@ -4676,7 +4739,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:757](https://github.com/h
|
|
|
4676
4739
|
signIn: <AsPromise>(signInBody, redirect?, asPromise?, showError?) => AsPromise extends true ? Promise<AuthResponse> : Observable<AuthResponse>;
|
|
4677
4740
|
```
|
|
4678
4741
|
|
|
4679
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:774](https://github.com/hichchidev/hichchi/blob/
|
|
4742
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:774](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/state/auth.state.ts#L774)
|
|
4680
4743
|
|
|
4681
4744
|
###### Type Parameters
|
|
4682
4745
|
|
|
@@ -4774,7 +4837,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:774](https://github.com/h
|
|
|
4774
4837
|
signOut: <AsPromise>(redirect?, asPromise?, showError?) => AsPromise extends true ? Promise<SuccessResponse | null> : Observable<SuccessResponse | null>;
|
|
4775
4838
|
```
|
|
4776
4839
|
|
|
4777
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:786](https://github.com/hichchidev/hichchi/blob/
|
|
4840
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:786](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/state/auth.state.ts#L786)
|
|
4778
4841
|
|
|
4779
4842
|
###### Type Parameters
|
|
4780
4843
|
|
|
@@ -4860,7 +4923,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:786](https://github.com/h
|
|
|
4860
4923
|
user: Signal<U | null>;
|
|
4861
4924
|
```
|
|
4862
4925
|
|
|
4863
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:759](https://github.com/hichchidev/hichchi/blob/
|
|
4926
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:759](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/state/auth.state.ts#L759)
|
|
4864
4927
|
|
|
4865
4928
|
## Variables
|
|
4866
4929
|
|
|
@@ -4882,7 +4945,7 @@ const AuthState: Type<
|
|
|
4882
4945
|
>;
|
|
4883
4946
|
```
|
|
4884
4947
|
|
|
4885
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:164](https://github.com/hichchidev/hichchi/blob/
|
|
4948
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:164](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/state/auth.state.ts#L164)
|
|
4886
4949
|
|
|
4887
4950
|
Authentication state management store using NgRx Signals
|
|
4888
4951
|
|
|
@@ -4975,7 +5038,7 @@ export class HeaderComponent {
|
|
|
4975
5038
|
const SKIPPED_ERRORS: ErrorResponseCode[];
|
|
4976
5039
|
```
|
|
4977
5040
|
|
|
4978
|
-
Defined in: [libs/ngx-auth/src/lib/interceptors/auth.interceptor.ts:30](https://github.com/hichchidev/hichchi/blob/
|
|
5041
|
+
Defined in: [libs/ngx-auth/src/lib/interceptors/auth.interceptor.ts:30](https://github.com/hichchidev/hichchi/blob/945db660e7bba28e17d58da0bb856736e708db35/libs/ngx-auth/src/lib/interceptors/auth.interceptor.ts#L30)
|
|
4979
5042
|
|
|
4980
5043
|
Array of authentication error codes that should trigger token refresh instead of immediate redirect
|
|
4981
5044
|
|