@ieeesa-npm/groups 0.0.1 → 0.0.4

package/lib/groups.component.d.ts

@@ -1,9 +1,13 @@
-import { OnDestroy, OnInit } from "@angular/core";
-import { MatDialog } from "@angular/material/dialog";
-import { GroupsService } from "./services/groups.service";
-import { AlertsService } from "@ieeesa-npm/utility";
-import { Subject } from "rxjs";
-import { GroupFunctionType } from "./models/group-function-type.model";
+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 { AlertsService, GlobalErrorHandlerService, BreakpointObserverService } from '@ieeesa-npm/utility';
+import { GroupFunctionType } from './models/group-function-type.model';
+import { GetGroupsPayload } from './models/view-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.
@@ -13,8 +17,36 @@ export declare class GroupsComponent implements OnInit, OnDestroy {
     dialog: MatDialog;
     private groupsService;
     alertService: AlertsService;
+    private breakpointObserverService;
+    private globalErrorHandlerService;
     destroy$: Subject<boolean>;
     dialogRef: any;
+    constants: any;
+    viewGroupTexts: any;
+    isGroupSearchActive: boolean;
+    isGroupFilterActive: boolean;
+    isGroupSearchOrFilterActive: boolean;
+    isMobileView: boolean;
+    childGroupsInfo: GroupInfo[];
+    addGroupInfo: GroupInfo[];
+    isGroupAdded: boolean;
+    selectedGroupType: SelectOption;
+    parentGroupsInfo: GroupInfo[];
+    selectGroupOptions: SelectOption[];
+    deletedGroupId: string;
+    groupTypes: {
+        [key: string]: GroupType;
+    };
+    searchPlaceHolderText: string;
+    filterPlaceHolderText: string;
+    createGroupIcon: IconButton;
+    filterGroupIcon: IconButton;
+    groupsLegends: Legend[];
+    getGroupsPayload: GetGroupsPayload[];
+    groupsPageInfo: {
+        groupsTitle: string;
+        groupsDescription: string;
+    };
     applicationId: string;
     apiBaseURL: string;
     permissions: any;
@@ -56,13 +88,13 @@ export declare class GroupsComponent implements OnInit, OnDestroy {
                 };
                 pattern: {
                     groupName: string;
+                    /**
+                     * 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.
+                     * @class GroupsComponent
+                     */
                     shortName: string;
                     groupScope: string;
                 };
-                unique: {
-                    "1001": string;
-                    "1002": string;
-                };
             };
             success: {
                 submission: string;
@@ -76,7 +108,8 @@ export declare class GroupsComponent implements OnInit, OnDestroy {
         };
     };
     functionType: GroupFunctionType;
-    constructor(dialog: MatDialog, groupsService: GroupsService, alertService: AlertsService);
+    alignmentType: typeof AlignType;
+    constructor(dialog: MatDialog, groupsService: GroupsService, alertService: AlertsService, breakpointObserverService: BreakpointObserverService, globalErrorHandlerService: GlobalErrorHandlerService);
     /**
      * Initialize the groups component.
      * @return -returns nothing
@@ -97,11 +130,71 @@ export declare class GroupsComponent implements OnInit, OnDestroy {
      * @memberof GroupsComponent
      */
     openModal(dialogOptions: any, className?: string): void;
+    /**
+     * This method invokes the delete modal, and asks user for confirmation to delete the group.
+     * @memberof GroupComponent
+     */
+    openDeleteConfirmationModal(groupInfo: GroupInfo): void;
+    /**
+     * This method sends API Request to delete the selected group and handles the success and error response of the http request.
+     * @memberof GroupComponent
+     */
+    deleteGroup(groupInfo: GroupInfo): void;
+    /**
+     * Shows the search field on click of search icon in case of mobile view
+     * @memberof GroupsComponent
+     */
+    onGroupSearch(): void;
+    /**
+     * Shows the Filter by dropdown options on click of filter icon in case of mobile view
+     * @memberof GroupsComponent
+     */
+    showGroupFilter(): void;
+    /**
+     * Sets isGroupSearchOrFilterActive to true and loads the groups those are configured with selected group type.
+     * @param {string} searchTerm
+     * @memberof GroupsComponent
+     */
+    onGroupSearchClick(searchTerm: string): void;
+    /**
+     * Sets select group type options from groupTypes response
+     * @return {*}  {SelectOption[]}
+     * @memberof GroupsComponent
+     */
+    getGroupTypeOptions(): SelectOption[];
+    /**
+     * Sets legend color from groupTypes response
+     * @memberof GroupsComponent
+     */
+    legendColor(): void;
+    /**
+     * Sets the isGroupSearchOrFilterActive flag and loads parent group info as per selected filter option.
+     * @param {SelectOption} event
+     * @memberof GroupsComponent
+     */
+    onGroupTypeFiltered(event: SelectOption): void;
+    /**
+     * Loads all the parent groups information.
+     * @memberof GroupsComponent
+     */
+    getGroups(group?: GroupInfo): void;
+    /**
+     * Sets groupType info with group response from groupType response
+     * @param {GroupInfo[]} response
+     * @return {*}  {GroupInfo[]}
+     * @memberof GroupsComponent
+     */
+    viewGroupResponse(response: GroupInfo[]): GroupInfo[];
+    /**
+     * Loads the group types.
+     * @memberof GroupsComponent
+     */
+    getGroupTypes(): void;
     /**
      * NgOnDestroy performs necessary cleanup tasks, such as unsubscribing from subscription when the component is being destroyed.
      * @memberof GroupsComponent
      */
     ngOnDestroy(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<GroupsComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<GroupsComponent, "ieeesa-groups", never, { "applicationId": { "alias": "applicationId"; "required": false; }; "apiBaseURL": { "alias": "apiBaseURL"; "required": false; }; "permissions": { "alias": "permissions"; "required": false; }; }, {}, never, never, true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<GroupsComponent, "ieeesa-groups", never, { "groupsPageInfo": { "alias": "groupsPageInfo"; "required": false; }; "applicationId": { "alias": "applicationId"; "required": false; }; "apiBaseURL": { "alias": "apiBaseURL"; "required": false; }; "permissions": { "alias": "permissions"; "required": false; }; }, {}, never, never, true, never>;
 }

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

@@ -0,0 +1,5 @@
+export interface DeleteGroupPayload {
+    payload: {
+        groupId: string;
+    };
+}

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

@@ -0,0 +1,8 @@
+export declare enum GroupAction {
+    VIEW_ROSTER = 1,
+    CREATE_SUB_GROUP = 2,
+    EDIT_GROUP = 3,
+    DELETE_GROUP = 4,
+    EXPAND_GROUP_VIEW = 5,
+    COLLAPSE_GROUP_VIEW = 6
+}

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

@@ -0,0 +1,12 @@
+import { GroupType } from './group-types.model';
+export interface GroupInfo {
+    groupId: string;
+    groupName: string;
+    groupAcronym: string;
+    groupType: string;
+    groupParentId: string | null;
+    hasChildren: boolean;
+    groupLevel: number;
+    groupTypeInfo?: GroupType;
+    children?: GroupInfo[];
+}

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

@@ -0,0 +1,9 @@
+import { GroupInfo } from "./group-info.model";
+export interface GetGroupsPayload {
+    [key: string]: string;
+}
+export interface GetGroupResponse {
+    status: boolean;
+    message: string;
+    body: GroupInfo[];
+}

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

@@ -1,18 +1,29 @@
-import { CreateGroupPayload, CreateGroupResponse } from "../models/create-group.model";
-import { HttpService } from "@ieeesa-npm/utility";
-import { Observable } from "rxjs";
-import { GroupTypeResponse } from "../models/group-types.model";
+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 } from '../models/view-group.model';
+import { DeleteGroupPayload } from '../models/delete-group.model';
 import * as i0 from "@angular/core";
 /**
  * Groups service is an abstract layer and responsible for managing groups REST API calls.
  * @class GroupsService
- * @implements {OnDestroy}
  */
 export declare class GroupsService {
     private httpService;
+    alertService: AlertsService;
+    groupsText: {
+        "1001": string;
+        "1002": string;
+        "1010": string;
+        "1011": string;
+        "1012": string;
+        "1009": string;
+        "1008": string;
+    };
     apiBaseUrl: string;
     userPermission: any;
-    constructor(httpService: HttpService);
+    constructor(httpService: HttpService, alertService: AlertsService);
     setAppConfig(apiBaseUrl: string, userPermission: any): void;
     /**
      * Gets application group types from API and returns it as an observable.
@@ -20,6 +31,20 @@ export declare class GroupsService {
      * @memberof GroupsService
      */
     getGroupTypes(): Observable<GroupTypeResponse>;
+    /**
+     * Returns all the groups based on passed group Id and group type.
+     * @param {GetGroupsPayload} getGroupsPayload
+     * @return {Observable<GetGroupResponse>}
+     * @memberof GroupsService
+     */
+    getAllGroups(getGroupsPayload: any): Observable<GetGroupResponse>;
+    /**
+     * Deletes a group based on the provided information
+     * @param {groupId} string -groupId of the group which is to be deleted
+     * @return {*}  {Observable<any>} -Observable representing the group deletion response
+     * @memberof GroupsService
+     */
+    deleteGroup(deleteGroupPayload: DeleteGroupPayload): Observable<any>;
     /**
      * 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.
@@ -27,6 +52,13 @@ export declare class GroupsService {
      * @memberof GroupsService
      */
     createGroup(createGroupPayload: CreateGroupPayload): Observable<CreateGroupResponse>;
+    /**
+     * This method will parse the error codes and return the respective error message for each code.
+     * @param {string[]} errorCodes
+     * @return {string[]} errorMessage
+     * @memberof GroupsService
+     */
+    parseErrorMessage(errorCodes: string[]): string[];
     static ɵfac: i0.ɵɵFactoryDeclaration<GroupsService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<GroupsService>;
 }

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@ieeesa-npm/groups",
-  "version": "0.0.1",
+  "version": "0.0.4",
   "peerDependencies": {
     "@angular/common": "^16.1.0",
     "@angular/core": "^16.1.0",
-    "@ieeesa-npm/presentation": "^0.2.4",
-    "@ieeesa-npm/shared-styles": "^0.0.4",
-    "@ieeesa-npm/utility": "^0.2.1"
+    "@ieeesa-npm/presentation": "^0.3.3",
+    "@ieeesa-npm/shared-styles": "^0.0.5",
+    "@ieeesa-npm/utility": "^0.2.5"
   },
   "dependencies": {
     "tslib": "^2.3.0"

package/public-api.d.ts

@@ -1,8 +1,12 @@
-export * from "./lib/components/create-group/create-group.component";
-export * from "./lib/groups.component";
-export * from "./lib/services/groups.service";
-export * from "./lib/models/create-group.model";
-export * from "./lib/models/group-types.model";
-export * from "./lib/models/group-function-type.model";
-export * from "./lib/assets/form-validations";
-export * from "./lib/groups.module";
+export * from './lib/components/create-group/create-group.component';
+export * from './lib/components/tree-view/tree-view.component';
+export * from './lib/groups.component';
+export * from './lib/models/create-group.model';
+export * from './lib/models/group-action.model';
+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/services/groups.service';
+export * from './lib/assets/form-validations';
+export * from './lib/groups.module';