ngx-lift 1.7.2 → 1.7.3

package/lib/utils/idle-detection/idle-detection.service.d.ts

@@ -0,0 +1,116 @@
+import { IdleDetectionConfig } from './idle-detection.config';
+import * as i0 from "@angular/core";
+/**
+ * Service for detecting user idle time and implementing a countdown.
+ */
+export declare class IdleDetectionService {
+    /**
+     * The list of interruption events that will end the idle detection.
+     */
+    private interruptionEvents;
+    private interruptionSubscription?;
+    /**
+     * The default idle duration in seconds (19 minutes).
+     */
+    private idleDuration;
+    /**
+     * The default timeout duration in seconds (1 minute).
+     */
+    private timeoutDuration;
+    /**
+     * Timer for idle detection.
+     */
+    private idleTimer?;
+    /**
+     * Timer for countdown.
+     */
+    private countdownTimer?;
+    /**
+     * Flag to indicate if countdown is in progress.
+     */
+    private isCountingDown;
+    /**
+     * The current countdown value.
+     */
+    private countdown;
+    /**
+     * Subject to emit when idle period ends.
+     */
+    private idleEndSubject;
+    /**
+     * Subject to emit the countdown value.
+     */
+    private countdownSubject;
+    /**
+     * Subject to emit when countdown ends.
+     */
+    private countdownEndSubject;
+    /**
+     * Constructs the IdleDetectionService.
+     * @param config - Optional configuration for idle and timeout durations.
+     */
+    constructor(config: IdleDetectionConfig);
+    /**
+     * Starts to watch for user inactivity.
+     */
+    startWatching(): void;
+    /**
+     * Resets the idle timer when user activity is detected.
+     */
+    resetTimer(): void;
+    /**
+     * 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
+     */
+    private setupInterruptionEvents;
+    /**
+     * Starts the idle timer.
+     * When the timer expires, it emits an event through onIdleEnd() and starts the countdown.
+     */
+    private startIdleTimer;
+    /**
+     * Starts the countdown.
+     */
+    private startCountdown;
+    /**
+     * Stops the countdown.
+     */
+    private stopCountdown;
+    /**
+     * 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(): import("rxjs").Observable<void>;
+    /**
+     * 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(): import("rxjs").Observable<void>;
+    /**
+     * Returns an observable that emits the countdown value every second.
+     * @returns {Observable<number>} - Observable for countdown value.
+     */
+    onCountDown(): import("rxjs").Observable<number>;
+    /**
+     * Clears all timers when the component is destroyed.
+     */
+    clearTimers(): void;
+    /**
+     * Sets the idle and timeout durations based on the provided configuration.
+     * @param config - Configuration object with idle and timeout durations.
+     */
+    setConfig(config: IdleDetectionConfig): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<IdleDetectionService, [{ optional: true; }]>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<IdleDetectionService>;
+}

package/lib/utils/idle-detection/index.d.ts

@@ -0,0 +1,3 @@
+export * from './idle-detection.config';
+export * from './idle-detection.module';
+export * from './idle-detection.service';

package/lib/utils/index.d.ts

@@ -1,5 +1,6 @@
 export * from './difference-in-days.util';
 export * from './form.util';
+export * from './idle-detection';
 export * from './is-empty.util';
 export * from './is-equal.util';
 export * from './omit-by.util';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ngx-lift",
-  "version": "1.7.2",
+  "version": "1.7.3",
   "description": "A project has been crafted with the goal of enhancing and simplifying your Angular development experience.",
   "author": "Guanghui Wang <guanghui-wang@foxmail.com>",
   "peerDependencies": {