@hichchi/ngx-auth 0.0.9 → 0.0.11

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 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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L97)
216
+ Defined in: [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:97](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L146)
226
+ Defined in: [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:146](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L318)
240
+ Defined in: [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:318](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L183)
298
+ Defined in: [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:183](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L213)
325
+ Defined in: [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:213](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L248)
384
+ Defined in: [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:248](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L278)
445
+ Defined in: [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:278](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L132)
527
+ [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:132](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L135)
549
+ [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:135](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L144)
571
+ [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:144](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L141)
593
+ [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:141](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L138)
615
+ [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:138](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L111)
637
+ [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:111](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L108)
659
+ [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:108](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L129)
681
+ [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:129](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L123)
703
+ [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:123](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L126)
725
+ [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:126](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L105)
747
+ [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:105](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L114)
769
+ [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:114](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L117)
791
+ [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:117](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts#L120)
813
+ [libs/ngx-auth/src/lib/components/auth-form/auth-form.component.ts:120](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/services/auth.service.ts#L72)
824
+ Defined in: [libs/ngx-auth/src/lib/services/auth.service.ts:72](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/services/auth.service.ts#L82)
888
+ Defined in: [libs/ngx-auth/src/lib/services/auth.service.ts:82](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/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:95](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-utils/src/lib/services/crud-http.service.ts#L95)
948
+ Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:97](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-utils/src/lib/services/crud-http.service.ts#L97)
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:97](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-utils/src/lib/services/crud-http.service.ts#L97)
1028
+ Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:99](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-utils/src/lib/services/crud-http.service.ts#L99)
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:48](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-utils/src/lib/services/crud-http.service.ts#L48)
1110
+ Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:50](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-utils/src/lib/services/crud-http.service.ts#L50)
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:50](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-utils/src/lib/services/crud-http.service.ts#L50)
1190
+ Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:52](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-utils/src/lib/services/crud-http.service.ts#L52)
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:265](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/services/auth.service.ts#L265)
1270
+ Defined in: [libs/ngx-auth/src/lib/services/auth.service.ts:265](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/services/auth.service.ts#L183)
1367
+ Defined in: [libs/ngx-auth/src/lib/services/auth.service.ts:183](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/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:83](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-utils/src/lib/services/crud-http.service.ts#L83)
1443
+ Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:85](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-utils/src/lib/services/crud-http.service.ts#L85)
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:85](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-utils/src/lib/services/crud-http.service.ts#L85)
1550
+ Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:87](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-utils/src/lib/services/crud-http.service.ts#L87)
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:59](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-utils/src/lib/services/crud-http.service.ts#L59)
1659
+ Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:61](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-utils/src/lib/services/crud-http.service.ts#L61)
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:61](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-utils/src/lib/services/crud-http.service.ts#L61)
1766
+ Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:63](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-utils/src/lib/services/crud-http.service.ts#L63)
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:71](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-utils/src/lib/services/crud-http.service.ts#L71)
1875
+ Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:73](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-utils/src/lib/services/crud-http.service.ts#L73)
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:73](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-utils/src/lib/services/crud-http.service.ts#L73)
1982
+ Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:75](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-utils/src/lib/services/crud-http.service.ts#L75)
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:371](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/services/auth.service.ts#L371)
2086
+ Defined in: [libs/ngx-auth/src/lib/services/auth.service.ts:371](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/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:23](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-utils/src/lib/services/crud-http.service.ts#L23)
2190
+ Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:23](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/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/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/services/auth.service.ts#L118)
2306
+ Defined in: [libs/ngx-auth/src/lib/services/auth.service.ts:118](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/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:439](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/services/auth.service.ts#L439)
2400
+ Defined in: [libs/ngx-auth/src/lib/services/auth.service.ts:439](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/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, TenantSlug>>;
2497
2497
  ```
2498
2498
 
2499
- Defined in: [libs/ngx-auth/src/lib/services/auth.service.ts:325](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/services/auth.service.ts#L325)
2499
+ Defined in: [libs/ngx-auth/src/lib/services/auth.service.ts:325](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/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:106](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-utils/src/lib/services/crud-http.service.ts#L106)
2602
+ Defined in: [libs/ngx-utils/src/lib/services/crud-http.service.ts:108](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-utils/src/lib/services/crud-http.service.ts#L108)
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:21](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-utils/src/lib/services/crud-http.service.ts#L21)
2696
+ [libs/ngx-utils/src/lib/services/crud-http.service.ts:21](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/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:93](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/auth.module.ts#L93)
2707
+ Defined in: [libs/ngx-auth/src/lib/auth.module.ts:93](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/auth.module.ts#L93)
2708
2708
 
2709
2709
  Angular module for authentication functionality
2710
2710
 
@@ -2794,7 +2794,7 @@ new NgxHichchiAuthModule(): NgxHichchiAuthModule;
2794
2794
  static forRoot(config): ModuleWithProviders<NgxHichchiAuthModule>;
2795
2795
  ```
2796
2796
 
2797
- Defined in: [libs/ngx-auth/src/lib/auth.module.ts:135](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/auth.module.ts#L135)
2797
+ Defined in: [libs/ngx-auth/src/lib/auth.module.ts:135](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/auth.module.ts#L135)
2798
2798
 
2799
2799
  Configures the NgxHichchiAuthModule with the provided authentication configuration
2800
2800
 
@@ -2875,7 +2875,7 @@ NgxHichchiAuthModule.forRoot({
2875
2875
 
2876
2876
  ### PermissionDirective
2877
2877
 
2878
- Defined in: [libs/ngx-auth/src/lib/directives/permission.directive.ts:67](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/directives/permission.directive.ts#L67)
2878
+ Defined in: [libs/ngx-auth/src/lib/directives/permission.directive.ts:67](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/directives/permission.directive.ts#L67)
2879
2879
 
2880
2880
  Angular structural directive for permission-based conditional rendering
2881
2881
 
@@ -2942,7 +2942,7 @@ export class UserListComponent {
2942
2942
  new PermissionDirective(): PermissionDirective;
2943
2943
  ```
2944
2944
 
2945
- Defined in: [libs/ngx-auth/src/lib/directives/permission.directive.ts:114](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/directives/permission.directive.ts#L114)
2945
+ Defined in: [libs/ngx-auth/src/lib/directives/permission.directive.ts:114](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/directives/permission.directive.ts#L114)
2946
2946
 
2947
2947
  Constructor that sets up the permission checking effect
2948
2948
 
@@ -3001,7 +3001,7 @@ the specified permissions (OR logic).
3001
3001
  </td>
3002
3002
  <td>
3003
3003
 
3004
- [libs/ngx-auth/src/lib/directives/permission.directive.ts:105](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/directives/permission.directive.ts#L105)
3004
+ [libs/ngx-auth/src/lib/directives/permission.directive.ts:105](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/directives/permission.directive.ts#L105)
3005
3005
 
3006
3006
  </td>
3007
3007
  </tr>
@@ -3012,7 +3012,7 @@ the specified permissions (OR logic).
3012
3012
 
3013
3013
  ### AuthGuardCondition
3014
3014
 
3015
- Defined in: [libs/ngx-auth/src/lib/enums/auth-guard-condition.enum.ts:33](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/enums/auth-guard-condition.enum.ts#L33)
3015
+ Defined in: [libs/ngx-auth/src/lib/enums/auth-guard-condition.enum.ts:33](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/enums/auth-guard-condition.enum.ts#L33)
3016
3016
 
3017
3017
  Enumeration of authentication guard conditions
3018
3018
 
@@ -3077,7 +3077,7 @@ Check if the user has a valid access token
3077
3077
  </td>
3078
3078
  <td>
3079
3079
 
3080
- [libs/ngx-auth/src/lib/enums/auth-guard-condition.enum.ts:37](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/enums/auth-guard-condition.enum.ts#L37)
3080
+ [libs/ngx-auth/src/lib/enums/auth-guard-condition.enum.ts:37](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/enums/auth-guard-condition.enum.ts#L37)
3081
3081
 
3082
3082
  </td>
3083
3083
  </tr>
@@ -3099,7 +3099,7 @@ Check if the user is signed in to the application
3099
3099
  </td>
3100
3100
  <td>
3101
3101
 
3102
- [libs/ngx-auth/src/lib/enums/auth-guard-condition.enum.ts:35](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/enums/auth-guard-condition.enum.ts#L35)
3102
+ [libs/ngx-auth/src/lib/enums/auth-guard-condition.enum.ts:35](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/enums/auth-guard-condition.enum.ts#L35)
3103
3103
 
3104
3104
  </td>
3105
3105
  </tr>
@@ -3202,7 +3202,7 @@ const routes: Routes = [
3202
3202
  function authGuard(options): CanActivateFn;
3203
3203
  ```
3204
3204
 
3205
- Defined in: [libs/ngx-auth/src/lib/guards/auth.guard.ts:37](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/guards/auth.guard.ts#L37)
3205
+ Defined in: [libs/ngx-auth/src/lib/guards/auth.guard.ts:37](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/guards/auth.guard.ts#L37)
3206
3206
 
3207
3207
  Creates an authentication guard function with multiple configuration options
3208
3208
 
@@ -3284,7 +3284,7 @@ const routes: Routes = [
3284
3284
  function authGuard(condition, state, fallbackRedirect): CanActivateFn;
3285
3285
  ```
3286
3286
 
3287
- Defined in: [libs/ngx-auth/src/lib/guards/auth.guard.ts:77](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/guards/auth.guard.ts#L77)
3287
+ Defined in: [libs/ngx-auth/src/lib/guards/auth.guard.ts:77](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/guards/auth.guard.ts#L77)
3288
3288
 
3289
3289
  Creates an authentication guard function with a single condition
3290
3290
 
@@ -3399,7 +3399,7 @@ const routes: Routes = [
3399
3399
  function authInterceptor(redirect, onRedirect?): HttpInterceptorFn;
3400
3400
  ```
3401
3401
 
3402
- Defined in: [libs/ngx-auth/src/lib/interceptors/auth.interceptor.ts:167](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/interceptors/auth.interceptor.ts#L167)
3402
+ Defined in: [libs/ngx-auth/src/lib/interceptors/auth.interceptor.ts:167](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/interceptors/auth.interceptor.ts#L167)
3403
3403
 
3404
3404
  Creates an HTTP interceptor for handling authentication tokens and automatic token refresh
3405
3405
 
@@ -3530,30 +3530,57 @@ export class AppModule {}
3530
3530
  ### roleGuard()
3531
3531
 
3532
3532
  ```ts
3533
- function roleGuard(role, options): CanActivateFn;
3533
+ function roleGuard<T>(role, options): CanActivateFn;
3534
3534
  ```
3535
3535
 
3536
- Defined in: [libs/ngx-auth/src/lib/guards/role.guard.ts:76](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/guards/role.guard.ts#L76)
3536
+ Defined in: [libs/ngx-auth/src/lib/guards/role.guard.ts:100](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/guards/role.guard.ts#L100)
3537
3537
 
3538
3538
  Creates a role-based authorization guard function for Angular route protection
3539
3539
 
3540
3540
  This function creates a route guard that protects routes based on user roles.
3541
- It checks if the current user's role matches the required role, and if not,
3542
- it evaluates the provided options to determine the appropriate action (redirect
3543
- or sign out).
3541
+ It first checks whether the current user's role matches the required role(s).
3542
+ If it does not match, it evaluates the provided options to determine the
3543
+ appropriate action (redirect or sign out).
3544
3544
 
3545
3545
  The guard integrates with the AuthState service to check the current user's role
3546
- and uses the Angular Router for navigation when redirects are needed. If no
3547
- matching role or redirect option is found, the user is automatically signed out.
3546
+ and uses the Angular Router for navigation when redirects are needed. If the
3547
+ required role check fails and no matching redirect option is found, the user is
3548
+ automatically signed out.
3548
3549
 
3549
3550
  Key features:
3550
3551
 
3551
3552
  - Role-based route protection
3553
+ - Supports both a single required role and multiple allowed roles
3552
3554
  - Configurable redirect options based on user roles
3553
3555
  - Automatic sign-out for unauthorized access
3554
3556
  - Integration with AuthState for reactive role checking
3555
3557
  - Support for multiple role-based redirect scenarios
3556
3558
 
3559
+ #### Type Parameters
3560
+
3561
+ <table>
3562
+ <thead>
3563
+ <tr>
3564
+ <th>Type Parameter</th>
3565
+ <th>Default type</th>
3566
+ </tr>
3567
+ </thead>
3568
+ <tbody>
3569
+ <tr>
3570
+ <td>
3571
+
3572
+ `T`
3573
+
3574
+ </td>
3575
+ <td>
3576
+
3577
+ `string`
3578
+
3579
+ </td>
3580
+ </tr>
3581
+ </tbody>
3582
+ </table>
3583
+
3557
3584
  #### Parameters
3558
3585
 
3559
3586
  <table>
@@ -3573,12 +3600,12 @@ Key features:
3573
3600
  </td>
3574
3601
  <td>
3575
3602
 
3576
- `string`
3603
+ `T` | `T`\[]
3577
3604
 
3578
3605
  </td>
3579
3606
  <td>
3580
3607
 
3581
- The required role name that the user must have to access the route
3608
+ The required role name (or list of allowed roles) for route access
3582
3609
 
3583
3610
  </td>
3584
3611
  </tr>
@@ -3590,7 +3617,7 @@ The required role name that the user must have to access the route
3590
3617
  </td>
3591
3618
  <td>
3592
3619
 
3593
- [`RoleGuardOption`](#roleguardoption)\[]
3620
+ [`RoleGuardOption`](#roleguardoption)<`T`>\[]
3594
3621
 
3595
3622
  </td>
3596
3623
  <td>
@@ -3653,6 +3680,29 @@ const routes: Routes = [
3653
3680
  ];
3654
3681
  ```
3655
3682
 
3683
+ ```typescript
3684
+ // Allowing multiple roles
3685
+ const routes: Routes = [
3686
+ {
3687
+ path: "reports",
3688
+ component: ReportsComponent,
3689
+ canActivate: [
3690
+ roleGuard(
3691
+ ["admin", "manager"],
3692
+ [{ state: "user", redirect: "/dashboard" }],
3693
+ ),
3694
+ ],
3695
+ },
3696
+ ];
3697
+ ```
3698
+
3699
+ ```typescript
3700
+ // Evaluation order:
3701
+ // 1) role match => allow
3702
+ // 2) role mismatch + matching option.state => redirect
3703
+ // 3) role mismatch + no matching option.state => sign out
3704
+ ```
3705
+
3656
3706
  #### See
3657
3707
 
3658
3708
  - [AuthState](#authstate-1) Service that provides authentication and role state information
@@ -3662,7 +3712,7 @@ const routes: Routes = [
3662
3712
 
3663
3713
  ### AuthConfig
3664
3714
 
3665
- Defined in: [libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:3](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts#L3)
3715
+ Defined in: [libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:3](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts#L3)
3666
3716
 
3667
3717
  #### Properties
3668
3718
 
@@ -3688,7 +3738,7 @@ Defined in: [libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:3](https:
3688
3738
  </td>
3689
3739
  <td>
3690
3740
 
3691
- [libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:5](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts#L5)
3741
+ [libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:5](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts#L5)
3692
3742
 
3693
3743
  </td>
3694
3744
  </tr>
@@ -3705,7 +3755,7 @@ Defined in: [libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:3](https:
3705
3755
  </td>
3706
3756
  <td>
3707
3757
 
3708
- [libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:4](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts#L4)
3758
+ [libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:4](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts#L4)
3709
3759
 
3710
3760
  </td>
3711
3761
  </tr>
@@ -3722,7 +3772,7 @@ Defined in: [libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:3](https:
3722
3772
  </td>
3723
3773
  <td>
3724
3774
 
3725
- [libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:6](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts#L6)
3775
+ [libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:6](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts#L6)
3726
3776
 
3727
3777
  </td>
3728
3778
  </tr>
@@ -3739,7 +3789,7 @@ Defined in: [libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:3](https:
3739
3789
  </td>
3740
3790
  <td>
3741
3791
 
3742
- [libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:7](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts#L7)
3792
+ [libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:7](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts#L7)
3743
3793
 
3744
3794
  </td>
3745
3795
  </tr>
@@ -3750,7 +3800,7 @@ Defined in: [libs/ngx-auth/src/lib/interfaces/auth-config.interface.ts:3](https:
3750
3800
 
3751
3801
  ### AuthFormData
3752
3802
 
3753
- Defined in: [libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts:52](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts#L52)
3803
+ Defined in: [libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts:52](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts#L52)
3754
3804
 
3755
3805
  Interface for authentication form data
3756
3806
 
@@ -3835,7 +3885,7 @@ Authentication field value (email, username, etc.)
3835
3885
  </td>
3836
3886
  <td>
3837
3887
 
3838
- [libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts:58](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts#L58)
3888
+ [libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts:58](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts#L58)
3839
3889
 
3840
3890
  </td>
3841
3891
  </tr>
@@ -3857,7 +3907,7 @@ User's first name
3857
3907
  </td>
3858
3908
  <td>
3859
3909
 
3860
- [libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts:54](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts#L54)
3910
+ [libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts:54](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts#L54)
3861
3911
 
3862
3912
  </td>
3863
3913
  </tr>
@@ -3879,7 +3929,7 @@ User's last name
3879
3929
  </td>
3880
3930
  <td>
3881
3931
 
3882
- [libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts:56](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts#L56)
3932
+ [libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts:56](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts#L56)
3883
3933
 
3884
3934
  </td>
3885
3935
  </tr>
@@ -3901,7 +3951,7 @@ User's password
3901
3951
  </td>
3902
3952
  <td>
3903
3953
 
3904
- [libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts:60](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts#L60)
3954
+ [libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts:60](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/interfaces/auth-form-data.interface.ts#L60)
3905
3955
 
3906
3956
  </td>
3907
3957
  </tr>
@@ -3912,7 +3962,7 @@ User's password
3912
3962
 
3913
3963
  ### AuthGuardOption
3914
3964
 
3915
- Defined in: [libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts:66](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts#L66)
3965
+ Defined in: [libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts:66](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts#L66)
3916
3966
 
3917
3967
  Interface for configuring authentication guard behavior
3918
3968
 
@@ -4006,7 +4056,7 @@ The authentication condition to check
4006
4056
  </td>
4007
4057
  <td>
4008
4058
 
4009
- [libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts:68](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts#L68)
4059
+ [libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts:68](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts#L68)
4010
4060
 
4011
4061
  </td>
4012
4062
  </tr>
@@ -4028,7 +4078,7 @@ The route to redirect to if the condition is not met
4028
4078
  </td>
4029
4079
  <td>
4030
4080
 
4031
- [libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts:72](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts#L72)
4081
+ [libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts:72](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts#L72)
4032
4082
 
4033
4083
  </td>
4034
4084
  </tr>
@@ -4050,7 +4100,7 @@ The required state of the condition (true/false)
4050
4100
  </td>
4051
4101
  <td>
4052
4102
 
4053
- [libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts:70](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts#L70)
4103
+ [libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts:70](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/interfaces/auth-guard-option.interface.ts#L70)
4054
4104
 
4055
4105
  </td>
4056
4106
  </tr>
@@ -4061,7 +4111,7 @@ The required state of the condition (true/false)
4061
4111
 
4062
4112
  ### AuthStateModel
4063
4113
 
4064
- Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:57](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/state/auth.state.ts#L57)
4114
+ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:57](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/state/auth.state.ts#L57)
4065
4115
 
4066
4116
  Interface defining the authentication state model
4067
4117
 
@@ -4151,7 +4201,7 @@ JWT access token for API authentication
4151
4201
  </td>
4152
4202
  <td>
4153
4203
 
4154
- [libs/ngx-auth/src/lib/state/auth.state.ts:65](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/state/auth.state.ts#L65)
4204
+ [libs/ngx-auth/src/lib/state/auth.state.ts:65](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/state/auth.state.ts#L65)
4155
4205
 
4156
4206
  </td>
4157
4207
  </tr>
@@ -4173,7 +4223,7 @@ Expiration date of the access token
4173
4223
  </td>
4174
4224
  <td>
4175
4225
 
4176
- [libs/ngx-auth/src/lib/state/auth.state.ts:69](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/state/auth.state.ts#L69)
4226
+ [libs/ngx-auth/src/lib/state/auth.state.ts:69](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/state/auth.state.ts#L69)
4177
4227
 
4178
4228
  </td>
4179
4229
  </tr>
@@ -4195,7 +4245,7 @@ Expiration date of the access token
4195
4245
  </td>
4196
4246
  <td>
4197
4247
 
4198
- [libs/ngx-auth/src/lib/state/auth.state.ts:73](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/state/auth.state.ts#L73)
4248
+ [libs/ngx-auth/src/lib/state/auth.state.ts:73](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/state/auth.state.ts#L73)
4199
4249
 
4200
4250
  </td>
4201
4251
  </tr>
@@ -4217,7 +4267,7 @@ JWT refresh token for obtaining new access tokens
4217
4267
  </td>
4218
4268
  <td>
4219
4269
 
4220
- [libs/ngx-auth/src/lib/state/auth.state.ts:67](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/state/auth.state.ts#L67)
4270
+ [libs/ngx-auth/src/lib/state/auth.state.ts:67](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/state/auth.state.ts#L67)
4221
4271
 
4222
4272
  </td>
4223
4273
  </tr>
@@ -4239,7 +4289,7 @@ Expiration date of the refresh token
4239
4289
  </td>
4240
4290
  <td>
4241
4291
 
4242
- [libs/ngx-auth/src/lib/state/auth.state.ts:71](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/state/auth.state.ts#L71)
4292
+ [libs/ngx-auth/src/lib/state/auth.state.ts:71](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/state/auth.state.ts#L71)
4243
4293
 
4244
4294
  </td>
4245
4295
  </tr>
@@ -4261,7 +4311,7 @@ Unique identifier for the current session
4261
4311
  </td>
4262
4312
  <td>
4263
4313
 
4264
- [libs/ngx-auth/src/lib/state/auth.state.ts:61](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/state/auth.state.ts#L61)
4314
+ [libs/ngx-auth/src/lib/state/auth.state.ts:61](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/state/auth.state.ts#L61)
4265
4315
 
4266
4316
  </td>
4267
4317
  </tr>
@@ -4283,7 +4333,7 @@ Whether the user is currently signed in
4283
4333
  </td>
4284
4334
  <td>
4285
4335
 
4286
- [libs/ngx-auth/src/lib/state/auth.state.ts:59](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/state/auth.state.ts#L59)
4336
+ [libs/ngx-auth/src/lib/state/auth.state.ts:59](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/state/auth.state.ts#L59)
4287
4337
 
4288
4338
  </td>
4289
4339
  </tr>
@@ -4305,7 +4355,7 @@ Current authenticated user information
4305
4355
  </td>
4306
4356
  <td>
4307
4357
 
4308
- [libs/ngx-auth/src/lib/state/auth.state.ts:63](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/state/auth.state.ts#L63)
4358
+ [libs/ngx-auth/src/lib/state/auth.state.ts:63](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/state/auth.state.ts#L63)
4309
4359
 
4310
4360
  </td>
4311
4361
  </tr>
@@ -4316,7 +4366,32 @@ Current authenticated user information
4316
4366
 
4317
4367
  ### RoleGuardOption
4318
4368
 
4319
- Defined in: [libs/ngx-auth/src/lib/interfaces/role-guard-option.interface.ts:1](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/interfaces/role-guard-option.interface.ts#L1)
4369
+ Defined in: [libs/ngx-auth/src/lib/interfaces/role-guard-option.interface.ts:1](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/interfaces/role-guard-option.interface.ts#L1)
4370
+
4371
+ #### Type Parameters
4372
+
4373
+ <table>
4374
+ <thead>
4375
+ <tr>
4376
+ <th>Type Parameter</th>
4377
+ <th>Default type</th>
4378
+ </tr>
4379
+ </thead>
4380
+ <tbody>
4381
+ <tr>
4382
+ <td>
4383
+
4384
+ `T`
4385
+
4386
+ </td>
4387
+ <td>
4388
+
4389
+ `string`
4390
+
4391
+ </td>
4392
+ </tr>
4393
+ </tbody>
4394
+ </table>
4320
4395
 
4321
4396
  #### Properties
4322
4397
 
@@ -4343,12 +4418,12 @@ Defined in: [libs/ngx-auth/src/lib/interfaces/role-guard-option.interface.ts:1](
4343
4418
  </td>
4344
4419
  <td>
4345
4420
 
4346
- The route to redirect to if the role exist
4421
+ Route path to navigate to when `state` matches the current role
4347
4422
 
4348
4423
  </td>
4349
4424
  <td>
4350
4425
 
4351
- [libs/ngx-auth/src/lib/interfaces/role-guard-option.interface.ts:5](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/interfaces/role-guard-option.interface.ts#L5)
4426
+ [libs/ngx-auth/src/lib/interfaces/role-guard-option.interface.ts:5](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/interfaces/role-guard-option.interface.ts#L5)
4352
4427
 
4353
4428
  </td>
4354
4429
  </tr>
@@ -4360,17 +4435,17 @@ The route to redirect to if the role exist
4360
4435
  </td>
4361
4436
  <td>
4362
4437
 
4363
- `string`
4438
+ `T`
4364
4439
 
4365
4440
  </td>
4366
4441
  <td>
4367
4442
 
4368
- The required state of the role
4443
+ Role name that should be redirected when the required role check fails
4369
4444
 
4370
4445
  </td>
4371
4446
  <td>
4372
4447
 
4373
- [libs/ngx-auth/src/lib/interfaces/role-guard-option.interface.ts:3](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/interfaces/role-guard-option.interface.ts#L3)
4448
+ [libs/ngx-auth/src/lib/interfaces/role-guard-option.interface.ts:3](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/interfaces/role-guard-option.interface.ts#L3)
4374
4449
 
4375
4450
  </td>
4376
4451
  </tr>
@@ -4385,7 +4460,7 @@ The required state of the role
4385
4460
  type AuthState<D, R, P, U> = object;
4386
4461
  ```
4387
4462
 
4388
- Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:164](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/state/auth.state.ts#L164)
4463
+ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:164](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/state/auth.state.ts#L164)
4389
4464
 
4390
4465
  Public typed shape of the `AuthState` signal store.
4391
4466
 
@@ -4438,7 +4513,7 @@ Public typed shape of the `AuthState` signal store.
4438
4513
  <tr>
4439
4514
  <td>
4440
4515
 
4441
- `U` _extends_ `User`<`R`, `P`>
4516
+ `U`
4442
4517
 
4443
4518
  </td>
4444
4519
  <td>
@@ -4458,7 +4533,7 @@ Public typed shape of the `AuthState` signal store.
4458
4533
  accessToken: Signal<AccessToken | null>;
4459
4534
  ```
4460
4535
 
4461
- Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:760](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/state/auth.state.ts#L760)
4536
+ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:760](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/state/auth.state.ts#L760)
4462
4537
 
4463
4538
  ##### accessTokenExpiresOn
4464
4539
 
@@ -4466,7 +4541,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:760](https://github.com/h
4466
4541
  accessTokenExpiresOn: Signal<Date | null>;
4467
4542
  ```
4468
4543
 
4469
- Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:762](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/state/auth.state.ts#L762)
4544
+ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:762](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/state/auth.state.ts#L762)
4470
4545
 
4471
4546
  ##### authenticateWithToken()
4472
4547
 
@@ -4474,7 +4549,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:762](https://github.com/h
4474
4549
  authenticateWithToken: <AsPromise>(accessToken, redirect?, asPromise?, showError?) => AsPromise extends true ? Promise<AuthResponse> : Observable<AuthResponse>;
4475
4550
  ```
4476
4551
 
4477
- Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:780](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/state/auth.state.ts#L780)
4552
+ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:780](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/state/auth.state.ts#L780)
4478
4553
 
4479
4554
  ###### Type Parameters
4480
4555
 
@@ -4572,7 +4647,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:780](https://github.com/h
4572
4647
  data: Signal<D>;
4573
4648
  ```
4574
4649
 
4575
- Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:764](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/state/auth.state.ts#L764)
4650
+ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:764](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/state/auth.state.ts#L764)
4576
4651
 
4577
4652
  ##### emailVerified
4578
4653
 
@@ -4580,7 +4655,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:764](https://github.com/h
4580
4655
  emailVerified: Signal<boolean>;
4581
4656
  ```
4582
4657
 
4583
- Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:770](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/state/auth.state.ts#L770)
4658
+ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:770](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/state/auth.state.ts#L770)
4584
4659
 
4585
4660
  ##### hasAccessToken
4586
4661
 
@@ -4588,7 +4663,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:770](https://github.com/h
4588
4663
  hasAccessToken: Signal<boolean>;
4589
4664
  ```
4590
4665
 
4591
- Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:766](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/state/auth.state.ts#L766)
4666
+ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:766](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/state/auth.state.ts#L766)
4592
4667
 
4593
4668
  ##### permissions
4594
4669
 
@@ -4596,7 +4671,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:766](https://github.com/h
4596
4671
  permissions: Signal<P[]>;
4597
4672
  ```
4598
4673
 
4599
- Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:769](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/state/auth.state.ts#L769)
4674
+ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:769](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/state/auth.state.ts#L769)
4600
4675
 
4601
4676
  ##### refreshToken
4602
4677
 
@@ -4604,7 +4679,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:769](https://github.com/h
4604
4679
  refreshToken: Signal<RefreshToken | null>;
4605
4680
  ```
4606
4681
 
4607
- Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:761](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/state/auth.state.ts#L761)
4682
+ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:761](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/state/auth.state.ts#L761)
4608
4683
 
4609
4684
  ##### refreshTokenExpiresOn
4610
4685
 
@@ -4612,7 +4687,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:761](https://github.com/h
4612
4687
  refreshTokenExpiresOn: Signal<Date | null>;
4613
4688
  ```
4614
4689
 
4615
- Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:763](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/state/auth.state.ts#L763)
4690
+ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:763](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/state/auth.state.ts#L763)
4616
4691
 
4617
4692
  ##### reset()
4618
4693
 
@@ -4620,7 +4695,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:763](https://github.com/h
4620
4695
  reset: () => void;
4621
4696
  ```
4622
4697
 
4623
- Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:772](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/state/auth.state.ts#L772)
4698
+ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:772](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/state/auth.state.ts#L772)
4624
4699
 
4625
4700
  ###### Returns
4626
4701
 
@@ -4629,10 +4704,10 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:772](https://github.com/h
4629
4704
  ##### role
4630
4705
 
4631
4706
  ```ts
4632
- role: Signal<U["role"] | null | undefined>;
4707
+ role: Signal<U extends object ? T : null | undefined>;
4633
4708
  ```
4634
4709
 
4635
- Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:767](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/state/auth.state.ts#L767)
4710
+ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:767](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/state/auth.state.ts#L767)
4636
4711
 
4637
4712
  ##### roleName
4638
4713
 
@@ -4640,7 +4715,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:767](https://github.com/h
4640
4715
  roleName: Signal<R | null | undefined>;
4641
4716
  ```
4642
4717
 
4643
- Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:768](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/state/auth.state.ts#L768)
4718
+ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:768](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/state/auth.state.ts#L768)
4644
4719
 
4645
4720
  ##### sessionId
4646
4721
 
@@ -4648,7 +4723,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:768](https://github.com/h
4648
4723
  sessionId: Signal<string | null>;
4649
4724
  ```
4650
4725
 
4651
- Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:758](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/state/auth.state.ts#L758)
4726
+ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:758](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/state/auth.state.ts#L758)
4652
4727
 
4653
4728
  ##### setData()
4654
4729
 
@@ -4656,7 +4731,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:758](https://github.com/h
4656
4731
  setData: (stateData) => void;
4657
4732
  ```
4658
4733
 
4659
- Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:791](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/state/auth.state.ts#L791)
4734
+ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:791](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/state/auth.state.ts#L791)
4660
4735
 
4661
4736
  ###### Parameters
4662
4737
 
@@ -4693,7 +4768,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:791](https://github.com/h
4693
4768
  setTokens: (tokenResponse) => void;
4694
4769
  ```
4695
4770
 
4696
- Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:773](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/state/auth.state.ts#L773)
4771
+ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:773](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/state/auth.state.ts#L773)
4697
4772
 
4698
4773
  ###### Parameters
4699
4774
 
@@ -4730,7 +4805,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:773](https://github.com/h
4730
4805
  signedIn: Signal<boolean>;
4731
4806
  ```
4732
4807
 
4733
- Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:757](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/state/auth.state.ts#L757)
4808
+ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:757](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/state/auth.state.ts#L757)
4734
4809
 
4735
4810
  ##### signIn()
4736
4811
 
@@ -4738,7 +4813,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:757](https://github.com/h
4738
4813
  signIn: <AsPromise>(signInBody, redirect?, asPromise?, showError?) => AsPromise extends true ? Promise<AuthResponse> : Observable<AuthResponse>;
4739
4814
  ```
4740
4815
 
4741
- Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:774](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/state/auth.state.ts#L774)
4816
+ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:774](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/state/auth.state.ts#L774)
4742
4817
 
4743
4818
  ###### Type Parameters
4744
4819
 
@@ -4836,7 +4911,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:774](https://github.com/h
4836
4911
  signOut: <AsPromise>(redirect?, asPromise?, showError?) => AsPromise extends true ? Promise<SuccessResponse | null> : Observable<SuccessResponse | null>;
4837
4912
  ```
4838
4913
 
4839
- Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:786](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/state/auth.state.ts#L786)
4914
+ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:786](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/state/auth.state.ts#L786)
4840
4915
 
4841
4916
  ###### Type Parameters
4842
4917
 
@@ -4922,7 +4997,7 @@ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:786](https://github.com/h
4922
4997
  user: Signal<U | null>;
4923
4998
  ```
4924
4999
 
4925
- Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:759](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/state/auth.state.ts#L759)
5000
+ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:759](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/state/auth.state.ts#L759)
4926
5001
 
4927
5002
  ## Variables
4928
5003
 
@@ -4944,7 +5019,7 @@ const AuthState: Type<
4944
5019
  >;
4945
5020
  ```
4946
5021
 
4947
- Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:164](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/state/auth.state.ts#L164)
5022
+ Defined in: [libs/ngx-auth/src/lib/state/auth.state.ts:164](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/state/auth.state.ts#L164)
4948
5023
 
4949
5024
  Authentication state management store using NgRx Signals
4950
5025
 
@@ -5037,7 +5112,7 @@ export class HeaderComponent {
5037
5112
  const SKIPPED_ERRORS: ErrorResponseCode[];
5038
5113
  ```
5039
5114
 
5040
- Defined in: [libs/ngx-auth/src/lib/interceptors/auth.interceptor.ts:30](https://github.com/hichchidev/hichchi/blob/0b9a2445c124fc8574826bbe19e8d3e57d724a38/libs/ngx-auth/src/lib/interceptors/auth.interceptor.ts#L30)
5115
+ Defined in: [libs/ngx-auth/src/lib/interceptors/auth.interceptor.ts:30](https://github.com/hichchidev/hichchi/blob/bc1ecaf443ef68763fa462222f701f37aab30ab7/libs/ngx-auth/src/lib/interceptors/auth.interceptor.ts#L30)
5041
5116
 
5042
5117
  Array of authentication error codes that should trigger token refresh instead of immediate redirect
5043
5118