oip-common 0.1.6 → 0.1.8

package/index.d.ts

@@ -1,12 +1,13 @@
 import * as i0 from '@angular/core';
-import { OnInit, OnDestroy, WritableSignal, Type, Provider, InjectionToken, EventEmitter, Renderer2, OnChanges, SimpleChanges, PipeTransform } from '@angular/core';
+import { OnInit, OnDestroy, 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 { TranslateService, InterpolationParameters, Translation, TranslationObject } from '@ngx-translate/core';
+import { InterpolationParameters, Translation, TranslationObject, TranslateService } from '@ngx-translate/core';
 import * as rxjs from 'rxjs';
 import { Subscription, Subject, Observable, BehaviorSubject } 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';
 import { PrimeNG } from 'primeng/config';
 import { Table } from 'primeng/table';
 import { HttpInterceptorFn, HttpClient as HttpClient$1 } from '@angular/common/http';
@@ -44,6 +45,9 @@ declare class MsgService {
     warn(detail: any, summary?: any, life?: number): void;
     error(detail: any, summary?: any, life?: number): void;
     extractErrorMessage(error: unknown, fallback: string): string;
+    private extractValidationMessage;
+    private toValidationMessages;
+    private getObjectProperty;
     errorFromException(error: unknown, fallback: string, summary?: string, life?: number): void;
     contrast(detail: any, summary?: any, life?: number): void;
     secondary(detail: any, summary?: any, life?: number): void;
@@ -176,9 +180,64 @@ declare class LayoutService {
     static ɵprov: i0.ɵɵInjectableDeclaration<LayoutService>;
 }
 
+interface LanguageDto {
+    code: string;
+    name: string;
+    icon: string;
+}
+/**
+ * Service for managing translation loading in the application
+ */
+declare class L10nService {
+    private loadedTranslations;
+    private httpClient;
+    private translateService;
+    private readonly primeNg;
+    private readonly layoutService;
+    availableLanguages: LanguageDto[];
+    /**
+     * Loads translations for a specific component
+     * @param component - Name of the component to load translations for
+     */
+    loadComponentTranslations(component: string): void;
+    /**
+     * Gets the translated value of a key (or an array of keys)
+     * @returns the translated key, or an object of translated keys
+     */
+    get(key: string): rxjs.Observable<any>;
+    /**
+     * Internal method to load translations from JSON files
+     * @param component - Component or translation namespace
+     * @param lang - Language code to load translations for
+     */
+    private loadTranslations;
+    /**
+     * Changes the lang currently used
+     */
+    use(selectedLanguage: string, key?: string): void;
+    init(languages: LanguageDto[]): void;
+    instant(key: string | string[], interpolateParams?: InterpolationParameters): Translation | TranslationObject;
+    static ɵfac: i0.ɵɵFactoryDeclaration<L10nService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<L10nService>;
+}
+
+interface SecurityDto {
+    code: string;
+    name: string;
+    description: string;
+    roles: string[];
+}
+
 declare abstract class BaseModuleComponent<TBackendStoreSettings, TLocalStoreSettings> implements OnInit, OnDestroy {
+    private static readonly readRight;
+    private static readonly editRight;
+    private static readonly deleteRight;
     private isInitialized;
     private moduleInstanceReloadPromise;
+    private rightsSubscription?;
+    private readonly destroyRef;
+    private readonly securityDataService;
+    private readonly securityService;
     /**
      * Provide access to app settings
      */
@@ -246,6 +305,12 @@ declare abstract class BaseModuleComponent<TBackendStoreSettings, TLocalStoreSet
      * @type {string}
      */
     title: string;
+    l10nService: L10nService;
+    l10n$: Observable<Translation | TranslationObject>;
+    canRead: boolean;
+    canEdit: boolean;
+    canDelete: boolean;
+    securityRightsLoaded: boolean;
     /**
      * Updates local settings and persists them to local storage.
      * @return {void}
@@ -281,6 +346,10 @@ declare abstract class BaseModuleComponent<TBackendStoreSettings, TLocalStoreSet
      * Defines the top bar items.
      */
     topBarItems: TopBarDto[];
+    /**
+     * Gets an instant translation for a key or an array of keys.
+     */
+    t(key: string | string[], interpolateParams?: InterpolationParameters): Translation | TranslationObject;
     /**
      * Initializes the component and subscribes to local settings updates.
      */
@@ -315,23 +384,37 @@ declare abstract class BaseModuleComponent<TBackendStoreSettings, TLocalStoreSet
      * Derived components can override this to refresh module-specific data.
      */
     protected onModuleInstanceChange(): Promise<void>;
+    /**
+     * Called whenever current user rights for the active module instance are recalculated.
+     */
+    protected onSecurityRightsChange(): void;
+    /**
+     * Starts watching current token roles and maps them to module instance security settings.
+     */
+    protected watchSecurityRights(controller?: string, id?: number | undefined): void;
+    private resetRightsState;
+    private updateRightsState;
+    protected hasSecurityRight(roles: string[], securitySettings: SecurityDto[], code: string): boolean;
     private reloadModuleInstance;
     static ɵfac: i0.ɵɵFactoryDeclaration<BaseModuleComponent<any, any>, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<BaseModuleComponent<any, any>, "ng-component", never, {}, {}, never, never, true, never>;
 }
 
-declare class SecurityComponent implements OnInit, OnDestroy {
+declare class SecurityComponent implements OnChanges, OnInit, OnDestroy {
     private readonly msgService;
     private readonly dataService;
     private readonly translateService;
+    private securityLoadToken;
     securityData: any[];
-    id: number;
-    controller: string;
+    id?: number;
+    controller?: string;
     roles: string[];
     ngOnDestroy(): void;
+    ngOnChanges(changes: SimpleChanges): void;
     ngOnInit(): void;
     saveClick(): void;
     saveKeyDown($event: KeyboardEvent): void;
+    private loadSecurity;
     static ɵfac: i0.ɵɵFactoryDeclaration<SecurityComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<SecurityComponent, "security", never, { "id": { "alias": "id"; "required": false; }; "controller": { "alias": "controller"; "required": false; }; }, {}, never, never, true, never>;
 }
@@ -925,47 +1008,6 @@ declare class LogoComponent {
     static ɵcmp: i0.ɵɵComponentDeclaration<LogoComponent, "logo", never, { "width": { "alias": "width"; "required": false; }; "height": { "alias": "height"; "required": false; }; }, {}, never, never, true, never>;
 }
 
-interface LanguageDto {
-    code: string;
-    name: string;
-    icon: string;
-}
-/**
- * Service for managing translation loading in the application
- */
-declare class L10nService {
-    private loadedTranslations;
-    private httpClient;
-    private translateService;
-    private readonly primeNg;
-    private readonly layoutService;
-    availableLanguages: LanguageDto[];
-    /**
-     * Loads translations for a specific component
-     * @param component - Name of the component to load translations for
-     */
-    loadComponentTranslations(component: string): void;
-    /**
-     * Gets the translated value of a key (or an array of keys)
-     * @returns the translated key, or an object of translated keys
-     */
-    get(key: string): rxjs.Observable<any>;
-    /**
-     * Internal method to load translations from JSON files
-     * @param component - Component or translation namespace
-     * @param lang - Language code to load translations for
-     */
-    private loadTranslations;
-    /**
-     * Changes the lang currently used
-     */
-    use(selectedLanguage: string, key?: string): void;
-    init(languages: LanguageDto[]): void;
-    instant(key: string | string[], interpolateParams?: InterpolationParameters): Translation | TranslationObject;
-    static ɵfac: i0.ɵɵFactoryDeclaration<L10nService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<L10nService>;
-}
-
 declare class NotfoundComponent {
     constructor(l10nService: L10nService);
     static ɵfac: i0.ɵɵFactoryDeclaration<NotfoundComponent, never>;
@@ -1041,7 +1083,6 @@ interface MigrationDto {
 }
 declare class DbMigrationComponent extends BaseModuleComponent<NoSettingsDto, NoSettingsDto> implements OnInit, OnDestroy {
     data: MigrationDto[];
-    l10nService: L10nService;
     constructor();
     ngOnInit(): Promise<void>;
     refreshAction(): Promise<void>;
@@ -1090,20 +1131,7 @@ declare class AppModulesComponent implements OnInit {
 
 declare type SurfacesType = {
     name?: string;
-    palette?: {
-        0?: string;
-        50?: string;
-        100?: string;
-        200?: string;
-        300?: string;
-        400?: string;
-        500?: string;
-        600?: string;
-        700?: string;
-        800?: string;
-        900?: string;
-        950?: string;
-    };
+    palette?: PaletteDesignToken;
 };
 declare class AppConfiguratorComponent implements OnInit {
     router: Router;
@@ -1111,7 +1139,16 @@ declare class AppConfiguratorComponent implements OnInit {
     layoutService: LayoutService;
     platformId: Object;
     primeng: PrimeNG;
-    presets: string[];
+    private readonly injectedThemePresets;
+    private readonly themePresetMergeMode;
+    private readonly themePresets;
+    private readonly themePresetsMap;
+    private readonly defaultThemePreset;
+    private readonly fallbackPrimaryColors;
+    presets: {
+        label: string;
+        value: string;
+    }[];
     showMenuModeButton: i0.WritableSignal<boolean>;
     menuModeOptions: {
         label: string;
@@ -1124,22 +1161,10 @@ declare class AppConfiguratorComponent implements OnInit {
     selectedPreset: i0.Signal<string>;
     menuMode: i0.Signal<string>;
     primaryColors: i0.Signal<SurfacesType[]>;
+    surfaceColors: i0.Signal<SurfacesType[]>;
     getPresetExt(): {
         semantic: {
-            primary: {
-                0?: string;
-                50?: string;
-                100?: string;
-                200?: string;
-                300?: string;
-                400?: string;
-                500?: string;
-                600?: string;
-                700?: string;
-                800?: string;
-                900?: string;
-                950?: string;
-            };
+            primary: PaletteDesignToken;
             colorScheme: {
                 light: {
                     primary: {
@@ -1172,6 +1197,11 @@ declare class AppConfiguratorComponent implements OnInit {
             };
         };
     };
+    private getThemePresets;
+    private getThemeById;
+    private getPrimaryColorOptions;
+    private getSurfaceColorOptions;
+    private ensureValidThemeId;
     updateColors(event: MouseEvent, type: string, color: SurfacesType): void;
     applyTheme(type: string, color: SurfacesType): void;
     onPresetChange(event: string): void;
@@ -1423,13 +1453,6 @@ 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 SecurityDto {
-    code: string;
-    name: string;
-    description: string;
-    roles: string[];
-}
-
 interface PutSecurityDto {
     id: number;
     securities: SecurityDto[];
@@ -1522,6 +1545,24 @@ declare class TableFilterService {
     static ɵprov: i0.ɵɵInjectableDeclaration<TableFilterService>;
 }
 
+interface AppThemePreset {
+    id: string;
+    label?: string;
+    preset: Preset;
+    primaryColors?: Record<string, PaletteDesignToken | undefined>;
+    surfaceColors?: Record<string, PaletteDesignToken | undefined>;
+}
+type AppThemePresetMergeMode = 'mergeWithDefaults' | 'replaceDefaults';
+declare const APP_THEME_PRESETS: InjectionToken<readonly AppThemePreset[]>;
+declare const APP_THEME_PRESETS_MERGE_MODE: InjectionToken<AppThemePresetMergeMode>;
+
+interface ProvideAppThemesOptions {
+    mode?: AppThemePresetMergeMode;
+}
+declare function provideAppThemes(themes: AppThemePreset[], options?: ProvideAppThemesOptions): EnvironmentProviders;
+declare function mergeWithDefaults(themes: AppThemePreset[]): EnvironmentProviders;
+declare function replaceDefaults(themes: AppThemePreset[]): EnvironmentProviders;
+
 type OipFrontendAppMode = 'standalone' | 'distributed';
 interface OipFrontendConfig {
     appMode: OipFrontendAppMode;
@@ -1548,5 +1589,5 @@ declare class SecurePipe implements PipeTransform {
  */
 declare const httpLoaderAuthFactory: (httpClient: HttpClient$1) => StsConfigHttpLoader;
 
-export { 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, provideLogoComponent };
-export type { AppConfig, LanguageDto, MenuChangeEvent, NoSettingsDto, OipFrontendAppMode, OipFrontendConfig, PutSecurityDto, RequestParams, SecurityDto, TopBarDto };
+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 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.6",
+  "version": "0.1.8",
   "description": "A template for cross-platform web applications based on sakai-ng and primeNG",
   "main": "index.js",
   "keywords": [