oip-common 0.0.5 → 0.0.7

package/src/components/app.layout.component.ts

@@ -0,0 +1,130 @@
+import { Component, Renderer2, ViewChild, OnDestroy, inject } from '@angular/core';
+import { CommonModule } from '@angular/common';
+import { NavigationEnd, Router, RouterModule } from '@angular/router';
+import { filter, Subscription } from 'rxjs';
+import { AppTopbar } from './top-bar.component';
+import { FooterComponent } from './footer.component';
+import { LayoutService } from './../services/app.layout.service';
+import { SidebarComponent } from './sidebar.component';
+import { Menu } from '../api/Menu';
+import { MenuService } from '../services/app.menu.service';
+
+@Component({
+  selector: 'app-layout',
+  standalone: true,
+  imports: [CommonModule, AppTopbar, SidebarComponent, RouterModule, FooterComponent],
+  template: `
+    <div class="layout-wrapper" [ngClass]="containerClass">
+      <app-topbar></app-topbar>
+      <app-sidebar></app-sidebar>
+      <div class="layout-main-container">
+        <div class="layout-main">
+          <router-outlet></router-outlet>
+        </div>
+        <app-footer></app-footer>
+      </div>
+      <div class="layout-mask animate-fadein"></div>
+    </div>
+  `,
+  providers: [MenuService, Menu]
+})
+export class AppLayoutComponent implements OnDestroy {
+  protected layoutService = inject(LayoutService);
+  protected router = inject(Router);
+  protected renderer = inject(Renderer2);
+  overlayMenuOpenSubscription: Subscription;
+
+  menuOutsideClickListener: () => void;
+
+  @ViewChild(SidebarComponent) appSidebar!: SidebarComponent;
+
+  @ViewChild(AppTopbar) appTopBar!: AppTopbar;
+
+  constructor() {
+    this.overlayMenuOpenSubscription = this.layoutService.overlayOpen$.subscribe(() => {
+      if (!this.menuOutsideClickListener) {
+        this.menuOutsideClickListener = this.renderer.listen('document', 'click', (event) => {
+          if (this.isOutsideClicked(event)) {
+            this.hideMenu();
+          }
+        });
+      }
+
+      if (this.layoutService.layoutState().staticMenuMobileActive) {
+        this.blockBodyScroll();
+      }
+    });
+
+    this.router.events.pipe(filter((event) => event instanceof NavigationEnd)).subscribe(() => {
+      this.hideMenu();
+    });
+  }
+
+  isOutsideClicked(event: MouseEvent) {
+    const sidebarEl = document.querySelector('.layout-sidebar');
+    const topbarEl = document.querySelector('.layout-menu-button');
+    const eventTarget = event.target as Node;
+
+    return !(
+      sidebarEl?.isSameNode(eventTarget) ||
+      sidebarEl?.contains(eventTarget) ||
+      topbarEl?.isSameNode(eventTarget) ||
+      topbarEl?.contains(eventTarget)
+    );
+  }
+
+  hideMenu() {
+    this.layoutService.layoutState.update((prev) => ({
+      ...prev,
+      overlayMenuActive: false,
+      staticMenuMobileActive: false,
+      menuHoverActive: false
+    }));
+    if (this.menuOutsideClickListener) {
+      this.menuOutsideClickListener();
+      this.menuOutsideClickListener = null;
+    }
+    this.unblockBodyScroll();
+  }
+
+  blockBodyScroll(): void {
+    if (document.body.classList) {
+      document.body.classList.add('blocked-scroll');
+    } else {
+      document.body.className += ' blocked-scroll';
+    }
+  }
+
+  unblockBodyScroll(): void {
+    if (document.body.classList) {
+      document.body.classList.remove('blocked-scroll');
+    } else {
+      document.body.className = document.body.className.replace(
+        new RegExp('(^|\\b)' + 'blocked-scroll'.split(' ').join('|') + '(\\b|$)', 'gi'),
+        ' '
+      );
+    }
+  }
+
+  get containerClass() {
+    return {
+      'layout-overlay': this.layoutService.layoutConfig().menuMode === 'overlay',
+      'layout-static': this.layoutService.layoutConfig().menuMode === 'static',
+      'layout-static-inactive':
+        this.layoutService.layoutState().staticMenuDesktopInactive &&
+        this.layoutService.layoutConfig().menuMode === 'static',
+      'layout-overlay-active': this.layoutService.layoutState().overlayMenuActive,
+      'layout-mobile-active': this.layoutService.layoutState().staticMenuMobileActive
+    };
+  }
+
+  ngOnDestroy() {
+    if (this.overlayMenuOpenSubscription) {
+      this.overlayMenuOpenSubscription.unsubscribe();
+    }
+
+    if (this.menuOutsideClickListener) {
+      this.menuOutsideClickListener();
+    }
+  }
+}

package/src/components/auth/access/access.component.ts

@@ -0,0 +1,42 @@
+import { Component } from '@angular/core';
+import { RouterLink } from '@angular/router';
+import { ButtonModule } from 'primeng/button';
+import { RippleModule } from 'primeng/ripple';
+
+@Component({
+  selector: 'app-access',
+  template: `<div
+    class="surface-ground flex align-items-center justify-content-center min-h-screen min-w-screen overflow-hidden">
+    <div class="flex flex-column align-items-center justify-content-center">
+      <img alt="Sakai logo" class="mb-5 w-6rem flex-shrink-0" src="assets/demo/images/access/logo-orange.svg" />
+      <div
+        style="border-radius:56px; padding:0.3rem; background: linear-gradient(180deg, rgba(247, 149, 48, 0.4) 10%, rgba(247, 149, 48, 0) 30%);">
+        <div
+          class="w-full surface-card py-8 px-5 sm:px-8 flex flex-column align-items-center"
+          style="border-radius:53px">
+          <div class="grid flex flex-column align-items-center">
+            <div
+              class="flex justify-content-center align-items-center bg-orange-500 border-circle"
+              style="width:3.2rem; height:3.2rem;">
+              <i class="text-50 pi pi-fw pi-lock text-2xl"></i>
+            </div>
+            <h1 class="text-900 font-bold text-4xl lg:text-5xl mb-2">Access Denied</h1>
+            <span class="text-600 mb-5">You do not have the necessary permisions. Please contact admins.</span>
+            <img alt="Access denied" class="mb-5" src="assets/demo/images/access/asset-access.svg" width="80%" />
+            <button
+              class="p-button-text"
+              icon="pi pi-arrow-left"
+              id="oip-app-access-go-to-dashboard-button"
+              label="Go to Dashboard"
+              pButton
+              pRipple
+              [routerLink]="['/']"></button>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>`,
+  imports: [RouterLink, ButtonModule, RippleModule],
+  standalone: true
+})
+export class AccessComponent {}

package/src/components/auth/error/error.component.ts

@@ -0,0 +1,42 @@
+import { Component } from '@angular/core';
+import { ButtonModule } from 'primeng/button';
+import { RippleModule } from 'primeng/ripple';
+import { RouterLink } from '@angular/router';
+
+@Component({
+  selector: 'app-error',
+  template: `<div
+    class="surface-ground flex align-items-center justify-content-center min-h-screen min-w-screen overflow-hidden">
+    <div class="flex flex-column align-items-center justify-content-center">
+      <img alt="Sakai logo" class="mb-5 w-6rem flex-shrink-0" src="assets/demo/images/error/logo-error.svg" />
+      <div
+        style="border-radius:56px; padding:0.3rem; background: linear-gradient(180deg, rgba(233, 30, 99, 0.4) 10%, rgba(33, 150, 243, 0) 30%);">
+        <div
+          class="w-full surface-card py-8 px-5 sm:px-8 flex flex-column align-items-center"
+          style="border-radius:53px">
+          <div class="grid flex flex-column align-items-center">
+            <div
+              class="flex justify-content-center align-items-center bg-pink-500 border-circle"
+              style="height:3.2rem; width:3.2rem;">
+              <i class="pi pi-fw pi-exclamation-circle text-2xl text-white"></i>
+            </div>
+            <h1 class="text-900 font-bold text-5xl mb-2">Error Occured</h1>
+            <span class="text-600 mb-5">Requested resource is not available.</span>
+            <img alt="Error" class="mb-5" src="assets/demo/images/error/asset-error.svg" width="80%" />
+            <button
+              class="p-button-text"
+              icon="pi pi-arrow-left"
+              id="oip-app-error-go-to-dashboard-button"
+              label="Go to Dashboard"
+              pButton
+              pRipple
+              [routerLink]="['/']"></button>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>`,
+  standalone: true,
+  imports: [ButtonModule, RippleModule, RouterLink]
+})
+export class ErrorComponent {}

package/src/components/auth/login/login.component.ts

@@ -0,0 +1,120 @@
+import { Component } from '@angular/core';
+import { FormsModule } from '@angular/forms';
+import { RouterModule } from '@angular/router';
+import { ButtonModule } from 'primeng/button';
+import { CheckboxModule } from 'primeng/checkbox';
+import { InputTextModule } from 'primeng/inputtext';
+import { PasswordModule } from 'primeng/password';
+import { RippleModule } from 'primeng/ripple';
+import { AppFloatingConfiguratorComponent } from '../../app-floating-configurator.component';
+
+@Component({
+  selector: 'app-login',
+  standalone: true,
+  imports: [
+    ButtonModule,
+    CheckboxModule,
+    InputTextModule,
+    PasswordModule,
+    FormsModule,
+    RouterModule,
+    RippleModule,
+    AppFloatingConfiguratorComponent
+  ],
+  template: `
+    <app-floating-configurator />
+    <div
+      class="bg-surface-50 dark:bg-surface-950 flex items-center justify-center min-h-screen min-w-[100vw] overflow-hidden">
+      <div class="flex flex-col items-center justify-center">
+        <div
+          style="border-radius: 56px; padding: 0.3rem; background: linear-gradient(180deg, var(--primary-color) 10%, rgba(33, 150, 243, 0) 30%)">
+          <div class="w-full bg-surface-0 dark:bg-surface-900 py-20 px-8 sm:px-20" style="border-radius: 53px">
+            <div class="text-center mb-8">
+              <svg
+                class="mb-8 w-16 shrink-0 mx-auto"
+                fill="none"
+                viewBox="0 0 54 40"
+                xmlns="http://www.w3.org/2000/svg">
+                <path
+                  clip-rule="evenodd"
+                  d="M17.1637 19.2467C17.1566 19.4033 17.1529 19.561 17.1529 19.7194C17.1529 25.3503 21.7203 29.915 27.3546 29.915C32.9887 29.915 37.5561 25.3503 37.5561 19.7194C37.5561 19.5572 37.5524 19.3959 37.5449 19.2355C38.5617 19.0801 39.5759 18.9013 40.5867 18.6994L40.6926 18.6782C40.7191 19.0218 40.7326 19.369 40.7326 19.7194C40.7326 27.1036 34.743 33.0896 27.3546 33.0896C19.966 33.0896 13.9765 27.1036 13.9765 19.7194C13.9765 19.374 13.9896 19.0316 14.0154 18.6927L14.0486 18.6994C15.0837 18.9062 16.1223 19.0886 17.1637 19.2467ZM33.3284 11.4538C31.6493 10.2396 29.5855 9.52381 27.3546 9.52381C25.1195 9.52381 23.0524 10.2421 21.3717 11.4603C20.0078 11.3232 18.6475 11.1387 17.2933 10.907C19.7453 8.11308 23.3438 6.34921 27.3546 6.34921C31.36 6.34921 34.9543 8.10844 37.4061 10.896C36.0521 11.1292 34.692 11.3152 33.3284 11.4538ZM43.826 18.0518C43.881 18.6003 43.9091 19.1566 43.9091 19.7194C43.9091 28.8568 36.4973 36.2642 27.3546 36.2642C18.2117 36.2642 10.8 28.8568 10.8 19.7194C10.8 19.1615 10.8276 18.61 10.8816 18.0663L7.75383 17.4411C7.66775 18.1886 7.62354 18.9488 7.62354 19.7194C7.62354 30.6102 16.4574 39.4388 27.3546 39.4388C38.2517 39.4388 47.0855 30.6102 47.0855 19.7194C47.0855 18.9439 47.0407 18.1789 46.9536 17.4267L43.826 18.0518ZM44.2613 9.54743L40.9084 10.2176C37.9134 5.95821 32.9593 3.1746 27.3546 3.1746C21.7442 3.1746 16.7856 5.96385 13.7915 10.2305L10.4399 9.56057C13.892 3.83178 20.1756 0 27.3546 0C34.5281 0 40.8075 3.82591 44.2613 9.54743Z"
+                  fill="var(--primary-color)"
+                  fill-rule="evenodd" />
+                <mask
+                  height="11"
+                  id="mask0_1413_1551"
+                  maskUnits="userSpaceOnUse"
+                  style="mask-type: alpha"
+                  width="54"
+                  x="0"
+                  y="8">
+                  <path
+                    d="M27 18.3652C10.5114 19.1944 0 8.88892 0 8.88892C0 8.88892 16.5176 14.5866 27 14.5866C37.4824 14.5866 54 8.88892 54 8.88892C54 8.88892 43.4886 17.5361 27 18.3652Z"
+                    fill="var(--primary-color)" />
+                </mask>
+                <g mask="url(#mask0_1413_1551)">
+                  <path
+                    d="M-4.673e-05 8.88887L3.73084 -1.91434L-8.00806 17.0473L-4.673e-05 8.88887ZM27 18.3652L26.4253 6.95109L27 18.3652ZM54 8.88887L61.2673 17.7127L50.2691 -1.91434L54 8.88887ZM-4.673e-05 8.88887C-8.00806 17.0473 -8.00469 17.0505 -8.00132 17.0538C-8.00018 17.055 -7.99675 17.0583 -7.9944 17.0607C-7.98963 17.0653 -7.98474 17.0701 -7.97966 17.075C-7.96949 17.0849 -7.95863 17.0955 -7.94707 17.1066C-7.92401 17.129 -7.89809 17.1539 -7.86944 17.1812C-7.8122 17.236 -7.74377 17.3005 -7.66436 17.3743C-7.50567 17.5218 -7.30269 17.7063 -7.05645 17.9221C-6.56467 18.3532 -5.89662 18.9125 -5.06089 19.5534C-3.39603 20.83 -1.02575 22.4605 1.98012 24.0457C7.97874 27.2091 16.7723 30.3226 27.5746 29.7793L26.4253 6.95109C20.7391 7.23699 16.0326 5.61231 12.6534 3.83024C10.9703 2.94267 9.68222 2.04866 8.86091 1.41888C8.45356 1.10653 8.17155 0.867278 8.0241 0.738027C7.95072 0.673671 7.91178 0.637576 7.90841 0.634492C7.90682 0.63298 7.91419 0.639805 7.93071 0.65557C7.93897 0.663455 7.94952 0.673589 7.96235 0.686039C7.96883 0.692262 7.97582 0.699075 7.98338 0.706471C7.98719 0.710167 7.99113 0.714014 7.99526 0.718014C7.99729 0.720008 8.00047 0.723119 8.00148 0.724116C8.00466 0.727265 8.00796 0.730446 -4.673e-05 8.88887ZM27.5746 29.7793C37.6904 29.2706 45.9416 26.3684 51.6602 23.6054C54.5296 22.2191 56.8064 20.8465 58.4186 19.7784C59.2265 19.2431 59.873 18.7805 60.3494 18.4257C60.5878 18.2482 60.7841 18.0971 60.9374 17.977C61.014 17.9169 61.0799 17.8645 61.1349 17.8203C61.1624 17.7981 61.1872 17.7781 61.2093 17.7602C61.2203 17.7512 61.2307 17.7427 61.2403 17.7348C61.2452 17.7308 61.2499 17.727 61.2544 17.7233C61.2566 17.7215 61.2598 17.7188 61.261 17.7179C61.2642 17.7153 61.2673 17.7127 54 8.88887C46.7326 0.0650536 46.7357 0.0625219 46.7387 0.0600241C46.7397 0.0592345 46.7427 0.0567658 46.7446 0.0551857C46.7485 0.0520238 46.7521 0.0489887 46.7557 0.0460799C46.7628 0.0402623 46.7694 0.0349487 46.7753 0.0301318C46.7871 0.0204986 46.7966 0.0128495 46.8037 0.00712562C46.818 -0.00431848 46.8228 -0.00808311 46.8184 -0.00463784C46.8096 0.00228345 46.764 0.0378652 46.6828 0.0983779C46.5199 0.219675 46.2165 0.439161 45.7812 0.727519C44.9072 1.30663 43.5257 2.14765 41.7061 3.02677C38.0469 4.79468 32.7981 6.63058 26.4253 6.95109L27.5746 29.7793ZM54 8.88887C50.2691 -1.91433 50.27 -1.91467 50.271 -1.91498C50.2712 -1.91506 50.272 -1.91535 50.2724 -1.9155C50.2733 -1.91581 50.274 -1.91602 50.2743 -1.91616C50.2752 -1.91643 50.275 -1.91636 50.2738 -1.91595C50.2714 -1.91515 50.2652 -1.91302 50.2552 -1.9096C50.2351 -1.90276 50.1999 -1.89078 50.1503 -1.874C50.0509 -1.84043 49.8938 -1.78773 49.6844 -1.71863C49.2652 -1.58031 48.6387 -1.377 47.8481 -1.13035C46.2609 -0.635237 44.0427 0.0249875 41.5325 0.6823C36.215 2.07471 30.6736 3.15796 27 3.15796V26.0151C33.8087 26.0151 41.7672 24.2495 47.3292 22.7931C50.2586 22.026 52.825 21.2618 54.6625 20.6886C55.5842 20.4011 56.33 20.1593 56.8551 19.986C57.1178 19.8993 57.3258 19.8296 57.4735 19.7797C57.5474 19.7548 57.6062 19.7348 57.6493 19.72C57.6709 19.7127 57.6885 19.7066 57.7021 19.7019C57.7089 19.6996 57.7147 19.6976 57.7195 19.696C57.7219 19.6952 57.7241 19.6944 57.726 19.6938C57.7269 19.6934 57.7281 19.693 57.7286 19.6929C57.7298 19.6924 57.7309 19.692 54 8.88887ZM27 3.15796C23.3263 3.15796 17.7849 2.07471 12.4674 0.6823C9.95717 0.0249875 7.73904 -0.635237 6.15184 -1.13035C5.36118 -1.377 4.73467 -1.58031 4.3155 -1.71863C4.10609 -1.78773 3.94899 -1.84043 3.84961 -1.874C3.79994 -1.89078 3.76474 -1.90276 3.74471 -1.9096C3.73469 -1.91302 3.72848 -1.91515 3.72613 -1.91595C3.72496 -1.91636 3.72476 -1.91643 3.72554 -1.91616C3.72593 -1.91602 3.72657 -1.91581 3.72745 -1.9155C3.72789 -1.91535 3.72874 -1.91506 3.72896 -1.91498C3.72987 -1.91467 3.73084 -1.91433 -4.673e-05 8.88887C-3.73093 19.692 -3.72983 19.6924 -3.72868 19.6929C-3.72821 19.693 -3.72698 19.6934 -3.72603 19.6938C-3.72415 19.6944 -3.72201 19.6952 -3.71961 19.696C-3.71482 19.6976 -3.70901 19.6996 -3.7022 19.7019C-3.68858 19.7066 -3.67095 19.7127 -3.6494 19.72C-3.60629 19.7348 -3.54745 19.7548 -3.47359 19.7797C-3.32589 19.8296 -3.11788 19.8993 -2.85516 19.986C-2.33008 20.1593 -1.58425 20.4011 -0.662589 20.6886C1.17485 21.2618 3.74125 22.026 6.67073 22.7931C12.2327 24.2495 20.1913 26.0151 27 26.0151V3.15796Z"
+                    fill="var(--primary-color)" />
+                </g>
+              </svg>
+              <div class="text-surface-900 dark:text-surface-0 text-3xl font-medium mb-4">Welcome to PrimeLand!</div>
+              <span class="text-muted-color font-medium">Sign in to continue</span>
+            </div>
+
+            <div>
+              <label
+                class="block text-surface-900 dark:text-surface-0 text-xl font-medium mb-2"
+                for="oip-app-login-email-address-input"
+                >Email</label
+              >
+              <input
+                class="w-full md:w-[30rem] mb-8"
+                id="oip-app-login-email-address-input"
+                pInputText
+                placeholder="Email address"
+                type="text"
+                [(ngModel)]="email" />
+
+              <label
+                class="block text-surface-900 dark:text-surface-0 font-medium text-xl mb-2"
+                for="oip-app-login-password"
+                >Password</label
+              >
+              <p-password
+                id="oip-app-login-password"
+                placeholder="Password"
+                styleClass="mb-4"
+                [feedback]="false"
+                [fluid]="true"
+                [toggleMask]="true"
+                [(ngModel)]="password"></p-password>
+
+              <div class="flex items-center justify-between mt-2 mb-8 gap-8">
+                <div class="flex items-center">
+                  <p-checkbox
+                    binary
+                    class="mr-2"
+                    id="oip-app-login-remember-me-checkbox"
+                    [(ngModel)]="checked"></p-checkbox>
+                  <label for="oip-app-login-remember-me-checkbox">Remember me</label>
+                </div>
+                <span class="font-medium no-underline ml-2 text-right cursor-pointer text-primary"
+                  >Forgot password?</span
+                >
+              </div>
+              <p-button id="oip-app-login-sign-in-button" label="Sign In" routerLink="/" styleClass="w-full"></p-button>
+            </div>
+          </div>
+        </div>
+      </div>
+    </div>
+  `
+})
+export class LoginComponent {
+  email: string = '';
+
+  password: string = '';
+
+  checked: boolean = false;
+}

package/src/components/auth/unauthorized/unauthorized.component.ts

@@ -0,0 +1,51 @@
+import { Component, inject } from '@angular/core';
+import { ButtonModule } from 'primeng/button';
+import { RippleModule } from 'primeng/ripple';
+import { LogoComponent } from '../../logo.component';
+import { SecurityService } from '../../../services/security.service';
+import { AppFloatingConfiguratorComponent } from '../../app-floating-configurator.component';
+import { ReactiveFormsModule } from '@angular/forms';
+import { TranslatePipe } from '@ngx-translate/core';
+
+@Component({
+  template: `
+    <app-floating-configurator />
+    <div
+      class="bg-surface-50 dark:bg-surface-950 flex items-center justify-center min-h-screen min-w-[100vw] overflow-hidden">
+      <div class="flex flex-col items-center justify-center">
+        <div
+          style="border-radius: 56px; padding: 0.3rem; background: linear-gradient(180deg, var(--primary-color) 10%, rgba(33, 150, 243, 0) 30%)">
+          <div class="w-full bg-surface-0 dark:bg-surface-900 py-20 px-8 sm:px-20" style="border-radius: 53px">
+            <div class="flex flex-col items-center justify-center">
+              <logo [height]="96" [width]="96" />
+            </div>
+            <div class="text-center mb-8">
+              <div class="text-surface-900 dark:text-surface-0 text-3xl font-medium mb-4">
+                {{ 'unauthorized.welcomeToOip' | translate }}
+              </div>
+              <span class="text-muted-color font-medium">{{ 'unauthorized.signInToContinue' | translate }}</span>
+            </div>
+            <div>
+              <p-button
+                id="oip-unauthorized-error-sign-in-button"
+                label="{{ 'unauthorized.signIn' | translate }}"
+                styleClass="w-full"
+                (click)="securityService.authorize()"></p-button>
+            </div>
+          </div>
+        </div>
+      </div>
+    </div>
+  `,
+  imports: [
+    ButtonModule,
+    RippleModule,
+    LogoComponent,
+    AppFloatingConfiguratorComponent,
+    ReactiveFormsModule,
+    TranslatePipe
+  ]
+})
+export class UnauthorizedComponent {
+  protected readonly securityService = inject(SecurityService);
+}

package/src/components/base-module.component.ts

@@ -0,0 +1,258 @@
+import { ChangeDetectorRef, Component, effect, inject, OnDestroy, OnInit, signal, WritableSignal } from '@angular/core';
+import { TopBarDto } from '../dtos/top-bar.dto';
+import { TopBarService } from '../services/top-bar.service';
+import { MsgService } from '../services/msg.service';
+import { ActivatedRoute } from '@angular/router';
+import { BaseDataService } from '../services/base-data.service';
+import { TranslateService } from '@ngx-translate/core';
+import { Subject, Subscription } from 'rxjs';
+import { AppTitleService } from '../services/app-title.service';
+
+interface BaseComponentLocalization {
+  security: string;
+  settings: string;
+  content: string;
+}
+
+@Component({ standalone: true, template: '' })
+export abstract class BaseModuleComponent<TBackendStoreSettings, TLocalStoreSettings> implements OnInit, OnDestroy {
+  /**
+   * Provides access to topbar related functionality, such as managing visibility and content.
+   * @type {TopBarService}
+   */
+  public readonly topBarService: TopBarService = inject(TopBarService);
+
+  /**
+   * Provides access to information about the current route.
+   * This includes route parameters, data, and the route's path.
+   */
+  public readonly route: ActivatedRoute = inject(ActivatedRoute);
+
+  /**
+   * Provides access to messaging services.
+   */
+  public readonly msgService = inject(MsgService);
+
+  /**
+   * Provides access to base data service functionality.
+   * @deprecated The method should not be used
+   */
+  public readonly baseDataService: BaseDataService = inject(BaseDataService);
+
+  /**
+   * Provides access to translation functionality.
+   */
+  public readonly translateService = inject(TranslateService);
+
+  /**
+   * Provides access to the application's title service.
+   */
+  public readonly appTitleService = inject(AppTitleService);
+
+  /**
+   * Reference to the ChangeDetector. Used to trigger change detection manually.
+   */
+  private changeDetectorRef: ChangeDetectorRef = inject(ChangeDetectorRef);
+
+  /**
+   * Represents a subscription to an observable.
+   * Manages the lifecycle of receiving data from the observable and allows unsubscribing to stop receiving data.
+   * @type {Subscription}
+   */
+  private subscriptions: Subscription[] = [];
+  /**
+   * Configuration object for backend storage
+   * @type {TBackendStoreSettings}
+   */
+  public settings: TBackendStoreSettings = {} as TBackendStoreSettings;
+
+  /**
+   * Configuration object for local storage.
+   * @type {TLocalStoreSettings}
+   */
+  public _localSettings: TLocalStoreSettings = {} as TLocalStoreSettings;
+
+  /**
+   * A signal representing the local application settings.  Changes to this signal
+   * propagate updates to the underlying local store settings.
+   * @type {WritableSignal<TLocalStoreSettings>}
+   */
+  public localSettings: WritableSignal<TLocalStoreSettings> = signal<TLocalStoreSettings>(this._localSettings);
+
+  /**
+   * A Subject emitting updates to local store settings. Observables can subscribe to this Subject to react to changes in local settings.
+   * @type {Subject<TLocalStoreSettings>}
+   */
+  public localSettingsUpdate: Subject<TLocalStoreSettings> = new Subject<TLocalStoreSettings>();
+
+  /**
+   * The title of the component. Get from Title in ngOnInit
+   * @type {string}
+   */
+  public title: string;
+
+  /**
+   * Updates local settings and persists them to local storage.
+   * @return {void}
+   */
+  private onConfigUpdate(): void {
+    if (Object.keys(this.localSettings()).length > 0) {
+      this._localSettings = { ...this.localSettings() };
+      this.localSettingsUpdate.next(this._localSettings);
+      localStorage.setItem(`Instance_${this.id}`, JSON.stringify(this._localSettings));
+    }
+  }
+
+  private getLocalStorageSettings() {
+    try {
+      const localStorageSettingsString = localStorage.getItem(`Instance_${this.id}`);
+      if (localStorageSettingsString != null) {
+        this.localSettings.set(JSON.parse(localStorageSettingsString) as TLocalStoreSettings);
+      }
+    } catch (error) {
+      this.msgService.error(error, 'Error parsing layoutConfig:');
+      this.localSettings.set({} as TLocalStoreSettings);
+    }
+  }
+
+  /**
+   * A unique numerical identifier for the module.
+   * @type {number}
+   */
+  id: number | undefined = undefined;
+
+  /**
+   * The name of the controller currently handling the request.
+   * @type {string}
+   */
+  controller: string;
+
+  /**
+   * Checks if the content ID is present.
+   * @returns {boolean} True if the content ID is present, false otherwise.
+   */
+  get isContent(): boolean {
+    return this.topBarService.checkId('content');
+  }
+
+  /**
+   * Checks if the settings ID is present.
+   * @returns {boolean} True if the settings ID is present, false otherwise.
+   */
+  get isSettings(): boolean {
+    return this.topBarService.checkId('settings');
+  }
+
+  /**
+   * Checks if the security ID is present.
+   * @returns {boolean} True if the security ID is present, false otherwise.
+   */
+  get isSecurity(): boolean {
+    return this.topBarService.checkId('security');
+  }
+
+  /**
+   * Defines the top bar items.
+   */
+  public topBarItems: TopBarDto[] = [
+    { id: 'content', icon: 'pi-box', caption: '' },
+    { id: 'settings', icon: 'pi-cog', caption: '' },
+    { id: 'security', icon: 'pi-lock', caption: '' }
+  ];
+
+  /**
+   * Initializes the component and subscribes to local settings updates.
+   */
+  constructor() {
+    effect(() => {
+      const config = this.localSettings();
+      if (config) {
+        this.onConfigUpdate();
+      }
+    });
+    this.subscriptions.push(
+      this.route.url.subscribe((url) => {
+        this.controller = url[0].path;
+      })
+    );
+    this.subscriptions.push(
+      this.route.paramMap.subscribe((params) => {
+        this.id = +params.get('id');
+        this.getLocalStorageSettings();
+      })
+    );
+  }
+
+  /**
+   * 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).
+   */
+  ngOnDestroy() {
+    this.topBarService.setTopBarItems([]);
+    this.topBarService.activeId = this.topBarItems[0].id;
+    this.subscriptions.forEach((s) => s.unsubscribe());
+  }
+
+  /**
+   * Initializes the component. 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.
+   */
+  async ngOnInit(): Promise<void> {
+    this.subscriptions.push(
+      this.translateService.get('baseComponent').subscribe((value: BaseComponentLocalization) => {
+        this.topBarItems[0].caption = value.content;
+        this.topBarItems[1].caption = value.settings;
+        this.topBarItems[2].caption = value.security;
+      })
+    );
+
+    this.topBarService.setTopBarItems(this.topBarItems);
+    this.topBarService.activeId = this.topBarItems[0].id;
+
+    await this.getSettings();
+
+    this.subscriptions.push(
+      this.appTitleService.title$.subscribe((title) => {
+        this.title = title;
+        this.changeDetectorRef.detectChanges();
+      })
+    );
+  }
+
+  /**
+   * Retrieves module instance settings.
+   * @return {Promise<void>} A promise that resolves when settings are retrieved.
+   */
+  async getSettings(): Promise<void> {
+    try {
+      this.settings = await this.baseDataService.sendRequest<TBackendStoreSettings>(
+        `${this.baseDataService.baseUrl}api/${this.controller}/get-module-instance-settings?id=${this.id}`
+      );
+    } catch (error) {
+      this.msgService.error(error);
+    }
+  }
+
+  /**
+   * Saves the provided settings to the backend.
+   * @param {TLocalStoreSettings} settings - The settings object to save.
+   * @return {Promise<void>} A promise that resolves when the settings are saved. Reject if an error occurs.
+   */
+  async saveSettings(settings: TBackendStoreSettings): Promise<void> {
+    await this.baseDataService
+      .sendRequest(`api/${this.controller}/put-module-instance-settings`, 'PUT', {
+        id: this.id,
+        settings: settings
+      })
+      .then(() => {
+        this.msgService.success(this.translateService.instant('baseComponent.success'));
+      })
+      .catch((error) => {
+        this.msgService.error(error);
+      });
+  }
+}