@ieeesa-npm/groups 0.4.7 → 0.4.8

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

@@ -2,4 +2,5 @@ export declare const GroupsValidationPatterns: {
     groupName: RegExp;
     shortName: RegExp;
     groupScope: RegExp;
+    email: RegExp;
 };

package/lib/components/add-user-roster/add-user-roster.component.d.ts

@@ -0,0 +1,108 @@
+import { EventEmitter, OnDestroy, OnInit } from '@angular/core';
+import { FormGroup } from '@angular/forms';
+import { Subject } from 'rxjs';
+import { AlertsService, GlobalErrorHandlerService } from '@ieeesa-npm/utility';
+import { FormGrid, FormModel, AlignType, CheckboxOption } from '@ieeesa-npm/presentation';
+import { GroupsService } from '../../services/groups.service';
+import { UserInfo } from '../../models/user-info.model';
+import * as i0 from "@angular/core";
+/**
+ * Component implements the view and functionalities to add group users to roster.
+ * @export
+ * @class AddUserRosterComponent
+ * @implements {OnInit}
+ * @implements {OnDestroy}
+ */
+export declare class AddUserRosterComponent implements OnInit, OnDestroy {
+    private groupService;
+    private globalErrorHandlerService;
+    alertService: AlertsService;
+    destroy$: Subject<boolean>;
+    constants: any;
+    addUserRosterTexts: any;
+    leftButtonLabel: any;
+    rightButtonLabel: any;
+    isSubmitButtonDisabled: boolean;
+    colWidth: FormGrid;
+    searchUserFormGroup: FormModel;
+    addUserFormGroup: FormModel;
+    actionButtonAlign: AlignType;
+    addUserFormGroupRef: FormGroup;
+    isSearchUserForm: boolean;
+    userRoles: CheckboxOption[];
+    selectedUserRoles: string[];
+    userInfo: UserInfo;
+    isAddUserFormEmailSearch: boolean;
+    submitFormResponse: EventEmitter<any>;
+    formCancel: EventEmitter<any>;
+    constructor(groupService: GroupsService, globalErrorHandlerService: GlobalErrorHandlerService, alertService: AlertsService);
+    /**
+     * Initializes user roles and searchUserFormGroup.
+     * @memberof AddUserRosterComponent
+     */
+    ngOnInit(): void;
+    /**
+     * Creates search user form group
+     * @memberof AddUserRosterComponent
+     */
+    createSearchUserFormGroup(): void;
+    /**
+     * Checks form validity and searches the user by entered email.
+     * @param {FormGroup[]} form
+     * @memberof AddUserRosterComponent
+     */
+    onSearchUserFormSubmit(form: FormGroup[]): void;
+    /**
+     * Searches the user by entered email and gets the user details when the email id is found.
+     * @param {string} email
+     * @memberof AddUserRosterComponent
+     */
+    searchUserByEmail(email: string): void;
+    /**
+     * Validates whether the user is exists in the selected group and then creates add user form when the user does not exist in the selected group.
+     * @memberof AddUserRosterComponent
+     */
+    validateUserExistence(): void;
+    /**
+     * Handles add user form email search
+     * @param {string} email
+     * @memberof AddUserRosterComponent
+     */
+    formSearchApply(email: string): void;
+    /**
+     * Assigns role to user on form submission.
+     * @param {FormGroup[]} form
+     * @memberof AddUserRosterComponent
+     */
+    onAddUserFormSubmit(form: FormGroup[]): void;
+    /**
+     * Get add user form group reference.
+     * @param {FormGroup[]} form
+     * @memberof AddUserRosterComponent
+     */
+    getAddUserFormGroupRef(form: FormGroup[]): void;
+    /**
+     * Handles user role selection in add user form.
+     * @param {CheckboxOption} event
+     * @memberof AddUserRosterComponent
+     */
+    onUserRoleSelection(event: CheckboxOption): void;
+    /**
+     * Emits form cancel event.
+     * @memberof AddUserRosterComponent
+     */
+    onFormCancel(): void;
+    /**
+     * Handles the custom errors while searching user by email, validating user existence and adding new user to roster.
+     * @param {*} error
+     * @memberof AddUserRosterComponent
+     */
+    handleErrors(error: any): void;
+    /**
+     * NgOnDestroy performs necessary cleanup tasks, such as unsubscribing from subscription when the component is being destroyed.
+     * @memberof AddUserRosterComponent
+     */
+    ngOnDestroy(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AddUserRosterComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<AddUserRosterComponent, "ieeesa-add-user-roster", never, {}, { "submitFormResponse": "submitFormResponse"; "formCancel": "formCancel"; }, never, never, true, never>;
+}

package/lib/components/view-roster/view-roster.component.d.ts

@@ -58,6 +58,11 @@ export declare class ViewRosterComponent implements OnDestroy {
      * @memberof ViewRosterComponent
      */
     handleErrors(error: any): void;
+    /**
+     * Emits openModalNotifier event with GroupFunctionType value as ADD_USER_TO_ROSTER
+     * @memberof ViewRosterComponent
+     */
+    onAddNewUser(): void;
     /**
      * NgOnDestroy performs necessary cleanup tasks, such as unsubscribing from subscription when the component is being destroyed.
      * @memberof ViewRosterComponent

package/lib/groups.component.d.ts

@@ -27,6 +27,7 @@ export declare class GroupsComponent implements OnInit, OnDestroy {
     viewGroupTexts: any;
     createGroupText: any;
     editGroupTexts: any;
+    addUserRosterTexts: any;
     isGroupSearchActive: boolean;
     isGroupFilterActive: boolean;
     isGroupSearchOrFilterActive: boolean;
@@ -54,6 +55,7 @@ export declare class GroupsComponent implements OnInit, OnDestroy {
     functionType: GroupFunctionType;
     alignmentType: typeof AlignType;
     isSorting: boolean;
+    canReopenViewRosterModal: boolean;
     constructor(dialog: MatDialog, groupsService: GroupsService, alertService: AlertsService, breakpointObserverService: BreakpointObserverService, globalErrorHandlerService: GlobalErrorHandlerService);
     /**
      * Initialize the groups component.
@@ -75,6 +77,11 @@ export declare class GroupsComponent implements OnInit, OnDestroy {
      * @memberof GroupsComponent
      */
     openEditGroupForm(editGroupInfo: EditGroupAndParentInfo): void;
+    /**
+     * Sets the dialog options for add users modal and calls openModal method.
+     * @memberof GroupsComponent
+     */
+    openAddUserRosterModal(): void;
     /**
      * Sets the dialog options for users modal and calls openModal method.
      * @param {GroupInfo} group

package/lib/models/add-new-user.model.d.ts

@@ -0,0 +1,30 @@
+export interface SearchUserByEmailResponse {
+    status: boolean;
+    message: string;
+    body: {
+        userId: string;
+        email: string;
+        name: string;
+    };
+}
+export interface GetUserDetailsPayload {
+    payload: {
+        groupId: string;
+        userId: string;
+    };
+}
+export interface AddNewUserPayload {
+    payload: {
+        groupId: string;
+        userId: string;
+        roles: string[];
+        email: string;
+    };
+}
+export interface GroupUserDetailsResponse {
+    status: boolean;
+    message: string;
+    body?: string | null | {
+        errorCodes: string[];
+    };
+}

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

@@ -3,5 +3,6 @@ export declare enum GroupFunctionType {
     EDIT = "EDIT",
     VIEW_ROSTER = "VIEW_ROSTER",
     FILTER = "FILTER",
+    ADD_USER_TO_ROSTER = "ADD_USER_TO_ROSTER",
     TOGGLE = "TOGGLE"
 }

package/lib/models/user-info.model.d.ts

@@ -0,0 +1,5 @@
+export interface UserInfo {
+    email: string;
+    name: string;
+    userId: string;
+}

package/lib/services/groups.service.d.ts

@@ -1,4 +1,4 @@
-import { Observable } from 'rxjs';
+import { Observable, BehaviorSubject } from 'rxjs';
 import { CreateGroupPayload, CreateGroupResponse } from '../models/create-group.model';
 import { GroupTypeConfiguration, GroupTypeConfigValue, GroupTypeResponse } from '../models/group-types.model';
 import { AlertsService, HttpService } from '@ieeesa-npm/utility';
@@ -9,6 +9,7 @@ import { SearchUsersPayload, FilterUsersByRolesPayload, GetGroupUsersResponse, U
 import { CheckboxOption } from '@ieeesa-npm/presentation';
 import { EditGroupPayload } from '../models/edit-group.model';
 import { GroupFunctionType } from '../models/group-function-type.model';
+import { AddNewUserPayload, GetUserDetailsPayload, SearchUserByEmailResponse, GroupUserDetailsResponse } from '../models/add-new-user.model';
 import * as i0 from "@angular/core";
 /**
  * Groups service is an abstract layer and responsible for managing groups REST API calls.
@@ -25,6 +26,12 @@ export declare class GroupsService {
         "1004": string;
         "1005": string;
         "1006": string;
+        /**
+         * Sets selected group info.
+         * @param {(GroupInfo | undefined)} selectedGroupInfo -selected group info.
+         * @param {(GroupInfo | undefined)} [selectedGroupParentInfo] -selected parent group info.
+         * @memberof GroupsService
+         */
         "1007": string;
         "1008": string;
         "1009": string;
@@ -37,7 +44,17 @@ export declare class GroupsService {
         "1016": string;
         "1017": string;
         "1018": string;
-        "1020": string;
+        "1019": string;
+        "1020": string; /**
+         * Sets group function type.
+         * @param {GroupFunctionType} groupFunctionType -group function type.
+         * @memberof GroupsService
+         */
+        "1021": string;
+        "1022": string;
+        "1023": string;
+        "1024": string;
+        "1025": string;
         "1026": string;
         "1027": string;
         "1028": string;
@@ -45,6 +62,7 @@ export declare class GroupsService {
         "1030": string;
         "1031": string;
         "1032": string;
+        "2001": string;
         "2002": string;
     };
     apiBaseUrl: string;
@@ -52,6 +70,8 @@ export declare class GroupsService {
     selectedGroupInfo: GroupInfo | undefined;
     groupFunctionType: GroupFunctionType;
     selectedGroupParentInfo: GroupInfo | undefined;
+    openModalNotifier: BehaviorSubject<GroupFunctionType>;
+    groupTypeRoles: CheckboxOption[];
     constructor(httpService: HttpService, alertService: AlertsService);
     setAppConfig(apiBaseUrl: string, userPermission: any): void;
     /**
@@ -168,6 +188,39 @@ export declare class GroupsService {
      * @memberof GroupsService
      */
     getFormattedGroupTypes(groupTypeResponse: GroupTypeConfiguration[]): GroupTypeConfigValue;
+    /**
+     * Returns group user details if email is found, else throws error.
+     * @param {string} email
+     * @return {Observable<SearchUserByEmailResponse>}
+     * @memberof GroupsService
+     */
+    getUserByEmail(email: string): Observable<SearchUserByEmailResponse>;
+    /**
+     * Gets the user details for the selected group
+     * @param {GetUserDetailsPayload} payload
+     * @return {Observable<GroupUserDetailsResponse>}
+     * @memberof GroupsService
+     */
+    getGroupUserDetails(payload: GetUserDetailsPayload): Observable<GroupUserDetailsResponse>;
+    /**
+     * Posts add new user form data to the API for the selected group and returns the success or failure response.
+     * @param {AddNewUserPayload} addNewUserPayload
+     * @return {Observable<GroupUserDetailsResponse>}
+     * @memberof GroupsService
+     */
+    addNewGroupUser(addNewUserPayload: AddNewUserPayload): Observable<GroupUserDetailsResponse>;
+    /**
+     * Sets the loaded group type user roles
+     * @param {CheckboxOption[]} userRoles
+     * @memberof GroupsService
+     */
+    setGroupTypeUserRoles(userRoles: CheckboxOption[]): void;
+    /**
+     * Returns the group type user roles.
+     * @return {CheckboxOption[]}
+     * @memberof GroupsService
+     */
+    getGroupTypeUserRoles(): CheckboxOption[];
     static ɵfac: i0.ɵɵFactoryDeclaration<GroupsService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<GroupsService>;
 }

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@ieeesa-npm/groups",
-  "version": "0.4.7",
+  "version": "0.4.8",
   "peerDependencies": {
     "@angular/common": "^16.1.0",
     "@angular/core": "^16.1.0",
-    "@ieeesa-npm/presentation": "^0.6.5",
-    "@ieeesa-npm/shared-styles": "^0.1.6",
-    "@ieeesa-npm/utility": "^0.5.8"
+    "@ieeesa-npm/presentation": "^0.6.7",
+    "@ieeesa-npm/shared-styles": "^0.1.7",
+    "@ieeesa-npm/utility": "^0.5.9"
   },
   "dependencies": {
     "tslib": "^2.3.0"