oip-common 0.1.8 → 0.2.0

package/index.d.ts

@@ -1,10 +1,10 @@
 import * as i0 from '@angular/core';
-import { OnInit, OnDestroy, WritableSignal, OnChanges, SimpleChanges, Type, Provider, InjectionToken, EventEmitter, Renderer2, EnvironmentProviders, PipeTransform } from '@angular/core';
+import { OnDestroy, OnInit, DestroyRef, WritableSignal, OnChanges, SimpleChanges, Type, Provider, InjectionToken, EventEmitter, Renderer2, EnvironmentProviders, PipeTransform } from '@angular/core';
 import { MessageService, ToastMessageOptions, MenuItem, ConfirmationService, FilterMetadata } from 'primeng/api';
 import { ActivatedRoute, QueryParamsHandling, IsActiveMatchOptions, Params, Router, UrlTree } from '@angular/router';
 import { InterpolationParameters, Translation, TranslationObject, TranslateService } from '@ngx-translate/core';
 import * as rxjs from 'rxjs';
-import { Subscription, Subject, Observable, BehaviorSubject } from 'rxjs';
+import { Observable, BehaviorSubject, Subscription, Subject } from 'rxjs';
 import { LoginResponse, AuthOptions, OidcSecurityService, LogoutAuthOptions, AbstractSecurityStorage, StsConfigHttpLoader } from 'angular-auth-oidc-client';
 import { ContextMenu } from 'primeng/contextmenu';
 import { PaletteDesignToken, Preset } from '@primeuix/themes/types';
@@ -228,6 +228,105 @@ interface SecurityDto {
     roles: string[];
 }
 
+interface PutSecurityDto {
+    id: number;
+    securities: SecurityDto[];
+}
+
+declare class SecurityDataService extends BaseDataService {
+    getSecurity(controller: string, id: number): Promise<SecurityDto[]>;
+    saveSecurity(controller: string, request: PutSecurityDto): Promise<any>;
+    getRealmRoles(): Promise<string[]>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SecurityDataService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<SecurityDataService>;
+}
+
+declare abstract class SecurityService {
+    abstract auth(): void;
+    abstract logout(): void;
+    abstract isAuthenticated(): Observable<boolean>;
+    abstract getAccessToken(): Observable<string>;
+    abstract isTokenExpired(): Observable<boolean>;
+    abstract getCurrentUser(): any;
+    abstract getCurrentUser$(): Observable<any>;
+    abstract forceRefreshSession(): Observable<LoginResponse>;
+    abstract isAdmin(): boolean;
+    abstract authorize(configId?: string, authOptions?: AuthOptions): void;
+    abstract payload: BehaviorSubject<any>;
+}
+/**
+ * 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().
+     */
+    loginResponse: BehaviorSubject<LoginResponse>;
+    /**
+     * Stores the decoded access token payload.
+     */
+    readonly payload: BehaviorSubject<any>;
+    /**
+     * Stores user-specific data from the login response.
+     */
+    private readonly currentUser;
+    /**
+     * Emits access token updates from initial auth check, manual refresh,
+     * and library authentication events.
+     */
+    private accessToken;
+    /**
+     * Initializes service and subscribes to authentication events.
+     * When a 'NewAuthenticationResult' event is received, the `auth` method is called.
+     */
+    constructor();
+    getCurrentUser(): any;
+    getCurrentUser$(): Observable<any>;
+    /**
+     * Returns the ID token for the sign-in.
+     * @returns A string with the id token.
+     */
+    getAccessToken(configId?: string): 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>;
+}
+
 declare abstract class BaseModuleComponent<TBackendStoreSettings, TLocalStoreSettings> implements OnInit, OnDestroy {
     private static readonly readRight;
     private static readonly editRight;
@@ -235,9 +334,9 @@ declare abstract class BaseModuleComponent<TBackendStoreSettings, TLocalStoreSet
     private isInitialized;
     private moduleInstanceReloadPromise;
     private rightsSubscription?;
-    private readonly destroyRef;
-    private readonly securityDataService;
-    private readonly securityService;
+    protected readonly destroyRef: DestroyRef;
+    protected readonly securityDataService: SecurityDataService;
+    protected readonly securityService: SecurityService;
     /**
      * Provide access to app settings
      */
@@ -419,92 +518,6 @@ declare class SecurityComponent implements OnChanges, OnInit, OnDestroy {
     static ɵcmp: i0.ɵɵComponentDeclaration<SecurityComponent, "security", never, { "id": { "alias": "id"; "required": false; }; "controller": { "alias": "controller"; "required": false; }; }, {}, never, never, true, never>;
 }
 
-declare abstract class SecurityService {
-    abstract auth(): void;
-    abstract logout(): void;
-    abstract isAuthenticated(): Observable<boolean>;
-    abstract getAccessToken(): Observable<string>;
-    abstract isTokenExpired(): Observable<boolean>;
-    abstract getCurrentUser(): any;
-    abstract getCurrentUser$(): Observable<any>;
-    abstract forceRefreshSession(): Observable<LoginResponse>;
-    abstract isAdmin(): boolean;
-    abstract authorize(configId?: string, authOptions?: AuthOptions): void;
-    abstract payload: BehaviorSubject<any>;
-}
-/**
- * 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().
-     */
-    loginResponse: BehaviorSubject<LoginResponse>;
-    /**
-     * Stores the decoded access token payload.
-     */
-    readonly payload: BehaviorSubject<any>;
-    /**
-     * Stores user-specific data from the login response.
-     */
-    private readonly currentUser;
-    /**
-     * Emits access token updates from initial auth check, manual refresh,
-     * and library authentication events.
-     */
-    private accessToken;
-    /**
-     * Initializes service and subscribes to authentication events.
-     * When a 'NewAuthenticationResult' event is received, the `auth` method is called.
-     */
-    constructor();
-    getCurrentUser(): any;
-    getCurrentUser$(): Observable<any>;
-    /**
-     * Returns the ID token for the sign-in.
-     * @returns A string with the id token.
-     */
-    getAccessToken(configId?: string): 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,
  * including the user's photo and short label for avatar display.
@@ -614,6 +627,9 @@ interface EditModuleInstanceDto {
      */
     moduleId?: number | null;
 }
+interface IframeModuleSettings {
+    url?: string | null;
+}
 /** Represents a key-value pair where the key is an integer and the value is a string. */
 interface IntKeyValueDto {
     /** @format int32 */
@@ -1453,17 +1469,20 @@ declare class DiscussionComponent implements OnChanges, OnDestroy, OnInit {
     static ɵcmp: i0.ɵɵComponentDeclaration<DiscussionComponent, "discussion", never, { "objectTypeId": { "alias": "objectTypeId"; "required": true; }; "objectId": { "alias": "objectId"; "required": true; }; }, {}, never, never, true, never>;
 }
 
-interface PutSecurityDto {
-    id: number;
-    securities: SecurityDto[];
-}
-
-declare class SecurityDataService extends BaseDataService {
-    getSecurity(controller: string, id: number): Promise<SecurityDto[]>;
-    saveSecurity(controller: string, request: PutSecurityDto): Promise<any>;
-    getRealmRoles(): Promise<string[]>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<SecurityDataService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<SecurityDataService>;
+declare class IframeModuleComponent extends BaseModuleComponent<IframeModuleSettings, IframeModuleSettings> implements OnInit, OnDestroy {
+    private iframe?;
+    private readonly renderer;
+    private readonly translate;
+    protected iframeUrl: string | null;
+    constructor();
+    private set iframeElement(value);
+    private setIframeUrl;
+    private isAllowedIframeUrl;
+    protected onModuleInstanceChange(): Promise<void>;
+    private updateIframeSrc;
+    onIframeError(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<IframeModuleComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<IframeModuleComponent, "ng-component", never, {}, {}, never, never, true, never>;
 }
 
 /**
@@ -1589,5 +1608,5 @@ declare class SecurePipe implements PipeTransform {
  */
 declare const httpLoaderAuthFactory: (httpClient: HttpClient$1) => StsConfigHttpLoader;
 
-export { APP_THEME_PRESETS, APP_THEME_PRESETS_MERGE_MODE, AppConfiguratorComponent, AppFloatingConfiguratorComponent, AppLayoutComponent, AppModulesComponent, AppTopbar, AuthGuardService, BaseDataService, BaseModuleComponent, ConfigComponent, ContentType, DEFAULT_OIP_FRONTEND_CONFIG, DbMigrationComponent, DiscussionComponent, ErrorComponent, FooterComponent, HttpClient, KeycloakSecurityService, L10nService, LOGO_COMPONENT_TOKEN, LayoutService, LogoComponent, LogoService, MenuComponent, MenuService, MsgService, NotfoundComponent, NotificationService, OIP_FRONTEND_CONFIG, ProfileComponent, SecurePipe, SecurityComponent, SecurityDataService, SecurityService, SecurityStorageService, SidebarComponent, TableFilterService, TopBarService, UnauthorizedComponent, UserService, httpLoaderAuthFactory, langIntercept, mergeWithDefaults, provideAppThemes, provideLogoComponent, replaceDefaults };
+export { APP_THEME_PRESETS, APP_THEME_PRESETS_MERGE_MODE, AppConfiguratorComponent, AppFloatingConfiguratorComponent, AppLayoutComponent, AppModulesComponent, AppTopbar, AuthGuardService, BaseDataService, BaseModuleComponent, ConfigComponent, ContentType, DEFAULT_OIP_FRONTEND_CONFIG, DbMigrationComponent, DiscussionComponent, ErrorComponent, FooterComponent, HttpClient, IframeModuleComponent, KeycloakSecurityService, L10nService, LOGO_COMPONENT_TOKEN, LayoutService, LogoComponent, LogoService, MenuComponent, MenuService, MsgService, NotfoundComponent, NotificationService, OIP_FRONTEND_CONFIG, ProfileComponent, SecurePipe, SecurityComponent, SecurityDataService, SecurityService, SecurityStorageService, SidebarComponent, TableFilterService, TopBarService, UnauthorizedComponent, UserService, httpLoaderAuthFactory, langIntercept, mergeWithDefaults, provideAppThemes, provideLogoComponent, replaceDefaults };
 export type { AppConfig, AppThemePreset, AppThemePresetMergeMode, LanguageDto, MenuChangeEvent, NoSettingsDto, OipFrontendAppMode, OipFrontendConfig, PutSecurityDto, RequestParams, SecurityDto, TopBarDto };

package/package.json

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