oip-common 0.3.2 → 0.4.0

package/index.d.ts

@@ -1,11 +1,10 @@
 import * as i0 from '@angular/core';
-import { OnDestroy, OnInit, DestroyRef, WritableSignal, OnChanges, SimpleChanges, Type, Provider, InjectionToken, EventEmitter, Renderer2, EnvironmentProviders } from '@angular/core';
-import { MessageService, ToastMessageOptions, MenuItem, ConfirmationService, FilterMetadata } from 'primeng/api';
+import { OnDestroy, OnInit, DestroyRef, WritableSignal, OnChanges, SimpleChanges, Type, InjectionToken, Provider, EventEmitter, Renderer2, EnvironmentProviders } from '@angular/core';
+import { MessageService, ToastMessageOptions, ConfirmationService, MenuItem, 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 { Observable, BehaviorSubject, Subscription, Subject } from 'rxjs';
-import { LoginResponse, AuthOptions, OidcSecurityService, LogoutAuthOptions } from 'angular-auth-oidc-client';
 import { ContextMenu } from 'primeng/contextmenu';
 import { PaletteDesignToken, Preset } from '@primeuix/themes/types';
 import { PrimeNG } from 'primeng/config';
@@ -194,6 +193,10 @@ interface SecurityDto {
 type RefreshCustomParams = {
     [key: string]: string | number | boolean;
 };
+type AuthSessionRefreshResult = {
+    isAuthenticated: boolean;
+    userData: any;
+};
 type AuthCsrfToken = {
     token: string;
     headerName: string;
@@ -206,10 +209,10 @@ declare abstract class SecurityService {
     abstract isTokenExpired(): Observable<boolean>;
     abstract getCurrentUser(): any;
     abstract getCurrentUser$(): Observable<any>;
-    abstract forceRefreshSession(customParams?: RefreshCustomParams, configId?: string): Observable<LoginResponse>;
+    abstract forceRefreshSession(customParams?: RefreshCustomParams, configId?: string): Observable<AuthSessionRefreshResult>;
     abstract getCsrfToken(): Observable<AuthCsrfToken | null>;
     abstract isAdmin(): boolean;
-    abstract authorize(configId?: string, authOptions?: AuthOptions): void;
+    abstract authorize(): void;
     abstract payload: BehaviorSubject<any>;
 }
 declare class BffSecurityService implements OnDestroy, SecurityService {
@@ -225,7 +228,7 @@ declare class BffSecurityService implements OnDestroy, SecurityService {
     isTokenExpired(): Observable<boolean>;
     getCurrentUser(): any;
     getCurrentUser$(): Observable<any>;
-    forceRefreshSession(): Observable<LoginResponse>;
+    forceRefreshSession(): Observable<AuthSessionRefreshResult>;
     getCsrfToken(): Observable<AuthCsrfToken | null>;
     isAdmin(): boolean;
     authorize(): void;
@@ -239,103 +242,6 @@ declare class BffSecurityService implements OnDestroy, SecurityService {
     static ɵfac: i0.ɵɵFactoryDeclaration<BffSecurityService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<BffSecurityService>;
 }
-/**
- * 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 {
-    private readonly refreshLockKeyPrefix;
-    private readonly refreshResultKeyPrefix;
-    private readonly refreshLockTtlMs;
-    private readonly refreshWaitTimeoutMs;
-    private readonly refreshTabId;
-    private refreshSession$?;
-    /**
-     * 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>;
-    forceRefreshSession(customParams?: RefreshCustomParams, configId?: string): Observable<LoginResponse>;
-    getCsrfToken(): Observable<AuthCsrfToken | null>;
-    /**
-     * 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>;
-    private runSynchronizedRefresh;
-    private runSynchronizedRefreshWithStorageLock;
-    private refreshAsLockOwner;
-    private syncAuthState;
-    private applyLoginResponse;
-    private isCurrentAccessTokenExpired;
-    private tryAcquireRefreshLock;
-    private releaseRefreshLock;
-    private waitForRefreshResult;
-    private tryResolveRefreshResult;
-    private publishRefreshResult;
-    private readRefreshLock;
-    private readRefreshResult;
-    private getRefreshLockKey;
-    private getRefreshResultKey;
-    private getWebLocks;
-    private createRefreshTabId;
-    static ɵfac: i0.ɵɵFactoryDeclaration<KeycloakSecurityService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<KeycloakSecurityService>;
-}
 
 type QueryParamsType = Record<string | number, any>;
 type ResponseFormat = keyof Omit<Body, "body" | "bodyUsed">;
@@ -648,7 +554,6 @@ declare class LogoService {
 }
 
 declare class AppTopbar {
-    items: MenuItem[];
     securityService: SecurityService;
     topBarService: TopBarService;
     userService: UserService;
@@ -698,16 +603,6 @@ interface EditModuleInstanceDto {
 interface FolderModuleSettings {
     html?: string | null;
 }
-interface GetKeycloakClientSettingsResponse {
-    authority?: string | null;
-    clientId?: string | null;
-    scope?: string | null;
-    responseType?: string | null;
-    useRefreshToken?: boolean;
-    silentRenew?: boolean;
-    logLevel?: number;
-    secureRoutes?: string[] | null;
-}
 interface IframeModuleSettings {
     url?: string | null;
 }
@@ -1039,6 +934,86 @@ declare class AppModulesComponent implements OnInit {
     static ɵcmp: i0.ɵɵComponentDeclaration<AppModulesComponent, "app-modules", never, {}, {}, never, never, true, never>;
 }
 
+declare enum ServiceType {
+    Service = "Service",
+    Application = "Application"
+}
+interface ApplicationRegistryItemDto {
+    code?: string | null;
+    displayName?: string | null;
+    baseUrl?: string | null;
+    internalBaseUrl?: string | null;
+    icon?: string | null;
+    order?: number;
+    enabled?: boolean;
+    serviceType?: ServiceType;
+    isCurrent?: boolean;
+}
+interface GetApplicationRegistryItemByCodeParams {
+    code: string;
+}
+interface UpdateApplicationRegistryItemParams {
+    code: string;
+}
+interface DeleteApplicationRegistryItemParams {
+    code: string;
+}
+
+interface ApplicationEditModel {
+    code: string;
+    displayName: string;
+    baseUrl: string;
+    internalBaseUrl: string;
+    icon: string;
+    order: number;
+    enabled: boolean;
+    serviceType: NonNullable<ApplicationRegistryItemDto['serviceType']>;
+}
+interface ApplicationTableItem extends ApplicationRegistryItemDto {
+    _isEditing?: boolean;
+    _isNew?: boolean;
+    _editModel?: ApplicationEditModel;
+}
+declare class ApplicationsComponent implements OnInit {
+    protected readonly globalFilterFields: string[];
+    protected get serviceTypeOptions(): {
+        label: string;
+        value: NonNullable<ApplicationRegistryItemDto['serviceType']>;
+    }[];
+    protected applications: ApplicationTableItem[];
+    protected visibleApplications: ApplicationTableItem[];
+    protected globalFilter: string;
+    protected loading: boolean;
+    protected activeRowAction: boolean;
+    private readonly applicationsApi;
+    private readonly msgService;
+    private readonly l10nService;
+    private readonly titleService;
+    private readonly confirmationService;
+    private readonly translationsReady;
+    private draftApplication;
+    constructor();
+    ngOnInit(): Promise<void>;
+    protected refreshAction(): Promise<void>;
+    protected applyGlobalFilter(): void;
+    protected clearFilters(): void;
+    protected beginCreateApplication(): void;
+    protected editApplication(application: ApplicationTableItem): void;
+    protected cancelEdit(application: ApplicationTableItem): void;
+    protected saveApplication(application: ApplicationTableItem): Promise<void>;
+    protected deleteApplication(application: ApplicationTableItem): Promise<void>;
+    private createEditModel;
+    private normalizeEditModel;
+    protected serviceTypeLabel(serviceType: ApplicationRegistryItemDto['serviceType']): string;
+    private cancelAllEdits;
+    private syncVisibleApplications;
+    private filterApplications;
+    private getNextOrder;
+    private t;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ApplicationsComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<ApplicationsComponent, "app-applications", never, {}, {}, never, never, true, never>;
+}
+
 declare type SurfacesType = {
     name?: string;
     palette?: PaletteDesignToken;
@@ -1344,6 +1319,25 @@ declare class UserNotificationsComponent {
     static ɵcmp: i0.ɵɵComponentDeclaration<UserNotificationsComponent, "app-user-notifications", never, {}, {}, never, never, true, never>;
 }
 
+declare class ApplicationRegistryService {
+    private readonly applicationsApi;
+    applications: ApplicationRegistryItemDto[];
+    currentApplication: ApplicationRegistryItemDto | null;
+    loadApplications(): Promise<void>;
+    openApplication(application: ApplicationRegistryItemDto): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ApplicationRegistryService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ApplicationRegistryService>;
+}
+
+declare class AppTopbarApplicationSwitcherComponent implements OnInit {
+    protected applicationMenuItems: MenuItem[];
+    protected readonly applicationRegistryService: ApplicationRegistryService;
+    ngOnInit(): Promise<void>;
+    private createApplicationMenuItem;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AppTopbarApplicationSwitcherComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<AppTopbarApplicationSwitcherComponent, "app-topbar-application-switcher", never, {}, {}, never, never, true, never>;
+}
+
 /**
  * A route guard that ensures the user is authenticated and has a valid access token.
  * If the access token is expired, it attempts to refresh the session.
@@ -1447,12 +1441,21 @@ declare class SecurityApi<SecurityDataType = unknown> extends HttpClient<Securit
     createAuthSession: (params?: RequestParams) => Promise<any>;
     deleteAuthSession: (params?: RequestParams) => Promise<any>;
     getAuthCsrfToken: (params?: RequestParams) => Promise<AuthCsrfTokenResponse>;
-    getKeycloakClientSettings: (params?: RequestParams) => Promise<GetKeycloakClientSettingsResponse>;
     getRealmRoles: (params?: RequestParams) => Promise<string[]>;
     static ɵfac: i0.ɵɵFactoryDeclaration<SecurityApi<any>, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<SecurityApi<any>>;
 }
 
+declare class ApplicationsApi<SecurityDataType = unknown> extends HttpClient<SecurityDataType> {
+    getApplicationRegistryItems: (params?: RequestParams) => Promise<ApplicationRegistryItemDto[]>;
+    getApplicationRegistryItemByCode: ({ code, ...query }: GetApplicationRegistryItemByCodeParams, params?: RequestParams) => Promise<any>;
+    createApplicationRegistryItem: (data: ApplicationRegistryItemDto, params?: RequestParams) => Promise<any>;
+    updateApplicationRegistryItem: ({ code, ...query }: UpdateApplicationRegistryItemParams, data: ApplicationRegistryItemDto, params?: RequestParams) => Promise<any>;
+    deleteApplicationRegistryItem: ({ code, ...query }: DeleteApplicationRegistryItemParams, params?: RequestParams) => Promise<any>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ApplicationsApi<any>, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ApplicationsApi<any>>;
+}
+
 interface UserSettingsDto {
     preset?: string | null;
     primary?: string | null;
@@ -1491,5 +1494,5 @@ declare class NotificationApi<SecurityDataType = unknown> extends HttpClient<Sec
     static ɵprov: i0.ɵɵInjectableDeclaration<NotificationApi<any>>;
 }
 
-export { APP_THEME_PRESETS, APP_THEME_PRESETS_MERGE_MODE, AppConfiguratorComponent, AppFloatingConfiguratorComponent, AppLayoutComponent, AppModulesComponent, AppTopbar, AuthGuardService, BaseModuleComponent, BffSecurityService, ConfigComponent, ContentType, DbMigrationComponent, DiscussionComponent, ErrorComponent, FolderModuleApi, FooterComponent, HttpClient, IframeModuleApi, IframeModuleComponent, KeycloakSecurityService, L10nService, LOGO_COMPONENT_TOKEN, LayoutService, LogoComponent, LogoService, MenuComponent, MenuService, MsgService, NotfoundComponent, NotificationApi, NotificationService, ProfileComponent, SecurityApi, SecurityComponent, SecurityService, SidebarComponent, TableFilterService, TopBarService, UnauthorizedComponent, UserNotificationsComponent, UserProfileApi, UserService, convertToPrimeNgDateFormat, langIntercept, mergeWithDefaults, provideAppThemes, provideLogoComponent, provideOip, replaceDefaults };
+export { APP_THEME_PRESETS, APP_THEME_PRESETS_MERGE_MODE, AppConfiguratorComponent, AppFloatingConfiguratorComponent, AppLayoutComponent, AppModulesComponent, AppTopbar, AppTopbarApplicationSwitcherComponent, ApplicationRegistryService, ApplicationsApi, ApplicationsComponent, AuthGuardService, BaseModuleComponent, BffSecurityService, ConfigComponent, ContentType, DbMigrationComponent, DiscussionComponent, ErrorComponent, FolderModuleApi, FooterComponent, HttpClient, IframeModuleApi, IframeModuleComponent, L10nService, LOGO_COMPONENT_TOKEN, LayoutService, LogoComponent, LogoService, MenuComponent, MenuService, MsgService, NotfoundComponent, NotificationApi, NotificationService, ProfileComponent, SecurityApi, SecurityComponent, SecurityService, SidebarComponent, TableFilterService, TopBarService, UnauthorizedComponent, UserNotificationsComponent, UserProfileApi, UserService, convertToPrimeNgDateFormat, langIntercept, mergeWithDefaults, provideAppThemes, provideLogoComponent, provideOip, replaceDefaults };
 export type { AppConfig, AppThemePreset, AppThemePresetMergeMode, AuthCsrfToken, LanguageDto, MenuChangeEvent, NoSettingsDto, PutSecurityDto, RequestParams, SecurityDto, TopBarDto };

package/package.json

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

package/scripts/generate-api.mjs

@@ -82,8 +82,28 @@ let config = {
     onCreateRequestParams: (rawType) => {},
     onCreateRoute: (routeData) => {},
     onCreateRouteName: (routeNameInfo, rawRouteInfo) => {
-      if (routeNameInfo.usage.startsWith(rawRouteInfo.moduleName)) {
-        const str = routeNameInfo.usage.substring(rawRouteInfo.moduleName.length);
+      const route = rawRouteInfo.route || rawRouteInfo.path || "<unknown route>";
+      const method = rawRouteInfo.method || rawRouteInfo.requestMethod || "<unknown method>";
+      const tags = Array.isArray(rawRouteInfo.tags) ? rawRouteInfo.tags.join(", ") : (rawRouteInfo.tags || "<none>");
+      const moduleName = rawRouteInfo.moduleName;
+
+      if (!moduleName) {
+        throw new Error(
+          `Invalid API route name for ${method.toUpperCase()} ${route}. Missing moduleName. Tags: ${tags}. ` +
+            "Add a controller tag/module name or provide explicit operationId.",
+        );
+      }
+
+      if (routeNameInfo.usage === moduleName) {
+        throw new Error(
+          `Invalid API route name for ${method.toUpperCase()} ${route}. Generated usage "${routeNameInfo.usage}" ` +
+            `equals moduleName "${moduleName}". Add an action segment in controller route, ` +
+            `e.g. [HttpGet("get-${moduleName}")], or provide explicit operationId.`,
+        );
+      }
+
+      if (routeNameInfo.usage.startsWith(moduleName)) {
+        const str = routeNameInfo.usage.substring(moduleName.length);
         routeNameInfo.usage = str[0].toLowerCase() + str.slice(1);
         routeNameInfo.original = routeNameInfo.usage;
       }