@ieeesa-npm/tenants 0.2.1 → 0.2.3

package/lib/assets/tenant-validations.d.ts

@@ -6,3 +6,6 @@ export declare const TenantsValidationPatterns: {
     url: RegExp;
     alphaNumeric: RegExp;
 };
+export declare const RolesValidation: {
+    roleNameMaxLength: number;
+};

package/lib/components/create-modify-role/create-modify-role.component.d.ts

@@ -0,0 +1,85 @@
+import { EventEmitter, OnDestroy, OnInit } from '@angular/core';
+import { Subject } from 'rxjs';
+import { FormGroup } from '@angular/forms';
+import { AlignType, DynamicFormComponent, FormGrid, FormModel, SelectOption } from '@ieeesa-npm/presentation';
+import { TenantApplicationsService } from '../../services/tenant-applications.service';
+import { SharedService } from '@ieeesa-npm/shared';
+import { TenantFunctionType } from '../../models/tenant-function-type.model';
+import { TenantBasicInfo } from '../../models/tenant.model';
+import { CreateRoleRequestPayload } from '../../models/roles-and-permissions.model';
+import * as i0 from "@angular/core";
+export declare class CreateModifyRoleComponent implements OnInit, OnDestroy {
+    private tenantAppService;
+    private sharedService;
+    destroy$: Subject<boolean>;
+    constants: any;
+    createRoleTexts: any;
+    leftButtonLabel: any;
+    rightButtonLabel: any;
+    colWidth: FormGrid;
+    createRoleFormGroup: FormModel;
+    createRoleFormGroupRef: FormGroup;
+    actionButtonAlign: AlignType;
+    dynamicFormComponent: DynamicFormComponent;
+    submitFormResponse: EventEmitter<any>;
+    formCancel: EventEmitter<any>;
+    tenantFunctionType: TenantFunctionType;
+    selectedTenantInfo: TenantBasicInfo | undefined;
+    createRolePayload: CreateRoleRequestPayload;
+    roleTypeOptions: SelectOption[];
+    constructor(tenantAppService: TenantApplicationsService, sharedService: SharedService);
+    ngOnInit(): void;
+    /**
+     * Gets the role types and updates the form control.
+     * @memberof CreateRoleComponent
+     */
+    getRoleTypes(): void;
+    /**
+     * Initialize the create role form group array.
+     * @memberof CreateRoleComponent
+     */
+    initializeCreateRoleFormGroup(): void;
+    /**
+     * Gets create role form group reference.
+     * @param {FormGroup[]} form
+     * @memberof CreateRoleComponent
+     */
+    getCreateRoleFormGroupRef(form: FormGroup[]): void;
+    /**
+     * Updates createRoleFormGroupRef on add role form change event.
+     * @param {FormGroup[]} form
+     * @memberof CreateRoleComponent
+     */
+    onCreateRoleFormChange(form: FormGroup[]): void;
+    /**
+     * Creates a new role on form submission and the form is valid.
+     * @param {FormGroup[]} form
+     * @memberof CreateRoleComponent
+     */
+    onCreateRoleFormSubmit(form: FormGroup[]): void;
+    /**
+     * Constructs create role payload from the form data and returns.
+     * @param {*} formData
+     * @return {CreateRoleRequestPayload}
+     * @memberof CreateRoleComponent
+     */
+    getCreateRolePayload(formData: any): CreateRoleRequestPayload;
+    /**
+     * Post the creates new role form data to the server on form submission to create a new role.
+     * * @param {CreateRoleRequestPayload} createRolePayload
+     * @memberof CreateRoleComponent
+     */
+    createRole(): void;
+    /**
+     * Emits form cancel event.
+     * @memberof CreateRoleComponent
+     */
+    onFormCancel(): void;
+    /**
+     * Implementation of ngOnDestroy lifecycle hook method to unsubscribe the open observable subscriptions.
+     * @memberof CreateRoleComponent
+     */
+    ngOnDestroy(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<CreateModifyRoleComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<CreateModifyRoleComponent, "ieeesa-create-modify-role", never, {}, { "submitFormResponse": "submitFormResponse"; "formCancel": "formCancel"; }, never, never, true, never>;
+}

package/lib/components/tenant-basic-details/tenant-basic-details.component.d.ts

@@ -127,6 +127,48 @@ export declare class TenantBasicDetailsComponent implements OnDestroy {
                 addApplicationLabel: string;
             };
         };
+        createRole: {
+            heading: string;
+            label: {
+                leftButtonLabel: string;
+                rightButtonLabel: string;
+                appTitle: string;
+                roleType: string;
+                roleName: string;
+                ariaLabel: {
+                    appTitle: string;
+                    roleType: string;
+                    roleName: string;
+                };
+                ariaDescribedById: {
+                    appTitle: string;
+                    roleType: string;
+                    roleName: string;
+                };
+            };
+            message: {
+                error: {
+                    required: string;
+                };
+                success: {
+                    submission1: string;
+                    submission2: string;
+                    submission3: string;
+                };
+            };
+            supportText: {
+                roleType: string;
+                roleName: string;
+            };
+            errors: {
+                "3012": string;
+                "3013": string;
+                "3014": string;
+                "3015": string;
+                "3016": string;
+                "3011": string;
+            };
+        };
         editTenant: {
             message: {
                 success: {
@@ -174,13 +216,18 @@ export declare class TenantBasicDetailsComponent implements OnDestroy {
                 ariaLabel: {
                     alert: string;
                 };
+                deleteRoleConfirmationMessage: string;
+                deleteRolePromptMessage: string;
             };
             errors: {
                 "2050": string;
                 "2051": string;
                 "2054": string;
                 "3007": string;
+                "3008": string;
                 "3009": string;
+                "3010": string;
+                "3011": string;
             };
             tenantAccordionInfo: {
                 id: number;
@@ -229,6 +276,13 @@ export declare class TenantBasicDetailsComponent implements OnDestroy {
                 isToolTipNeeded: boolean;
             }[];
         };
+        deleteRole: {
+            message: {
+                success: {
+                    submission: string;
+                };
+            };
+        };
         routeConfigPath: {
             viewTenants: string;
             viewTenantDetails: string;

package/lib/components/view-tenant-details/view-tenant-details.component.d.ts

@@ -1,15 +1,16 @@
 import { OnDestroy, OnInit } from '@angular/core';
 import { BreakpointObserverService, GlobalErrorHandlerService } from '@ieeesa-npm/utility';
-import { AccordionInfo, Menu, PaginatorConfig, TableActions, AlignType, RadioOption, IconButton, SlideToggleOption, TableColumnSchema, AccordionDetails } from '@ieeesa-npm/presentation';
+import { AccordionInfo, Menu, PaginatorConfig, TableActions, AlignType, RadioOption, IconButton, SlideToggleOption, TableColumnSchema, AccordionDetails, TableColumnMenuInfo } from '@ieeesa-npm/presentation';
 import { Subject } from 'rxjs';
 import { TenantApplicationsService } from '../../services/tenant-applications.service';
 import { TenantsPermissions, UserPermission } from '../../models/tenants-permission.model';
 import { SharedService } from '@ieeesa-npm/shared';
 import { TenantsRoutesConfig } from '../../models/route-config.model';
 import { TenantBasicInfo } from '../../models/tenant.model';
+import { TenantFunctionType } from '../../models/tenant-function-type.model';
 import { PageEvent } from '@angular/material/paginator';
 import { MatDialog } from '@angular/material/dialog';
-import { GetRolesAndPermissionsPayload, RolesAndPermissions } from '../../models/roles-and-permissions.model';
+import { GetRolesAndPermissionsPayload, RolesAndPermissions, PaginationInfo, RoleDetails } from '../../models/roles-and-permissions.model';
 import { PermissionType } from '../../models/permission-type.model';
 import * as i0 from "@angular/core";
 export declare class ViewTenantDetailsComponent implements OnInit, OnDestroy {
@@ -45,6 +46,7 @@ export declare class ViewTenantDetailsComponent implements OnInit, OnDestroy {
     tableData: RolesAndPermissions[];
     isRolesAndPermissionsExpanded: boolean;
     paginatorConfig: PaginatorConfig;
+    tablePagination: PaginationInfo;
     rolesAndPermissionsClassName: string;
     headerElementClassName: string;
     tableActions: TableActions;
@@ -54,9 +56,14 @@ export declare class ViewTenantDetailsComponent implements OnInit, OnDestroy {
     appTypeOptions: RadioOption[];
     isBasicDetailsExpanded: boolean;
     editTenantScreenTexts: any;
+    deleteRoleScreenTexts: any;
     alignmentType: typeof AlignType;
     userTenantsPermissions: TenantsPermissions[];
     permissionType: typeof PermissionType;
+    functionType: TenantFunctionType;
+    createRoleScreenTexts: any;
+    roleMenuElement: HTMLElement;
+    selectedRoleInfo: RoleDetails;
     constructor(dialog: MatDialog, breakpointObserverService: BreakpointObserverService, tenantAppService: TenantApplicationsService, globalErrorHandlerService: GlobalErrorHandlerService, sharedService: SharedService);
     /**
      * Initializes view tenant details component.
@@ -93,11 +100,18 @@ export declare class ViewTenantDetailsComponent implements OnInit, OnDestroy {
      * @memberof ViewTenantDetailsComponent
      */
     onTablePaginationChange(pageEvent: PageEvent): void;
+    /**
+     * Captures the selected role's information and performs edit or delete action basis on the selected menu item.
+     * @param {TableColumnMenuInfo} roleMenuInfo
+     * @memberof ViewTenantDetailsComponent
+     */
+    onRoleMenuClick(roleMenuInfo: TableColumnMenuInfo): void;
     /**
      * Keeps track of the accordion based on the element's ID in DOM tree.
      * @memberof ViewTenantDetailsComponent
      */
     trackByAccordionFn(index: number, item: AccordionInfo): number;
+    openCreateRoleForm(): void;
     /**
      * Sets the dialog options for edit tenant modal and calls openModal method.
      * @return -returns nothing
@@ -148,6 +162,22 @@ export declare class ViewTenantDetailsComponent implements OnInit, OnDestroy {
      * @memberof ViewTenantDetailsComponent
      */
     validateAccess(permissionType: PermissionType): boolean;
+    /**
+     * Posts the details of the role to be deleted to the server using http request and display success/error message based on request response (success or failure).
+     * @memberof ViewTenantDetailsComponent
+     */
+    deleteRole(): void;
+    /**
+     * Sets the role menu HTMLElement.
+     * @param {HTMLElement} menuButton
+     * @memberof ViewTenantDetailsComponent
+     */
+    selectedRoleMenuElement(menuButton: HTMLElement): void;
+    /**
+     * Opens the confirmation modal to get user confirmation to delete the role.
+     * @memberof ViewTenantDetailsComponent
+     */
+    openDeleteRoleModal(): void;
     /**
      * Performs necessary cleanup tasks, such as unsubscribing from subscription when the component is being destroyed.
      * @memberof ViewTenantDetailsComponent

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

@@ -0,0 +1,4 @@
+export declare enum RoleMenuAction {
+    EDIT_ROLE = 1,
+    DELETE_ROLE = 2
+}

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

@@ -0,0 +1,27 @@
+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/lib/models/roles-and-permissions.model.d.ts

@@ -5,6 +5,9 @@ export interface RolesAndPermissions {
 export interface Role {
     roleId: string;
     roleName: string;
+    roleType: string;
+    roleTypeName: string;
+    viewOrder: number;
 }
 export interface GetRolesResponse {
     status: boolean;
@@ -13,16 +16,21 @@ export interface GetRolesResponse {
         errorCodes: string[];
     };
 }
+export interface PaginationInfo {
+    offset: number;
+    pageSize: number;
+}
 export interface GetRolesAndPermissionsPayload {
-    payload: {
-        offset: number;
-        pageSize: number;
-    };
+    payload: PaginationInfo;
+}
+export interface RoleDetails {
+    roleId: string;
+    roleName: string;
 }
 export interface RolesAndPermissionsMapping {
     permissionId: string;
     permissionName: string;
-    roleList: Role[];
+    roleList: RoleDetails[];
 }
 export interface GetRolesAndPermissionsResponse {
     status: boolean;
@@ -34,3 +42,33 @@ export interface GetRolesAndPermissionsResponse {
         };
     };
 }
+export interface RoleInfo {
+    roleType: string;
+    roleName: string;
+}
+export interface CreateRoleInfo extends RoleInfo {
+    appId: string;
+}
+export interface CreateRoleRequestPayload {
+    payload: CreateRoleInfo;
+}
+export interface CreateRoleResponse {
+    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[];
+    };
+}

package/lib/models/tenant-function-type.model.d.ts

@@ -1,4 +1,6 @@
 export declare enum TenantFunctionType {
     CREATE = "CREATE",
-    EDIT = "EDIT"
+    EDIT = "EDIT",
+    CREATE_ROLE = "CREATE_ROLE",
+    EDIT_ROLE = "EDIT_ROLE"
 }

package/lib/services/tenant-applications.service.d.ts

@@ -10,8 +10,9 @@ import { FeatureId, Features, GetFeaturesResponse } from '../models/features.mod
 import { AppTypeConfig, GetAppTypesResponse } from '../models/app-type-config.model';
 import { TenantPermissionsService } from './tenant-permissions.service';
 import { TenantFunctionType } from '../models/tenant-function-type.model';
-import { GetRolesAndPermissionsPayload, GetRolesAndPermissionsResponse, GetRolesResponse } from '../models/roles-and-permissions.model';
+import { CreateRoleResponse, GetRolesAndPermissionsPayload, GetRolesAndPermissionsResponse, GetRolesResponse, RoleInfo, CreateRoleRequestPayload, DeleteRoleRequestPayload, DeleteRoleResponse, Role } from '../models/roles-and-permissions.model';
 import { UpdateTenantStatusRequestPayload, UpdateTenantStatusResponse } from '../models/update-tenant-status.model';
+import { GetRoleTypesPayload, RoleTypeConfiguration, RoleTypeOption, RoleTypeResponse } from '../models/role-type.model';
 import * as i0 from "@angular/core";
 export declare class TenantApplicationsService {
     private httpService;
@@ -22,7 +23,10 @@ export declare class TenantApplicationsService {
         "2051": string;
         "2054": string;
         "3007": string;
+        "3008": string;
         "3009": string;
+        "3010": string;
+        "3011": string;
     };
     apiBaseUrl: string;
     userPermission: UserPermission[];
@@ -41,12 +45,12 @@ export declare class TenantApplicationsService {
         "2035": string;
         "2036": string;
         "2037": string;
+        "2038": string;
         /**
-         * Returns the tenants information
-         * @return {TenantBasicInfo}
+         * Sets the user tenants information
+         * @param {TenantBasicInfo} tenantInfo
          * @memberof TenantApplicationsService
          */
-        "2038": string;
         "2039": string;
         "2040": string;
         "2041": string;
@@ -68,6 +72,8 @@ export declare class TenantApplicationsService {
     checkBoxOptions: CheckboxOption[];
     appTypeInfo: RadioOption[];
     featureList: Features[];
+    roleTypeOptions: RoleTypeOption[];
+    newlyCreatedRole: RoleInfo;
     constructor(httpService: HttpService, tenantPermissionsService: TenantPermissionsService, tenantPermissionsMapService: TenantPermissionsMapService);
     setAppConfig(apiBaseUrl: string, userPermission: UserPermission[]): void;
     /**
@@ -160,6 +166,27 @@ export declare class TenantApplicationsService {
      * @memberof TenantApplicationsService
      */
     getApplicationTypes(): Observable<GetAppTypesResponse>;
+    /**
+     * Posts create role form data to server using HttpService to create a new role.
+     * @param {CreateRoleRequestPayload} createRolePayload
+     * @return {Observable<CreateRoleResponse>}
+     * @memberof TenantApplicationsService
+     */
+    createRole(createRolePayload: CreateRoleRequestPayload): Observable<CreateRoleResponse>;
+    /**
+     * Gets list of role types from server using HttpService.
+     * @param {GetRoleTypesPayload} payload
+     * @return {Observable<RoleTypeResponse>}
+     * @memberof TenantApplicationsService
+     */
+    getRoleTypes(payload: GetRoleTypesPayload): Observable<RoleTypeResponse>;
+    /**
+     * Constructs the select/dropdown options from the role types received from server.
+     * @param {RoleTypeConfiguration[]} roleTypeResponse
+     * @return {RoleTypeOption[]}
+     * @memberof TenantApplicationsService
+     */
+    getRoleTypeOptions(roleTypeResponse: RoleTypeConfiguration[]): RoleTypeOption[];
     /**
      * Posts tenant application form data to server using HttpService for creating new tenant application.
      * @param {CreateTenantPayload} createTenantPayload
@@ -204,6 +231,16 @@ export declare class TenantApplicationsService {
      * @return {TenantFunctionType} -tenant function type.
      */
     getTenantFunctionType(): TenantFunctionType;
+    /**
+     * Stores the newly created role information.
+     * @param {RoleInfo} newlyCreatedRole -create role information.
+     */
+    setNewlyCreatedRoleInfo(newlyCreatedRole: RoleInfo): void;
+    /**
+     * Returns the newly created role information.
+     * @return {RoleInfo} -create role information.
+     */
+    getNewlyCreatedRoleInfo(): RoleInfo;
     /**
      * Posts the edited tenant application form data to server using HttpService for updating the tenant information.
      * @param {CreateTenantPayload} editTenantPayload
@@ -225,6 +262,20 @@ export declare class TenantApplicationsService {
      * @memberof TenantApplicationsService
      */
     getFeaturesList(features: CheckboxOption[]): Features[];
+    /**
+     * Returns sorted role list data.
+     * @param {Role[]} roleList
+     * @return {Role[]}
+     * @memberof TenantApplicationsService
+     */
+    sortRolesByRoleType(roleList: Role[]): Role[];
+    /**
+     * Posts the role details to server using HttpService for deleting the role.
+     * @param {DeleteRoleRequestPayload} deleteRoleRequestPayload
+     * @return {Observable<DeleteRoleResponse>}
+     * @memberof TenantApplicationsService
+     */
+    deleteRole(deleteRolePayload: DeleteRoleRequestPayload): Observable<DeleteRoleResponse>;
     static ɵfac: i0.ɵɵFactoryDeclaration<TenantApplicationsService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<TenantApplicationsService>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ieeesa-npm/tenants",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "peerDependencies": {
     "@angular/common": "^16.1.0",
     "@angular/core": "^16.1.0"

package/public-api.d.ts

@@ -3,6 +3,7 @@ export * from './lib/components/view-tenant-details/view-tenant-details.componen
 export * from './lib/components/create-tenant-application/create-tenant-application.component';
 export * from './lib/tenant-applications.component';
 export * from './lib/components/tenant-basic-details/tenant-basic-details.component';
+export * from './lib/components/create-modify-role/create-modify-role.component';
 export * from './lib/models/app-type-config.model';
 export * from './lib/models/app-type.model';
 export * from './lib/models/tenant.model';
@@ -15,6 +16,8 @@ export * from './lib/models/table-column-schema-view-tenant-list.model';
 export * from './lib/models/roles-and-permissions.model';
 export * from './lib/models/update-tenant-status.model';
 export * from './lib/models/tenant-function-type.model';
+export * from './lib/models/role-type.model';
+export * from './lib/models/role-menu-action.model';
 export * from './lib/services/tenant-applications.service';
 export * from './lib/services/tenant-permissions-map.service';
 export * from './lib/services/tenant-permissions.service';