@ieeesa-npm/groups 0.1.7 → 0.1.9

package/lib/components/create-group/create-group.component.d.ts

@@ -1,10 +1,12 @@
-import { EventEmitter, OnDestroy, OnInit } from "@angular/core";
-import { FormGroup } from "@angular/forms";
-import { FormGrid, FormModel, SelectOption, AlignType } from "@ieeesa-npm/presentation";
-import { AlertsService, AlertType, GlobalErrorHandlerService } from "@ieeesa-npm/utility";
-import { GroupsService } from "../../services/groups.service";
-import { Subject } from "rxjs";
-import { GroupInfo } from "../../models/group-info.model";
+import { EventEmitter, OnDestroy, OnInit } from '@angular/core';
+import { FormGroup } from '@angular/forms';
+import { FormGrid, FormModel, SelectOption, AlignType, FieldConfig } from '@ieeesa-npm/presentation';
+import { AlertsService, AlertType, GlobalErrorHandlerService } from '@ieeesa-npm/utility';
+import { GroupsService } from '../../services/groups.service';
+import { HttpErrorResponse } from '@angular/common/http';
+import { Subject } from 'rxjs';
+import { GroupInfo } from '../../models/group-info.model';
+import { GroupFunctionType } from '../../models/group-function-type.model';
 import * as i0 from "@angular/core";
 /**
  * CreateGroupComponent uses DynamicFormComponent to build create new group form and implement the functionalities of submission of form and handling success and error scenarios.
@@ -82,6 +84,7 @@ export declare class CreateGroupComponent implements OnInit, OnDestroy {
             groupScope: string;
         };
     };
+    constants: any;
     leftButtonLabel: string;
     rightButtonLabel: string;
     isLegendVisible: boolean;
@@ -91,7 +94,9 @@ export declare class CreateGroupComponent implements OnInit, OnDestroy {
     groupTypes: SelectOption[];
     actionButtonAlign: AlignType;
     form: FormGroup;
-    selectedParentGroupInfo: GroupInfo | undefined;
+    selectedGroupInfo: GroupInfo | undefined;
+    groupFunctionType: GroupFunctionType;
+    selectedGroupParentInfo: GroupInfo | undefined;
     constructor(groupsService: GroupsService, globalErrorHandlerService: GlobalErrorHandlerService, alertService: AlertsService);
     /**
      * Initialize the create group form group array and component.
@@ -99,6 +104,12 @@ export declare class CreateGroupComponent implements OnInit, OnDestroy {
      * @memberof CreateGroupComponent
      */
     ngOnInit(): void;
+    /**
+     * Constructs and returns the group type form field based on edit group or not.
+     * @return {FieldConfig} -group type form field.
+     * @memberof CreateGroupComponent
+     */
+    getGroupTypeField(): FieldConfig;
     /**
      * Initialize the create group form group array.
      * @memberof CreateGroupComponent
@@ -107,16 +118,38 @@ export declare class CreateGroupComponent implements OnInit, OnDestroy {
     /**
      * Update the create sub group form group array.
      * @param {GroupInfo} parentGroupInfo -Parent group info.
+     * @return -returns nothing
      * @memberof CreateGroupComponent
      */
     updateCreateFormGroup(parentGroupInfo: GroupInfo): void;
     /**
-     * Handles client side validation and emits create group information.
+     * Handles client side validation and calls create group or edit group methods.
      * @param {FormGroup[]} form -Array of formGroup
      * @return -returns nothing
      * @memberof CreateGroupComponent
      */
     onFormSubmit(form: FormGroup[]): void;
+    /**
+     * Constructs create group payload and calls create group API and emits create group API response.
+     * @param formData
+     * @return -returns nothing
+     * @memberof CreateGroupComponent
+     */
+    createGroup(formData: any): void;
+    /**
+     * Constructs edit group payload and calls edit group API and emits create group API response.
+     * @param {*} formData
+     * @return -returns nothing
+     * @memberof CreateGroupComponent
+     */
+    editGroup(formData: any): void;
+    /**
+     * Captures the server side errors and handles the errors based on the custom or Http errors.
+     * @param {HttpErrorResponse} error
+     * @return -returns nothing
+     * @memberof CreateGroupComponent
+     */
+    handleErrors(error: HttpErrorResponse): void;
     /**
      * Get form reference.
      * @param {FormGroup[]} form

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

@@ -5,6 +5,7 @@ import { FlatTreeControl } from '@angular/cdk/tree';
 import { BehaviorSubject, Observable, Subject } from 'rxjs';
 import { MatTreeNodePadding } from '@angular/material/tree';
 import { GroupInfo } from '../../models/group-info.model';
+import { EditGroupAndParentInfo } from '../../models/edit-group.model';
 import * as i0 from "@angular/core";
 /**
  * Dynamic Flat node creates a node structure
@@ -138,11 +139,11 @@ export declare class TreeViewComponent implements OnInit, AfterViewInit, OnDestr
     set isGroupSearchOrFilterActive(value: boolean);
     get isGroupSearchOrFilterActive(): boolean;
     private deletedGroupId;
-    set deletedGroupIdInfo(id: string);
+    set deletedGroupIdInfo(id: string | undefined);
     get deletedGroupIdInfo(): string | undefined;
     toggleGroupClick: EventEmitter<GroupInfo>;
     createGroupClick: EventEmitter<GroupInfo>;
-    editGroupClick: EventEmitter<GroupInfo>;
+    editGroupClick: EventEmitter<EditGroupAndParentInfo>;
     deleteGroupClick: EventEmitter<GroupInfo>;
     constructor(database: Groups, elementRef: ElementRef);
     /**
@@ -203,7 +204,7 @@ export declare class TreeViewComponent implements OnInit, AfterViewInit, OnDestr
      * @param {string} deletedGroupId
      * @memberof TreeViewComponent
      */
-    deleteGroupNode(deletedGroupId: string): void;
+    deleteGroupNode(deletedGroupId: string | undefined): void;
     /**
      * Sets the selected menu group action
      * @param {Menu} menu

package/lib/groups.component.d.ts

@@ -1,13 +1,15 @@
+import { HttpErrorResponse } from '@angular/common/http';
 import { OnDestroy, OnInit } from '@angular/core';
 import { MatDialog } from '@angular/material/dialog';
 import { GroupsService } from './services/groups.service';
 import { Subject } from 'rxjs';
 import { GroupInfo } from './models/group-info.model';
 import { SelectOption, Legend, IconButton, AlignType } from '@ieeesa-npm/presentation';
-import { GroupType } from './models/group-types.model';
-import { GlobalErrorHandlerService, BreakpointObserverService, AlertsService } from '@ieeesa-npm/utility';
+import { GroupTypeConfigValue } from './models/group-types.model';
+import { AlertType, GlobalErrorHandlerService, BreakpointObserverService, AlertsService } from '@ieeesa-npm/utility';
 import { GroupFunctionType } from './models/group-function-type.model';
 import { GetGroupsPayload } from './models/view-group.model';
+import { EditGroupAndParentInfo } from './models/edit-group.model';
 import * as i0 from "@angular/core";
 /**
  * Groups component is a wrapper or container component for groups management reusable component and in this component integrates all group management functionalities and this will be entry component for managing groups when it is consumed in other applications.
@@ -23,6 +25,8 @@ export declare class GroupsComponent implements OnInit, OnDestroy {
     dialogRef: any;
     constants: any;
     viewGroupTexts: any;
+    createGroupText: any;
+    editGroupTexts: any;
     isGroupSearchActive: boolean;
     isGroupFilterActive: boolean;
     isGroupSearchOrFilterActive: boolean;
@@ -32,9 +36,7 @@ export declare class GroupsComponent implements OnInit, OnDestroy {
     parentGroupsInfo: GroupInfo[];
     selectGroupOptions: SelectOption[];
     deletedGroupId: string;
-    groupTypes: {
-        [key: string]: GroupType;
-    };
+    groupTypes: GroupTypeConfigValue;
     searchPlaceHolderText: string;
     filterPlaceHolderText: string;
     createGroupIcon: IconButton;
@@ -48,61 +50,6 @@ export declare class GroupsComponent implements OnInit, OnDestroy {
     applicationId: string;
     apiBaseURL: string;
     permissions: any;
-    createGroupText: {
-        heading: string;
-        label: {
-            parentGroup: string;
-            groupType: string;
-            groupName: string;
-            shortName: string;
-            groupScope: string;
-            rightButtonLabel: string;
-            leftButtonLabel: string;
-            ariaLabel: {
-                parentGroup: string;
-                groupType: string;
-                groupName: string;
-                shortName: string;
-                groupScope: string;
-            };
-            ariaDescribedById: {
-                groupType: string;
-                groupName: string;
-                shortName: string;
-                groupScope: string;
-            };
-        };
-        characterLimit: {
-            character500: number;
-            character15: number;
-            character1500: number;
-            character2000: number;
-        };
-        message: {
-            error: {
-                required: string;
-                limit: {
-                    groupName: string;
-                    shortName: string;
-                    groupScope: string;
-                };
-                pattern: {
-                    groupName: string;
-                    shortName: string;
-                    groupScope: string;
-                };
-            };
-            success: {
-                submission: string;
-            };
-        };
-        supportText: {
-            groupType: string;
-            groupName: string;
-            shortName: string;
-            groupScope: string;
-        };
-    };
     functionType: GroupFunctionType;
     alignmentType: typeof AlignType;
     constructor(dialog: MatDialog, groupsService: GroupsService, alertService: AlertsService, breakpointObserverService: BreakpointObserverService, globalErrorHandlerService: GlobalErrorHandlerService);
@@ -113,12 +60,19 @@ export declare class GroupsComponent implements OnInit, OnDestroy {
      */
     ngOnInit(): void;
     /**
-    * Sets the dialog options for create group modal and calls openModal method.
-    * @param {GroupInfo} [parentGroupInfo] -An optional parameter. Parent group info to be passed for create child group.
-    * @return -returns nothing
-    * @memberof GroupsComponent
-    */
+     * Sets the dialog options for create group modal and calls openModal method.
+     * @param {GroupInfo} [parentGroupInfo] -An optional parameter. Parent group info to be passed for create child group.
+     * @return -returns nothing
+     * @memberof GroupsComponent
+     */
     openCreateGroupForm(parentGroupInfo?: GroupInfo): void;
+    /**
+     * Sets the dialog options for edit group modal and calls openModal method.
+     * @param {EditGroupAndParentInfo} editGroupInfo -editing group and its parent group info to be passed for populating edit group form fields.
+     * @return -returns nothing
+     * @memberof GroupsComponent
+     */
+    openEditGroupForm(editGroupInfo: EditGroupAndParentInfo): void;
     /**
      * Opens modal component with for received params and handles form submission success and errors.
      * @param {*} dialogOptions
@@ -187,6 +141,21 @@ export declare class GroupsComponent implements OnInit, OnDestroy {
      * @memberof GroupsComponent
      */
     getGroupTypes(): void;
+    /**
+     * Handles alerts for success, error and warning.
+     * @param {(string | string[])} message -success or error or warning message.
+     * @param {AlertType} alertType
+     * @return -returns nothing
+     * @memberof GroupsComponent
+     */
+    showAlertMessage(alertType: AlertType, message: string | string[]): void;
+    /**
+     * Captures the server side errors and handles it based on the custom or Http errors.
+     * @param {HttpErrorResponse} error
+     * @return -returns nothing
+     * @memberof GroupsComponent
+     */
+    handleErrors(error: HttpErrorResponse): void;
     /**
      * NgOnDestroy performs necessary cleanup tasks, such as unsubscribing from subscription when the component is being destroyed.
      * @memberof GroupsComponent

package/lib/models/edit-group.model.d.ts

@@ -0,0 +1,14 @@
+import { GroupInfo } from './group-info.model';
+export interface EditGroupPayload {
+    payload: {
+        groupName: string;
+        groupShortName: string;
+        groupDesc: string;
+        groupParentId: string | null;
+        groupId: string;
+    };
+}
+export interface EditGroupAndParentInfo {
+    groupInfo: GroupInfo;
+    parentGroupInfo: GroupInfo | undefined;
+}

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

@@ -3,7 +3,9 @@ export interface GroupInfo {
     groupId: string;
     groupName: string;
     groupAcronym: string;
+    groupDesc?: string;
     groupType: string;
+    groupShortName: string;
     groupParentId: string | null;
     hasChildren: boolean;
     groupLevel: number;

package/lib/models/group-types.model.d.ts

@@ -1,23 +1,27 @@
-export interface GroupTypeResponse {
-    status: boolean;
-    message: string;
-    body: {
-        configFieldName: string;
-        configFieldValue: {
-            [key: string]: GroupType;
-        };
-    };
+export interface BusinessRule {
+    allowSubGroup: boolean;
+    allowRoster: boolean;
+    rosterType: string;
+    allowAlternateVoting: boolean;
+    manageRosterInApp: boolean;
+    allowedGroupType: string[];
 }
 export interface GroupType {
     name: string;
     legendColor: string;
     description: string;
-    businessRule: {
-        allowSubGroup: boolean;
-        allowRoster: boolean;
-        rosterType: string;
-        allowAlternateVoting: boolean;
-        manageRosterInApp: boolean;
-        allowedGroupType: string[];
-    };
+    businessRule: BusinessRule;
+}
+export interface GroupTypeConfiguration {
+    configFieldName: string;
+    configFieldId: string;
+    configFieldValue: GroupType;
+}
+export interface GroupTypeResponse {
+    status: boolean;
+    message: string;
+    body: GroupTypeConfiguration[];
+}
+export interface GroupTypeConfigValue {
+    [key: string]: GroupType;
 }

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

@@ -1,10 +1,12 @@
-import { Observable } from "rxjs";
-import { CreateGroupPayload, CreateGroupResponse } from "../models/create-group.model";
-import { GroupTypeResponse } from "../models/group-types.model";
-import { AlertsService, HttpService } from "@ieeesa-npm/utility";
-import { GetGroupResponse, GetGroupsPayload } from "../models/view-group.model";
+import { Observable } 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';
+import { GetGroupResponse, GetGroupsPayload } from '../models/view-group.model';
 import { DeleteGroupPayload } from '../models/delete-group.model';
-import { GroupInfo } from "../models/group-info.model";
+import { GroupInfo } from '../models/group-info.model';
+import { EditGroupPayload } from '../models/edit-group.model';
+import { GroupFunctionType } from '../models/group-function-type.model';
 import * as i0 from "@angular/core";
 /**
  * Groups service is an abstract layer and responsible for managing groups REST API calls.
@@ -36,6 +38,8 @@ export declare class GroupsService {
     apiBaseUrl: string;
     userPermission: any;
     selectedGroupInfo: GroupInfo | undefined;
+    groupFunctionType: GroupFunctionType;
+    selectedGroupParentInfo: GroupInfo | undefined;
     constructor(httpService: HttpService, alertService: AlertsService);
     setAppConfig(apiBaseUrl: string, userPermission: any): void;
     /**
@@ -61,10 +65,17 @@ export declare class GroupsService {
     /**
      * Posts create group form data to server using HttpService for creating new group.
      * @param {CreateGroupPayload} createGroupPayload -create group form data which includes group name, type, short name, scope.
-     * @return {Observable<any>} -returns create group API response (success or error) as an observable.
+     * @return {Observable<CreateGroupResponse>} -returns create group API response (success or error) as an observable.
      * @memberof GroupsService
      */
     createGroup(createGroupPayload: CreateGroupPayload): Observable<CreateGroupResponse>;
+    /**
+     * Updates group form data to server using HttpService.
+     * @param {EditGroupPayload} editGroupPayload -edit group form data which includes group name, short name, scope.
+     * @return {Observable<EditGroupPayload>} -returns edit group API response (success or error) as an observable.
+     * @memberof GroupsService
+     */
+    editGroup(editGroupPayload: EditGroupPayload): Observable<CreateGroupResponse>;
     /**
      * This method will parse the error codes and return the respective error message for each code.
      * @param {string[]} errorCodes
@@ -75,15 +86,41 @@ export declare class GroupsService {
     /**
      * Sets selected group info.
      * @param {(GroupInfo | undefined)} selectedGroupInfo -selected group info.
+     * @param {(GroupInfo | undefined)} [selectedGroupParentInfo] -selected parent group info.
      * @memberof GroupsService
      */
-    setSelectedGroupInfo(selectedGroupInfo: GroupInfo | undefined): void;
+    setSelectedGroupInfo(selectedGroupInfo: GroupInfo | undefined, selectedGroupParentInfo?: GroupInfo | undefined): void;
     /**
      * Returns the selected group info.
      * @return {(GroupInfo | undefined)} -group info.
      * @memberof GroupsService
      */
     getSelectedGroupInfo(): GroupInfo | undefined;
+    /**
+     * Returns the selected group parent group info.
+     * @return {(GroupInfo | undefined)} -group info.
+     * @memberof GroupsService
+     */
+    getSelectedGroupParentInfo(): GroupInfo | undefined;
+    /**
+     * Sets group function type.
+     * @param {GroupFunctionType} groupFunctionType -group function type.
+     * @memberof GroupsService
+     */
+    setGroupFunctionType(groupFunctionType: GroupFunctionType): void;
+    /**
+     * Returns group function type.
+     * @return {GroupFunctionType} -group function type.
+     * @memberof GroupsService
+     */
+    getGroupFunctionType(): GroupFunctionType;
+    /**
+     * Returns formatted group types.
+     * @param {GroupTypeConfiguration[]} groupTypeResponse
+     * @return {GroupTypeConfigValue}
+     * @memberof GroupsService
+     */
+    getFormattedGroupTypes(groupTypeResponse: GroupTypeConfiguration[]): GroupTypeConfigValue;
     static ɵfac: i0.ɵɵFactoryDeclaration<GroupsService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<GroupsService>;
 }

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@ieeesa-npm/groups",
-  "version": "0.1.7",
+  "version": "0.1.9",
   "peerDependencies": {
     "@angular/common": "^16.1.0",
     "@angular/core": "^16.1.0",
-    "@ieeesa-npm/presentation": "^0.4.2",
-    "@ieeesa-npm/shared-styles": "^0.0.9",
-    "@ieeesa-npm/utility": "^0.3.3"
+    "@ieeesa-npm/presentation": "^0.4.3",
+    "@ieeesa-npm/shared-styles": "^0.1.0",
+    "@ieeesa-npm/utility": "^0.3.4"
   },
   "dependencies": {
     "tslib": "^2.3.0"

package/public-api.d.ts

@@ -7,6 +7,9 @@ export * from './lib/models/group-function-type.model';
 export * from './lib/models/group-info.model';
 export * from './lib/models/group-types.model';
 export * from './lib/models/view-group.model';
+export * from './lib/models/edit-group.model';
+export * from './lib/models/form-status.model';
+export * from './lib/models/delete-group.model';
 export * from './lib/services/groups.service';
 export * from './lib/assets/form-validations';
 export * from './lib/groups.module';