@hichchi/ngx-auth 0.0.3 → 0.0.4
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 +195 -102
- package/fesm2022/hichchi-ngx-auth.mjs +67 -5
- package/fesm2022/hichchi-ngx-auth.mjs.map +1 -1
- package/package.json +5 -5
- package/types/hichchi-ngx-auth.d.ts +65 -2
package/README.md
CHANGED
|
@@ -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/4f0350925a950a3a9e81da44097f63463eade88d/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/4f0350925a950a3a9e81da44097f63463eade88d/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/4f0350925a950a3a9e81da44097f63463eade88d/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/4f0350925a950a3a9e81da44097f63463eade88d/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/4f0350925a950a3a9e81da44097f63463eade88d/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/4f0350925a950a3a9e81da44097f63463eade88d/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/4f0350925a950a3a9e81da44097f63463eade88d/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/4f0350925a950a3a9e81da44097f63463eade88d/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/4f0350925a950a3a9e81da44097f63463eade88d/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/4f0350925a950a3a9e81da44097f63463eade88d/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/4f0350925a950a3a9e81da44097f63463eade88d/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/4f0350925a950a3a9e81da44097f63463eade88d/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/4f0350925a950a3a9e81da44097f63463eade88d/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/4f0350925a950a3a9e81da44097f63463eade88d/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/4f0350925a950a3a9e81da44097f63463eade88d/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/4f0350925a950a3a9e81da44097f63463eade88d/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/4f0350925a950a3a9e81da44097f63463eade88d/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/4f0350925a950a3a9e81da44097f63463eade88d/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/4f0350925a950a3a9e81da44097f63463eade88d/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/4f0350925a950a3a9e81da44097f63463eade88d/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/4f0350925a950a3a9e81da44097f63463eade88d/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/4f0350925a950a3a9e81da44097f63463eade88d/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/4f0350925a950a3a9e81da44097f63463eade88d/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:93](https://github.com/hichchidev/hichchi/blob/
|
|
948
|
+
Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:93](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-utils/src/lib/services/crud-http.service.ts#L93)
|
|
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:95](https://github.com/hichchidev/hichchi/blob/
|
|
1028
|
+
Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:95](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-utils/src/lib/services/crud-http.service.ts#L95)
|
|
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:46](https://github.com/hichchidev/hichchi/blob/
|
|
1110
|
+
Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:46](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-utils/src/lib/services/crud-http.service.ts#L46)
|
|
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:48](https://github.com/hichchidev/hichchi/blob/
|
|
1190
|
+
Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:48](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-utils/src/lib/services/crud-http.service.ts#L48)
|
|
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:263](https://github.com/hichchidev/hichchi/blob/
|
|
1270
|
+
Defined in: [libs/ngx-auth/src/lib/services/auth.service.ts:263](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/services/auth.service.ts#L263)
|
|
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/4f0350925a950a3a9e81da44097f63463eade88d/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:81](https://github.com/hichchidev/hichchi/blob/
|
|
1443
|
+
Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:81](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-utils/src/lib/services/crud-http.service.ts#L81)
|
|
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:83](https://github.com/hichchidev/hichchi/blob/
|
|
1550
|
+
Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:83](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-utils/src/lib/services/crud-http.service.ts#L83)
|
|
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:57](https://github.com/hichchidev/hichchi/blob/
|
|
1659
|
+
Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:57](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-utils/src/lib/services/crud-http.service.ts#L57)
|
|
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:59](https://github.com/hichchidev/hichchi/blob/
|
|
1766
|
+
Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:59](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-utils/src/lib/services/crud-http.service.ts#L59)
|
|
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:69](https://github.com/hichchidev/hichchi/blob/
|
|
1875
|
+
Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:69](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-utils/src/lib/services/crud-http.service.ts#L69)
|
|
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:71](https://github.com/hichchidev/hichchi/blob/
|
|
1982
|
+
Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:71](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-utils/src/lib/services/crud-http.service.ts#L71)
|
|
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:369](https://github.com/hichchidev/hichchi/blob/
|
|
2086
|
+
Defined in: [libs/ngx-auth/src/lib/services/auth.service.ts:369](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/services/auth.service.ts#L369)
|
|
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:21](https://github.com/hichchidev/hichchi/blob/
|
|
2190
|
+
Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:21](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-utils/src/lib/services/crud-http.service.ts#L21)
|
|
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/4f0350925a950a3a9e81da44097f63463eade88d/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:437](https://github.com/hichchidev/hichchi/blob/
|
|
2400
|
+
Defined in: [libs/ngx-auth/src/lib/services/auth.service.ts:437](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/services/auth.service.ts#L437)
|
|
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:323](https://github.com/hichchidev/hichchi/blob/
|
|
2499
|
+
Defined in: [libs/ngx-auth/src/lib/services/auth.service.ts:323](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/services/auth.service.ts#L323)
|
|
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:104](https://github.com/hichchidev/hichchi/blob/
|
|
2602
|
+
Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:104](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-utils/src/lib/services/crud-http.service.ts#L104)
|
|
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:19](https://github.com/hichchidev/hichchi/blob/
|
|
2696
|
+
[libs/ngx-utils/src/lib/services/crud-http.service.ts:19](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-utils/src/lib/services/crud-http.service.ts#L19)
|
|
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:110](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/auth.module.ts#L110)
|
|
2708
2708
|
|
|
2709
2709
|
Angular module for authentication functionality
|
|
2710
2710
|
|
|
@@ -2721,6 +2721,14 @@ 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
|
+
API base URL handling:
|
|
2725
|
+
|
|
2726
|
+
- `apiBaseURL` defines the base API host for auth requests.
|
|
2727
|
+
- Optional `prependSubdomain` lets you prepend a subdomain to `apiBaseURL`.
|
|
2728
|
+
- `string`: uses the provided subdomain
|
|
2729
|
+
- `true`: resolves subdomain dynamically from the current host context
|
|
2730
|
+
- `false` / `undefined`: keeps `apiBaseURL` unchanged
|
|
2731
|
+
|
|
2724
2732
|
#### Examples
|
|
2725
2733
|
|
|
2726
2734
|
```typescript
|
|
@@ -2748,6 +2756,32 @@ export class AppModule {}
|
|
|
2748
2756
|
export class AppModule {}
|
|
2749
2757
|
```
|
|
2750
2758
|
|
|
2759
|
+
```typescript
|
|
2760
|
+
// Configuration with a static subdomain
|
|
2761
|
+
@NgModule({
|
|
2762
|
+
imports: [
|
|
2763
|
+
NgxHichchiAuthModule.forRoot({
|
|
2764
|
+
apiBaseURL: "https://api.example.com",
|
|
2765
|
+
prependSubdomain: "tenant-a",
|
|
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,
|
|
2779
|
+
}),
|
|
2780
|
+
],
|
|
2781
|
+
})
|
|
2782
|
+
export class AppModule {}
|
|
2783
|
+
```
|
|
2784
|
+
|
|
2751
2785
|
#### See
|
|
2752
2786
|
|
|
2753
2787
|
- [AuthConfig](#authconfig) Configuration interface for the authentication module
|
|
@@ -2775,13 +2809,21 @@ new NgxHichchiAuthModule(): NgxHichchiAuthModule;
|
|
|
2775
2809
|
static forRoot(config): ModuleWithProviders<NgxHichchiAuthModule>;
|
|
2776
2810
|
```
|
|
2777
2811
|
|
|
2778
|
-
Defined in: [libs/ngx-auth/src/lib/auth.module.ts:
|
|
2812
|
+
Defined in: [libs/ngx-auth/src/lib/auth.module.ts:168](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/auth.module.ts#L168)
|
|
2779
2813
|
|
|
2780
2814
|
Configures the NgxHichchiAuthModule with the provided authentication configuration
|
|
2781
2815
|
|
|
2782
2816
|
This static method sets up the module with the necessary providers and configuration
|
|
2783
|
-
for authentication functionality.
|
|
2784
|
-
|
|
2817
|
+
for authentication functionality. Before providers are created, `apiBaseURL` is normalized
|
|
2818
|
+
through `prependSubdomainToApi(config.apiBaseURL, config.prependSubdomain)`.
|
|
2819
|
+
It then provides the AuthService and authentication configuration token required
|
|
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
|
|
2785
2827
|
|
|
2786
2828
|
###### Parameters
|
|
2787
2829
|
|
|
@@ -2837,17 +2879,34 @@ NgxHichchiAuthModule.forRoot({
|
|
|
2837
2879
|
});
|
|
2838
2880
|
```
|
|
2839
2881
|
|
|
2882
|
+
```typescript
|
|
2883
|
+
// Static subdomain
|
|
2884
|
+
NgxHichchiAuthModule.forRoot({
|
|
2885
|
+
apiBaseURL: "https://api.example.com",
|
|
2886
|
+
prependSubdomain: "tenant-a",
|
|
2887
|
+
});
|
|
2888
|
+
```
|
|
2889
|
+
|
|
2890
|
+
```typescript
|
|
2891
|
+
// Dynamic subdomain
|
|
2892
|
+
NgxHichchiAuthModule.forRoot({
|
|
2893
|
+
apiBaseURL: "https://api.example.com",
|
|
2894
|
+
prependSubdomain: true,
|
|
2895
|
+
});
|
|
2896
|
+
```
|
|
2897
|
+
|
|
2840
2898
|
###### See
|
|
2841
2899
|
|
|
2842
2900
|
- [AuthConfig](#authconfig) Interface defining the configuration structure
|
|
2843
2901
|
- AUTH_CONFIG Injection token for the authentication configuration
|
|
2844
2902
|
- [AuthService](#authservice) Service that uses the provided configuration
|
|
2903
|
+
- prependSubdomainToUrlBrowser Utility used to transform `apiBaseURL`
|
|
2845
2904
|
|
|
2846
2905
|
---
|
|
2847
2906
|
|
|
2848
2907
|
### PermissionDirective
|
|
2849
2908
|
|
|
2850
|
-
Defined in: [libs/ngx-auth/src/lib/directives/permission.directive.ts:67](https://github.com/hichchidev/hichchi/blob/
|
|
2909
|
+
Defined in: [libs/ngx-auth/src/lib/directives/permission.directive.ts:67](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/directives/permission.directive.ts#L67)
|
|
2851
2910
|
|
|
2852
2911
|
Angular structural directive for permission-based conditional rendering
|
|
2853
2912
|
|
|
@@ -2914,7 +2973,7 @@ export class UserListComponent {
|
|
|
2914
2973
|
new PermissionDirective(): PermissionDirective;
|
|
2915
2974
|
```
|
|
2916
2975
|
|
|
2917
|
-
Defined in: [libs/ngx-auth/src/lib/directives/permission.directive.ts:114](https://github.com/hichchidev/hichchi/blob/
|
|
2976
|
+
Defined in: [libs/ngx-auth/src/lib/directives/permission.directive.ts:114](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/directives/permission.directive.ts#L114)
|
|
2918
2977
|
|
|
2919
2978
|
Constructor that sets up the permission checking effect
|
|
2920
2979
|
|
|
@@ -2973,7 +3032,7 @@ the specified permissions (OR logic).
|
|
|
2973
3032
|
</td>
|
|
2974
3033
|
<td>
|
|
2975
3034
|
|
|
2976
|
-
[libs/ngx-auth/src/lib/directives/permission.directive.ts:105](https://github.com/hichchidev/hichchi/blob/
|
|
3035
|
+
[libs/ngx-auth/src/lib/directives/permission.directive.ts:105](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/directives/permission.directive.ts#L105)
|
|
2977
3036
|
|
|
2978
3037
|
</td>
|
|
2979
3038
|
</tr>
|
|
@@ -2984,7 +3043,7 @@ the specified permissions (OR logic).
|
|
|
2984
3043
|
|
|
2985
3044
|
### AuthGuardCondition
|
|
2986
3045
|
|
|
2987
|
-
Defined in: [libs/ngx-auth/src/lib/enums/auth-guard-condition.enum.ts:33](https://github.com/hichchidev/hichchi/blob/
|
|
3046
|
+
Defined in: [libs/ngx-auth/src/lib/enums/auth-guard-condition.enum.ts:33](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/enums/auth-guard-condition.enum.ts#L33)
|
|
2988
3047
|
|
|
2989
3048
|
Enumeration of authentication guard conditions
|
|
2990
3049
|
|
|
@@ -3049,7 +3108,7 @@ Check if the user has a valid access token
|
|
|
3049
3108
|
</td>
|
|
3050
3109
|
<td>
|
|
3051
3110
|
|
|
3052
|
-
[libs/ngx-auth/src/lib/enums/auth-guard-condition.enum.ts:37](https://github.com/hichchidev/hichchi/blob/
|
|
3111
|
+
[libs/ngx-auth/src/lib/enums/auth-guard-condition.enum.ts:37](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/enums/auth-guard-condition.enum.ts#L37)
|
|
3053
3112
|
|
|
3054
3113
|
</td>
|
|
3055
3114
|
</tr>
|
|
@@ -3071,7 +3130,7 @@ Check if the user is signed in to the application
|
|
|
3071
3130
|
</td>
|
|
3072
3131
|
<td>
|
|
3073
3132
|
|
|
3074
|
-
[libs/ngx-auth/src/lib/enums/auth-guard-condition.enum.ts:35](https://github.com/hichchidev/hichchi/blob/
|
|
3133
|
+
[libs/ngx-auth/src/lib/enums/auth-guard-condition.enum.ts:35](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/enums/auth-guard-condition.enum.ts#L35)
|
|
3075
3134
|
|
|
3076
3135
|
</td>
|
|
3077
3136
|
</tr>
|
|
@@ -3174,7 +3233,7 @@ const routes: Routes = [
|
|
|
3174
3233
|
function authGuard(options): CanActivateFn;
|
|
3175
3234
|
```
|
|
3176
3235
|
|
|
3177
|
-
Defined in: [libs/ngx-auth/src/lib/guards/auth.guard.ts:37](https://github.com/hichchidev/hichchi/blob/
|
|
3236
|
+
Defined in: [libs/ngx-auth/src/lib/guards/auth.guard.ts:37](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/guards/auth.guard.ts#L37)
|
|
3178
3237
|
|
|
3179
3238
|
Creates an authentication guard function with multiple configuration options
|
|
3180
3239
|
|
|
@@ -3256,7 +3315,7 @@ const routes: Routes = [
|
|
|
3256
3315
|
function authGuard(condition, state, fallbackRedirect): CanActivateFn;
|
|
3257
3316
|
```
|
|
3258
3317
|
|
|
3259
|
-
Defined in: [libs/ngx-auth/src/lib/guards/auth.guard.ts:77](https://github.com/hichchidev/hichchi/blob/
|
|
3318
|
+
Defined in: [libs/ngx-auth/src/lib/guards/auth.guard.ts:77](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/guards/auth.guard.ts#L77)
|
|
3260
3319
|
|
|
3261
3320
|
Creates an authentication guard function with a single condition
|
|
3262
3321
|
|
|
@@ -3371,7 +3430,7 @@ const routes: Routes = [
|
|
|
3371
3430
|
function authInterceptor(redirect, onRedirect?): HttpInterceptorFn;
|
|
3372
3431
|
```
|
|
3373
3432
|
|
|
3374
|
-
Defined in: [libs/ngx-auth/src/lib/interceptors/auth.interceptor.ts:167](https://github.com/hichchidev/hichchi/blob/
|
|
3433
|
+
Defined in: [libs/ngx-auth/src/lib/interceptors/auth.interceptor.ts:167](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/interceptors/auth.interceptor.ts#L167)
|
|
3375
3434
|
|
|
3376
3435
|
Creates an HTTP interceptor for handling authentication tokens and automatic token refresh
|
|
3377
3436
|
|
|
@@ -3505,7 +3564,7 @@ export class AppModule {}
|
|
|
3505
3564
|
function roleGuard(role, options): CanActivateFn;
|
|
3506
3565
|
```
|
|
3507
3566
|
|
|
3508
|
-
Defined in: [libs/ngx-auth/src/lib/guards/role.guard.ts:76](https://github.com/hichchidev/hichchi/blob/
|
|
3567
|
+
Defined in: [libs/ngx-auth/src/lib/guards/role.guard.ts:76](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/guards/role.guard.ts#L76)
|
|
3509
3568
|
|
|
3510
3569
|
Creates a role-based authorization guard function for Angular route protection
|
|
3511
3570
|
|
|
@@ -3634,7 +3693,7 @@ const routes: Routes = [
|
|
|
3634
3693
|
|
|
3635
3694
|
### AuthConfig
|
|
3636
3695
|
|
|
3637
|
-
Defined in: [libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:3](https://github.com/hichchidev/hichchi/blob/
|
|
3696
|
+
Defined in: [libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:3](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts#L3)
|
|
3638
3697
|
|
|
3639
3698
|
#### Properties
|
|
3640
3699
|
|
|
@@ -3660,7 +3719,7 @@ Defined in: [libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:3](https:
|
|
|
3660
3719
|
</td>
|
|
3661
3720
|
<td>
|
|
3662
3721
|
|
|
3663
|
-
[libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:5](https://github.com/hichchidev/hichchi/blob/
|
|
3722
|
+
[libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:5](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts#L5)
|
|
3664
3723
|
|
|
3665
3724
|
</td>
|
|
3666
3725
|
</tr>
|
|
@@ -3677,7 +3736,41 @@ Defined in: [libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:3](https:
|
|
|
3677
3736
|
</td>
|
|
3678
3737
|
<td>
|
|
3679
3738
|
|
|
3680
|
-
[libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:4](https://github.com/hichchidev/hichchi/blob/
|
|
3739
|
+
[libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:4](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts#L4)
|
|
3740
|
+
|
|
3741
|
+
</td>
|
|
3742
|
+
</tr>
|
|
3743
|
+
<tr>
|
|
3744
|
+
<td>
|
|
3745
|
+
|
|
3746
|
+
<a id="property-devsubdomain"></a> `devSubdomain?`
|
|
3747
|
+
|
|
3748
|
+
</td>
|
|
3749
|
+
<td>
|
|
3750
|
+
|
|
3751
|
+
`string`
|
|
3752
|
+
|
|
3753
|
+
</td>
|
|
3754
|
+
<td>
|
|
3755
|
+
|
|
3756
|
+
[libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:7](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts#L7)
|
|
3757
|
+
|
|
3758
|
+
</td>
|
|
3759
|
+
</tr>
|
|
3760
|
+
<tr>
|
|
3761
|
+
<td>
|
|
3762
|
+
|
|
3763
|
+
<a id="property-splitdomain"></a> `splitDomain?`
|
|
3764
|
+
|
|
3765
|
+
</td>
|
|
3766
|
+
<td>
|
|
3767
|
+
|
|
3768
|
+
`string`
|
|
3769
|
+
|
|
3770
|
+
</td>
|
|
3771
|
+
<td>
|
|
3772
|
+
|
|
3773
|
+
[libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:6](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts#L6)
|
|
3681
3774
|
|
|
3682
3775
|
</td>
|
|
3683
3776
|
</tr>
|
|
@@ -3688,7 +3781,7 @@ Defined in: [libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:3](https:
|
|
|
3688
3781
|
|
|
3689
3782
|
### AuthFormData
|
|
3690
3783
|
|
|
3691
|
-
Defined in: [libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts:52](https://github.com/hichchidev/hichchi/blob/
|
|
3784
|
+
Defined in: [libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts:52](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts#L52)
|
|
3692
3785
|
|
|
3693
3786
|
Interface for authentication form data
|
|
3694
3787
|
|
|
@@ -3773,7 +3866,7 @@ Authentication field value (email, username, etc.)
|
|
|
3773
3866
|
</td>
|
|
3774
3867
|
<td>
|
|
3775
3868
|
|
|
3776
|
-
[libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts:58](https://github.com/hichchidev/hichchi/blob/
|
|
3869
|
+
[libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts:58](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts#L58)
|
|
3777
3870
|
|
|
3778
3871
|
</td>
|
|
3779
3872
|
</tr>
|
|
@@ -3795,7 +3888,7 @@ User's first name
|
|
|
3795
3888
|
</td>
|
|
3796
3889
|
<td>
|
|
3797
3890
|
|
|
3798
|
-
[libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts:54](https://github.com/hichchidev/hichchi/blob/
|
|
3891
|
+
[libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts:54](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts#L54)
|
|
3799
3892
|
|
|
3800
3893
|
</td>
|
|
3801
3894
|
</tr>
|
|
@@ -3817,7 +3910,7 @@ User's last name
|
|
|
3817
3910
|
</td>
|
|
3818
3911
|
<td>
|
|
3819
3912
|
|
|
3820
|
-
[libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts:56](https://github.com/hichchidev/hichchi/blob/
|
|
3913
|
+
[libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts:56](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts#L56)
|
|
3821
3914
|
|
|
3822
3915
|
</td>
|
|
3823
3916
|
</tr>
|
|
@@ -3839,7 +3932,7 @@ User's password
|
|
|
3839
3932
|
</td>
|
|
3840
3933
|
<td>
|
|
3841
3934
|
|
|
3842
|
-
[libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts:60](https://github.com/hichchidev/hichchi/blob/
|
|
3935
|
+
[libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts:60](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts#L60)
|
|
3843
3936
|
|
|
3844
3937
|
</td>
|
|
3845
3938
|
</tr>
|
|
@@ -3850,7 +3943,7 @@ User's password
|
|
|
3850
3943
|
|
|
3851
3944
|
### AuthGuardOption
|
|
3852
3945
|
|
|
3853
|
-
Defined in: [libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts:66](https://github.com/hichchidev/hichchi/blob/
|
|
3946
|
+
Defined in: [libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts:66](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts#L66)
|
|
3854
3947
|
|
|
3855
3948
|
Interface for configuring authentication guard behavior
|
|
3856
3949
|
|
|
@@ -3944,7 +4037,7 @@ The authentication condition to check
|
|
|
3944
4037
|
</td>
|
|
3945
4038
|
<td>
|
|
3946
4039
|
|
|
3947
|
-
[libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts:68](https://github.com/hichchidev/hichchi/blob/
|
|
4040
|
+
[libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts:68](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts#L68)
|
|
3948
4041
|
|
|
3949
4042
|
</td>
|
|
3950
4043
|
</tr>
|
|
@@ -3966,7 +4059,7 @@ The route to redirect to if the condition is not met
|
|
|
3966
4059
|
</td>
|
|
3967
4060
|
<td>
|
|
3968
4061
|
|
|
3969
|
-
[libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts:72](https://github.com/hichchidev/hichchi/blob/
|
|
4062
|
+
[libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts:72](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts#L72)
|
|
3970
4063
|
|
|
3971
4064
|
</td>
|
|
3972
4065
|
</tr>
|
|
@@ -3988,7 +4081,7 @@ The required state of the condition (true/false)
|
|
|
3988
4081
|
</td>
|
|
3989
4082
|
<td>
|
|
3990
4083
|
|
|
3991
|
-
[libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts:70](https://github.com/hichchidev/hichchi/blob/
|
|
4084
|
+
[libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts:70](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts#L70)
|
|
3992
4085
|
|
|
3993
4086
|
</td>
|
|
3994
4087
|
</tr>
|
|
@@ -3999,7 +4092,7 @@ The required state of the condition (true/false)
|
|
|
3999
4092
|
|
|
4000
4093
|
### AuthStateModel
|
|
4001
4094
|
|
|
4002
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:57](https://github.com/hichchidev/hichchi/blob/
|
|
4095
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:57](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/state/auth.state.ts#L57)
|
|
4003
4096
|
|
|
4004
4097
|
Interface defining the authentication state model
|
|
4005
4098
|
|
|
@@ -4089,7 +4182,7 @@ JWT access token for API authentication
|
|
|
4089
4182
|
</td>
|
|
4090
4183
|
<td>
|
|
4091
4184
|
|
|
4092
|
-
[libs/ngx-auth/src/lib/state/auth.state.ts:65](https://github.com/hichchidev/hichchi/blob/
|
|
4185
|
+
[libs/ngx-auth/src/lib/state/auth.state.ts:65](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/state/auth.state.ts#L65)
|
|
4093
4186
|
|
|
4094
4187
|
</td>
|
|
4095
4188
|
</tr>
|
|
@@ -4111,7 +4204,7 @@ Expiration date of the access token
|
|
|
4111
4204
|
</td>
|
|
4112
4205
|
<td>
|
|
4113
4206
|
|
|
4114
|
-
[libs/ngx-auth/src/lib/state/auth.state.ts:69](https://github.com/hichchidev/hichchi/blob/
|
|
4207
|
+
[libs/ngx-auth/src/lib/state/auth.state.ts:69](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/state/auth.state.ts#L69)
|
|
4115
4208
|
|
|
4116
4209
|
</td>
|
|
4117
4210
|
</tr>
|
|
@@ -4133,7 +4226,7 @@ Expiration date of the access token
|
|
|
4133
4226
|
</td>
|
|
4134
4227
|
<td>
|
|
4135
4228
|
|
|
4136
|
-
[libs/ngx-auth/src/lib/state/auth.state.ts:73](https://github.com/hichchidev/hichchi/blob/
|
|
4229
|
+
[libs/ngx-auth/src/lib/state/auth.state.ts:73](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/state/auth.state.ts#L73)
|
|
4137
4230
|
|
|
4138
4231
|
</td>
|
|
4139
4232
|
</tr>
|
|
@@ -4155,7 +4248,7 @@ JWT refresh token for obtaining new access tokens
|
|
|
4155
4248
|
</td>
|
|
4156
4249
|
<td>
|
|
4157
4250
|
|
|
4158
|
-
[libs/ngx-auth/src/lib/state/auth.state.ts:67](https://github.com/hichchidev/hichchi/blob/
|
|
4251
|
+
[libs/ngx-auth/src/lib/state/auth.state.ts:67](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/state/auth.state.ts#L67)
|
|
4159
4252
|
|
|
4160
4253
|
</td>
|
|
4161
4254
|
</tr>
|
|
@@ -4177,7 +4270,7 @@ Expiration date of the refresh token
|
|
|
4177
4270
|
</td>
|
|
4178
4271
|
<td>
|
|
4179
4272
|
|
|
4180
|
-
[libs/ngx-auth/src/lib/state/auth.state.ts:71](https://github.com/hichchidev/hichchi/blob/
|
|
4273
|
+
[libs/ngx-auth/src/lib/state/auth.state.ts:71](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/state/auth.state.ts#L71)
|
|
4181
4274
|
|
|
4182
4275
|
</td>
|
|
4183
4276
|
</tr>
|
|
@@ -4199,7 +4292,7 @@ Unique identifier for the current session
|
|
|
4199
4292
|
</td>
|
|
4200
4293
|
<td>
|
|
4201
4294
|
|
|
4202
|
-
[libs/ngx-auth/src/lib/state/auth.state.ts:61](https://github.com/hichchidev/hichchi/blob/
|
|
4295
|
+
[libs/ngx-auth/src/lib/state/auth.state.ts:61](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/state/auth.state.ts#L61)
|
|
4203
4296
|
|
|
4204
4297
|
</td>
|
|
4205
4298
|
</tr>
|
|
@@ -4221,7 +4314,7 @@ Whether the user is currently signed in
|
|
|
4221
4314
|
</td>
|
|
4222
4315
|
<td>
|
|
4223
4316
|
|
|
4224
|
-
[libs/ngx-auth/src/lib/state/auth.state.ts:59](https://github.com/hichchidev/hichchi/blob/
|
|
4317
|
+
[libs/ngx-auth/src/lib/state/auth.state.ts:59](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/state/auth.state.ts#L59)
|
|
4225
4318
|
|
|
4226
4319
|
</td>
|
|
4227
4320
|
</tr>
|
|
@@ -4243,7 +4336,7 @@ Current authenticated user information
|
|
|
4243
4336
|
</td>
|
|
4244
4337
|
<td>
|
|
4245
4338
|
|
|
4246
|
-
[libs/ngx-auth/src/lib/state/auth.state.ts:63](https://github.com/hichchidev/hichchi/blob/
|
|
4339
|
+
[libs/ngx-auth/src/lib/state/auth.state.ts:63](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/state/auth.state.ts#L63)
|
|
4247
4340
|
|
|
4248
4341
|
</td>
|
|
4249
4342
|
</tr>
|
|
@@ -4254,7 +4347,7 @@ Current authenticated user information
|
|
|
4254
4347
|
|
|
4255
4348
|
### RoleGuardOption
|
|
4256
4349
|
|
|
4257
|
-
Defined in: [libs/ngx-auth/src/lib/interfaces/role-guard-option.interface.ts:1](https://github.com/hichchidev/hichchi/blob/
|
|
4350
|
+
Defined in: [libs/ngx-auth/src/lib/interfaces/role-guard-option.interface.ts:1](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/interfaces/role-guard-option.interface.ts#L1)
|
|
4258
4351
|
|
|
4259
4352
|
#### Properties
|
|
4260
4353
|
|
|
@@ -4286,7 +4379,7 @@ The route to redirect to if the role exist
|
|
|
4286
4379
|
</td>
|
|
4287
4380
|
<td>
|
|
4288
4381
|
|
|
4289
|
-
[libs/ngx-auth/src/lib/interfaces/role-guard-option.interface.ts:5](https://github.com/hichchidev/hichchi/blob/
|
|
4382
|
+
[libs/ngx-auth/src/lib/interfaces/role-guard-option.interface.ts:5](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/interfaces/role-guard-option.interface.ts#L5)
|
|
4290
4383
|
|
|
4291
4384
|
</td>
|
|
4292
4385
|
</tr>
|
|
@@ -4308,7 +4401,7 @@ The required state of the role
|
|
|
4308
4401
|
</td>
|
|
4309
4402
|
<td>
|
|
4310
4403
|
|
|
4311
|
-
[libs/ngx-auth/src/lib/interfaces/role-guard-option.interface.ts:3](https://github.com/hichchidev/hichchi/blob/
|
|
4404
|
+
[libs/ngx-auth/src/lib/interfaces/role-guard-option.interface.ts:3](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/interfaces/role-guard-option.interface.ts#L3)
|
|
4312
4405
|
|
|
4313
4406
|
</td>
|
|
4314
4407
|
</tr>
|
|
@@ -4323,7 +4416,7 @@ The required state of the role
|
|
|
4323
4416
|
type AuthState<D, R, P, U> = object;
|
|
4324
4417
|
```
|
|
4325
4418
|
|
|
4326
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:164](https://github.com/hichchidev/hichchi/blob/
|
|
4419
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:164](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/state/auth.state.ts#L164)
|
|
4327
4420
|
|
|
4328
4421
|
Public typed shape of the `AuthState` signal store.
|
|
4329
4422
|
|
|
@@ -4396,7 +4489,7 @@ Public typed shape of the `AuthState` signal store.
|
|
|
4396
4489
|
accessToken: Signal<AccessToken | null>;
|
|
4397
4490
|
```
|
|
4398
4491
|
|
|
4399
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:760](https://github.com/hichchidev/hichchi/blob/
|
|
4492
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:760](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/state/auth.state.ts#L760)
|
|
4400
4493
|
|
|
4401
4494
|
##### accessTokenExpiresOn
|
|
4402
4495
|
|
|
@@ -4404,7 +4497,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:760](https://github.com/h
|
|
|
4404
4497
|
accessTokenExpiresOn: Signal<Date | null>;
|
|
4405
4498
|
```
|
|
4406
4499
|
|
|
4407
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:762](https://github.com/hichchidev/hichchi/blob/
|
|
4500
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:762](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/state/auth.state.ts#L762)
|
|
4408
4501
|
|
|
4409
4502
|
##### authenticateWithToken()
|
|
4410
4503
|
|
|
@@ -4412,7 +4505,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:762](https://github.com/h
|
|
|
4412
4505
|
authenticateWithToken: <AsPromise>(accessToken, redirect?, asPromise?, showError?) => AsPromise extends true ? Promise<AuthResponse> : Observable<AuthResponse>;
|
|
4413
4506
|
```
|
|
4414
4507
|
|
|
4415
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:780](https://github.com/hichchidev/hichchi/blob/
|
|
4508
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:780](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/state/auth.state.ts#L780)
|
|
4416
4509
|
|
|
4417
4510
|
###### Type Parameters
|
|
4418
4511
|
|
|
@@ -4510,7 +4603,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:780](https://github.com/h
|
|
|
4510
4603
|
data: Signal<D>;
|
|
4511
4604
|
```
|
|
4512
4605
|
|
|
4513
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:764](https://github.com/hichchidev/hichchi/blob/
|
|
4606
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:764](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/state/auth.state.ts#L764)
|
|
4514
4607
|
|
|
4515
4608
|
##### emailVerified
|
|
4516
4609
|
|
|
@@ -4518,7 +4611,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:764](https://github.com/h
|
|
|
4518
4611
|
emailVerified: Signal<boolean>;
|
|
4519
4612
|
```
|
|
4520
4613
|
|
|
4521
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:770](https://github.com/hichchidev/hichchi/blob/
|
|
4614
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:770](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/state/auth.state.ts#L770)
|
|
4522
4615
|
|
|
4523
4616
|
##### hasAccessToken
|
|
4524
4617
|
|
|
@@ -4526,7 +4619,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:770](https://github.com/h
|
|
|
4526
4619
|
hasAccessToken: Signal<boolean>;
|
|
4527
4620
|
```
|
|
4528
4621
|
|
|
4529
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:766](https://github.com/hichchidev/hichchi/blob/
|
|
4622
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:766](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/state/auth.state.ts#L766)
|
|
4530
4623
|
|
|
4531
4624
|
##### permissions
|
|
4532
4625
|
|
|
@@ -4534,7 +4627,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:766](https://github.com/h
|
|
|
4534
4627
|
permissions: Signal<P[]>;
|
|
4535
4628
|
```
|
|
4536
4629
|
|
|
4537
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:769](https://github.com/hichchidev/hichchi/blob/
|
|
4630
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:769](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/state/auth.state.ts#L769)
|
|
4538
4631
|
|
|
4539
4632
|
##### refreshToken
|
|
4540
4633
|
|
|
@@ -4542,7 +4635,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:769](https://github.com/h
|
|
|
4542
4635
|
refreshToken: Signal<RefreshToken | null>;
|
|
4543
4636
|
```
|
|
4544
4637
|
|
|
4545
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:761](https://github.com/hichchidev/hichchi/blob/
|
|
4638
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:761](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/state/auth.state.ts#L761)
|
|
4546
4639
|
|
|
4547
4640
|
##### refreshTokenExpiresOn
|
|
4548
4641
|
|
|
@@ -4550,7 +4643,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:761](https://github.com/h
|
|
|
4550
4643
|
refreshTokenExpiresOn: Signal<Date | null>;
|
|
4551
4644
|
```
|
|
4552
4645
|
|
|
4553
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:763](https://github.com/hichchidev/hichchi/blob/
|
|
4646
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:763](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/state/auth.state.ts#L763)
|
|
4554
4647
|
|
|
4555
4648
|
##### reset()
|
|
4556
4649
|
|
|
@@ -4558,7 +4651,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:763](https://github.com/h
|
|
|
4558
4651
|
reset: () => void;
|
|
4559
4652
|
```
|
|
4560
4653
|
|
|
4561
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:772](https://github.com/hichchidev/hichchi/blob/
|
|
4654
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:772](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/state/auth.state.ts#L772)
|
|
4562
4655
|
|
|
4563
4656
|
###### Returns
|
|
4564
4657
|
|
|
@@ -4570,7 +4663,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:772](https://github.com/h
|
|
|
4570
4663
|
role: Signal<U["role"] | null | undefined>;
|
|
4571
4664
|
```
|
|
4572
4665
|
|
|
4573
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:767](https://github.com/hichchidev/hichchi/blob/
|
|
4666
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:767](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/state/auth.state.ts#L767)
|
|
4574
4667
|
|
|
4575
4668
|
##### roleName
|
|
4576
4669
|
|
|
@@ -4578,7 +4671,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:767](https://github.com/h
|
|
|
4578
4671
|
roleName: Signal<R | null | undefined>;
|
|
4579
4672
|
```
|
|
4580
4673
|
|
|
4581
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:768](https://github.com/hichchidev/hichchi/blob/
|
|
4674
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:768](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/state/auth.state.ts#L768)
|
|
4582
4675
|
|
|
4583
4676
|
##### sessionId
|
|
4584
4677
|
|
|
@@ -4586,7 +4679,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:768](https://github.com/h
|
|
|
4586
4679
|
sessionId: Signal<string | null>;
|
|
4587
4680
|
```
|
|
4588
4681
|
|
|
4589
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:758](https://github.com/hichchidev/hichchi/blob/
|
|
4682
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:758](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/state/auth.state.ts#L758)
|
|
4590
4683
|
|
|
4591
4684
|
##### setData()
|
|
4592
4685
|
|
|
@@ -4594,7 +4687,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:758](https://github.com/h
|
|
|
4594
4687
|
setData: (stateData) => void;
|
|
4595
4688
|
```
|
|
4596
4689
|
|
|
4597
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:791](https://github.com/hichchidev/hichchi/blob/
|
|
4690
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:791](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/state/auth.state.ts#L791)
|
|
4598
4691
|
|
|
4599
4692
|
###### Parameters
|
|
4600
4693
|
|
|
@@ -4631,7 +4724,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:791](https://github.com/h
|
|
|
4631
4724
|
setTokens: (tokenResponse) => void;
|
|
4632
4725
|
```
|
|
4633
4726
|
|
|
4634
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:773](https://github.com/hichchidev/hichchi/blob/
|
|
4727
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:773](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/state/auth.state.ts#L773)
|
|
4635
4728
|
|
|
4636
4729
|
###### Parameters
|
|
4637
4730
|
|
|
@@ -4668,7 +4761,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:773](https://github.com/h
|
|
|
4668
4761
|
signedIn: Signal<boolean>;
|
|
4669
4762
|
```
|
|
4670
4763
|
|
|
4671
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:757](https://github.com/hichchidev/hichchi/blob/
|
|
4764
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:757](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/state/auth.state.ts#L757)
|
|
4672
4765
|
|
|
4673
4766
|
##### signIn()
|
|
4674
4767
|
|
|
@@ -4676,7 +4769,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:757](https://github.com/h
|
|
|
4676
4769
|
signIn: <AsPromise>(signInBody, redirect?, asPromise?, showError?) => AsPromise extends true ? Promise<AuthResponse> : Observable<AuthResponse>;
|
|
4677
4770
|
```
|
|
4678
4771
|
|
|
4679
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:774](https://github.com/hichchidev/hichchi/blob/
|
|
4772
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:774](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/state/auth.state.ts#L774)
|
|
4680
4773
|
|
|
4681
4774
|
###### Type Parameters
|
|
4682
4775
|
|
|
@@ -4774,7 +4867,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:774](https://github.com/h
|
|
|
4774
4867
|
signOut: <AsPromise>(redirect?, asPromise?, showError?) => AsPromise extends true ? Promise<SuccessResponse | null> : Observable<SuccessResponse | null>;
|
|
4775
4868
|
```
|
|
4776
4869
|
|
|
4777
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:786](https://github.com/hichchidev/hichchi/blob/
|
|
4870
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:786](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/state/auth.state.ts#L786)
|
|
4778
4871
|
|
|
4779
4872
|
###### Type Parameters
|
|
4780
4873
|
|
|
@@ -4860,7 +4953,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:786](https://github.com/h
|
|
|
4860
4953
|
user: Signal<U | null>;
|
|
4861
4954
|
```
|
|
4862
4955
|
|
|
4863
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:759](https://github.com/hichchidev/hichchi/blob/
|
|
4956
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:759](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/state/auth.state.ts#L759)
|
|
4864
4957
|
|
|
4865
4958
|
## Variables
|
|
4866
4959
|
|
|
@@ -4882,7 +4975,7 @@ const AuthState: Type<
|
|
|
4882
4975
|
>;
|
|
4883
4976
|
```
|
|
4884
4977
|
|
|
4885
|
-
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:164](https://github.com/hichchidev/hichchi/blob/
|
|
4978
|
+
Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:164](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/state/auth.state.ts#L164)
|
|
4886
4979
|
|
|
4887
4980
|
Authentication state management store using NgRx Signals
|
|
4888
4981
|
|
|
@@ -4975,7 +5068,7 @@ export class HeaderComponent {
|
|
|
4975
5068
|
const SKIPPED_ERRORS: ErrorResponseCode[];
|
|
4976
5069
|
```
|
|
4977
5070
|
|
|
4978
|
-
Defined in: [libs/ngx-auth/src/lib/interceptors/auth.interceptor.ts:30](https://github.com/hichchidev/hichchi/blob/
|
|
5071
|
+
Defined in: [libs/ngx-auth/src/lib/interceptors/auth.interceptor.ts:30](https://github.com/hichchidev/hichchi/blob/4f0350925a950a3a9e81da44097f63463eade88d/libs/ngx-auth/src/lib/interceptors/auth.interceptor.ts#L30)
|
|
4979
5072
|
|
|
4980
5073
|
Array of authentication error codes that should trigger token refresh instead of immediate redirect
|
|
4981
5074
|
|