@ieeesa-npm/tenants 0.4.2 → 0.4.4

package/src/lib/components/view-tenants-list/view-tenants-list.component.ts

@@ -0,0 +1,388 @@
+import { CommonModule } from '@angular/common';
+import {
+  Component,
+  EventEmitter,
+  Input,
+  OnDestroy,
+  OnInit,
+  Output,
+  ViewEncapsulation,
+} from '@angular/core';
+import {
+  DataTableComponent,
+  ModalComponent,
+  PaginatorConfig,
+  TableActions,
+  TableColumnSchema,
+  TableColumnSortDirection,
+  TableColumnType,
+} from '@ieeesa-npm/presentation';
+import { Subject, takeUntil } from 'rxjs';
+import * as constants from '../../assets/constants.json';
+import { MatButtonModule } from '@angular/material/button';
+import {
+  AlertType,
+  AlertsService,
+  BreakpointObserverService,
+  ModalType,
+} from '@ieeesa-npm/utility';
+import { TenantsRoutesConfig } from '../../models/route-config.model';
+import { SharedService } from '@ieeesa-npm/shared';
+import { TenantApplicationsService } from '../../services/tenant-applications.service';
+import { Router } from '@angular/router';
+import { PageEvent } from '@angular/material/paginator';
+import { Sort } from '@angular/material/sort';
+import {
+  TenantStatus,
+  PermissionType,
+} from '../../models/permission-type.model';
+import {
+  TenantsPermissions,
+  UserPermission,
+} from '../../models/tenants-permission.model';
+import {
+  ViewTenantsColumnSchemaDef,
+  SortOrderBy,
+  GetTenantsPayload,
+} from '../../models/table-column-schema-view-tenant-list.model';
+import { MatDialog } from '@angular/material/dialog';
+import { CreateTenantApplicationComponent } from '../create-tenant-application/create-tenant-application.component';
+import { SortConfig, TenantBasicInfo } from '../../models/tenant.model';
+import { Features } from '../../models/features.model';
+import { TenantFunctionType } from '../../models/tenant-function-type.model';
+@Component({
+  selector: 'ieeesa-view-tenants-list',
+  templateUrl: './view-tenants-list.component.html',
+  styleUrls: ['./view-tenants-list.component.scss'],
+  standalone: true,
+  imports: [CommonModule, MatButtonModule, DataTableComponent],
+  encapsulation: ViewEncapsulation.None,
+})
+export class ViewTenantsListComponent implements OnInit, OnDestroy {
+  destroy$: Subject<boolean> = new Subject<boolean>();
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  constants: any = constants;
+  viewTenantsConstants = this.constants?.viewTenants;
+  isMobileView = false;
+  @Input() tenantsPageInfo: {
+    tenantsTitle: string;
+  } = {
+    tenantsTitle: '',
+  };
+  @Input() apiBaseURL = '';
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  @Input() routePaths!: TenantsRoutesConfig;
+  @Input() userPermissions!: UserPermission[];
+  @Input() defaultSortedColumn: string = ViewTenantsColumnSchemaDef.APP_ID;
+  @Output() createTenant = new EventEmitter();
+  @Output() viewTenantsDetails: EventEmitter<TenantBasicInfo> =
+    new EventEmitter<TenantBasicInfo>();
+  tableData!: TenantBasicInfo[];
+  columnSchema!: TableColumnSchema[];
+  tableActions: TableActions = {
+    isPaginationNeeded: true,
+  };
+  tableColumns = this.viewTenantsConstants?.tableColumns;
+  emptyFieldValueReplacedBy =
+    this.viewTenantsConstants?.emptyFieldValueReplacedBy;
+  paginatorConfig: PaginatorConfig = {
+    recordsPerPage: this.viewTenantsConstants?.pageSizeOptions[0],
+    pageSizeOptions: this.viewTenantsConstants.pageSizeOptions,
+    totalRecords: 0,
+  };
+
+  userTenantsPermissions!: TenantsPermissions[];
+  permissionType = PermissionType;
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  dialogRef: any;
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  createTenantScreenTexts: any = this.constants?.createTenant;
+  defaultColumnSortDirection = true;
+  pageEvent!: PageEvent;
+  sortConfig!: SortConfig;
+  constructor(
+    // eslint-disable-next-line no-unused-vars
+    public dialog: MatDialog,
+    // eslint-disable-next-line no-unused-vars
+    public alertService: AlertsService,
+    // eslint-disable-next-line no-unused-vars
+    private breakpointObserverService: BreakpointObserverService,
+    // eslint-disable-next-line no-unused-vars
+    private sharedService: SharedService,
+    // eslint-disable-next-line no-unused-vars
+    private tenantApplicationsService: TenantApplicationsService,
+    // eslint-disable-next-line no-unused-vars
+    private router: Router
+  ) {
+    this.breakpointObserverService
+      .getBreakpoint()
+      .pipe(takeUntil(this.destroy$))
+      .subscribe((result: { matches: boolean }) => {
+        this.isMobileView = result.matches;
+      });
+  }
+
+  /**
+   * Sets the user permissions, router config path, base API URL, table column schema and gets the tenants list.
+   * @memberof ViewTenantsListComponent
+   */
+  ngOnInit(): void {
+    this.userTenantsPermissions =
+      this.tenantApplicationsService?.filterPermission(this.userPermissions);
+    this.tenantApplicationsService?.setAppConfig(
+      this.apiBaseURL,
+      this.userPermissions
+    );
+    this.tenantsPageInfo = {
+      tenantsTitle: this.viewTenantsConstants?.tenantsTitle,
+    };
+    this.routePaths = this.routePaths ?? this.constants?.routeConfigPath;
+    this.sharedService?.setRoutePaths(this.routePaths);
+    this.configureTableInfo();
+    this.defaultSortedColumn = this.columnSchema[0].columnDef;
+    this.getTenantsAndInitializeTableView(this.getTenantsPayload());
+  }
+  /**
+   * Validates permission based access for provided feature.
+   * @param {PermissionType} permissionType
+   * @return {boolean}
+   * @memberof ViewTenantsListComponent
+   */
+  validateAccess(permissionType: PermissionType): boolean {
+    return this.tenantApplicationsService.validateAccess(
+      permissionType,
+      this.userTenantsPermissions
+    );
+  }
+  /**
+   * Configures table schema to display the tenants in table view.
+   * @memberof ViewTenantsListComponent
+   */
+  configureTableInfo(): void {
+    this.columnSchema = [
+      {
+        id: 1,
+        columnDef: ViewTenantsColumnSchemaDef.APP_ID,
+        heading: this.tableColumns?.appId,
+        columnType: TableColumnType.LINK,
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        cellData: (element: any) => `${element.appId}`,
+        isSortableColumn: true,
+      },
+      {
+        id: 2,
+        columnDef: ViewTenantsColumnSchemaDef.APP_TITLE,
+        heading: this.tableColumns?.appTitle,
+        columnType: TableColumnType.TEXT,
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        cellData: (element: any) =>
+          `${element.appTitle ?? this.emptyFieldValueReplacedBy}`,
+        isSortableColumn: true,
+      },
+      {
+        id: 3,
+        columnDef: ViewTenantsColumnSchemaDef.APP_DESCRIPTION,
+        heading: this.tableColumns?.appDescription,
+        columnType: TableColumnType.TEXT,
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        cellData: (element: any) =>
+          `${element.appDescription ?? this.emptyFieldValueReplacedBy}`,
+      },
+
+      {
+        id: 4,
+        columnDef: ViewTenantsColumnSchemaDef.FEATURES,
+        heading: this.tableColumns?.features,
+        columnType: TableColumnType.TEXT,
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        cellData: (element: any) =>
+          `${
+            element?.features && element?.features?.length > 0
+              ? this.formatFeaturesName(element?.features)
+              : this.emptyFieldValueReplacedBy
+          }`,
+      },
+      {
+        id: 5,
+        columnDef: ViewTenantsColumnSchemaDef.STATUS,
+        heading: this.tableColumns?.status,
+        columnType: TableColumnType.TEXT,
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        cellData: (element: any) =>
+          `${element.status ? TenantStatus.ACTIVE : TenantStatus.INACTIVE}`,
+      },
+    ];
+  }
+
+  /**
+   * Format the features name in to single sentence with comma separated.
+   * @memberof ViewTenantsListComponent
+   */
+  formatFeaturesName(features: Features[]): string {
+    return features
+      .map((feature: Features) => {
+        // eslint-disable-next-line no-unused-expressions
+        return feature.featureName;
+      })
+      ?.join(', ');
+  }
+  /**
+   * Fetching details of tenants and initialize table view
+   * @param {GetTenantsPayload} payload
+   * @memberof ViewTenantsListComponent
+   */
+  getTenantsAndInitializeTableView(payload: GetTenantsPayload): void {
+    this.tenantApplicationsService
+      .getTenantsList(payload)
+      .pipe(takeUntil(this.destroy$))
+      .subscribe({
+        next: (response) => {
+          this.tableData = response?.body?.appDetails as TenantBasicInfo[];
+          this.paginatorConfig.totalRecords = response?.body
+            ?.totalRecords as number;
+        },
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        error: (error: any) => {
+          this.sharedService.handleErrors(error, this.constants?.errors);
+        },
+      });
+  }
+  /**
+   * Sets the dialog options for create tenant modal and calls openModal method.
+   * @return -returns nothing
+   * @memberof ViewTenantsListComponent
+   */
+  openCreateTenantForm(): void {
+    this.tenantApplicationsService.setTenantFunctionType(
+      TenantFunctionType.CREATE
+    );
+    const dialogOptions = {
+      heading: this.viewTenantsConstants?.addTenant,
+      isCloseNeeded: true,
+      componentReference: CreateTenantApplicationComponent,
+      modalType: ModalType.FORM,
+    };
+    this.openModal(dialogOptions, 'ieeesa-create-tenant');
+  }
+  /**
+   * Opens modal component with received params and handles form submission success and errors.
+   * @param {*} dialogOptions
+   * @param {string} [className]
+   * @return -returns nothing
+   * @memberof ViewTenantsListComponent
+   */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-inferrable-types, no-unused-vars
+  openModal(
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    dialogOptions: any,
+    className?: string
+  ): void {
+    className = className ?? '';
+    this.dialogRef = this.dialog?.open(ModalComponent, {
+      data: dialogOptions,
+      width: '',
+      panelClass: ['ieeesa-modal-dialog', className],
+      ariaModal: true,
+    });
+    this.dialogRef?.componentInstance?.submitFormResponse
+      .pipe(takeUntil(this.destroy$))
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars, @typescript-eslint/no-explicit-any, no-unused-vars
+      .subscribe((result: any) => {
+        this.dialogRef?.close();
+        const appTitle =
+          this.tenantApplicationsService.getNewTenantInfo?.appTitle;
+        this.sharedService.showAlertMessage(
+          AlertType?.SUCCESS,
+          `${appTitle} ${this.createTenantScreenTexts?.message?.success?.submission}`
+        );
+        this.getTenantsAndInitializeTableView(this.getTenantsPayload());
+      });
+    this.dialogRef?.componentInstance?.formCancel
+      .pipe(takeUntil(this.destroy$))
+      .subscribe(() => {
+        this.dialogRef?.close();
+      });
+  }
+  /**
+   * Sorts the tenants by application id or title in ascending or descending.
+   * @param {Sort} sort
+   * @memberof ViewTenantsListComponent
+   */
+  onSortTenants(sort: Sort): void {
+    this.defaultSortedColumn = sort.active;
+    this.defaultColumnSortDirection =
+      sort.direction === TableColumnSortDirection.ASCENDING;
+    this.sortConfig = {
+      sort: sort,
+      isSortedByAscending: this.defaultColumnSortDirection,
+    };
+    this.getTenantsAndInitializeTableView(this.getTenantsPayload());
+  }
+  /**
+   * Constructs and returns the payload for fetching the tenants list.
+   * @returns GetTenantsPayload
+   */
+  getTenantsPayload(): GetTenantsPayload {
+    const payload: GetTenantsPayload = {
+      payload: {
+        offset: this.pageEvent?.pageIndex
+          ? (this.pageEvent?.pageIndex as number)
+          : 0,
+        pageSize: this.pageEvent?.pageSize
+          ? (this.pageEvent?.pageSize as number)
+          : this.paginatorConfig?.recordsPerPage,
+        sortedBy: this.sortConfig?.sort?.active
+          ? (this.sortConfig?.sort?.active as string)
+          : ViewTenantsColumnSchemaDef.APP_ID,
+        sortedOrderBy: this.filterSortedOrderBy(
+          this.sortConfig?.isSortedByAscending
+            ? (this.sortConfig?.isSortedByAscending as boolean)
+            : this.defaultColumnSortDirection
+        ),
+      },
+    };
+    return payload;
+  }
+  /**
+   * Returning sorting order according to column definition.
+   * @param defaultColumnSortDirection
+   * @returns SortOrderBy.ASC | SortOrderBy.DESC
+   */
+  filterSortedOrderBy(defaultColumnSortDirection: boolean): string {
+    return defaultColumnSortDirection ? SortOrderBy.ASC : SortOrderBy.DESC;
+  }
+  /**
+   * Get the the records according to pagination.
+   *  @param {{
+   *     pageOffset: number;
+   *     pageLimit: number;
+   *   }} pageEvent
+   * @memberof ViewTenantsListComponent
+   */
+  onTablePaginationChange(pageEvent: PageEvent): void {
+    this.pageEvent = pageEvent;
+    this.getTenantsAndInitializeTableView(this.getTenantsPayload());
+  }
+  /**
+   * Navigates to view tenants detail component.
+   * @param {{tenantInfo: TenantBasicInfo}}
+   * @memberof ViewTenantsListComponent
+   */
+  navigateToViewTenantDetails(tenantInfo: TenantBasicInfo): void {
+    if (tenantInfo) {
+      this.tenantApplicationsService.setSelectedTenantInformation(tenantInfo);
+    }
+    if (this.routePaths?.viewTenantDetails)
+      this.router.navigate([this.routePaths?.viewTenantDetails], {queryParams: {id: tenantInfo?.appId}});
+    else this.viewTenantsDetails.emit(tenantInfo);
+  }
+  /**
+   * NgOnDestroy performs necessary cleanup tasks, such as unsubscribing from subscription when the component is being destroyed.
+   * @memberof ViewTenantsListComponent
+   * @return -returns nothing
+   */
+  ngOnDestroy(): void {
+    this.destroy$.next(true);
+    this.destroy$.unsubscribe();
+  }
+}

package/src/lib/models/app-type-config.model.ts

@@ -0,0 +1,14 @@
+import { AppType } from "./app-type.model";
+
+export interface AppTypeConfig {
+  configFieldId: string;
+  configFieldValue: {
+    type: AppType;
+  };
+}
+
+export interface GetAppTypesResponse {
+  status: boolean;
+  message: string;
+  body: AppTypeConfig[] | null | { errorCodes: string[] };
+}

package/src/lib/models/app-type.model.ts

@@ -0,0 +1,5 @@
+/* eslint-disable no-unused-vars */
+export enum AppType {
+    GENERIC = 'Generic',
+    STANDALONE = 'Standalone'
+}

package/src/lib/models/create-group-type-config.model.ts

@@ -0,0 +1,18 @@
+/* eslint-disable no-unused-vars */
+export enum Settings {
+  ALLOW_SUB_GROUPS = 'Allow Sub-Groups',
+  ALLOW_ROSTERS = 'Rosters Enabled',
+  ALLOW_ALTERNATE_VOTING = 'Allow Alternate Voting',
+  HAS_CLASSIFICATION = 'Has Classification',
+  ALLOW_EDIT = 'Allow Edit',
+  ALLOW_DELETE = 'Allow Delete',
+}
+/* eslint-disable no-unused-vars */
+export enum VotingMemberLevelRole {
+  VOTING_MEMBER_PRINCIPAL = 'Voting Member (Principal)',
+  VOTING_MEMBER_ALTERNATE = 'Voting Member (Alternate)',
+}
+export enum RosterTypeLOVCode {
+  INDIVIDUAL = 'IND',
+  ENTITY = 'EN',
+}

package/src/lib/models/create-group-type.model.ts

@@ -0,0 +1,46 @@
+import { LOV } from '@ieeesa-npm/shared';
+
+export interface GetRosterTypeOrSettingsResponse {
+  status: boolean;
+  message: string;
+  body?: LOV[] | null | { errorCodes: string[] };
+}
+export interface ConfigFieldValue {
+  name: string;
+  description: string;
+  businessRule: {
+    rosterType: string;
+    allowEdit: boolean;
+    allowRoster: boolean;
+    allowSubGroup: boolean;
+    allowAlternateVoting: boolean;
+    allowDelete: boolean;
+    hasClassification: boolean;
+    allowedGroupType: string[];
+    isRootGroup: boolean;
+  };
+  hierarchy?: number;
+}
+export interface CreatedOrModifiedGroupTypeInfo {
+  appId: string;
+  roles: {
+    roleId: string;
+  }[];
+  configFieldName: string;
+  configFieldValue: ConfigFieldValue;
+}
+export interface CreateGroupTypeRequestPayload {
+  payload: {
+    appId: string;
+    roles: {
+      roleId: string;
+    }[];
+    configFieldName: string;
+    configFieldValue: string;
+  };
+}
+export interface CreateGroupTypeResponse {
+  status: boolean;
+  message: string;
+  body?: string | null | { errorCodes: string[] };
+}

package/src/lib/models/feature-permission-id.model.ts

@@ -0,0 +1,6 @@
+export enum FeaturePermissionId {
+  // eslint-disable-next-line no-unused-vars
+  MEETINGS_AND_EVENTS = 'FEATURE_049753e8-ea5c-4fad-adb0-e1456e69c7a5',
+  // eslint-disable-next-line no-unused-vars
+  BALLOTS = 'FEATURE_a0ad3616-20dc-43da-813f-9b76d33f227a',
+}

package/src/lib/models/features.model.ts

@@ -0,0 +1,15 @@
+export interface Features {
+  featureId: string;
+  featureName: string;
+  isDefault: boolean;
+}
+
+export interface FeatureId {
+    featureId: string;
+}
+
+export interface GetFeaturesResponse {
+  status: boolean;
+  message: string;
+  body: Features[] | null | { errorCodes: string[] };
+}

package/src/lib/models/form-status.model.ts

@@ -0,0 +1,5 @@
+/* eslint-disable no-unused-vars */
+export enum FormStatus {
+    VALID = "VALID",
+    INVALID = "INVALID",
+  }

package/src/lib/models/permission-type.model.ts

@@ -0,0 +1,9 @@
+/* eslint-disable no-unused-vars */
+export enum PermissionType {
+  VIEW_TENANTS = 'VIEW_TENANTS',
+  MANAGE_TENANT = 'MANAGE_TENANT',
+}
+export enum TenantStatus {
+  ACTIVE = 'Active',
+  INACTIVE = 'Inactive',
+}

package/src/lib/models/role-menu-action.model.ts

@@ -0,0 +1,5 @@
+/* eslint-disable no-unused-vars */
+export enum RoleMenuAction {
+  EDIT_ROLE = 1,
+  DELETE_ROLE = 2,
+}

package/src/lib/models/role-type.model.ts

@@ -0,0 +1,34 @@
+export interface RoleType {
+  roleTypeName: string;
+  viewOrder: number;
+}
+
+export interface RoleTypeConfiguration {
+  configFieldId: string;
+  configFieldValue: RoleType;
+}
+
+export interface RoleTypeResponse {
+  status: boolean;
+  message: string;
+  body:
+    | RoleTypeConfiguration[]
+    | null
+    | {
+        errorCodes: string[];
+      };
+}
+
+export interface RoleTypeOption {
+  id: string | number;
+  name: string;
+  order: number;
+}
+export interface RoleTypePayload {
+  appId: string;
+  configFieldName: string;
+}
+
+export interface GetRoleTypesPayload {
+  payload: RoleTypePayload;
+}

package/src/lib/models/roles-and-permissions-table-type.model.ts

@@ -0,0 +1,5 @@
+/* eslint-disable no-unused-vars */
+export enum RoleAndPermissionsTableType {
+  ROLE = 'ROLE',
+  PERMISSION = 'PERMISSION',
+}

package/src/lib/models/roles-and-permissions.model.ts

@@ -0,0 +1,113 @@
+export interface RolesAndPermissions {
+  permission: string;
+  roleIdsList: string[];
+}
+export interface Role {
+  roleId: string;
+  roleName: string;
+  roleType: string;
+  roleTypeName: string;
+  viewOrder: number;
+}
+export interface GetRolesResponse {
+  status: boolean;
+  message: string;
+  body?: Role[] | null | { errorCodes: string[] };
+}
+export interface PaginationInfo {
+  offset: number;
+  pageSize: number;
+}
+export interface GetRolesAndPermissionsPayload {
+  payload: PaginationInfo;
+}
+export interface RoleDetails {
+  roleId: string;
+  roleName: string;
+}
+export interface RolesAndPermissionsMapping {
+  permissionId: string;
+  permissionName: string;
+  roleList: RoleDetails[];
+}
+export interface GetRolesAndPermissionsResponse {
+  status: boolean;
+  message: string;
+  body: {
+    totalRecords: number;
+    rolePermissionDetails:
+      | RolesAndPermissionsMapping[]
+      | null
+      | { errorCodes: string[] };
+  };
+}
+
+export interface RoleInfo {
+  roleType?: string;
+  roleName: string;
+  roleId?: string;
+}
+
+export interface CreateModifyRoleInfo extends RoleInfo {
+  appId: string;
+}
+
+export interface CreateModifyRoleRequestPayload {
+  payload: CreateModifyRoleInfo;
+}
+
+export interface CreateModifyRoleResponse {
+  status: boolean;
+  message: string;
+  body?: string | null | { errorCodes: string[] };
+}
+export interface DeleteRoleRequestPayload {
+  payload: {
+    roleId: string;
+    appId: string;
+  };
+}
+export interface DeleteRoleResponse {
+  status: boolean;
+  message: string;
+  body?: string | null | { errorCodes: string[] };
+}
+export interface Permission {
+  permissionId: string;
+  permissionName: string;
+}
+export interface GetPermissionsResponse {
+  status: boolean;
+  message: string;
+  body?: Permission[] | null | { errorCodes: string[] };
+}
+export interface RoleOrPermissionMapping {
+  roleOrPermissionName: string;
+  roleOrPermissionId: string;
+  status: boolean;
+}
+export interface MapRolesAndPermissions {
+  appId: string;
+  permissionId: string | null;
+  roleId: string | null;
+}
+export interface ModifiedRolesAndPermissionsMapping
+  extends MapRolesAndPermissions {
+  status: boolean;
+}
+export interface RolePermissionMappingRequestPayload {
+  payload: MapRolesAndPermissions;
+}
+export interface RolePermissionMappingResponse {
+  status: boolean;
+  message: string;
+  body?: RoleDetails[] | Permission[] | { errorCodes: string[] };
+}
+export interface RolesAndPermissionsRequestPayload {
+  payload: ModifiedRolesAndPermissionsMapping[];
+}
+export interface RolesAndPermissionsResponse {
+  status: boolean;
+  message: string;
+  body?: string | { errorCodes: string[] };
+}

package/src/lib/models/route-config.model.ts

@@ -0,0 +1,4 @@
+export interface TenantsRoutesConfig {
+  viewTenants: string;
+  viewTenantDetails: string;
+}