oip-common 0.0.13 → 0.0.14

package/index.d.ts

@@ -5,7 +5,7 @@ import { ActivatedRoute, QueryParamsHandling, IsActiveMatchOptions, Params, Rout
 import { TranslateService } from '@ngx-translate/core';
 import * as rxjs from 'rxjs';
 import { Subject, Observable, Subscription } from 'rxjs';
-import { LoginResponse, AuthOptions, AbstractSecurityStorage, StsConfigHttpLoader } from 'angular-auth-oidc-client';
+import { LoginResponse, AuthOptions, OidcSecurityService, LogoutAuthOptions, AbstractSecurityStorage, StsConfigHttpLoader } from 'angular-auth-oidc-client';
 import { ContextMenu } from 'primeng/contextmenu';
 import { PrimeNG } from 'primeng/config';
 import { HttpInterceptorFn, HttpClient as HttpClient$1 } from '@angular/common/http';
@@ -326,6 +326,72 @@ declare abstract class SecurityService {
     abstract isAdmin(): boolean;
     abstract authorize(configId?: string, authOptions?: AuthOptions): void;
 }
+/**
+ * SecurityService extends OidcSecurityService to manage authentication,
+ * token handling, and user role access in an Angular application.
+ *
+ * It provides helper methods for checking authentication, managing tokens,
+ * determining user roles, and performing logout and refresh operations.
+ */
+declare class KeycloakSecurityService extends OidcSecurityService implements OnDestroy, SecurityService {
+    /**
+     * Handles angular OIDC events.
+     */
+    private readonly publicEventsService;
+    /**
+     * Stores the latest login response from checkAuth().
+     */
+    private loginResponse;
+    /**
+     * Stores the decoded access token payload.
+     */
+    private payload;
+    /**
+     * Stores user-specific data from the login response.
+     */
+    userData: any;
+    /**
+     * Initializes service and subscribes to authentication events.
+     * When a 'NewAuthenticationResult' event is received, the `auth` method is called.
+     */
+    constructor();
+    getCurrentUser(): any;
+    /**
+     * Returns the ID token for the sign-in.
+     * @returns A string with the id token.
+     */
+    getAccessToken(): Observable<string>;
+    /**
+     * Indicates whether the current user has the 'admin' role.
+     *
+     * @returns {boolean} True if the user is an admin, false otherwise.
+     */
+    isAdmin(): boolean;
+    /**
+     * Initiates authentication check and updates login response, user data,
+     * and decoded token payload if authenticated.
+     */
+    auth(): void;
+    /**
+     * Performs logout and clears the local token payload.
+     *
+     * @param {string} [configId] Optional configuration ID for logout.
+     * @param {LogoutAuthOptions} [logoutAuthOptions] Optional logout options.
+     */
+    logout(configId?: string, logoutAuthOptions?: LogoutAuthOptions): void;
+    /**
+     * Completes the BehaviorSubjects when the service is destroyed to avoid memory leaks.
+     */
+    ngOnDestroy(): void;
+    /**
+     * Checks whether the current access token is expired based on the 'exp' claim.
+     *
+     * @returns {Observable<boolean>} Observable that emits true if the token is expired.
+     */
+    isTokenExpired(): Observable<boolean>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<KeycloakSecurityService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<KeycloakSecurityService>;
+}
 
 /**
  * UserService is responsible for retrieving and handling user-related data,
@@ -1068,5 +1134,5 @@ declare class SecurePipe implements PipeTransform {
  */
 declare const httpLoaderAuthFactory: (httpClient: HttpClient$1) => StsConfigHttpLoader;
 
-export { AppConfiguratorComponent, AppFloatingConfiguratorComponent, AppLayoutComponent, AppModulesComponent, AppTopbar, AuthGuardService, BaseDataService, BaseModuleComponent, ConfigComponent, DbMigrationComponent, ErrorComponent, FooterComponent, LayoutService, LogoComponent, MenuComponent, MenuService, MsgService, NotfoundComponent, ProfileComponent, SecurePipe, SecurityComponent, SecurityDataService, SecurityService, SecurityStorageService, SidebarComponent, TopBarService, UnauthorizedComponent, UserService, httpLoaderAuthFactory, langIntercept };
+export { AppConfiguratorComponent, AppFloatingConfiguratorComponent, AppLayoutComponent, AppModulesComponent, AppTopbar, AuthGuardService, BaseDataService, BaseModuleComponent, ConfigComponent, DbMigrationComponent, ErrorComponent, FooterComponent, KeycloakSecurityService, LayoutService, LogoComponent, MenuComponent, MenuService, MsgService, NotfoundComponent, ProfileComponent, SecurePipe, SecurityComponent, SecurityDataService, SecurityService, SecurityStorageService, SidebarComponent, TopBarService, UnauthorizedComponent, UserService, httpLoaderAuthFactory, langIntercept };
 export type { AppConfig, MenuChangeEvent, NoSettingsDto, PutSecurityDto, SecurityDto, TopBarDto };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oip-common",
-  "version": "0.0.13",
+  "version": "0.0.14",
   "description": "A template for cross-platform web applications based on sakai-ng and primeNG",
   "main": "index.js",
   "keywords": [