UNPKG

@omostan/ngx-idle

Version:

A module for responding to idle users in Angular applications. this is a forked version of the original @ng-Idle

67 lines 11 kB
import { isPlatformServer } from '@angular/common'; import { Subscription, fromEvent, merge } from 'rxjs'; import { filter, throttleTime } from 'rxjs/operators'; import { InterruptArgs } from './interruptargs'; import { InterruptSource } from './interruptsource'; const defaultThrottleDelay = 500; /* * An interrupt source on an EventTarget object, such as a Window or HTMLElement. */ export class EventTargetInterruptSource extends InterruptSource { constructor(target, events, opts) { super(null, null); this.target = target; this.events = events; this.opts = opts; this.eventSubscription = new Subscription(); if (typeof this.opts === 'number') { this.opts = { throttleDelay: this.opts, passive: false }; } this.opts = this.opts || { passive: false, throttleDelay: defaultThrottleDelay }; if (this.opts.throttleDelay === undefined || this.opts.throttleDelay === null) { this.opts.throttleDelay = defaultThrottleDelay; } this.throttleDelay = this.opts.throttleDelay; this.passive = !!this.opts.passive; } initialize(options) { if (options?.platformId && isPlatformServer(options.platformId)) { return; } const eventTarget = typeof this.target === 'function' ? this.target() : this.target; const opts = this.passive ? { passive: true } : null; const fromEvents = this.events .split(' ') .map(eventName => fromEvent(eventTarget, eventName, opts)); this.eventSrc = merge(...fromEvents); this.eventSrc = this.eventSrc.pipe(filter(innerArgs => !this.filterEvent(innerArgs))); if (this.throttleDelay > 0) { this.eventSrc = this.eventSrc.pipe(throttleTime(this.throttleDelay)); } const handler = (innerArgs) => this.onInterrupt.emit(new InterruptArgs(this, innerArgs)); this.attachFn = () => (this.eventSubscription = this.eventSrc.subscribe(handler)); this.detachFn = () => this.eventSubscription.unsubscribe(); } /* * Checks to see if the event should be filtered. Always returns false unless overriden. * @param event - The original event object. * @return True if the event should be filtered (don't cause an interrupt); otherwise, false. */ filterEvent(event) { return false; } /** * Returns the current options being used. * @return The current option values. */ get options() { return { passive: this.passive, throttleDelay: this.throttleDelay }; } } //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"eventtargetinterruptsource.js","sourceRoot":"","sources":["../../../../projects/core/src/lib/eventtargetinterruptsource.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EAAc,YAAY,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAClE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAGtD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAkBpD,MAAM,oBAAoB,GAAG,GAAG,CAAC;AAEjC;;GAEG;AACH,MAAM,OAAO,0BAA2B,SAAQ,eAAe;IAM7D,YACY,MAAmD,EACnD,MAAc,EAChB,IAA2C;QAEnD,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAJR,WAAM,GAAN,MAAM,CAA6C;QACnD,WAAM,GAAN,MAAM,CAAQ;QAChB,SAAI,GAAJ,IAAI,CAAuC;QAP7C,sBAAiB,GAAiB,IAAI,YAAY,EAAE,CAAC;QAW3D,IAAI,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE;YACjC,IAAI,CAAC,IAAI,GAAG,EAAE,aAAa,EAAE,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;SAC1D;QAED,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI;YACvB,OAAO,EAAE,KAAK;YACd,aAAa,EAAE,oBAAoB;SACpC,CAAC;QAEF,IAAI,IAAI,CAAC,IAAI,CAAC,aAAa,KAAK,SAAS,IAAI,IAAI,CAAC,IAAI,CAAC,aAAa,KAAK,IAAI,EAAE;YAC7E,IAAI,CAAC,IAAI,CAAC,aAAa,GAAG,oBAAoB,CAAC;SAChD;QAED,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC;QAC7C,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;IACrC,CAAC;IAED,UAAU,CAAC,OAA0B;QACnC,IAAI,OAAO,EAAE,UAAU,IAAI,gBAAgB,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;YAC/D,OAAO;SACR;QAED,MAAM,WAAW,GAAG,OAAO,IAAI,CAAC,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;QACpF,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;QACrD,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM;aAC3B,KAAK,CAAC,GAAG,CAAC;aACV,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,WAAkB,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;QACpE,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,GAAG,UAAU,CAAC,CAAC;QACrC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAChC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAClD,CAAC;QACF,IAAI,IAAI,CAAC,aAAa,GAAG,CAAC,EAAE;YAC1B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;SACtE;QAED,MAAM,OAAO,GAAG,CAAC,SAAc,EAAE,EAAE,CACjC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,aAAa,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;QAE5D,IAAI,CAAC,QAAQ,GAAG,GAAG,EAAE,CACnB,CAAC,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;QAE9D,IAAI,CAAC,QAAQ,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,WAAW,EAAE,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IACO,WAAW,CAAC,KAAU;QAC9B,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACH,IAAI,OAAO;QACT,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,aAAa,EAAE,IAAI,CAAC,aAAa;SAClC,CAAC;IACJ,CAAC;CACF","sourcesContent":["import { isPlatformServer } from '@angular/common';\r\nimport { Observable, Subscription, fromEvent, merge } from 'rxjs';\r\nimport { filter, throttleTime } from 'rxjs/operators';\r\n\r\nimport { EventTarget } from './eventtarget';\r\nimport { InterruptArgs } from './interruptargs';\r\nimport { InterruptOptions } from './interruptoptions';\r\nimport { InterruptSource } from './interruptsource';\r\n\r\n/**\r\n * Options for EventTargetInterruptSource\r\n */\r\nexport interface EventTargetInterruptOptions {\r\n  /**\r\n   * The number of milliseconds to throttle the events coming from the target.\r\n   */\r\n  throttleDelay?: number;\r\n\r\n  /**\r\n   * Whether or not to use passive event listeners.\r\n   * Note: you need to detect if the browser supports passive listeners, and only set this to true if it does.\r\n   */\r\n  passive?: boolean;\r\n}\r\n\r\nconst defaultThrottleDelay = 500;\r\n\r\n/*\r\n * An interrupt source on an EventTarget object, such as a Window or HTMLElement.\r\n */\r\nexport class EventTargetInterruptSource extends InterruptSource {\r\n  private eventSrc: Observable<any>;\r\n  private eventSubscription: Subscription = new Subscription();\r\n  protected throttleDelay: number;\r\n  protected passive: boolean;\r\n\r\n  constructor(\r\n    protected target: EventTarget<any> | (() => EventTarget<any>),\r\n    protected events: string,\r\n    private opts?: number | EventTargetInterruptOptions\r\n  ) {\r\n    super(null, null);\r\n\r\n    if (typeof this.opts === 'number') {\r\n      this.opts = { throttleDelay: this.opts, passive: false };\r\n    }\r\n\r\n    this.opts = this.opts || {\r\n      passive: false,\r\n      throttleDelay: defaultThrottleDelay\r\n    };\r\n\r\n    if (this.opts.throttleDelay === undefined || this.opts.throttleDelay === null) {\r\n      this.opts.throttleDelay = defaultThrottleDelay;\r\n    }\r\n\r\n    this.throttleDelay = this.opts.throttleDelay;\r\n    this.passive = !!this.opts.passive;\r\n  }\r\n\r\n  initialize(options?: InterruptOptions) {\r\n    if (options?.platformId && isPlatformServer(options.platformId)) {\r\n      return;\r\n    }\r\n\r\n    const eventTarget = typeof this.target === 'function' ? this.target() : this.target;\r\n    const opts = this.passive ? { passive: true } : null;\r\n    const fromEvents = this.events\r\n      .split(' ')\r\n      .map(eventName => fromEvent(eventTarget as any, eventName, opts));\r\n    this.eventSrc = merge(...fromEvents);\r\n    this.eventSrc = this.eventSrc.pipe(\r\n      filter(innerArgs => !this.filterEvent(innerArgs))\r\n    );\r\n    if (this.throttleDelay > 0) {\r\n      this.eventSrc = this.eventSrc.pipe(throttleTime(this.throttleDelay));\r\n    }\r\n\r\n    const handler = (innerArgs: any) =>\r\n      this.onInterrupt.emit(new InterruptArgs(this, innerArgs));\r\n\r\n    this.attachFn = () =>\r\n      (this.eventSubscription = this.eventSrc.subscribe(handler));\r\n\r\n    this.detachFn = () => this.eventSubscription.unsubscribe();\r\n  }\r\n\r\n  /*\r\n   * Checks to see if the event should be filtered. Always returns false unless overriden.\r\n   * @param event - The original event object.\r\n   * @return True if the event should be filtered (don't cause an interrupt); otherwise, false.\r\n   */\r\n  protected filterEvent(event: any): boolean {\r\n    return false;\r\n  }\r\n\r\n  /**\r\n   * Returns the current options being used.\r\n   * @return The current option values.\r\n   */\r\n  get options(): EventTargetInterruptOptions {\r\n    return {\r\n      passive: this.passive,\r\n      throttleDelay: this.throttleDelay\r\n    };\r\n  }\r\n}\r\n"]}