oip-common 0.4.0 → 0.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oip-common",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "A template for cross-platform web applications based on sakai-ng and primeNG",
   "main": "index.js",
   "keywords": [
@@ -8,7 +8,7 @@
     "template"
   ],
   "peerDependencies": {
-    "@fortawesome/fontawesome-free": "^7.2.0"
+    "@angular-architects/module-federation": "^20.0.0"
   },
   "author": "Igor Tyulyakov aka g101k",
   "license": "MIT",

package/scripts/generate-api.mjs

@@ -67,7 +67,7 @@ let config = {
   fixInvalidTypeNamePrefix: "Type",
   fixInvalidEnumKeyPrefix: "Value",
   codeGenConstructs: (constructs) => ({
-    ...constructs,
+    ...constructs
   }),
   primitiveTypeConstructs: (constructs) => ({
     ...constructs,
@@ -84,13 +84,13 @@ let config = {
     onCreateRouteName: (routeNameInfo, rawRouteInfo) => {
       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 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.",
+            "Add a controller tag/module name or provide explicit operationId."
         );
       }
 
@@ -98,7 +98,7 @@ let config = {
         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.`,
+            `e.g. [HttpGet("get-${moduleName}")], or provide explicit operationId.`
         );
       }
 

package/templates/http-client.ejs

@@ -8,6 +8,7 @@ const { apiConfig, generateResponses, config } = it;
 import { LayoutService } from "../services/app.layout.service";
 import { SecurityService } from "../services/security.service";
 import { inject, Injectable } from "@angular/core";
+import { ActivatedRoute, Router } from "@angular/router";
 import { firstValueFrom } from "rxjs";
 
 export type QueryParamsType = Record<string | number, any>;
@@ -61,16 +62,41 @@ export enum ContentType {
 export class HttpClient<SecurityDataType = unknown> {
     protected securityService = inject(SecurityService);
     protected layoutService = inject(LayoutService);
+    protected router = inject(Router);
     public baseUrl: string = "<%~ apiConfig.baseUrl %>";
     private securityWorker?: ApiConfig<SecurityDataType>["securityWorker"]  =
-      () => ({
-        headers: {
-          "Accept-language": this.layoutService.language()
-            ? this.layoutService.language()
-            : 'en',
-          "X-Timezone": this.layoutService.timeZone(),
-        },
-      });
+      () => {
+        const moduleInstanceId = this.getCurrentModuleInstanceId();
+        return {
+          headers: {
+            "Accept-language": this.layoutService.language()
+              ? this.layoutService.language()
+              : 'en',
+            "X-Timezone": this.layoutService.timeZone(),
+            ...(moduleInstanceId != null
+              ? { "X-Module-Instance-Id": String(moduleInstanceId) }
+              : {}),
+          },
+        };
+      };
+
+    /**
+     * Reads the module instance id of the deepest activated route.
+     * The backend uses it to check module instance rights on endpoints that do not carry the id in their contract.
+     */
+    protected getCurrentModuleInstanceId(): number | undefined {
+      // May run before the first navigation completes, when route snapshots are not available yet.
+      let route: ActivatedRoute | null | undefined = this.router.routerState?.root;
+      let id: string | null = null;
+
+      while (route) {
+        id = route.snapshot?.paramMap?.get("id") ?? id;
+        route = route.firstChild;
+      }
+
+      const parsed = id != null ? Number(id) : Number.NaN;
+      return Number.isFinite(parsed) ? parsed : undefined;
+    }
 
     private abortControllers = new Map<CancelToken, AbortController>();
     private customFetch = (...fetchParams: Parameters<typeof fetch>) => fetch(...fetchParams);
@@ -238,7 +264,10 @@ export class HttpClient<SecurityDataType = unknown> {
             }
 
 <% if (!config.disableThrowOnError) { %>
-            if (!response.ok) throw data;
+            if (!response.ok) {
+                this.authorizeOnUnauthorized(response, path);
+                throw data;
+            }
 <% } %>
 <% if (config.unwrapResponseData) { %>
             return data.data;
@@ -248,6 +277,16 @@ export class HttpClient<SecurityDataType = unknown> {
     });
   };
 
+  private authorizeOnUnauthorized(response: Response, path: string): void {
+    if (response.status !== 401 || path.includes("/api/security/create-auth-session")) {
+      return;
+    }
+
+    this.securityService.authorize(
+      `${window.location.pathname}${window.location.search}${window.location.hash}`,
+    );
+  }
+
   private async getCsrfRequestParams(method: string | undefined, path: string): Promise<RequestParams> {
     if (!method || !["POST", "PUT", "PATCH", "DELETE"].includes(method.toUpperCase())) {
       return {};

package/assets/i18n/app-modules.en.json

@@ -1,23 +0,0 @@
-{
-  "app-modules": {
-    "title": "Modules",
-    "refreshTooltip": "Refresh",
-    "table": {
-      "moduleId": "Module ID",
-      "name": "Name",
-      "currentlyLoaded": "Currently Loaded",
-      "yes": "Yes",
-      "no": "No",
-      "deleteTooltip": "Delete"
-    },
-    "confirm": {
-      "header": "Warning",
-      "message": "Are you sure you want to delete the module?",
-      "cancel": "Cancel",
-      "delete": "Delete"
-    },
-    "messages": {
-      "deleteSuccess": "Module deleted"
-    }
-  }
-}

package/assets/i18n/app-modules.ru.json

@@ -1,23 +0,0 @@
-{
-  "app-modules": {
-    "title": "Модули",
-    "refreshTooltip": "Обновить",
-    "table": {
-      "moduleId": "ID модуля",
-      "name": "Название",
-      "currentlyLoaded": "Загружен",
-      "yes": "Да",
-      "no": "Нет",
-      "deleteTooltip": "Удалить"
-    },
-    "confirm": {
-      "header": "Внимание",
-      "message": "Вы уверены, что хотите удалить модуль?",
-      "cancel": "Отмена",
-      "delete": "Удалить"
-    },
-    "messages": {
-      "deleteSuccess": "Модуль удален"
-    }
-  }
-}

package/assets/i18n/applications.en.json

@@ -1,46 +0,0 @@
-{
-  "applications": {
-    "title": "Applications",
-    "subtitle": "Manage the frontend application registry",
-    "searchPlaceholder": "Search applications",
-    "search": "Search",
-    "clear": "Clear",
-    "add": "Add",
-    "refreshTooltip": "Refresh",
-    "empty": "No applications found",
-    "table": {
-      "code": "Code",
-      "displayName": "Name",
-      "baseUrl": "Base URL",
-      "internalBaseUrl": "Internal Base URL",
-      "icon": "Icon",
-      "order": "Order",
-      "enabled": "Enabled",
-      "serviceType": "Service type",
-      "current": "Current",
-      "actions": "Actions",
-      "yes": "Yes",
-      "no": "No",
-      "editTooltip": "Edit",
-      "deleteTooltip": "Delete",
-      "saveTooltip": "Save",
-      "cancelTooltip": "Cancel"
-    },
-    "serviceTypes": {
-      "service": "Service",
-      "application": "Application"
-    },
-    "confirm": {
-      "header": "Warning",
-      "message": "Are you sure you want to delete application {{displayName}}?",
-      "cancel": "Cancel",
-      "delete": "Delete"
-    },
-    "messages": {
-      "requiredFields": "Fill code, name and Base URL",
-      "createSuccess": "Application created",
-      "updateSuccess": "Application updated",
-      "deleteSuccess": "Application deleted"
-    }
-  }
-}

package/assets/i18n/applications.ru.json

@@ -1,46 +0,0 @@
-{
-  "applications": {
-    "title": "Приложения",
-    "subtitle": "Управление реестром фронтенд-приложений",
-    "searchPlaceholder": "Поиск по приложениям",
-    "search": "Найти",
-    "clear": "Очистить",
-    "add": "Добавить",
-    "refreshTooltip": "Обновить",
-    "empty": "Приложения не найдены",
-    "table": {
-      "code": "Код",
-      "displayName": "Название",
-      "baseUrl": "Base URL",
-      "internalBaseUrl": "Internal Base URL",
-      "icon": "Иконка",
-      "order": "Порядок",
-      "enabled": "Включено",
-      "serviceType": "Тип сервиса",
-      "current": "Текущее",
-      "actions": "Действия",
-      "yes": "Да",
-      "no": "Нет",
-      "editTooltip": "Редактировать",
-      "deleteTooltip": "Удалить",
-      "saveTooltip": "Сохранить",
-      "cancelTooltip": "Отменить"
-    },
-    "serviceTypes": {
-      "service": "Сервис",
-      "application": "Приложение"
-    },
-    "confirm": {
-      "header": "Внимание",
-      "message": "Вы уверены, что хотите удалить приложение {{displayName}}?",
-      "cancel": "Отмена",
-      "delete": "Удалить"
-    },
-    "messages": {
-      "requiredFields": "Заполните код, название и Base URL",
-      "createSuccess": "Приложение создано",
-      "updateSuccess": "Приложение обновлено",
-      "deleteSuccess": "Приложение удалено"
-    }
-  }
-}

package/assets/i18n/config.en.json

@@ -1,18 +0,0 @@
-{
-  "config": {
-    "all": "All",
-    "applicationManagement": "Application management",
-    "dateFormat": "Date format",
-    "dateTimeFormat": "Date and time format:",
-    "goTo": "Go to",
-    "localization": "Localization",
-    "menu": "Menu",
-    "moduleManagement": "Module management",
-    "photo": "Photo",
-    "profile": "Profile",
-    "selectLanguage": "Select language",
-    "timeFormat": "Time format",
-    "timeZone": "Time zone",
-    "usePhoto256x256Pixel": "Use photo 256x256 pixel"
-  }
-}

package/assets/i18n/config.ru.json

@@ -1,18 +0,0 @@
-{
-  "config": {
-    "all": "Все",
-    "applicationManagement": "Управление приложениями",
-    "dateFormat": "Формат даты",
-    "dateTimeFormat": "Формат даты и времени:",
-    "goTo": "Перейти",
-    "localization": "Локализация",
-    "menu": "Меню",
-    "moduleManagement": "Управление модулями",
-    "photo": "Фото",
-    "profile": "Профиль",
-    "selectLanguage": "Выберите язык",
-    "timeFormat": "Формат времени",
-    "timeZone": "Часовой пояс",
-    "usePhoto256x256Pixel": "Используйте фото 256x256 пикселей"
-  }
-}

package/assets/i18n/db-migration.en.json

@@ -1,19 +0,0 @@
-{
-  "db-migration": {
-    "migrationManager": "Migration manager",
-    "actions": {
-      "refresh": "Refresh",
-      "cleanFilter": "Clean filter",
-      "applyMigration": "Apply migration"
-    },
-    "columns": {
-      "name": "Migration name",
-      "applied": "Applied",
-      "exist": "Exist",
-      "pending": "Pending"
-    },
-    "messages": {
-      "errorRefreshing": "Error refreshing database"
-    }
-  }
-}

package/assets/i18n/db-migration.ru.json

@@ -1,19 +0,0 @@
-{
-  "db-migration": {
-    "migrationManager": "Менеджер миграций",
-    "actions": {
-      "refresh": "Обновить",
-      "cleanFilter": "Очистить фильтр",
-      "applyMigration": "Применить миграцию"
-    },
-    "columns": {
-      "name": "Название миграции",
-      "applied": "Применена",
-      "exist": "Существует",
-      "pending": "Ожидает"
-    },
-    "messages": {
-      "errorRefreshing": "Ошибка обновления базы данных"
-    }
-  }
-}

package/assets/i18n/en.json

@@ -1,137 +0,0 @@
-{
-  "app-configurator": {
-    "primary": "Primary",
-    "surface": "Surface",
-    "presets": "Presets",
-    "menuMode": "Menu Mode"
-  },
-  "msgService": {
-    "success": "Success",
-    "info": "Info",
-    "warn": "Warn",
-    "error": "Error",
-    "secondary": "Secondary"
-  },
-  "securityComponent": {
-    "security": "Security",
-    "save": "Save",
-    "savedSecurity": "Security settings saved",
-    "selectRoles": "Select roles"
-  },
-  "profileComponent": {
-    "changePhoto": "Upload Photo",
-    "successfullyUploaded": "Uploaded successfully"
-  },
-  "configComponent": {
-    "profile": "Profile",
-    "photo": "Photo",
-    "usePhoto256x256Pixel": "Use a 256x256 pixel photo",
-    "localization": "Language",
-    "selectLanguage": "Select language"
-  },
-  "baseComponent": {
-    "content": "Content",
-    "settings": "Settings",
-    "security": "Security",
-    "success": "Saved successfully"
-  },
-  "menuComponent": {
-    "all": "All",
-    "new": "Add"
-  },
-  "menuItemEditDialogComponent": {
-    "header": "Edit menu item",
-    "parentLabel": "Parent item",
-    "label": "Label",
-    "module": "Module",
-    "selectModule": "Select module",
-    "icon": "Icon",
-    "cancel": "Cancel",
-    "save": "Save",
-    "security": "Read access"
-  },
-  "menuItemCreateDialogComponent": {
-    "header": "New menu item",
-    "parentLabel": "Parent item",
-    "label": "Label",
-    "module": "Module",
-    "selectModule": "Select module",
-    "icon": "Icon",
-    "cancel": "Cancel",
-    "save": "Save"
-  },
-  "unauthorized": {
-    "welcomeToOip": "Welcome to OIP!",
-    "signInToContinue": "Sign in to continue",
-    "signIn": "Sign In"
-  },
-  "menuItemComponent": {
-    "new": "Add",
-    "edit": "Edit",
-    "delete": "Delete",
-    "deleteItemConfirmHeader": "Delete",
-    "deleteItemConfirmMessage": "Are you sure you want to delete the item?",
-    "deleteItemSuccessMessage": "Deleted successfully",
-    "deleteItemConfirmRejectButtonPropsLabel": "Cancel",
-    "deleteItemConfirmAcceptButtonPropsLabel": "Delete",
-    "moveUp": "Move up",
-    "moveDown": "Move down"
-  },
-  "topbar": {
-    "logout": "Logout",
-    "logoutConfirmHeader": "Logout",
-    "logoutConfirmMessage": "Are you sure you want to logout?",
-    "logoutConfirmCancel": "Cancel",
-    "logoutConfirmAccept": "Logout",
-    "profile": "Profile",
-    "applications": "Applications"
-  },
-  "userNotifications": {
-    "title": "Notifications",
-    "empty": "No unread notifications",
-    "refresh": "Refresh",
-    "markAsRead": "Read",
-    "markedAsRead": "Notification marked as read"
-  },
-  "discussionComponent": {
-    "writeCommentPlaceholder": "Write a comment. Use @email or @first.last for mentions.",
-    "mentionSuggestions": "Mention suggestions",
-    "edit": "Edit",
-    "preview": "Preview",
-    "attachFiles": "Attach files",
-    "send": "Send",
-    "loadingComments": "Loading comments...",
-    "noCommentsYet": "No comments yet.",
-    "edited": "Edited",
-    "editCommentPlaceholder": "Edit comment",
-    "addAttachment": "Add attachment",
-    "save": "Save",
-    "cancel": "Cancel",
-    "editHistory": "Edit history",
-    "loadingHistory": "Loading history...",
-    "before": "Before",
-    "after": "After",
-    "warning": "Warning",
-    "delete": "Delete",
-    "confirmDeleteComment": "Are you sure you want to delete this comment?",
-    "confirmDeleteFile": "Are you sure you want to delete the file \"{{fileName}}\"?",
-    "units": {
-      "bytes": "B",
-      "kilobytes": "KB",
-      "megabytes": "MB"
-    },
-    "errors": {
-      "loadComments": "Failed to load comments.",
-      "createComment": "Failed to create comment.",
-      "updateComment": "Failed to update comment.",
-      "loadEditHistory": "Failed to load edit history.",
-      "uploadAttachment": "Failed to upload attachment.",
-      "deleteComment": "Failed to delete comment.",
-      "deleteAttachment": "Failed to delete attachment.",
-      "downloadAttachment": "Failed to download attachment.",
-      "updateReaction": "Failed to update reaction.",
-      "addReaction": "Failed to add reaction."
-    }
-  },
-  "primeng": ""
-}

package/assets/i18n/iframe-module.en.json

@@ -1,10 +0,0 @@
-{
-  "iframe-module": {
-    "iframeModule": {
-      "urlPlaceholder": "Site URL",
-      "settingSaveButtonLabel": "Save",
-      "emptyUrlMessage": "Site URL is not specified.",
-      "siteLoadingMessage": "Failed to load the site."
-    }
-  }
-}

package/assets/i18n/iframe-module.ru.json

@@ -1,10 +0,0 @@
-{
-  "iframe-module": {
-    "iframeModule": {
-      "urlPlaceholder": "URL сайта",
-      "settingSaveButtonLabel": "Сохранить",
-      "emptyUrlMessage": "URL сайта не указан.",
-      "siteLoadingMessage": "Не удалось загрузить сайт."
-    }
-  }
-}

package/assets/i18n/notfound.en.json

@@ -1,8 +0,0 @@
-{
-  "notfound": {
-    "title": "Not Found",
-    "errorCode": "404",
-    "description": "Requested resource is not available.",
-    "button": "Go to home"
-  }
-}

package/assets/i18n/notfound.ru.json

@@ -1,8 +0,0 @@
-{
-  "notfound": {
-    "title": "Не найдено",
-    "errorCode": "404",
-    "description": "Запрашиваемый ресурс недоступен.",
-    "button": "На главную"
-  }
-}