@c8y/ngx-components
Version:
Angular modules for Cumulocity IoT applications
103 lines • 12.2 kB
JavaScript
import { coerceNumberProperty } from '@angular/cdk/coercion';
import { BehaviorSubject, NEVER } from 'rxjs';
import { filter, map, switchMap } from 'rxjs/operators';
/**
* A wrapper class for handling realtime notifications in RxJS fashion.
*/
export class RealtimeService {
/**
* A flag displaying if realtime notifications are currently active.
*/
get active() {
return this.isActive.value;
}
/**
* An observable emitting a value in case the realtime connection has been interrupted.
* Can be used to reload data of e.g. a datapoint graph that wasn't received while realtime was interrupted.
*/
get reconnect$() {
return this.realtimeSubject.reconnect$;
}
/**
* An observable emitting either `connected` or `disconnected` depending on the state of the realtime connection.
* Can be used to e.g. inform the user about the interrupted realtime connection.
*/
get connectionStatus$() {
return this.realtimeSubject.connectionStatus$;
}
constructor(realtimeSubject) {
this.realtimeSubject = realtimeSubject;
this.isActive = new BehaviorSubject(true);
}
/**
* Get an Observable of all realtime notifications.
*
* @param {string | number | IIdentified} entityOrId Entity object or id
*
* @returns An [[Observable]] of notifications wrapped as [[RealtimeMessage]]
*/
onAll$(entityOrId) {
const subject$ = this.realtimeSubject.getObservableForChannel(this.getChannel(entityOrId));
return this.isActive.pipe(switchMap(active => (active ? subject$ : NEVER)));
}
/**
* Subscribes again all realtime channels with active observers.
*/
start() {
if (!this.active) {
this.isActive.next(true);
}
}
/**
* Stops realtime notifications and unsubscribes all realtime channels.
*/
stop() {
if (this.active) {
this.isActive.next(false);
}
}
/**
* Get an Observable of all CREATE realtime notifications.
*
* @param {string | number | IIdentified} entityOrId Entity object or id
*
* @returns An [[Observable]] of newly created entity objects.
*/
onCreate$(entityOrId) {
return this.onAll$(entityOrId).pipe(filter(msg => msg.realtimeAction === 'CREATE'), map(msg => msg.data));
}
/**
* Get an Observable of all UPDATE realtime notifications.
*
* @param {string | number | IIdentified} entityOrId Entity object or id
*
* @returns An [[Observable]] of updated entity objects.
*/
onUpdate$(entityOrId) {
return this.onAll$(entityOrId).pipe(filter(msg => msg.realtimeAction === 'UPDATE'), map(msg => msg.data));
}
/**
* Get an Observable of all DELETE realtime notifications.
*
* @param {string | number | IIdentified} entityOrId Entity object or id
*
* @returns An [[Observable]] of deleted entity objects.
*/
onDelete$(entityOrId) {
return this.onAll$(entityOrId).pipe(filter(msg => msg.realtimeAction === 'DELETE'), map(msg => coerceNumberProperty(msg.data)));
}
getIdString(reference) {
let id;
if (typeof reference === 'object') {
id = reference.id;
}
else {
id = reference;
}
return String(id);
}
getChannel(entityOrId) {
return entityOrId ? this.channel().replace('*', this.getIdString(entityOrId)) : this.channel();
}
}
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"realtime.service.js","sourceRoot":"","sources":["../../../../core/realtime/realtime.service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAE7D,OAAO,EAAE,eAAe,EAAE,KAAK,EAAc,MAAM,MAAM,CAAC;AAC1D,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAIxD;;GAEG;AACH,MAAM,OAAgB,eAAe;IACnC;;OAEG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACH,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC;IACzC,CAAC;IAED;;;OAGG;IACH,IAAI,iBAAiB;QACnB,OAAO,IAAI,CAAC,eAAe,CAAC,iBAAiB,CAAC;IAChD,CAAC;IAID,YAAsB,eAAuC;QAAvC,oBAAe,GAAf,eAAe,CAAwB;QAFrD,aAAQ,GAAG,IAAI,eAAe,CAAU,IAAI,CAAC,CAAC;IAEU,CAAC;IAEjE;;;;;;OAMG;IACH,MAAM,CAAC,UAA0C;QAC/C,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,uBAAuB,CAAI,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC;QAE9F,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC9E,CAAC;IAED;;OAEG;IACH,KAAK;QACH,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;IAED;;OAEG;IACH,IAAI;QACF,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,SAAS,CAAC,UAA0C;QAClD,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CACjC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,cAAc,KAAK,QAAQ,CAAC,EAC9C,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAS,CAAC,CAC1B,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,SAAS,CAAC,UAA0C;QAClD,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CACjC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,cAAc,KAAK,QAAQ,CAAC,EAC9C,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAS,CAAC,CAC1B,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,SAAS,CAAC,UAA0C;QAClD,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CACjC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,cAAc,KAAK,QAAQ,CAAC,EAC9C,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,oBAAoB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAC3C,CAAC;IACJ,CAAC;IAES,WAAW,CAAC,SAAwC;QAC5D,IAAI,EAAmB,CAAC;QACxB,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;YAClC,EAAE,GAAG,SAAS,CAAC,EAAE,CAAC;QACpB,CAAC;aAAM,CAAC;YACN,EAAE,GAAG,SAAS,CAAC;QACjB,CAAC;QACD,OAAO,MAAM,CAAC,EAAE,CAAC,CAAC;IACpB,CAAC;IAES,UAAU,CAAC,UAA0C;QAC7D,OAAO,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;IACjG,CAAC;CAGF","sourcesContent":["import { coerceNumberProperty } from '@angular/cdk/coercion';\nimport { IIdentified } from '@c8y/client';\nimport { BehaviorSubject, NEVER, Observable } from 'rxjs';\nimport { filter, map, switchMap } from 'rxjs/operators';\nimport { RealtimeSubjectService } from './realtime-subject.service';\nimport { RealtimeMessage } from './realtime.model';\n\n/**\n * A wrapper class for handling realtime notifications in RxJS fashion.\n */\nexport abstract class RealtimeService<T> {\n  /**\n   * A flag displaying if realtime notifications are currently active.\n   */\n  get active(): boolean {\n    return this.isActive.value;\n  }\n\n  /**\n   * An observable emitting a value in case the realtime connection has been interrupted.\n   * Can be used to reload data of e.g. a datapoint graph that wasn't received while realtime was interrupted.\n   */\n  get reconnect$(): Observable<void> {\n    return this.realtimeSubject.reconnect$;\n  }\n\n  /**\n   * An observable emitting either `connected` or `disconnected` depending on the state of the realtime connection.\n   * Can be used to e.g. inform the user about the interrupted realtime connection.\n   */\n  get connectionStatus$(): Observable<'connected' | 'disconnected'> {\n    return this.realtimeSubject.connectionStatus$;\n  }\n\n  private isActive = new BehaviorSubject<boolean>(true);\n\n  constructor(protected realtimeSubject: RealtimeSubjectService) {}\n\n  /**\n   * Get an Observable of all realtime notifications.\n   *\n   * @param {string | number | IIdentified} entityOrId Entity object or id\n   *\n   * @returns An [[Observable]] of notifications wrapped as [[RealtimeMessage]]\n   */\n  onAll$(entityOrId?: string | number | IIdentified): Observable<RealtimeMessage<T>> {\n    const subject$ = this.realtimeSubject.getObservableForChannel<T>(this.getChannel(entityOrId));\n\n    return this.isActive.pipe(switchMap(active => (active ? subject$ : NEVER)));\n  }\n\n  /**\n   * Subscribes again all realtime channels with active observers.\n   */\n  start() {\n    if (!this.active) {\n      this.isActive.next(true);\n    }\n  }\n\n  /**\n   * Stops realtime notifications and unsubscribes all realtime channels.\n   */\n  stop() {\n    if (this.active) {\n      this.isActive.next(false);\n    }\n  }\n\n  /**\n   * Get an Observable of all CREATE realtime notifications.\n   *\n   * @param {string | number | IIdentified} entityOrId Entity object or id\n   *\n   * @returns An [[Observable]] of newly created entity objects.\n   */\n  onCreate$(entityOrId?: string | number | IIdentified): Observable<T> {\n    return this.onAll$(entityOrId).pipe(\n      filter(msg => msg.realtimeAction === 'CREATE'),\n      map(msg => msg.data as T)\n    );\n  }\n\n  /**\n   * Get an Observable of all UPDATE realtime notifications.\n   *\n   * @param {string | number | IIdentified} entityOrId Entity object or id\n   *\n   * @returns An [[Observable]] of updated entity objects.\n   */\n  onUpdate$(entityOrId?: string | number | IIdentified): Observable<T> {\n    return this.onAll$(entityOrId).pipe(\n      filter(msg => msg.realtimeAction === 'UPDATE'),\n      map(msg => msg.data as T)\n    );\n  }\n\n  /**\n   * Get an Observable of all DELETE realtime notifications.\n   *\n   * @param {string | number | IIdentified} entityOrId Entity object or id\n   *\n   * @returns An [[Observable]] of deleted entity objects.\n   */\n  onDelete$(entityOrId?: string | number | IIdentified): Observable<number> {\n    return this.onAll$(entityOrId).pipe(\n      filter(msg => msg.realtimeAction === 'DELETE'),\n      map(msg => coerceNumberProperty(msg.data))\n    );\n  }\n\n  protected getIdString(reference: number | string | IIdentified): string {\n    let id: string | number;\n    if (typeof reference === 'object') {\n      id = reference.id;\n    } else {\n      id = reference;\n    }\n    return String(id);\n  }\n\n  protected getChannel(entityOrId?: string | number | IIdentified) {\n    return entityOrId ? this.channel().replace('*', this.getIdString(entityOrId)) : this.channel();\n  }\n\n  protected abstract channel(): string;\n}\n"]}