@ieeesa-npm/groups 0.15.3 → 0.15.4

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

@@ -2,7 +2,7 @@ import { AfterViewInit, ChangeDetectorRef, OnDestroy, OnInit } from '@angular/co
 import { Subject } from 'rxjs';
 import { Sort } from '@angular/material/sort';
 import { MatDialog } from '@angular/material/dialog';
-import { TableColumnSchema, TableActions, AlignType, ChipOption, CheckboxOption, FiltersAndOptions } from '@ieeesa-npm/presentation';
+import { TableColumnSchema, TableActions, AlignType, ChipOption, CheckboxOption, FiltersAndOptions, ExportFormat } from '@ieeesa-npm/presentation';
 import { AlertsService, GlobalErrorHandlerService } from '@ieeesa-npm/utility';
 import { AlertType } from '@ieeesa-npm/models';
 import { GroupsService } from '../../services/groups.service';
@@ -10,6 +10,7 @@ import { User, LoggedInUserInfo } from '../../models/user.model';
 import { GroupUserInfo } from '../../models/group-user-info.model';
 import { GroupRosterType } from '../../models/roster-type.model';
 import { FilterType } from '../../models/filter-type.model';
+import { RosterExportService } from '../../services/roster-export.service';
 import * as i0 from "@angular/core";
 /**
  * ViewRosterComponent implements the functionalities to add, edit, delete user to group roster, assign and modify roles(s) to the group users, and search user from roster.
@@ -23,6 +24,7 @@ export declare class ViewRosterComponent implements AfterViewInit, OnDestroy, On
     private alertService;
     private cdr;
     private globalErrorHandlerService;
+    rosterExportService: RosterExportService;
     destroy$: Subject<boolean>;
     constants: any;
     viewRosterConstants: any;
@@ -53,7 +55,7 @@ export declare class ViewRosterComponent implements AfterViewInit, OnDestroy, On
     tableColumnsForSystemUsers: any;
     emptyFieldValueReplacedBy: any;
     userInfo: LoggedInUserInfo;
-    constructor(dialog: MatDialog, groupService: GroupsService, alertService: AlertsService, cdr: ChangeDetectorRef, globalErrorHandlerService: GlobalErrorHandlerService);
+    constructor(dialog: MatDialog, groupService: GroupsService, alertService: AlertsService, cdr: ChangeDetectorRef, globalErrorHandlerService: GlobalErrorHandlerService, rosterExportService: RosterExportService);
     ngOnInit(): void;
     /**
      * Show add new user success message when canShowMessage is set true
@@ -159,6 +161,18 @@ export declare class ViewRosterComponent implements AfterViewInit, OnDestroy, On
      * @memberof ViewRosterComponent
      */
     showAlertMessage(message: string | string[], alertType: AlertType): void;
+    /**
+     * Toggles the export format popover — delegates to RosterExportService.
+     * @memberof ViewRosterComponent
+     */
+    onExportClick(): void;
+    /**
+     * Handles export format selection — delegates to RosterExportService using the
+     * currently selected group's id and name.
+     * @param {ExportFormat} format
+     * @memberof ViewRosterComponent
+     */
+    onExportFormatSelected(format: ExportFormat): void;
     /**
      * NgOnDestroy performs necessary cleanup tasks, such as unsubscribing from subscription when the component is being destroyed.
      * @memberof ViewRosterComponent

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

@@ -46,14 +46,6 @@ export declare class GroupsService {
         "1006": string;
         "1007": string;
         "1008": string;
-        /**
-         * Handles custom API errors: maps BE error codes to messages and shows an
-         * alert. Mirrors the events-and-meetings error handling so reciprocal-credit
-         * failures (e.g. MTG-011 duplicate, MTG-012 permission) surface consistently.
-         * @param {*} error the HttpErrorResponse from a failed call
-         * @param {boolean} [showAlert=true] whether to display the alert
-         * @memberof GroupsService
-         */
         "1009": string;
         "1010": string;
         "1011": string;
@@ -86,11 +78,7 @@ export declare class GroupsService {
         "1038": string;
         "1039": string;
         "2001": string;
-        "2002": string; /**
-         * Sets group function type.
-         * @param {GroupFunctionType} groupFunctionType -group function type.
-         * @memberof GroupsService
-         */
+        "2002": string;
         "2010": string;
         "2011": string;
         "20l2": string;

package/lib/services/roster-export.service.d.ts

@@ -0,0 +1,171 @@
+import { HttpClient } from '@angular/common/http';
+import { MatDialog } from '@angular/material/dialog';
+import { ExportFormat, ExportFormatOption } from '@ieeesa-npm/presentation';
+import { AlertsService } from '@ieeesa-npm/utility';
+import * as i0 from "@angular/core";
+/**
+ * RosterExportService owns the complete group roster export flow:
+ * 1. Manages export popover open/close state
+ * 2. Opens IEEE Data Access and Use Policy confirmation dialog
+ * 3. Calls the backend roster export API (blob response)
+ * 4. Triggers file download via File System Access API / file-saver
+ * 5. Shows success/error dialogs and toasts
+ *
+ * The component only needs to:
+ * - Subscribe to `isPopoverOpen$` for popover visibility
+ * - Call `togglePopover()` on Export button click
+ * - Call `onFormatSelected(format, groupId, groupName)` when user picks a format
+ *
+ * Follows the same pattern as MeetingExportService in the events-and-meetings library.
+ * @export
+ * @class RosterExportService
+ */
+export declare class RosterExportService {
+    private httpClient;
+    private dialog;
+    private alertService;
+    private constants;
+    private apiBaseUrl;
+    private destroy$;
+    /** Controls popover open/close state */
+    private isPopoverOpenSubject$;
+    isPopoverOpen$: import("rxjs").Observable<boolean>;
+    /** Controls in-progress state for button disable */
+    private isExportInProgressSubject$;
+    isExportInProgress$: import("rxjs").Observable<boolean>;
+    /** Format options for the export popover */
+    exportFormatOptions: ExportFormatOption[];
+    /** Subtitle labels for the format selection cards */
+    exportFormatSubtitles: Record<string, string>;
+    /** Popover title */
+    popoverTitle: any;
+    constructor(httpClient: HttpClient, dialog: MatDialog, alertService: AlertsService);
+    /**
+     * Sets the API base URL for roster export calls.
+     * @param {string} url - Base URL (e.g., 'https://saappsapidev.ieee.org/v1')
+     * @memberof RosterExportService
+     */
+    setApiBaseUrl(url: string): void;
+    /**
+     * Toggles the export format popover open/closed.
+     * Called by the component on Export button click.
+     * @memberof RosterExportService
+     */
+    togglePopover(): void;
+    /**
+     * Closes the export format popover.
+     * @memberof RosterExportService
+     */
+    closePopover(): void;
+    /**
+     * Handles format selection from the export popover.
+     * Closes popover, opens IEEE Policy dialog, on confirm triggers export.
+     * This is the main entry point called by the component after user picks a format.
+     * @param {ExportFormat} format - Selected format (CSV or XLS)
+     * @param {string} groupId - The group ID to export the roster for
+     * @param {string} groupName - The group name for filename generation
+     * @memberof RosterExportService
+     */
+    onFormatSelected(format: ExportFormat, groupId: string, groupName: string): void;
+    /**
+     * Starts the export after the user confirms the policy dialog.
+     *
+     * When the File System Access API is available, the native Save picker is opened
+     * HERE — synchronously within the confirm handler — while the user activation from
+     * the confirm click is still valid. (Opening it later, inside the async HTTP
+     * response callback, would exceed the activation window and the browser would
+     * reject it with a SecurityError.) The obtained file handle is then passed to the
+     * HTTP flow, which writes the downloaded bytes to it once the response arrives, so
+     * the success dialog is still shown only AFTER the file is saved.
+     *
+     * If the user cancels the picker we abort before making the request. If the API is
+     * unavailable (Firefox/Safari) we proceed without a handle and fall back to
+     * `saveAs()` after the response.
+     * @param {ExportFormat} format
+     * @param {string} groupId
+     * @param {string} groupName
+     * @memberof RosterExportService
+     */
+    private startExport;
+    /**
+     * Executes the roster export API call and writes the downloaded file.
+     * Endpoint: GET /v1/groups/roster/export/{groupId}?format=csv|xlsx
+     * When a pre-obtained file handle is provided (from the picker opened at confirm
+     * time) the bytes are written to it; otherwise it falls back to `saveAs()`.
+     * The success dialog is shown only after the file has been written.
+     * @param {ExportFormat} format - The selected export format
+     * @param {string} groupId - The group identifier
+     * @param {string} groupName - The group name for filename
+     * @param {FileSystemFileHandle | null} fileHandle - Handle from the Save picker, or null
+     * @memberof RosterExportService
+     */
+    private executeExport;
+    /**
+     * Shows the export success dialog after a successful file download.
+     * @param {string} filename - The downloaded filename
+     * @memberof RosterExportService
+     */
+    private showExportSuccessDialogAfterDownload;
+    /**
+     * Returns the API base URL for roster export.
+     * @return {string}
+     * @memberof RosterExportService
+     */
+    private getExportApiUrl;
+    /**
+     * Extracts filename from Content-Disposition header.
+     * Falls back to buildFilename() if header is missing.
+     * @param {HttpResponse<Blob>} response
+     * @param {ExportFormat} format
+     * @param {string} groupName
+     * @return {string}
+     * @memberof RosterExportService
+     */
+    private extractFilenameFromResponse;
+    /**
+     * Builds a sanitized filename for the roster export.
+     * Pattern: {SanitizedGroupName}_Roster.{extension}
+     * @param {string} groupName
+     * @param {ExportFormat} format
+     * @return {string}
+     * @memberof RosterExportService
+     */
+    buildFilename(groupName: string, format: ExportFormat): string;
+    /**
+     * Sanitizes the group name for use in a filename.
+     * Replaces non-alphanumeric characters (except hyphen/underscore) with underscore,
+     * collapses consecutive underscores, and truncates to 200 chars.
+     * @param {string} groupName
+     * @return {string}
+     * @memberof RosterExportService
+     */
+    sanitizeGroupName(groupName: string): string;
+    /**
+     * Writes the downloaded bytes to disk and resolves ONLY when the save has actually
+     * completed.
+     *
+     * The Save picker is opened earlier (at policy-confirm time, while user activation
+     * is still valid — see {@link startExport}); this method only writes to the handle
+     * it produced. That keeps the "success dialog after save" ordering without hitting
+     * the SecurityError that occurs when the picker is opened from this async callback.
+     *
+     * When no handle is provided (File System Access API unavailable, or the picker
+     * errored), we fall back to FileSaver's `saveAs()`, which resolves immediately.
+     * @param {Blob} blob - The file contents
+     * @param {string} filename - The suggested filename (used by the saveAs fallback)
+     * @param {ExportFormat} format - The selected export format (drives MIME type)
+     * @param {FileSystemFileHandle | null} fileHandle - Handle from the Save picker, or null
+     * @return {Promise<{ saved: boolean }>} Resolves with `saved: true` once written.
+     * @memberof RosterExportService
+     */
+    downloadFile(blob: Blob, filename: string, format: ExportFormat, fileHandle: any): Promise<{
+        saved: boolean;
+    }>;
+    /**
+     * Cleanup — call from the component's ngOnDestroy.
+     * @memberof RosterExportService
+     */
+    destroy(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<RosterExportService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<RosterExportService>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ieeesa-npm/groups",
-  "version": "0.15.3",
+  "version": "0.15.4",
   "peerDependencies": {
     "@angular/common": "^16.1.0",
     "@angular/core": "^16.1.0"

package/public-api.d.ts

@@ -24,5 +24,6 @@ export * from './lib/models/table-column-schema-user-group.model';
 export * from './lib/models/parent-groups-info.model';
 export * from './lib/models/reciprocal-credit.model';
 export * from './lib/services/groups.service';
+export * from './lib/services/roster-export.service';
 export * from './lib/assets/form-validations';
 export * from './lib/groups.module';