ngx-lift 1.7.2 → 1.8.0

package/fesm2022/ngx-lift.mjs

@@ -1,7 +1,7 @@
-import { startWith, Subject, combineLatest, pipe, tap, map, catchError, of, Observable, timer, EMPTY, isObservable, merge, exhaustMap, from, share, switchMap, identity, distinctUntilChanged, switchAll, mergeAll, concatAll, exhaustAll } from 'rxjs';
+import { startWith, Subject, combineLatest, pipe, tap, map, catchError, of, Observable, timer, EMPTY, isObservable, merge, exhaustMap, from, share, switchMap, fromEvent, throttleTime, identity, distinctUntilChanged, switchAll, mergeAll, concatAll, exhaustAll } from 'rxjs';
 import { toObservable, toSignal } from '@angular/core/rxjs-interop';
 import * as i0 from '@angular/core';
-import { Pipe, inject, LOCALE_ID, assertInInjectionContext, isSignal, untracked, computed, DestroyRef, signal, effect } from '@angular/core';
+import { Pipe, inject, LOCALE_ID, makeEnvironmentProviders, NgModule, Injectable, Optional, assertInInjectionContext, isSignal, untracked, computed, DestroyRef, signal, effect } from '@angular/core';
 import { Validators, FormArray } from '@angular/forms';
 import { ActivatedRoute } from '@angular/router';
 
@@ -210,26 +210,26 @@ function isPromise$1(obj) {
 function poll(options) {
     const timerEmitValue = '__timer__emission__';
     const timer$ = timer(0, options.interval).pipe(map((i) => `${timerEmitValue}${i}`));
-    const trigger$ = options.trigger === undefined
+    const trigger$ = options.forceRefresh === undefined
         ? EMPTY
-        : isObservable(options.trigger)
-            ? options.trigger
-            : toObservable(options.trigger);
-    let inputByTrigger = undefined; // if trigger is not provided, input will be undefined
+        : isObservable(options.forceRefresh)
+            ? options.forceRefresh
+            : toObservable(options.forceRefresh);
+    let inputByForceRefresh = undefined; // if forceRefresh is not provided, input will be undefined
     return merge(trigger$, timer$).pipe(exhaustMap((input) => {
-        // input can be either by trigger or timer
+        // input can be either by forceRefresh or timer
         const isTimerTrigger = typeof input === 'string' && input.includes(timerEmitValue);
         const isManualTrigger = !isTimerTrigger;
         if (isManualTrigger) {
-            inputByTrigger = input;
+            inputByForceRefresh = input;
         }
-        // build params by trigger input
+        // build params by input
         // if paramsBuilder is provided, params will be the value of this function call
-        // if paramsBuilder is not provided, params will be the value emitted by the trigger
-        const params = options.paramsBuilder ? options.paramsBuilder(inputByTrigger) : inputByTrigger;
-        // NOTE: using exhaustMap will NOT emit ${timerEmitValue}0 if trigger is not provided
-        // using concatMap will emit ${timerEmitValue}0 if trigger is not provided
-        const isFirstRequest = input === `${timerEmitValue}0`; // timer first emission when trigger is not provided
+        // if paramsBuilder is not provided, params will be the value emitted by the forceRefresh
+        const params = options.paramsBuilder ? options.paramsBuilder(inputByForceRefresh) : inputByForceRefresh;
+        // NOTE: using exhaustMap will NOT emit ${timerEmitValue}0 if forceRefresh is not provided
+        // using concatMap will emit ${timerEmitValue}0 if forceRefresh is not provided
+        const isFirstRequest = input === `${timerEmitValue}0`; // timer first emission when forceRefresh is not provided
         const shouldShowLoading = isManualTrigger || isFirstRequest;
         const fnResult = options.pollingFn(params);
         const fnResult$ = isObservable(fnResult) ? fnResult : isPromise$1(fnResult) ? from(fnResult) : of(fnResult);
@@ -295,10 +295,10 @@ class ArrayJoinPipe {
         // For non-array cases or unexpected types, return the value as is
         return value;
     }
-    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "18.2.2", ngImport: i0, type: ArrayJoinPipe, deps: [], target: i0.ɵɵFactoryTarget.Pipe }); }
-    static { this.ɵpipe = i0.ɵɵngDeclarePipe({ minVersion: "14.0.0", version: "18.2.2", ngImport: i0, type: ArrayJoinPipe, isStandalone: true, name: "arrayJoin" }); }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "18.2.7", ngImport: i0, type: ArrayJoinPipe, deps: [], target: i0.ɵɵFactoryTarget.Pipe }); }
+    static { this.ɵpipe = i0.ɵɵngDeclarePipe({ minVersion: "14.0.0", version: "18.2.7", ngImport: i0, type: ArrayJoinPipe, isStandalone: true, name: "arrayJoin" }); }
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.2.2", ngImport: i0, type: ArrayJoinPipe, decorators: [{
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.2.7", ngImport: i0, type: ArrayJoinPipe, decorators: [{
             type: Pipe,
             args: [{
                     name: 'arrayJoin',
@@ -356,10 +356,10 @@ class ByteConverterPipe {
     formatNumber(value) {
         return new Intl.NumberFormat(this.locale, { maximumFractionDigits: 2 }).format(value);
     }
-    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "18.2.2", ngImport: i0, type: ByteConverterPipe, deps: [], target: i0.ɵɵFactoryTarget.Pipe }); }
-    static { this.ɵpipe = i0.ɵɵngDeclarePipe({ minVersion: "14.0.0", version: "18.2.2", ngImport: i0, type: ByteConverterPipe, isStandalone: true, name: "byteConverter" }); }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "18.2.7", ngImport: i0, type: ByteConverterPipe, deps: [], target: i0.ɵɵFactoryTarget.Pipe }); }
+    static { this.ɵpipe = i0.ɵɵngDeclarePipe({ minVersion: "14.0.0", version: "18.2.7", ngImport: i0, type: ByteConverterPipe, isStandalone: true, name: "byteConverter" }); }
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.2.2", ngImport: i0, type: ByteConverterPipe, decorators: [{
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.2.7", ngImport: i0, type: ByteConverterPipe, decorators: [{
             type: Pipe,
             args: [{
                     name: 'byteConverter',
@@ -533,6 +533,220 @@ function composeValidators(control, validatorFn) {
     return Validators.compose(validatorFns)?.(control) || null;
 }
 
+class IdleDetectionConfig {
+}
+function provideIdleDetectionConfig(config) {
+    return makeEnvironmentProviders([{ provide: IdleDetectionConfig, useValue: config }]);
+}
+
+/**
+ * Idle detection module.
+ * @deprecated use provideIdleDetectionConfig(config: IdleDetectionConfig) instead
+ */
+class IdleDetectionModule {
+    static forRoot(config) {
+        return {
+            ngModule: IdleDetectionModule,
+            providers: [provideIdleDetectionConfig(config)],
+        };
+    }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "18.2.7", ngImport: i0, type: IdleDetectionModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule }); }
+    static { this.ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "18.2.7", ngImport: i0, type: IdleDetectionModule }); }
+    static { this.ɵinj = i0.ɵɵngDeclareInjector({ minVersion: "12.0.0", version: "18.2.7", ngImport: i0, type: IdleDetectionModule }); }
+}
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.2.7", ngImport: i0, type: IdleDetectionModule, decorators: [{
+            type: NgModule,
+            args: [{
+                    imports: [],
+                }]
+        }] });
+
+/**
+ * Service for detecting user idle time and implementing a countdown.
+ */
+class IdleDetectionService {
+    /**
+     * Constructs the IdleDetectionService.
+     * @param config - Optional configuration for idle and timeout durations.
+     */
+    constructor(config) {
+        /**
+         * The list of interruption events that will end the idle detection.
+         */
+        this.interruptionEvents = [
+            'click',
+            'keydown',
+            'keypress',
+            'mousemove',
+            'mousedown',
+            'scroll',
+            'wheel',
+            'touchmove',
+            'pointermove',
+            'resize',
+        ];
+        /**
+         * The default idle duration in seconds (19 minutes).
+         */
+        this.idleDuration = 19 * 60;
+        /**
+         * The default timeout duration in seconds (1 minute).
+         */
+        this.timeoutDuration = 60;
+        /**
+         * Flag to indicate if countdown is in progress.
+         */
+        this.isCountingDown = false;
+        /**
+         * The current countdown value.
+         */
+        this.countdown = this.timeoutDuration;
+        /**
+         * Subject to emit when idle period ends.
+         */
+        this.idleEndSubject = new Subject();
+        /**
+         * Subject to emit the countdown value.
+         */
+        this.countdownSubject = new Subject();
+        /**
+         * Subject to emit when countdown ends.
+         */
+        this.countdownEndSubject = new Subject();
+        if (config) {
+            this.setConfig(config);
+        }
+    }
+    /**
+     * Starts to watch for user inactivity.
+     */
+    startWatching() {
+        this.setupInterruptionEvents();
+        this.startIdleTimer();
+    }
+    /**
+     * Resets the idle timer when user activity is detected.
+     * @param withCountdownReset - Flag to indicate if countdown should be reset.
+     * By default, it only reset the idle-detection timer. If you enter the countdown phase, it won't stop the countdown.
+     * Pass true when you want to reset the countdown as well. This is useful when you click "Keep Me Signed In" button in cll-idle-detection component
+     */
+    resetTimer(withCountdownReset = false) {
+        this.startIdleTimer();
+        if (withCountdownReset && this.isCountingDown) {
+            this.stopCountdown();
+        }
+    }
+    /**
+     * Sets up the interruption events that will end the idle detection.
+     * Listens to a set of events on the document (e.g. click, keydown, mousemove, etc.).
+     * When any of these events is triggered, the idle timer is reset.
+     * Uses `throttleTime` operator to only trigger the reset when the events are spaced
+     * out by at least 1000ms (1 second).
+     * @private
+     */
+    setupInterruptionEvents() {
+        if (!this.interruptionSubscription) {
+            const throttledInterruptionEvents = this.interruptionEvents.map((eventName) => fromEvent(document, eventName).pipe(throttleTime(1000)));
+            this.interruptionSubscription = merge(...throttledInterruptionEvents).subscribe(() => this.resetTimer());
+        }
+    }
+    /**
+     * Starts the idle timer.
+     * When the timer expires, it emits an event through onIdleEnd() and starts the countdown.
+     */
+    startIdleTimer() {
+        clearTimeout(this.idleTimer);
+        this.idleTimer = window.setTimeout(() => {
+            // after idle period, user inactivity detected
+            this.idleEndSubject.next();
+            this.startCountdown();
+        }, this.idleDuration * 1000);
+    }
+    /**
+     * Starts the countdown.
+     */
+    startCountdown() {
+        this.isCountingDown = true;
+        this.countdownSubject.next(this.countdown);
+        this.countdownTimer = window.setInterval(() => {
+            this.countdown--;
+            this.countdownSubject.next(this.countdown);
+            if (this.countdown <= 0) {
+                this.stopCountdown();
+                this.countdownEndSubject.next();
+            }
+        }, 1000);
+    }
+    /**
+     * Stops the countdown.
+     */
+    stopCountdown() {
+        clearInterval(this.countdownTimer);
+        this.isCountingDown = false;
+        // reset countdown
+        this.countdown = this.timeoutDuration;
+    }
+    /**
+     * Returns an observable that emits when the user has been idle for a long period.
+     * Developers can use this to perform actions like opening a dialog.
+     *
+     * user has been inactive for a long period (idleDuration), at this moment, idle detection phase ends, onIdleEnd event is emitted, and then enter countdown/timeout phase.
+     * During the countdown phase:
+     *  - if user has any activity, countdown phase immediately ends and restart the idle detection phase.
+     *  - else, countdownEnd event will be emitted when timeoutDuration is over.
+     * @returns {Observable<void>} - Observable for idle end event.
+     */
+    onIdleEnd() {
+        return this.idleEndSubject.asObservable();
+    }
+    /**
+     * Returns an observable that emits when the countdown ends.
+     * Usually means the user has been inactive for a very long time and should be logged out.
+     * @returns {Observable<void>} - Observable for countdown end event.
+     */
+    onTimeoutEnd() {
+        return this.countdownEndSubject.asObservable();
+    }
+    /**
+     * Returns an observable that emits the countdown value every second.
+     * @returns {Observable<number>} - Observable for countdown value.
+     */
+    onCountDown() {
+        return this.countdownSubject.asObservable();
+    }
+    /**
+     * Clears all timers when the component is destroyed.
+     */
+    clearTimers() {
+        clearTimeout(this.idleTimer);
+        clearInterval(this.countdownTimer);
+        this.interruptionSubscription?.unsubscribe();
+        this.interruptionSubscription = undefined;
+    }
+    /**
+     * Sets the idle and timeout durations based on the provided configuration.
+     * @param config - Configuration object with idle and timeout durations.
+     */
+    setConfig(config) {
+        if (config.idleDurationInSeconds) {
+            this.idleDuration = config.idleDurationInSeconds;
+        }
+        if (config.timeoutDurationInSeconds) {
+            this.countdown = this.timeoutDuration = config.timeoutDurationInSeconds;
+        }
+    }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "18.2.7", ngImport: i0, type: IdleDetectionService, deps: [{ token: IdleDetectionConfig, optional: true }], target: i0.ɵɵFactoryTarget.Injectable }); }
+    static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "18.2.7", ngImport: i0, type: IdleDetectionService, providedIn: 'root' }); }
+}
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.2.7", ngImport: i0, type: IdleDetectionService, decorators: [{
+            type: Injectable,
+            args: [{
+                    providedIn: 'root',
+                }]
+        }], ctorParameters: () => [{ type: IdleDetectionConfig, decorators: [{
+                    type: Optional
+                }] }] });
+
 /**
  * Check if a value is empty.
  * @param {T | undefined | null} value - The value to check for emptiness.
@@ -676,10 +890,10 @@ class IsHttpsPipe {
     transform(value) {
         return isHttps(value);
     }
-    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "18.2.2", ngImport: i0, type: IsHttpsPipe, deps: [], target: i0.ɵɵFactoryTarget.Pipe }); }
-    static { this.ɵpipe = i0.ɵɵngDeclarePipe({ minVersion: "14.0.0", version: "18.2.2", ngImport: i0, type: IsHttpsPipe, isStandalone: true, name: "isHttps" }); }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "18.2.7", ngImport: i0, type: IsHttpsPipe, deps: [], target: i0.ɵɵFactoryTarget.Pipe }); }
+    static { this.ɵpipe = i0.ɵɵngDeclarePipe({ minVersion: "14.0.0", version: "18.2.7", ngImport: i0, type: IsHttpsPipe, isStandalone: true, name: "isHttps" }); }
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.2.2", ngImport: i0, type: IsHttpsPipe, decorators: [{
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.2.7", ngImport: i0, type: IsHttpsPipe, decorators: [{
             type: Pipe,
             args: [{
                     name: 'isHttps',
@@ -710,10 +924,10 @@ class MaskPipe {
             .map((char, i) => (i < unmaskedPrefixLength || i > value.length - unmaskedSuffixLength - 1 ? char : maskChar))
             .join('');
     }
-    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "18.2.2", ngImport: i0, type: MaskPipe, deps: [], target: i0.ɵɵFactoryTarget.Pipe }); }
-    static { this.ɵpipe = i0.ɵɵngDeclarePipe({ minVersion: "14.0.0", version: "18.2.2", ngImport: i0, type: MaskPipe, isStandalone: true, name: "mask" }); }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "18.2.7", ngImport: i0, type: MaskPipe, deps: [], target: i0.ɵɵFactoryTarget.Pipe }); }
+    static { this.ɵpipe = i0.ɵɵngDeclarePipe({ minVersion: "14.0.0", version: "18.2.7", ngImport: i0, type: MaskPipe, isStandalone: true, name: "mask" }); }
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.2.2", ngImport: i0, type: MaskPipe, decorators: [{
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.2.7", ngImport: i0, type: MaskPipe, decorators: [{
             type: Pipe,
             args: [{
                     name: 'mask',
@@ -726,10 +940,10 @@ class RangePipe {
         const input = value;
         return range(...input);
     }
-    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "18.2.2", ngImport: i0, type: RangePipe, deps: [], target: i0.ɵɵFactoryTarget.Pipe }); }
-    static { this.ɵpipe = i0.ɵɵngDeclarePipe({ minVersion: "14.0.0", version: "18.2.2", ngImport: i0, type: RangePipe, isStandalone: true, name: "range" }); }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "18.2.7", ngImport: i0, type: RangePipe, deps: [], target: i0.ɵɵFactoryTarget.Pipe }); }
+    static { this.ɵpipe = i0.ɵɵngDeclarePipe({ minVersion: "14.0.0", version: "18.2.7", ngImport: i0, type: RangePipe, isStandalone: true, name: "range" }); }
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.2.2", ngImport: i0, type: RangePipe, decorators: [{
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.2.7", ngImport: i0, type: RangePipe, decorators: [{
             type: Pipe,
             args: [{
                     name: 'range',
@@ -1209,5 +1423,5 @@ function httpsValidator(control) {
  * Generated bundle index. Do not edit.
  */
 
-export { ArrayJoinPipe, ByteConverterPipe, IsHttpsPipe, MaskPipe, RangePipe, UniqueValidator, combineFrom, combineLatestEager, computedAsync, createAsyncState, createTrigger, dateRangeValidator, differenceInDays, distinctOnChange, httpsValidator, ifAsyncValidator, ifValidator, injectParams, injectQueryParams, intersectionValidator, isEmpty, isEqual, isFQDN, isHttps, isIP, isURL, logger, mergeFrom, omitBy, pickBy, poll, range, startWithTap, switchMapWithAsyncState, urlValidator };
+export { ArrayJoinPipe, ByteConverterPipe, IdleDetectionConfig, IdleDetectionModule, IdleDetectionService, IsHttpsPipe, MaskPipe, RangePipe, UniqueValidator, combineFrom, combineLatestEager, computedAsync, createAsyncState, createTrigger, dateRangeValidator, differenceInDays, distinctOnChange, httpsValidator, ifAsyncValidator, ifValidator, injectParams, injectQueryParams, intersectionValidator, isEmpty, isEqual, isFQDN, isHttps, isIP, isURL, logger, mergeFrom, omitBy, pickBy, poll, provideIdleDetectionConfig, range, startWithTap, switchMapWithAsyncState, urlValidator };
 //# sourceMappingURL=ngx-lift.mjs.map