@hichchi/ngx-auth 0.0.4 → 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 +120 -150
- package/fesm2022/hichchi-ngx-auth.mjs +16 -47
- package/fesm2022/hichchi-ngx-auth.mjs.map +1 -1
- package/package.json +5 -5
- package/types/hichchi-ngx-auth.d.ts +15 -46
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,13 +2721,11 @@ 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
|
-
|
|
2724
|
+
Tenant handling:
|
|
2725
2725
|
|
|
2726
|
-
- `
|
|
2727
|
-
|
|
2728
|
-
|
|
2729
|
-
- `true`: resolves subdomain dynamically from the current host context
|
|
2730
|
-
- `false` / `undefined`: keeps `apiBaseURL` unchanged
|
|
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.
|
|
2731
2729
|
|
|
2732
2730
|
#### Examples
|
|
2733
2731
|
|
|
@@ -2757,25 +2755,12 @@ export class AppModule {}
|
|
|
2757
2755
|
```
|
|
2758
2756
|
|
|
2759
2757
|
```typescript
|
|
2760
|
-
//
|
|
2758
|
+
// Optional static tenant header
|
|
2761
2759
|
@NgModule({
|
|
2762
2760
|
imports: [
|
|
2763
2761
|
NgxHichchiAuthModule.forRoot({
|
|
2764
2762
|
apiBaseURL: "https://api.example.com",
|
|
2765
|
-
|
|
2766
|
-
}),
|
|
2767
|
-
],
|
|
2768
|
-
})
|
|
2769
|
-
export class AppModule {}
|
|
2770
|
-
```
|
|
2771
|
-
|
|
2772
|
-
```typescript
|
|
2773
|
-
// Configuration with dynamic subdomain resolution
|
|
2774
|
-
@NgModule({
|
|
2775
|
-
imports: [
|
|
2776
|
-
NgxHichchiAuthModule.forRoot({
|
|
2777
|
-
apiBaseURL: "https://api.example.com",
|
|
2778
|
-
prependSubdomain: true,
|
|
2763
|
+
tenant: "tenant-a",
|
|
2779
2764
|
}),
|
|
2780
2765
|
],
|
|
2781
2766
|
})
|
|
@@ -2809,21 +2794,14 @@ new NgxHichchiAuthModule(): NgxHichchiAuthModule;
|
|
|
2809
2794
|
static forRoot(config): ModuleWithProviders<NgxHichchiAuthModule>;
|
|
2810
2795
|
```
|
|
2811
2796
|
|
|
2812
|
-
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)
|
|
2813
2798
|
|
|
2814
2799
|
Configures the NgxHichchiAuthModule with the provided authentication configuration
|
|
2815
2800
|
|
|
2816
2801
|
This static method sets up the module with the necessary providers and configuration
|
|
2817
|
-
for authentication functionality.
|
|
2818
|
-
|
|
2819
|
-
|
|
2820
|
-
for the module to function properly.
|
|
2821
|
-
|
|
2822
|
-
`prependSubdomain` behavior:
|
|
2823
|
-
|
|
2824
|
-
- `string`: prepend that subdomain to the API host
|
|
2825
|
-
- `true`: derive subdomain dynamically from the current host context
|
|
2826
|
-
- `false` / `undefined`: do not prepend a subdomain
|
|
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.
|
|
2827
2805
|
|
|
2828
2806
|
###### Parameters
|
|
2829
2807
|
|
|
@@ -2849,7 +2827,7 @@ for the module to function properly.
|
|
|
2849
2827
|
</td>
|
|
2850
2828
|
<td>
|
|
2851
2829
|
|
|
2852
|
-
The authentication configuration object containing API endpoints and settings
|
|
2830
|
+
The authentication configuration object containing API endpoints, tenant, and other settings
|
|
2853
2831
|
|
|
2854
2832
|
</td>
|
|
2855
2833
|
</tr>
|
|
@@ -2880,18 +2858,10 @@ NgxHichchiAuthModule.forRoot({
|
|
|
2880
2858
|
```
|
|
2881
2859
|
|
|
2882
2860
|
```typescript
|
|
2883
|
-
//
|
|
2861
|
+
// Configuration with static tenant
|
|
2884
2862
|
NgxHichchiAuthModule.forRoot({
|
|
2885
2863
|
apiBaseURL: "https://api.example.com",
|
|
2886
|
-
|
|
2887
|
-
});
|
|
2888
|
-
```
|
|
2889
|
-
|
|
2890
|
-
```typescript
|
|
2891
|
-
// Dynamic subdomain
|
|
2892
|
-
NgxHichchiAuthModule.forRoot({
|
|
2893
|
-
apiBaseURL: "https://api.example.com",
|
|
2894
|
-
prependSubdomain: true,
|
|
2864
|
+
tenant: "tenant-a",
|
|
2895
2865
|
});
|
|
2896
2866
|
```
|
|
2897
2867
|
|
|
@@ -2900,13 +2870,13 @@ NgxHichchiAuthModule.forRoot({
|
|
|
2900
2870
|
- [AuthConfig](#authconfig) Interface defining the configuration structure
|
|
2901
2871
|
- AUTH_CONFIG Injection token for the authentication configuration
|
|
2902
2872
|
- [AuthService](#authservice) Service that uses the provided configuration
|
|
2903
|
-
-
|
|
2873
|
+
- TENANT_HEADER_KEY Constant used to attach tenant header to requests
|
|
2904
2874
|
|
|
2905
2875
|
---
|
|
2906
2876
|
|
|
2907
2877
|
### PermissionDirective
|
|
2908
2878
|
|
|
2909
|
-
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)
|
|
2910
2880
|
|
|
2911
2881
|
Angular structural directive for permission-based conditional rendering
|
|
2912
2882
|
|
|
@@ -2973,7 +2943,7 @@ export class UserListComponent {
|
|
|
2973
2943
|
new PermissionDirective(): PermissionDirective;
|
|
2974
2944
|
```
|
|
2975
2945
|
|
|
2976
|
-
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)
|
|
2977
2947
|
|
|
2978
2948
|
Constructor that sets up the permission checking effect
|
|
2979
2949
|
|
|
@@ -3032,7 +3002,7 @@ the specified permissions (OR logic).
|
|
|
3032
3002
|
</td>
|
|
3033
3003
|
<td>
|
|
3034
3004
|
|
|
3035
|
-
[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)
|
|
3036
3006
|
|
|
3037
3007
|
</td>
|
|
3038
3008
|
</tr>
|
|
@@ -3043,7 +3013,7 @@ the specified permissions (OR logic).
|
|
|
3043
3013
|
|
|
3044
3014
|
### AuthGuardCondition
|
|
3045
3015
|
|
|
3046
|
-
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)
|
|
3047
3017
|
|
|
3048
3018
|
Enumeration of authentication guard conditions
|
|
3049
3019
|
|
|
@@ -3108,7 +3078,7 @@ Check if the user has a valid access token
|
|
|
3108
3078
|
</td>
|
|
3109
3079
|
<td>
|
|
3110
3080
|
|
|
3111
|
-
[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)
|
|
3112
3082
|
|
|
3113
3083
|
</td>
|
|
3114
3084
|
</tr>
|
|
@@ -3130,7 +3100,7 @@ Check if the user is signed in to the application
|
|
|
3130
3100
|
</td>
|
|
3131
3101
|
<td>
|
|
3132
3102
|
|
|
3133
|
-
[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)
|
|
3134
3104
|
|
|
3135
3105
|
</td>
|
|
3136
3106
|
</tr>
|
|
@@ -3233,7 +3203,7 @@ const routes: Routes = [
|
|
|
3233
3203
|
function authGuard(options): CanActivateFn;
|
|
3234
3204
|
```
|
|
3235
3205
|
|
|
3236
|
-
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)
|
|
3237
3207
|
|
|
3238
3208
|
Creates an authentication guard function with multiple configuration options
|
|
3239
3209
|
|
|
@@ -3315,7 +3285,7 @@ const routes: Routes = [
|
|
|
3315
3285
|
function authGuard(condition, state, fallbackRedirect): CanActivateFn;
|
|
3316
3286
|
```
|
|
3317
3287
|
|
|
3318
|
-
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)
|
|
3319
3289
|
|
|
3320
3290
|
Creates an authentication guard function with a single condition
|
|
3321
3291
|
|
|
@@ -3430,7 +3400,7 @@ const routes: Routes = [
|
|
|
3430
3400
|
function authInterceptor(redirect, onRedirect?): HttpInterceptorFn;
|
|
3431
3401
|
```
|
|
3432
3402
|
|
|
3433
|
-
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)
|
|
3434
3404
|
|
|
3435
3405
|
Creates an HTTP interceptor for handling authentication tokens and automatic token refresh
|
|
3436
3406
|
|
|
@@ -3564,7 +3534,7 @@ export class AppModule {}
|
|
|
3564
3534
|
function roleGuard(role, options): CanActivateFn;
|
|
3565
3535
|
```
|
|
3566
3536
|
|
|
3567
|
-
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)
|
|
3568
3538
|
|
|
3569
3539
|
Creates a role-based authorization guard function for Angular route protection
|
|
3570
3540
|
|
|
@@ -3693,7 +3663,7 @@ const routes: Routes = [
|
|
|
3693
3663
|
|
|
3694
3664
|
### AuthConfig
|
|
3695
3665
|
|
|
3696
|
-
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)
|
|
3697
3667
|
|
|
3698
3668
|
#### Properties
|
|
3699
3669
|
|
|
@@ -3719,7 +3689,7 @@ Defined in: [libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:3](https:
|
|
|
3719
3689
|
</td>
|
|
3720
3690
|
<td>
|
|
3721
3691
|
|
|
3722
|
-
[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)
|
|
3723
3693
|
|
|
3724
3694
|
</td>
|
|
3725
3695
|
</tr>
|
|
@@ -3736,14 +3706,14 @@ Defined in: [libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:3](https:
|
|
|
3736
3706
|
</td>
|
|
3737
3707
|
<td>
|
|
3738
3708
|
|
|
3739
|
-
[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)
|
|
3740
3710
|
|
|
3741
3711
|
</td>
|
|
3742
3712
|
</tr>
|
|
3743
3713
|
<tr>
|
|
3744
3714
|
<td>
|
|
3745
3715
|
|
|
3746
|
-
<a id="property-
|
|
3716
|
+
<a id="property-splitdomain"></a> `splitDomain?`
|
|
3747
3717
|
|
|
3748
3718
|
</td>
|
|
3749
3719
|
<td>
|
|
@@ -3753,24 +3723,24 @@ Defined in: [libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:3](https:
|
|
|
3753
3723
|
</td>
|
|
3754
3724
|
<td>
|
|
3755
3725
|
|
|
3756
|
-
[libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:
|
|
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)
|
|
3757
3727
|
|
|
3758
3728
|
</td>
|
|
3759
3729
|
</tr>
|
|
3760
3730
|
<tr>
|
|
3761
3731
|
<td>
|
|
3762
3732
|
|
|
3763
|
-
<a id="property-
|
|
3733
|
+
<a id="property-tenant"></a> `tenant?`
|
|
3764
3734
|
|
|
3765
3735
|
</td>
|
|
3766
3736
|
<td>
|
|
3767
3737
|
|
|
3768
|
-
`
|
|
3738
|
+
`TenantSlug`
|
|
3769
3739
|
|
|
3770
3740
|
</td>
|
|
3771
3741
|
<td>
|
|
3772
3742
|
|
|
3773
|
-
[libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:
|
|
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)
|
|
3774
3744
|
|
|
3775
3745
|
</td>
|
|
3776
3746
|
</tr>
|
|
@@ -3781,7 +3751,7 @@ Defined in: [libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:3](https:
|
|
|
3781
3751
|
|
|
3782
3752
|
### AuthFormData
|
|
3783
3753
|
|
|
3784
|
-
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)
|
|
3785
3755
|
|
|
3786
3756
|
Interface for authentication form data
|
|
3787
3757
|
|
|
@@ -3866,7 +3836,7 @@ Authentication field value (email, username, etc.)
|
|
|
3866
3836
|
</td>
|
|
3867
3837
|
<td>
|
|
3868
3838
|
|
|
3869
|
-
[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)
|
|
3870
3840
|
|
|
3871
3841
|
</td>
|
|
3872
3842
|
</tr>
|
|
@@ -3888,7 +3858,7 @@ User's first name
|
|
|
3888
3858
|
</td>
|
|
3889
3859
|
<td>
|
|
3890
3860
|
|
|
3891
|
-
[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)
|
|
3892
3862
|
|
|
3893
3863
|
</td>
|
|
3894
3864
|
</tr>
|
|
@@ -3910,7 +3880,7 @@ User's last name
|
|
|
3910
3880
|
</td>
|
|
3911
3881
|
<td>
|
|
3912
3882
|
|
|
3913
|
-
[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)
|
|
3914
3884
|
|
|
3915
3885
|
</td>
|
|
3916
3886
|
</tr>
|
|
@@ -3932,7 +3902,7 @@ User's password
|
|
|
3932
3902
|
</td>
|
|
3933
3903
|
<td>
|
|
3934
3904
|
|
|
3935
|
-
[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)
|
|
3936
3906
|
|
|
3937
3907
|
</td>
|
|
3938
3908
|
</tr>
|
|
@@ -3943,7 +3913,7 @@ User's password
|
|
|
3943
3913
|
|
|
3944
3914
|
### AuthGuardOption
|
|
3945
3915
|
|
|
3946
|
-
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)
|
|
3947
3917
|
|
|
3948
3918
|
Interface for configuring authentication guard behavior
|
|
3949
3919
|
|
|
@@ -4037,7 +4007,7 @@ The authentication condition to check
|
|
|
4037
4007
|
</td>
|
|
4038
4008
|
<td>
|
|
4039
4009
|
|
|
4040
|
-
[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)
|
|
4041
4011
|
|
|
4042
4012
|
</td>
|
|
4043
4013
|
</tr>
|
|
@@ -4059,7 +4029,7 @@ The route to redirect to if the condition is not met
|
|
|
4059
4029
|
</td>
|
|
4060
4030
|
<td>
|
|
4061
4031
|
|
|
4062
|
-
[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)
|
|
4063
4033
|
|
|
4064
4034
|
</td>
|
|
4065
4035
|
</tr>
|
|
@@ -4081,7 +4051,7 @@ The required state of the condition (true/false)
|
|
|
4081
4051
|
</td>
|
|
4082
4052
|
<td>
|
|
4083
4053
|
|
|
4084
|
-
[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)
|
|
4085
4055
|
|
|
4086
4056
|
</td>
|
|
4087
4057
|
</tr>
|
|
@@ -4092,7 +4062,7 @@ The required state of the condition (true/false)
|
|
|
4092
4062
|
|
|
4093
4063
|
### AuthStateModel
|
|
4094
4064
|
|
|
4095
|
-
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)
|
|
4096
4066
|
|
|
4097
4067
|
Interface defining the authentication state model
|
|
4098
4068
|
|
|
@@ -4182,7 +4152,7 @@ JWT access token for API authentication
|
|
|
4182
4152
|
</td>
|
|
4183
4153
|
<td>
|
|
4184
4154
|
|
|
4185
|
-
[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)
|
|
4186
4156
|
|
|
4187
4157
|
</td>
|
|
4188
4158
|
</tr>
|
|
@@ -4204,7 +4174,7 @@ Expiration date of the access token
|
|
|
4204
4174
|
</td>
|
|
4205
4175
|
<td>
|
|
4206
4176
|
|
|
4207
|
-
[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)
|
|
4208
4178
|
|
|
4209
4179
|
</td>
|
|
4210
4180
|
</tr>
|
|
@@ -4226,7 +4196,7 @@ Expiration date of the access token
|
|
|
4226
4196
|
</td>
|
|
4227
4197
|
<td>
|
|
4228
4198
|
|
|
4229
|
-
[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)
|
|
4230
4200
|
|
|
4231
4201
|
</td>
|
|
4232
4202
|
</tr>
|
|
@@ -4248,7 +4218,7 @@ JWT refresh token for obtaining new access tokens
|
|
|
4248
4218
|
</td>
|
|
4249
4219
|
<td>
|
|
4250
4220
|
|
|
4251
|
-
[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)
|
|
4252
4222
|
|
|
4253
4223
|
</td>
|
|
4254
4224
|
</tr>
|
|
@@ -4270,7 +4240,7 @@ Expiration date of the refresh token
|
|
|
4270
4240
|
</td>
|
|
4271
4241
|
<td>
|
|
4272
4242
|
|
|
4273
|
-
[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)
|
|
4274
4244
|
|
|
4275
4245
|
</td>
|
|
4276
4246
|
</tr>
|
|
@@ -4292,7 +4262,7 @@ Unique identifier for the current session
|
|
|
4292
4262
|
</td>
|
|
4293
4263
|
<td>
|
|
4294
4264
|
|
|
4295
|
-
[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)
|
|
4296
4266
|
|
|
4297
4267
|
</td>
|
|
4298
4268
|
</tr>
|
|
@@ -4314,7 +4284,7 @@ Whether the user is currently signed in
|
|
|
4314
4284
|
</td>
|
|
4315
4285
|
<td>
|
|
4316
4286
|
|
|
4317
|
-
[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)
|
|
4318
4288
|
|
|
4319
4289
|
</td>
|
|
4320
4290
|
</tr>
|
|
@@ -4336,7 +4306,7 @@ Current authenticated user information
|
|
|
4336
4306
|
</td>
|
|
4337
4307
|
<td>
|
|
4338
4308
|
|
|
4339
|
-
[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)
|
|
4340
4310
|
|
|
4341
4311
|
</td>
|
|
4342
4312
|
</tr>
|
|
@@ -4347,7 +4317,7 @@ Current authenticated user information
|
|
|
4347
4317
|
|
|
4348
4318
|
### RoleGuardOption
|
|
4349
4319
|
|
|
4350
|
-
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)
|
|
4351
4321
|
|
|
4352
4322
|
#### Properties
|
|
4353
4323
|
|
|
@@ -4379,7 +4349,7 @@ The route to redirect to if the role exist
|
|
|
4379
4349
|
</td>
|
|
4380
4350
|
<td>
|
|
4381
4351
|
|
|
4382
|
-
[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)
|
|
4383
4353
|
|
|
4384
4354
|
</td>
|
|
4385
4355
|
</tr>
|
|
@@ -4401,7 +4371,7 @@ The required state of the role
|
|
|
4401
4371
|
</td>
|
|
4402
4372
|
<td>
|
|
4403
4373
|
|
|
4404
|
-
[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)
|
|
4405
4375
|
|
|
4406
4376
|
</td>
|
|
4407
4377
|
</tr>
|
|
@@ -4416,7 +4386,7 @@ The required state of the role
|
|
|
4416
4386
|
type AuthState<D, R, P, U> = object;
|
|
4417
4387
|
```
|
|
4418
4388
|
|
|
4419
|
-
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)
|
|
4420
4390
|
|
|
4421
4391
|
Public typed shape of the `AuthState` signal store.
|
|
4422
4392
|
|
|
@@ -4489,7 +4459,7 @@ Public typed shape of the `AuthState` signal store.
|
|
|
4489
4459
|
accessToken: Signal<AccessToken | null>;
|
|
4490
4460
|
```
|
|
4491
4461
|
|
|
4492
|
-
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)
|
|
4493
4463
|
|
|
4494
4464
|
##### accessTokenExpiresOn
|
|
4495
4465
|
|
|
@@ -4497,7 +4467,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:760](https://github.com/h
|
|
|
4497
4467
|
accessTokenExpiresOn: Signal<Date | null>;
|
|
4498
4468
|
```
|
|
4499
4469
|
|
|
4500
|
-
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)
|
|
4501
4471
|
|
|
4502
4472
|
##### authenticateWithToken()
|
|
4503
4473
|
|
|
@@ -4505,7 +4475,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:762](https://github.com/h
|
|
|
4505
4475
|
authenticateWithToken: <AsPromise>(accessToken, redirect?, asPromise?, showError?) => AsPromise extends true ? Promise<AuthResponse> : Observable<AuthResponse>;
|
|
4506
4476
|
```
|
|
4507
4477
|
|
|
4508
|
-
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)
|
|
4509
4479
|
|
|
4510
4480
|
###### Type Parameters
|
|
4511
4481
|
|
|
@@ -4603,7 +4573,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:780](https://github.com/h
|
|
|
4603
4573
|
data: Signal<D>;
|
|
4604
4574
|
```
|
|
4605
4575
|
|
|
4606
|
-
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)
|
|
4607
4577
|
|
|
4608
4578
|
##### emailVerified
|
|
4609
4579
|
|
|
@@ -4611,7 +4581,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:764](https://github.com/h
|
|
|
4611
4581
|
emailVerified: Signal<boolean>;
|
|
4612
4582
|
```
|
|
4613
4583
|
|
|
4614
|
-
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)
|
|
4615
4585
|
|
|
4616
4586
|
##### hasAccessToken
|
|
4617
4587
|
|
|
@@ -4619,7 +4589,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:770](https://github.com/h
|
|
|
4619
4589
|
hasAccessToken: Signal<boolean>;
|
|
4620
4590
|
```
|
|
4621
4591
|
|
|
4622
|
-
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)
|
|
4623
4593
|
|
|
4624
4594
|
##### permissions
|
|
4625
4595
|
|
|
@@ -4627,7 +4597,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:766](https://github.com/h
|
|
|
4627
4597
|
permissions: Signal<P[]>;
|
|
4628
4598
|
```
|
|
4629
4599
|
|
|
4630
|
-
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)
|
|
4631
4601
|
|
|
4632
4602
|
##### refreshToken
|
|
4633
4603
|
|
|
@@ -4635,7 +4605,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:769](https://github.com/h
|
|
|
4635
4605
|
refreshToken: Signal<RefreshToken | null>;
|
|
4636
4606
|
```
|
|
4637
4607
|
|
|
4638
|
-
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)
|
|
4639
4609
|
|
|
4640
4610
|
##### refreshTokenExpiresOn
|
|
4641
4611
|
|
|
@@ -4643,7 +4613,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:761](https://github.com/h
|
|
|
4643
4613
|
refreshTokenExpiresOn: Signal<Date | null>;
|
|
4644
4614
|
```
|
|
4645
4615
|
|
|
4646
|
-
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)
|
|
4647
4617
|
|
|
4648
4618
|
##### reset()
|
|
4649
4619
|
|
|
@@ -4651,7 +4621,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:763](https://github.com/h
|
|
|
4651
4621
|
reset: () => void;
|
|
4652
4622
|
```
|
|
4653
4623
|
|
|
4654
|
-
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)
|
|
4655
4625
|
|
|
4656
4626
|
###### Returns
|
|
4657
4627
|
|
|
@@ -4663,7 +4633,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:772](https://github.com/h
|
|
|
4663
4633
|
role: Signal<U["role"] | null | undefined>;
|
|
4664
4634
|
```
|
|
4665
4635
|
|
|
4666
|
-
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)
|
|
4667
4637
|
|
|
4668
4638
|
##### roleName
|
|
4669
4639
|
|
|
@@ -4671,7 +4641,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:767](https://github.com/h
|
|
|
4671
4641
|
roleName: Signal<R | null | undefined>;
|
|
4672
4642
|
```
|
|
4673
4643
|
|
|
4674
|
-
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)
|
|
4675
4645
|
|
|
4676
4646
|
##### sessionId
|
|
4677
4647
|
|
|
@@ -4679,7 +4649,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:768](https://github.com/h
|
|
|
4679
4649
|
sessionId: Signal<string | null>;
|
|
4680
4650
|
```
|
|
4681
4651
|
|
|
4682
|
-
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)
|
|
4683
4653
|
|
|
4684
4654
|
##### setData()
|
|
4685
4655
|
|
|
@@ -4687,7 +4657,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:758](https://github.com/h
|
|
|
4687
4657
|
setData: (stateData) => void;
|
|
4688
4658
|
```
|
|
4689
4659
|
|
|
4690
|
-
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)
|
|
4691
4661
|
|
|
4692
4662
|
###### Parameters
|
|
4693
4663
|
|
|
@@ -4724,7 +4694,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:791](https://github.com/h
|
|
|
4724
4694
|
setTokens: (tokenResponse) => void;
|
|
4725
4695
|
```
|
|
4726
4696
|
|
|
4727
|
-
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)
|
|
4728
4698
|
|
|
4729
4699
|
###### Parameters
|
|
4730
4700
|
|
|
@@ -4761,7 +4731,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:773](https://github.com/h
|
|
|
4761
4731
|
signedIn: Signal<boolean>;
|
|
4762
4732
|
```
|
|
4763
4733
|
|
|
4764
|
-
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)
|
|
4765
4735
|
|
|
4766
4736
|
##### signIn()
|
|
4767
4737
|
|
|
@@ -4769,7 +4739,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:757](https://github.com/h
|
|
|
4769
4739
|
signIn: <AsPromise>(signInBody, redirect?, asPromise?, showError?) => AsPromise extends true ? Promise<AuthResponse> : Observable<AuthResponse>;
|
|
4770
4740
|
```
|
|
4771
4741
|
|
|
4772
|
-
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)
|
|
4773
4743
|
|
|
4774
4744
|
###### Type Parameters
|
|
4775
4745
|
|
|
@@ -4867,7 +4837,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:774](https://github.com/h
|
|
|
4867
4837
|
signOut: <AsPromise>(redirect?, asPromise?, showError?) => AsPromise extends true ? Promise<SuccessResponse | null> : Observable<SuccessResponse | null>;
|
|
4868
4838
|
```
|
|
4869
4839
|
|
|
4870
|
-
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)
|
|
4871
4841
|
|
|
4872
4842
|
###### Type Parameters
|
|
4873
4843
|
|
|
@@ -4953,7 +4923,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:786](https://github.com/h
|
|
|
4953
4923
|
user: Signal<U | null>;
|
|
4954
4924
|
```
|
|
4955
4925
|
|
|
4956
|
-
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)
|
|
4957
4927
|
|
|
4958
4928
|
## Variables
|
|
4959
4929
|
|
|
@@ -4975,7 +4945,7 @@ const AuthState: Type<
|
|
|
4975
4945
|
>;
|
|
4976
4946
|
```
|
|
4977
4947
|
|
|
4978
|
-
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)
|
|
4979
4949
|
|
|
4980
4950
|
Authentication state management store using NgRx Signals
|
|
4981
4951
|
|
|
@@ -5068,7 +5038,7 @@ export class HeaderComponent {
|
|
|
5068
5038
|
const SKIPPED_ERRORS: ErrorResponseCode[];
|
|
5069
5039
|
```
|
|
5070
5040
|
|
|
5071
|
-
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)
|
|
5072
5042
|
|
|
5073
5043
|
Array of authentication error codes that should trigger token refresh instead of immediate redirect
|
|
5074
5044
|
|