@yuuvis/client-core 2.2.0 → 2.3.1

package/fesm2022/yuuvis-client-core.mjs

@@ -3,15 +3,16 @@ import { TranslateService, TranslateLoader, MissingTranslationHandler, Translate
 export { TranslateDirective, TranslateLoader, TranslateModule, TranslatePipe, TranslateService } from '@ngx-translate/core';
 import { HttpErrorResponse, HttpClient, HttpHeaders, HttpParams, HttpRequest, HttpResponse, HttpEventType, provideHttpClient, withInterceptors } from '@angular/common/http';
 import * as i0 from '@angular/core';
-import { inject, Injectable, InjectionToken, Inject, Pipe, importProvidersFrom, provideAppInitializer } from '@angular/core';
+import { inject, Injectable, InjectionToken, Inject, Directive, Pipe, importProvidersFrom, provideAppInitializer } from '@angular/core';
 import { tap, finalize, shareReplay, catchError, map, switchMap, first, filter, scan, delay } from 'rxjs/operators';
-import { EMPTY, of, forkJoin, Observable, ReplaySubject, Subject, BehaviorSubject, tap as tap$1, map as map$1, merge, fromEvent, filter as filter$1, debounceTime, throwError, switchMap as switchMap$1 } from 'rxjs';
+import { EMPTY, of, forkJoin, Observable, ReplaySubject, Subject, BehaviorSubject, tap as tap$1, map as map$1, merge, fromEvent, filter as filter$1, debounceTime, throwError, isObservable, switchMap as switchMap$1 } from 'rxjs';
 import { StorageMap } from '@ngx-pwa/local-storage';
 import { __decorate, __param, __metadata } from 'tslib';
 import { coerceBooleanProperty } from '@angular/cdk/coercion';
-import { toSignal } from '@angular/core/rxjs-interop';
+import { toSignal, takeUntilDestroyed } from '@angular/core/rxjs-interop';
 import { DeviceDetectorService } from 'ngx-device-detector';
 import { DOCUMENT, DecimalPipe, PercentPipe, CurrencyPipe, registerLocaleData } from '@angular/common';
+import { MatTabGroup } from '@angular/material/tabs';
 import { FormGroup, FormControl } from '@angular/forms';
 import * as i1$1 from '@angular/platform-browser';
 import localeAr from '@angular/common/locales/ar';
@@ -4477,6 +4478,185 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.14", ngImpo
                 }]
         }], ctorParameters: () => [{ type: PendingChangesService }] });
 
+/**
+ * Service that provides guards for Material Dialog close operations.
+ *
+ * This service allows you to intercept and control dialog close events,
+ * enabling confirmation dialogs or preventing accidental closure when
+ * there are unsaved changes or pending operations.
+ *
+ * @example
+ * ```typescript
+ * readonly #dialogCloseGuard = inject(DialogCloseGuard);
+ *
+ * openDialog() {
+ *   const dialogRef = this.dialog.open(MyComponent);
+ *
+ *   // Prevent dialog from closing if there are unsaved changes
+ *   this.#dialogCloseGuard.dialogCanClose(dialogRef, () => {
+ *     return this.hasUnsavedChanges() ? this.confirmClose() : true;
+ *   }).subscribe();
+ * }
+ * ```
+ */
+class DialogCloseGuard {
+    #pendingChangesService = inject(PendingChangesService);
+    /**
+     * Converts a synchronous or asynchronous check function result to an Observable.
+     *
+     * This private method normalizes the return value of check functions,
+     * ensuring they are always handled as Observables for consistent processing.
+     *
+     * @private
+     * @param checkFunction - Function that returns either a boolean or Observable<boolean>
+     * @returns Observable<boolean> - Always returns an Observable, regardless of input type
+     */
+    #canClose(checkFunction) {
+        const result = checkFunction();
+        return isObservable(result) ? result : of(result);
+    }
+    /**
+     * Guards against dialog closure when the backdrop is clicked.
+     *
+     * This method disables the default close behavior and only allows the dialog
+     * to close when the provided check function returns true. The check is triggered
+     * specifically when the user clicks on the dialog backdrop.
+     *
+     * @param dialogRef - Reference to the Material Dialog instance
+     * @param checkFunction - Function that determines if the dialog can be closed.
+     *                        Can return a boolean directly or an Observable<boolean>
+     * @returns Observable<boolean> - Emits true when the dialog can be closed via backdrop click
+     *
+     * @example
+     * ```typescript
+     * this.dialogCloseGuard.checkBackdropCanClose(dialogRef, () => {
+     *   return this.formIsDirty ? this.showConfirmDialog() : true;
+     * }).subscribe(canClose => {
+     *   if (canClose) {
+     *     dialogRef.close();
+     *   }
+     * });
+     * ```
+     */
+    checkBackdropCanClose(dialogRef, checkFunction) {
+        dialogRef.disableClose = true;
+        return dialogRef.backdropClick().pipe(switchMap$1(() => this.#canClose(checkFunction)));
+    }
+    /**
+     * Guards against dialog closure when the Escape key is pressed.
+     *
+     * This method disables the default close behavior and only allows the dialog
+     * to close when the provided check function returns true. The check is triggered
+     * specifically when the user presses the Escape key.
+     *
+     * @param dialogRef - Reference to the Material Dialog instance
+     * @param checkFunction - Function that determines if the dialog can be closed.
+     *                        Can return a boolean directly or an Observable<boolean>
+     * @returns Observable<boolean> - Emits true when the dialog can be closed via Escape key
+     *
+     * @example
+     * ```typescript
+     * this.dialogCloseGuard.checkKeydownEventsCanClose(dialogRef, () => {
+     *   return this.hasUnsavedChanges ? this.confirmDiscardChanges() : true;
+     * }).subscribe(canClose => {
+     *   if (canClose) {
+     *     dialogRef.close();
+     *   }
+     * });
+     * ```
+     */
+    checkKeydownEventsCanClose(dialogRef, checkFunction) {
+        dialogRef.disableClose = true;
+        return dialogRef.keydownEvents().pipe(filter$1((event) => event.key === 'Escape'), switchMap$1(() => this.#canClose(checkFunction)));
+    }
+    /**
+     * Comprehensive dialog close guard that handles both backdrop clicks and Escape key presses.
+     *
+     * This method provides a unified approach to guard dialog closure by monitoring both
+     * backdrop clicks and Escape key events. When either event occurs, it runs the provided
+     * check function and automatically closes the dialog if the check passes.
+     *
+     * This is the most convenient method when you want to guard against all common
+     * dialog close scenarios with a single setup.
+     *
+     * @template T - The type of data that the dialog returns
+     * @param dialogRef - Reference to the Material Dialog instance
+     * @param checkFunction - Function that determines if the dialog can be closed.
+     *                        Can return a boolean directly or an Observable<boolean>
+     * @returns Observable<false | void> - Emits false if the dialog cannot be closed,
+     *                                    or void when the dialog is successfully closed
+     *
+     * @example
+     * ```typescript
+     * // Simple boolean check
+     * this.dialogCloseGuard.dialogCanClose(dialogRef, () => !this.hasUnsavedChanges).subscribe();
+     *
+     * // Async check with confirmation dialog
+     * this.dialogCloseGuard.dialogCanClose(dialogRef, () => {
+     *   return this.hasUnsavedChanges
+     *     ? this.confirmationService.confirm('Discard changes?')
+     *     : of(true);
+     * }).subscribe();
+     * ```
+     */
+    preventCloseUntil(dialogRef, checkFunction) {
+        dialogRef.disableClose = true;
+        return merge(dialogRef.backdropClick(), dialogRef.keydownEvents().pipe(filter$1((event) => event.key === 'Escape'))).pipe(switchMap$1(() => this.#canClose(checkFunction)), map$1((canClose) => canClose && dialogRef.close()));
+    }
+    /**
+     * Specialized dialog close guard that automatically checks for pending changes.
+     *
+     * This convenience method provides automatic pending changes detection without
+     * requiring a custom check function. It integrates with the PendingChangesService
+     * to determine if there are any unsaved changes, and handles both backdrop clicks
+     * and Escape key presses automatically.
+     *
+     * This method is ideal when you want to prevent dialog closure if there are
+     * pending changes anywhere in the application, without having to implement
+     * custom change detection logic.
+     *
+     * @template T - The type of data that the dialog returns
+     * @param dialogRef - Reference to the Material Dialog instance
+     * @returns Observable<false | void> - Emits false if there are pending changes
+     *                                    preventing closure, or void when the dialog
+     *                                    is successfully closed
+     *
+     */
+    pendingChangesDialogCanClose(dialogRef) {
+        dialogRef.disableClose = true;
+        return merge(dialogRef.backdropClick(), dialogRef.keydownEvents().pipe(filter$1((event) => event.key === 'Escape'))).pipe(switchMap$1(() => of(this.#pendingChangesService.check())), map$1((canClose) => !canClose && dialogRef.close()));
+    }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "19.2.14", ngImport: i0, type: DialogCloseGuard, deps: [], target: i0.ɵɵFactoryTarget.Injectable }); }
+    static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "19.2.14", ngImport: i0, type: DialogCloseGuard }); }
+}
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.14", ngImport: i0, type: DialogCloseGuard, decorators: [{
+            type: Injectable
+        }] });
+
+class TabGuardDirective {
+    #tabGroup = inject(MatTabGroup);
+    #pending = inject(PendingChangesService);
+    constructor() {
+        this.#tabGroup.selectedIndexChange.pipe(takeUntilDestroyed()).subscribe(() => this.#updateTabs());
+    }
+    ngDoCheck() {
+        this.#updateTabs();
+    }
+    #updateTabs() {
+        const activeIndex = this.#tabGroup.selectedIndex ?? 0;
+        const hasPending = this.#pending.hasPendingTask();
+        this.#tabGroup._tabs.forEach((tab, i) => (tab.disabled = hasPending && i !== activeIndex));
+    }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "19.2.14", ngImport: i0, type: TabGuardDirective, deps: [], target: i0.ɵɵFactoryTarget.Directive }); }
+    static { this.ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "14.0.0", version: "19.2.14", type: TabGuardDirective, isStandalone: true, selector: "mat-tab-group[yuvTabGuardDisable]", ngImport: i0 }); }
+}
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.14", ngImport: i0, type: TabGuardDirective, decorators: [{
+            type: Directive,
+            args: [{
+                    selector: 'mat-tab-group[yuvTabGuardDisable]'
+                }]
+        }], ctorParameters: () => [] });
+
 class PredictionService {
     #backend = inject(BackendService);
     classify(objectIDs, schemaObjectTypeId = 'CLASSIFICATION') {
@@ -5245,5 +5425,5 @@ const provideYuvClientCore = (options = { translations: [] }) => {
  * Generated bundle index. Do not edit.
  */
 
-export { AFO_STATE, AdministrationRoles, ApiBase, AppCacheService, AuditField, AuditService, AuthService, BackendService, BaseObjectTypeField, BpmService, CORE_CONFIG, CUSTOM_CONFIG, CatalogService, Classification, ClassificationPrefix, ClientDefaultsObjectTypeField, ClipboardService, ColumnConfigSkipFields, ConfigService, ConnectionService, ContentStreamAllowed, ContentStreamField, CoreConfig, DeviceScreenOrientation, DeviceService, Direction, DmsObject, DmsService, EventService, FileSizePipe, IdmService, InternalFieldType, KeysPipe, LocaleCurrencyPipe, LocaleDatePipe, LocaleDecimalPipe, LocaleNumberPipe, LocalePercentPipe, Logger, LoginStateName, NativeNotificationService, NotificationService, ObjectConfigService, ObjectFormControl, ObjectFormControlWrapper, ObjectFormGroup, ObjectTag, ObjectTypeClassification, ObjectTypePropertyClassification, Operator, OperatorLabel, ParentField, PendingChangesGuard, PendingChangesService, PredictionService, ProcessAction, RelationshipTypeField, RetentionField, RetentionService, SafeHtmlPipe, SafeUrlPipe, SearchService, SearchUtils, SecondaryObjectTypeClassification, SessionStorageService, Situation, Sort, SystemResult, SystemSOT, SystemService, SystemType, TENANT_HEADER, ToastService, UploadService, UserRoles, UserService, UserStorageService, Utils, YUV_USER, YuvError, YuvEventType, YuvUser, init_moduleFnc, provideUser, provideYuvClientCore };
+export { AFO_STATE, AdministrationRoles, ApiBase, AppCacheService, AuditField, AuditService, AuthService, BackendService, BaseObjectTypeField, BpmService, CORE_CONFIG, CUSTOM_CONFIG, CatalogService, Classification, ClassificationPrefix, ClientDefaultsObjectTypeField, ClipboardService, ColumnConfigSkipFields, ConfigService, ConnectionService, ContentStreamAllowed, ContentStreamField, CoreConfig, DeviceScreenOrientation, DeviceService, DialogCloseGuard, Direction, DmsObject, DmsService, EventService, FileSizePipe, IdmService, InternalFieldType, KeysPipe, LocaleCurrencyPipe, LocaleDatePipe, LocaleDecimalPipe, LocaleNumberPipe, LocalePercentPipe, Logger, LoginStateName, NativeNotificationService, NotificationService, ObjectConfigService, ObjectFormControl, ObjectFormControlWrapper, ObjectFormGroup, ObjectTag, ObjectTypeClassification, ObjectTypePropertyClassification, Operator, OperatorLabel, ParentField, PendingChangesGuard, PendingChangesService, PredictionService, ProcessAction, RelationshipTypeField, RetentionField, RetentionService, SafeHtmlPipe, SafeUrlPipe, SearchService, SearchUtils, SecondaryObjectTypeClassification, SessionStorageService, Situation, Sort, SystemResult, SystemSOT, SystemService, SystemType, TENANT_HEADER, TabGuardDirective, ToastService, UploadService, UserRoles, UserService, UserStorageService, Utils, YUV_USER, YuvError, YuvEventType, YuvUser, init_moduleFnc, provideUser, provideYuvClientCore };
 //# sourceMappingURL=yuuvis-client-core.mjs.map