oip-common 0.10.0 → 0.11.1

package/index.d.ts

@@ -85,6 +85,8 @@ interface AppConfig {
     timeFormat: string;
     dateTimeFormat: string;
     timeZone: string;
+    /** First day of the week in date pickers: 0 - Sunday, 1 - Monday, ..., 6 - Saturday. */
+    firstDayOfWeek?: number;
     adminMode?: boolean;
 }
 interface LayoutState {
@@ -124,6 +126,7 @@ declare class LayoutService {
     dateTimeFormat: i0.Signal<string>;
     monthFormat: i0.Signal<string>;
     timeZone: i0.Signal<string>;
+    firstDayOfWeek: i0.Signal<number>;
     adminMode: i0.Signal<boolean>;
     transitionComplete: i0.WritableSignal<boolean>;
     /**
@@ -219,6 +222,10 @@ declare class L10nService {
      */
     use(selectedLanguage: string, key?: string): void;
     init(languages: LanguageDto[]): void;
+    /**
+     * Passes the PrimeNG dictionary of the current language to PrimeNG, keeping the user's first day of the week
+     */
+    private applyPrimeNgTranslation;
     instant(key: string | string[], interpolateParams?: InterpolationParameters): Translation | TranslationObject;
     static ɵfac: i0.ɵɵFactoryDeclaration<L10nService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<L10nService>;
@@ -796,10 +803,6 @@ interface FolderModuleSettings {
 interface IframeModuleSettings {
     url?: string | null;
 }
-interface IntKeyValueDto {
-    key?: number;
-    value?: string | null;
-}
 interface ModuleInstanceDto {
     moduleInstanceId?: number;
     moduleId?: number;
@@ -815,6 +818,13 @@ interface ModuleInstanceDto {
     order?: number;
     separator?: boolean;
     isStart?: boolean;
+    isFolder?: boolean;
+}
+interface ModuleKeyValueDto {
+    key?: number;
+    value?: string | null;
+    icon?: string | null;
+    isFolder?: boolean;
 }
 interface GetAuthSessionsParams {
     userId?: string;
@@ -834,14 +844,21 @@ interface GetModuleInstanceRightsParams {
 interface DeleteModuleInstanceParams {
     id?: number;
 }
+interface CopyModuleInstanceParams {
+    id: number;
+}
 interface ChangeOrderParams {
     firstModuleId?: number;
     secondModuleId?: number;
 }
+interface CreateAuthSessionParams {
+    returnUrl?: string;
+}
 
 interface ContextMenuItemDto {
     moduleInstanceId: number;
     isStart?: boolean;
+    isFolder?: boolean;
     url: any;
     class: string | string[] | Set<string> | {
         [p: string]: any;
@@ -915,7 +932,7 @@ declare class MenuService {
     reset(): void;
     getMenu(): Promise<ModuleInstanceDto[]>;
     getAdminMenu(): Promise<ModuleInstanceDto[]>;
-    getModules(): Promise<IntKeyValueDto[]>;
+    getModules(): Promise<ModuleKeyValueDto[]>;
     addModuleInstance(addModuleInstance: AddModuleInstanceDto): Promise<void>;
     deleteItem(moduleInstanceId: number): Promise<void>;
     editModuleInstance(item: EditModuleInstanceDto): Promise<void>;
@@ -929,10 +946,11 @@ declare class MenuApi<SecurityDataType = unknown> extends HttpClient<SecurityDat
     deleteStartModule: (params?: RequestParams) => Promise<void>;
     getModuleInstanceRights: (query: GetModuleInstanceRightsParams, params?: RequestParams) => Promise<string[]>;
     getAdminMenu: (params?: RequestParams) => Promise<ModuleInstanceDto[]>;
-    getModules: (params?: RequestParams) => Promise<IntKeyValueDto[]>;
+    getModules: (params?: RequestParams) => Promise<ModuleKeyValueDto[]>;
     addModuleInstance: (data: AddModuleInstanceDto, params?: RequestParams) => Promise<void>;
     editModuleInstance: (data: EditModuleInstanceDto, params?: RequestParams) => Promise<void>;
     deleteModuleInstance: (query: DeleteModuleInstanceParams, params?: RequestParams) => Promise<void>;
+    copyModuleInstance: ({ id, ...query }: CopyModuleInstanceParams, params?: RequestParams) => Promise<number>;
     changeOrder: (query: ChangeOrderParams, params?: RequestParams) => Promise<void>;
     static ɵfac: i0.ɵɵFactoryDeclaration<MenuApi<any>, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<MenuApi<any>>;
@@ -943,12 +961,14 @@ type PrimeIconOption$1 = {
     value: string;
 };
 declare class MenuItemCreateDialogComponent implements OnInit {
+    private static readonly defaultIcon;
     protected readonly menuService: MenuService;
     protected readonly menu: MenuApi<any>;
     private readonly msgService;
     visible: boolean;
     visibleChange: EventEmitter<boolean>;
-    modules: IntKeyValueDto[];
+    modules: ModuleKeyValueDto[];
+    moduleOptions: ModuleKeyValueDto[];
     iconOptions: PrimeIconOption$1[];
     selectModule: any;
     label: string;
@@ -956,6 +976,12 @@ declare class MenuItemCreateDialogComponent implements OnInit {
     saving: boolean;
     get canSave(): boolean;
     ngOnInit(): Promise<void>;
+    /**
+     * Restricts the module list to the folder when the item is created at the menu root,
+     * since only a folder can be placed there.
+     */
+    private updateModuleOptions;
+    onModuleChange(moduleId: number): void;
     changeVisible(): void;
     save(): Promise<void>;
     hide(): void;
@@ -1125,10 +1151,17 @@ declare class ConfigComponent {
     protected selectedDateFormat: string;
     protected selectedTimeFormat: string;
     protected selectedTimeZone: string;
+    protected selectedFirstDayOfWeek: number;
+    /** Days of the week starting from Monday, named in the current language. */
+    protected readonly weekDays: i0.Signal<{
+        value: number;
+        label: string;
+    }[]>;
     constructor();
     changeLanguage(): void;
     changeDateFormat(): void;
     changeTimeFormat(): void;
+    changeFirstDayOfWeek(): void;
     changeTimeZone(): void;
     onSwitchChange(): Promise<void>;
     static ɵfac: i0.ɵɵFactoryDeclaration<ConfigComponent, never>;
@@ -1597,6 +1630,10 @@ declare enum ImportanceLevel {
     High = "High",
     Critical = "Critical"
 }
+interface CreateTestNotificationRequest {
+    subject?: string | null;
+    message?: string | null;
+}
 interface UserNotificationCountResponse {
     count?: number;
 }
@@ -2027,7 +2064,7 @@ declare class IframeModuleApi<SecurityDataType = unknown> extends HttpClient<Sec
 
 declare class SecurityApi<SecurityDataType = unknown> extends HttpClient<SecurityDataType> {
     getCurrentAuthSession: (params?: RequestParams) => Promise<AuthSessionResponse>;
-    createAuthSession: (params?: RequestParams) => Promise<any>;
+    createAuthSession: (query: CreateAuthSessionParams, params?: RequestParams) => Promise<any>;
     deleteAuthSession: (params?: RequestParams) => Promise<any>;
     getAuthCsrfToken: (params?: RequestParams) => Promise<AuthCsrfTokenResponse>;
     getRealmRoles: (params?: RequestParams) => Promise<string[]>;
@@ -2047,6 +2084,7 @@ declare class AuthSessionsApi<SecurityDataType = unknown> extends HttpClient<Sec
 
 declare class ApplicationsApi<SecurityDataType = unknown> extends HttpClient<SecurityDataType> {
     getApplicationRegistryItems: (params?: RequestParams) => Promise<ApplicationRegistryItemDto[]>;
+    getAllApplicationRegistryItems: (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>;
@@ -2083,6 +2121,7 @@ declare class NotificationApi<SecurityDataType = unknown> extends HttpClient<Sec
     getNotificationCountByUser: (params?: RequestParams) => Promise<UserNotificationCountResponse>;
     markNotificationAsRead: ({ id, ...query }: MarkNotificationAsReadParams, params?: RequestParams) => Promise<void>;
     getNotificationById: (query: GetNotificationByIdParams, params?: RequestParams) => Promise<UserNotificationDto>;
+    createTestNotification: (data: CreateTestNotificationRequest, params?: RequestParams) => Promise<UserNotificationDto>;
     static ɵfac: i0.ɵɵFactoryDeclaration<NotificationApi<any>, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<NotificationApi<any>>;
 }
@@ -2171,8 +2210,6 @@ declare function oipStartRoute(path?: string, data?: StartRouteData): Route;
 declare function oipAccessRoute(path?: string): Route;
 /** Authentication error page. */
 declare function oipErrorRoute(path?: string): Route;
-/** Current user profile. */
-declare function oipProfileRoute(path?: string): Route;
 /** Application configuration. */
 declare function oipConfigRoute(path?: string): Route;
 /** Registered applications, administrators only. */
@@ -2206,8 +2243,6 @@ interface OipRouteFeatures {
     access?: OipRouteToggle;
     /** Authentication error page. Default path: `error`. */
     error?: OipRouteToggle;
-    /** Current user profile. Default path: `profile`. */
-    profile?: OipRouteToggle;
     /** Application configuration. Default path: `config`. */
     config?: OipRouteToggle;
     /** Registered applications, administrators only. Default path: `applications`. */
@@ -2279,5 +2314,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, AuthSessionsApi, AuthSessionsComponent, 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, oipSessionsRoute, 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, AuthSessionsApi, AuthSessionsComponent, 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, oipSessionsRoute, 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.10.0",
+  "version": "0.11.1",
   "description": "A template for cross-platform web applications based on sakai-ng and primeNG",
   "main": "index.js",
   "keywords": [