oip-common 0.7.1 → 0.9.0

package/index.d.ts

@@ -126,6 +126,11 @@ declare class LayoutService {
     timeZone: i0.Signal<string>;
     adminMode: i0.Signal<boolean>;
     transitionComplete: i0.WritableSignal<boolean>;
+    /**
+     * Controls the visibility of the layout footer.
+     * Modules can hide the footer to free up vertical space for full-screen content.
+     */
+    footerVisible: i0.WritableSignal<boolean>;
     private initialized;
     constructor();
     /**
@@ -393,6 +398,11 @@ declare abstract class BaseModuleComponent<TBackendStoreSettings, TLocalStoreSet
     private static readonly editRight;
     private static readonly deleteRight;
     protected isInitialized: boolean;
+    /**
+     * Set to true in a descendant to hide the layout footer while the module is active.
+     * The footer is restored when the module is destroyed.
+     */
+    protected hideFooter: boolean;
     protected moduleInstanceReloadPromise: Promise<void>;
     protected rightsSubscription?: Subscription;
     protected securityRoles: string[];
@@ -519,12 +529,13 @@ declare abstract class BaseModuleComponent<TBackendStoreSettings, TLocalStoreSet
     /**
      * Lifecycle hook that is called when a component is destroyed.
      * Unsubscribes from all subscriptions to prevent memory leaks,
-     * resets the top bar items to an empty array, and sets the active ID
-     * to the ID of the first top bar item (if available).
+     * restores the layout footer, resets the top bar items to an empty array,
+     * and sets the active ID to the ID of the first top bar item (if available).
      */
     ngOnDestroy(): void;
     /**
-     * Initializes the component. Subscribes to translation service to set captions for top bar items,
+     * Initializes the component. Applies the footer visibility declared by the module,
+     * subscribes to translation service to set captions for top bar items,
      * sets the top bar items via the top bar service, sets the active ID,
      * subscribes to route parameters to get the ID, and retrieves settings.
      * @return {Promise<void>} A promise that resolves when the initialization is complete.
@@ -717,6 +728,10 @@ declare class FooterComponent {
     static ɵcmp: i0.ɵɵComponentDeclaration<FooterComponent, "app-footer", never, {}, {}, never, never, true, never>;
 }
 
+declare enum DefaultSecretFindingKind {
+    ShippedDefault = "ShippedDefault",
+    Missing = "Missing"
+}
 interface AddModuleInstanceDto {
     moduleId?: number;
     label?: string | null;
@@ -735,6 +750,17 @@ interface AuthSessionResponse {
     email?: string | null;
     roles?: string[] | null;
 }
+interface DefaultSecretFindingResponse {
+    configKey?: string | null;
+    kind?: DefaultSecretFindingKind;
+    environmentVariable?: string | null;
+}
+interface DefaultSecretsReportResponse {
+    hasFindings?: boolean;
+    checkedCount?: number;
+    showBanner?: boolean;
+    findings?: DefaultSecretFindingResponse[] | null;
+}
 interface EditModuleInstanceDto {
     moduleInstanceId?: number;
     label?: string | null;
@@ -1632,6 +1658,31 @@ declare class NoModulesComponent {
     static ɵcmp: i0.ɵɵComponentDeclaration<NoModulesComponent, "app-no-modules", never, {}, {}, never, never, true, never>;
 }
 
+/**
+ * Administrator banner listing the secret settings that still hold a value shipped with the repository.
+ *
+ * The report comes from the same cached validator that feeds the startup log and the `default-secrets`
+ * health check, so the three never disagree. Only administrators see it - the endpoint is admin-only.
+ *
+ * Whether the banner is raised at all is decided by the server through `showBanner`: findings are reported in
+ * every environment, but the banner appears only in Production. Set `ASPNETCORE_ENVIRONMENT=Production` to see
+ * it locally.
+ */
+declare class DefaultSecretsBannerComponent implements OnInit {
+    private readonly translations;
+    private readonly securityApi;
+    private readonly securityService;
+    private readonly destroyRef;
+    protected readonly report: i0.WritableSignal<DefaultSecretsReportResponse>;
+    protected readonly expanded: i0.WritableSignal<boolean>;
+    ngOnInit(): void;
+    protected kindLabel(finding: DefaultSecretFindingResponse): string;
+    protected dismiss(): void;
+    private load;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DefaultSecretsBannerComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<DefaultSecretsBannerComponent, "default-secrets-banner", 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.
@@ -1919,6 +1970,7 @@ declare class SecurityApi<SecurityDataType = unknown> extends HttpClient<Securit
     deleteAuthSession: (params?: RequestParams) => Promise<any>;
     getAuthCsrfToken: (params?: RequestParams) => Promise<AuthCsrfTokenResponse>;
     getRealmRoles: (params?: RequestParams) => Promise<string[]>;
+    getDefaultSecretsReport: (params?: RequestParams) => Promise<DefaultSecretsReportResponse>;
     static ɵfac: i0.ɵɵFactoryDeclaration<SecurityApi<any>, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<SecurityApi<any>>;
 }
@@ -2153,5 +2205,5 @@ interface OipRoutesOptions {
  */
 declare function provideOipRoutes(options?: OipRoutesOptions): Routes;
 
-export { APP_INFO_TOKEN, APP_THEME_PRESETS, APP_THEME_PRESETS_MERGE_MODE, AccessComponent, AppConfiguratorComponent, AppFloatingConfiguratorComponent, AppInfoService, AppLayoutComponent, AppModulesComponent, AppTopbar, AppTopbarApplicationSwitcherComponent, ApplicationRegistryService, ApplicationsApi, ApplicationsComponent, AuthGuardService, BaseModuleComponent, BffSecurityService, BlockLoaderComponent, ConfigComponent, ContentType, CustomElementExtensionModuleHostComponent, DbMigrationComponent, DiscussionComponent, ErrorComponent, ExtensionLoaderService, ExtensionModuleHostComponent, FolderModuleApi, FooterComponent, HttpClient, IframeModuleApi, IframeModuleComponent, L10nService, LOGO_COMPONENT_TOKEN, LayoutService, LogoComponent, LogoService, MenuComponent, MenuService, ModuleInstanceRightsService, ModuleLoadingService, MsgService, NoModulesComponent, NotfoundComponent, NotificationApi, NotificationService, OIP_EXTENSION_EVENTS, SecurityApi, SecurityComponent, SecurityService, SidebarComponent, StartPageService, TableFilterService, TopBarService, UnauthorizedComponent, UserNotificationsComponent, UserProfileApi, UserProfileComponent, UserService, convertToPrimeNgDateFormat, defaultTheme, emitOipContextChange, emitOipError, emitOipNavigate, emitOipNotify, emitOipSettingsChange, emitOipTitleChange, langIntercept, mergeWithDefaults, moduleAccessGuard, oipAccessRoute, oipApplicationsRoute, oipAuthGuard, oipConfigRoute, oipDbMigrationRoute, oipDiscussionRoute, oipErrorRoute, oipExtensionsRoute, oipIframeModuleRoute, oipModulesRoute, oipNoModulesRoute, oipProfileRoute, oipStartRedirectGuard, oipStartRoute, provideAppInfo, provideAppThemes, provideLogoComponent, provideOip, provideOipRoutes, provideTranslations, replaceDefaults };
+export { APP_INFO_TOKEN, APP_THEME_PRESETS, APP_THEME_PRESETS_MERGE_MODE, AccessComponent, AppConfiguratorComponent, AppFloatingConfiguratorComponent, AppInfoService, AppLayoutComponent, AppModulesComponent, AppTopbar, AppTopbarApplicationSwitcherComponent, ApplicationRegistryService, ApplicationsApi, ApplicationsComponent, AuthGuardService, BaseModuleComponent, BffSecurityService, BlockLoaderComponent, ConfigComponent, ContentType, CustomElementExtensionModuleHostComponent, DbMigrationComponent, DefaultSecretsBannerComponent, DiscussionComponent, ErrorComponent, ExtensionLoaderService, ExtensionModuleHostComponent, FolderModuleApi, FooterComponent, HttpClient, IframeModuleApi, IframeModuleComponent, L10nService, LOGO_COMPONENT_TOKEN, LayoutService, LogoComponent, LogoService, MenuComponent, MenuService, ModuleInstanceRightsService, ModuleLoadingService, MsgService, NoModulesComponent, NotfoundComponent, NotificationApi, NotificationService, OIP_EXTENSION_EVENTS, SecurityApi, SecurityComponent, SecurityService, SidebarComponent, StartPageService, TableFilterService, TopBarService, UnauthorizedComponent, UserNotificationsComponent, UserProfileApi, UserProfileComponent, UserService, convertToPrimeNgDateFormat, defaultTheme, emitOipContextChange, emitOipError, emitOipNavigate, emitOipNotify, emitOipSettingsChange, emitOipTitleChange, langIntercept, mergeWithDefaults, moduleAccessGuard, oipAccessRoute, oipApplicationsRoute, oipAuthGuard, oipConfigRoute, oipDbMigrationRoute, oipDiscussionRoute, oipErrorRoute, oipExtensionsRoute, oipIframeModuleRoute, oipModulesRoute, oipNoModulesRoute, oipProfileRoute, oipStartRedirectGuard, oipStartRoute, provideAppInfo, provideAppThemes, provideLogoComponent, provideOip, provideOipRoutes, provideTranslations, replaceDefaults };
 export type { AppConfig, AppInfo, AppInfoValue, AppThemePreset, AppThemePresetLoader, AppThemePresetMergeMode, AuthCsrfToken, LanguageDto, MenuChangeEvent, ModuleAccessRouteData, NoSettingsDto, OipExtensionHostContext, OipExtensionLoadType, OipExtensionManifest, OipExtensionModuleMetadata, OipExtensionNavigateEvent, OipExtensionNotifyEvent, OipRouteFeatures, OipRouteToggle, OipRoutesOptions, PutSecurityDto, RequestParams, SecurityDto, StartRouteData, TopBarDto };

package/package.json

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