oip-common 0.6.2 → 0.6.4

package/index.d.ts

@@ -197,8 +197,9 @@ declare class L10nService {
      */
     get(key: string): Observable<any>;
     /**
-     * Internal method to load translations from JSON files
-     * @param component - Component or translation namespace
+     * Internal method to merge a namespace's statically-registered translations
+     * (see <c>registerTranslations</c>) into the active language dictionary.
+     * @param component - Translation namespace
      * @param lang - Language code to load translations for
      */
     private loadTranslations;
@@ -422,18 +423,8 @@ declare abstract class BaseModuleComponent<TBackendStoreSettings, TLocalStoreSet
      * @type {string}
      */
     title: string;
-    /**
-     * Translations bundled with the component, grouped by language code.
-     * Declare it in a derived component to load translations from the component folder
-     * instead of `assets/i18n`:
-     *
-     * ```ts
-     * static override readonly translations = { en, ru };
-     * ```
-     */
-    static readonly translations: TranslationsByLang | undefined;
+    private readonly baseTranslations;
     l10nService: L10nService;
-    l10n$: Observable<Translation | TranslationObject>;
     canRead: boolean;
     canEdit: boolean;
     canDelete: boolean;
@@ -541,6 +532,7 @@ declare abstract class BaseModuleComponent<TBackendStoreSettings, TLocalStoreSet
 }
 
 declare class SecurityComponent implements OnChanges, OnInit, OnDestroy {
+    private readonly translations;
     private readonly msgService;
     private readonly translateService;
     private readonly httpClient;
@@ -550,7 +542,6 @@ declare class SecurityComponent implements OnChanges, OnInit, OnDestroy {
     id?: number;
     controller?: string;
     roles: string[];
-    constructor(l10nService: L10nService);
     ngOnDestroy(): void;
     ngOnChanges(changes: SimpleChanges): void;
     ngOnInit(): void;
@@ -615,12 +606,60 @@ declare class LogoService {
     static ɵprov: i0.ɵɵInjectableDeclaration<LogoService>;
 }
 
+/**
+ * Application information value. A function or a signal is read on every change detection,
+ * so it can return a localized value.
+ */
+type AppInfoValue = string | (() => string);
+/**
+ * Application information displayed by the shell components.
+ */
+interface AppInfo {
+    /**
+     * Application version, for example generated at build time from package.json.
+     */
+    version?: AppInfoValue;
+    /**
+     * Application name displayed in the footer.
+     */
+    footer?: AppInfoValue;
+    /**
+     * Application name displayed in the top bar.
+     */
+    title?: AppInfoValue;
+}
+declare const APP_INFO_TOKEN: InjectionToken<AppInfo>;
+/**
+ * Provides application information instead of the `app-info.*` translation keys.
+ */
+declare function provideAppInfo(appInfo: AppInfo): Provider;
+declare class AppInfoService {
+    private appInfo;
+    /**
+     * Returns the provided version or null when it should be taken from translations.
+     */
+    getVersion(): string | null;
+    /**
+     * Returns the provided application name or null when it should be taken from translations.
+     */
+    getFooter(): string | null;
+    /**
+     * Returns the provided application name or null when it should be taken from translations.
+     */
+    getTitle(): string | null;
+    private resolve;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AppInfoService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AppInfoService>;
+}
+
 declare class AppTopbar {
+    private readonly translations;
     securityService: SecurityService;
     topBarService: TopBarService;
     userService: UserService;
     layoutService: LayoutService;
     logoService: LogoService;
+    appInfoService: AppInfoService;
     private readonly confirmationService;
     private readonly translateService;
     onActiveTabChange(value: string | number | undefined): void;
@@ -633,6 +672,7 @@ declare class AppTopbar {
 
 declare class FooterComponent {
     protected logoService: LogoService;
+    protected appInfoService: AppInfoService;
     static ɵfac: i0.ɵɵFactoryDeclaration<FooterComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<FooterComponent, "app-footer", never, {}, {}, never, never, true, never>;
 }
@@ -848,6 +888,7 @@ declare class MenuItemEditDialogComponent {
 }
 
 declare class MenuComponent implements OnInit {
+    private readonly translations;
     readonly menuService: MenuService;
     readonly securityService: SecurityService;
     readonly translateService: TranslateService;
@@ -900,12 +941,13 @@ declare class LogoComponent {
 }
 
 declare class NotfoundComponent {
-    constructor(l10nService: L10nService);
+    private readonly translations;
     static ɵfac: i0.ɵɵFactoryDeclaration<NotfoundComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<NotfoundComponent, "app-notfound", never, {}, {}, never, never, true, never>;
 }
 
 declare class UnauthorizedComponent implements OnInit {
+    private readonly translations;
     protected readonly securityService: SecurityService;
     private readonly route;
     ngOnInit(): void;
@@ -915,11 +957,13 @@ declare class UnauthorizedComponent implements OnInit {
 }
 
 declare class AccessComponent {
+    private readonly translations;
     static ɵfac: i0.ɵɵFactoryDeclaration<AccessComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<AccessComponent, "app-access", never, {}, {}, never, never, true, never>;
 }
 
 declare class ErrorComponent {
+    private readonly translations;
     static ɵfac: i0.ɵɵFactoryDeclaration<ErrorComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<ErrorComponent, "app-error", never, {}, {}, never, never, true, never>;
 }
@@ -954,12 +998,12 @@ declare class UserProfileApi<SecurityDataType = unknown> extends HttpClient<Secu
 }
 
 declare class UserProfileComponent {
+    private readonly translations;
     readonly userService: UserService;
     readonly msgService: MsgService;
     readonly translateService: TranslateService;
     readonly userProfileApi: UserProfileApi<any>;
     private readonly confirmationService;
-    constructor(l10nService: L10nService);
     uploadPhoto(event: any): Promise<void>;
     confirmDeletePhoto(event: Event): void;
     private deletePhoto;
@@ -968,6 +1012,7 @@ declare class UserProfileComponent {
 }
 
 declare class ConfigComponent {
+    private readonly translations;
     private readonly layoutService;
     protected readonly l10nService: L10nService;
     protected readonly userService: UserService;
@@ -1003,46 +1048,7 @@ interface MigrationDto {
     exist: boolean;
 }
 declare class DbMigrationComponent extends BaseModuleComponent<NoSettingsDto, NoSettingsDto> implements OnInit, OnDestroy {
-    static readonly translations: {
-        en: {
-            "db-migration": {
-                migrationManager: string;
-                actions: {
-                    refresh: string;
-                    cleanFilter: string;
-                    applyMigration: string;
-                };
-                columns: {
-                    name: string;
-                    applied: string;
-                    exist: string;
-                    pending: string;
-                };
-                messages: {
-                    errorRefreshing: string;
-                };
-            };
-        };
-        ru: {
-            "db-migration": {
-                migrationManager: string;
-                actions: {
-                    refresh: string;
-                    cleanFilter: string;
-                    applyMigration: string;
-                };
-                columns: {
-                    name: string;
-                    applied: string;
-                    exist: string;
-                    pending: string;
-                };
-                messages: {
-                    errorRefreshing: string;
-                };
-            };
-        };
-    };
+    private readonly translations;
     data: MigrationDto[];
     ngOnInit(): Promise<void>;
     refreshAction(): Promise<void>;
@@ -1159,6 +1165,7 @@ declare type SurfacesType = {
     palette?: PaletteDesignToken;
 };
 declare class AppConfiguratorComponent implements OnInit {
+    private readonly translations;
     router: Router;
     config: PrimeNG;
     layoutService: LayoutService;
@@ -1179,7 +1186,6 @@ declare class AppConfiguratorComponent implements OnInit {
         label: string;
         value: string;
     }[];
-    constructor(l10nService: L10nService);
     ngOnInit(): void;
     surfaces: SurfacesType[];
     selectedPrimaryColor: i0.Signal<string>;
@@ -1321,6 +1327,7 @@ type DiscussionComment = Omit<CommentDto, 'attachments' | 'reactions' | 'mention
 type DiscussionHistoryItem = Required<CommentHistoryDto>;
 declare class DiscussionComponent implements OnChanges, OnDestroy, OnInit {
     private readonly msgService;
+    private readonly translations;
     private readonly discussionApi;
     private readonly sanitizer;
     private readonly translateService;
@@ -1341,7 +1348,6 @@ declare class DiscussionComponent implements OnChanges, OnDestroy, OnInit {
     historyByComment: Record<number, HistoryState>;
     emojiPalette: string[];
     private mentionSearchTimer;
-    constructor(l10nService: L10nService);
     ngOnChanges(changes: SimpleChanges): void;
     ngOnInit(): Promise<void>;
     ngOnDestroy(): void;
@@ -1382,28 +1388,7 @@ declare class DiscussionComponent implements OnChanges, OnDestroy, OnInit {
 }
 
 declare class IframeModuleComponent extends BaseModuleComponent<IframeModuleSettings, IframeModuleSettings> implements OnInit, OnDestroy {
-    static readonly translations: {
-        en: {
-            "iframe-module": {
-                iframeModule: {
-                    urlPlaceholder: string;
-                    settingSaveButtonLabel: string;
-                    emptyUrlMessage: string;
-                    siteLoadingMessage: string;
-                };
-            };
-        };
-        ru: {
-            "iframe-module": {
-                iframeModule: {
-                    urlPlaceholder: string;
-                    settingSaveButtonLabel: string;
-                    emptyUrlMessage: string;
-                    siteLoadingMessage: string;
-                };
-            };
-        };
-    };
+    private readonly translations;
     private iframe?;
     private readonly renderer;
     private readonly translate;
@@ -1494,6 +1479,7 @@ interface GetNotificationByIdParams {
 }
 
 declare class UserNotificationsComponent {
+    private readonly translations;
     private popover?;
     protected notifications: UserNotificationDto[];
     protected totalCount: number;
@@ -1507,7 +1493,6 @@ declare class UserNotificationsComponent {
     private readonly translateService;
     protected readonly unreadNotificationCount: i0.Signal<number>;
     protected readonly unreadNotificationBadge: i0.Signal<string>;
-    constructor(l10nService: L10nService);
     protected toggle(event: Event): Promise<void>;
     loadNotifications(): Promise<void>;
     onPageChange(event: PaginatorState): Promise<void>;
@@ -1782,6 +1767,27 @@ declare class ApplicationsApi<SecurityDataType = unknown> extends HttpClient<Sec
 
 declare function convertToPrimeNgDateFormat(dateformat: string): string;
 
+/**
+ * Registers a component's co-located translations and merges them into the
+ * active language. The namespace is derived from the JSON's own root key,
+ * so callers never repeat it as a string literal.
+ *
+ * Must be called from an injection context - as a field initializer, or as
+ * the first statement in a constructor - the same requirement as `inject()`
+ * itself, which it uses internally.
+ *
+ * ```ts
+ * import en from './l10n/menu.en.json';
+ * import ru from './l10n/menu.ru.json';
+ *
+ * @Component({ ... })
+ * export class MenuComponent {
+ *   private readonly translations = provideTranslations({ en, ru });
+ * }
+ * ```
+ */
+declare function provideTranslations(byLang: TranslationsByLang): Observable<Translation | TranslationObject>;
+
 declare class NotificationApi<SecurityDataType = unknown> extends HttpClient<SecurityDataType> {
     getNotificationByUser: (query: GetNotificationByUserParams, params?: RequestParams) => Promise<UserNotificationListResponse>;
     getNotificationCountByUser: (params?: RequestParams) => Promise<UserNotificationCountResponse>;
@@ -1833,5 +1839,5 @@ declare class CustomElementExtensionModuleHostComponent extends BaseModuleCompon
     static ɵcmp: i0.ɵɵComponentDeclaration<CustomElementExtensionModuleHostComponent, "ng-component", never, {}, {}, never, never, true, never>;
 }
 
-export { APP_THEME_PRESETS, APP_THEME_PRESETS_MERGE_MODE, AccessComponent, AppConfiguratorComponent, AppFloatingConfiguratorComponent, AppLayoutComponent, AppModulesComponent, AppTopbar, AppTopbarApplicationSwitcherComponent, ApplicationRegistryService, ApplicationsApi, ApplicationsComponent, AuthGuardService, BaseModuleComponent, BffSecurityService, ConfigComponent, ContentType, CustomElementExtensionModuleHostComponent, DbMigrationComponent, DiscussionComponent, ErrorComponent, ExtensionLoaderService, ExtensionModuleHostComponent, FolderModuleApi, FooterComponent, HttpClient, IframeModuleApi, IframeModuleComponent, L10nService, LOGO_COMPONENT_TOKEN, LayoutService, LogoComponent, LogoService, MenuComponent, MenuService, ModuleInstanceRightsService, MsgService, NotfoundComponent, NotificationApi, NotificationService, OIP_EXTENSION_EVENTS, SecurityApi, SecurityComponent, SecurityService, SidebarComponent, TableFilterService, TopBarService, UnauthorizedComponent, UserNotificationsComponent, UserProfileApi, UserProfileComponent, UserService, convertToPrimeNgDateFormat, defaultTheme, emitOipContextChange, emitOipError, emitOipNavigate, emitOipNotify, emitOipSettingsChange, emitOipTitleChange, langIntercept, mergeWithDefaults, moduleAccessGuard, provideAppThemes, provideLogoComponent, provideOip, replaceDefaults };
-export type { AppConfig, AppThemePreset, AppThemePresetMergeMode, AuthCsrfToken, LanguageDto, MenuChangeEvent, ModuleAccessRouteData, NoSettingsDto, OipExtensionHostContext, OipExtensionLoadType, OipExtensionManifest, OipExtensionModuleMetadata, OipExtensionNavigateEvent, OipExtensionNotifyEvent, PutSecurityDto, RequestParams, SecurityDto, TopBarDto };
+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, ConfigComponent, ContentType, CustomElementExtensionModuleHostComponent, DbMigrationComponent, DiscussionComponent, ErrorComponent, ExtensionLoaderService, ExtensionModuleHostComponent, FolderModuleApi, FooterComponent, HttpClient, IframeModuleApi, IframeModuleComponent, L10nService, LOGO_COMPONENT_TOKEN, LayoutService, LogoComponent, LogoService, MenuComponent, MenuService, ModuleInstanceRightsService, MsgService, NotfoundComponent, NotificationApi, NotificationService, OIP_EXTENSION_EVENTS, SecurityApi, SecurityComponent, SecurityService, SidebarComponent, TableFilterService, TopBarService, UnauthorizedComponent, UserNotificationsComponent, UserProfileApi, UserProfileComponent, UserService, convertToPrimeNgDateFormat, defaultTheme, emitOipContextChange, emitOipError, emitOipNavigate, emitOipNotify, emitOipSettingsChange, emitOipTitleChange, langIntercept, mergeWithDefaults, moduleAccessGuard, provideAppInfo, provideAppThemes, provideLogoComponent, provideOip, provideTranslations, replaceDefaults };
+export type { AppConfig, AppInfo, AppInfoValue, AppThemePreset, AppThemePresetMergeMode, AuthCsrfToken, LanguageDto, MenuChangeEvent, ModuleAccessRouteData, NoSettingsDto, OipExtensionHostContext, OipExtensionLoadType, OipExtensionManifest, OipExtensionModuleMetadata, OipExtensionNavigateEvent, OipExtensionNotifyEvent, PutSecurityDto, RequestParams, SecurityDto, TopBarDto };

package/package.json

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