taon 21.0.53 → 21.0.54

package/lib-prod/realtime/realtime-server.js

@@ -1,252 +1,237 @@
-import { Subject } from "rxjs";
-import { ___NS__isArray, ___NS__isFunction, ___NS__isObject, ___NS__isString, Helpers__NS__error, UtilsOs__NS__isElectron, UtilsOs__NS__isWebSQL } from "tnp-core/lib-prod";
-import { ClassHelpers__NS__getClassFnFromObject, ClassHelpers__NS__getName, ClassHelpers__NS__getUniqueKey } from "../helpers/class-helpers";
-import { Symbols__NS__REALTIME } from "../symbols";
-class RealtimeServer {
-  // private jobs = {};
-  constructor(core) {
-    this.core = core;
-    this.core = core;
-    if (core.ctx.disabledRealtime || this.core.ctx.isRemoteHost) {
-      return;
+import { Subject } from 'rxjs';
+import { ___NS__isArray, ___NS__isFunction, ___NS__isObject, ___NS__isString, Helpers__NS__error, UtilsOs__NS__isElectron, UtilsOs__NS__isWebSQL } from 'tnp-core/lib-prod';
+import { ClassHelpers__NS__getClassFnFromObject, ClassHelpers__NS__getName, ClassHelpers__NS__getUniqueKey } from '../helpers/class-helpers';
+import { Symbols__NS__REALTIME } from '../symbols';
+//#endregion
+/**
+ * Server for realtime communication
+ * you can trigger:
+ * - entity changes (any property in table changed)
+ * - entity custom property changes (specific property changed)
+ * - entity table changes (new instance added, instance removed)
+ * - custom events
+ *
+ * and also listen to:
+ * - custom events from yourself
+ */
+export class RealtimeServer {
+    // private jobs = {};
+    constructor(core) {
+        this.core = core;
+        this.core = core;
+        if (core.ctx.disabledRealtime || this.core.ctx.isRemoteHost) {
+            return;
+        }
+        //#region @websql
+        this.init();
+        //#endregion
+    }
+    //#region methods & getters / init
+    init() {
+        /* */
+        /* */
+        /* */
+        /* */
+        /* */
+        /* */
+        /* */
+        /* */
+        /* */
+        /* */
+        /* */
+        //#region @websql
+        //#region prepare namespaces pathes
+        const nspPathGlobal = this.core.pathFor();
+        const nspPathRealtime = this.core.pathFor(Symbols__NS__REALTIME.NAMESPACE(this.core.ctx.contextName));
+        //#endregion
+        // console.log('[backend] nspPath', nspPath);
+        const cors = {
+            origin: this.core.ctx.frontendHostUri.origin, // only origin needs to be set - pathname not needed
+            methods: this.core.allHttpMethods,
+        };
+        // console.log('frontendHost', this.core.ctx.config.frontendHost);
+        // console.log('cors', cors);
+        //#region prepare global BE socket
+        this.core.connectSocketBE = this.core.strategy.ioServer(UtilsOs__NS__isWebSQL ? this.core.ctx.uriOrigin : this.core.ctx.serverTcpUdp, {
+            path: nspPathGlobal.pathname,
+            cors,
+        }, // @ts-ignore
+        this.core.ctx);
+        this.core.ctx.logRealtime &&
+            console.info(`[backend] CREATE GLOBAL NAMESPACE: '${this.core.connectSocketBE.path()}'` +
+                ` , path: '${nspPathGlobal.pathname}'`);
+        this.core.connectSocketBE.on('connection', clientSocket => {
+            this.core.ctx.logRealtime &&
+                console.info(`[backend] client connected to namespace "${nspPathGlobal.pathname}", ` +
+                    ` host: ${this.core.ctx.host}`);
+        });
+        //#endregion
+        //#region prepare realtime BE socket
+        this.core.socketBE = this.core.strategy.ioServer(UtilsOs__NS__isWebSQL || UtilsOs__NS__isElectron
+            ? this.core.ctx.uriOrigin
+            : this.core.ctx.serverTcpUdp, {
+            path: nspPathRealtime.pathname,
+            cors,
+        }, // @ts-ignore
+        this.core.ctx);
+        this.core.ctx.logRealtime &&
+            console.info(`[backend] CREATE REALTIME NAMESPACE: '${this.core.socketBE.path()}'` +
+                ` , path: '${nspPathRealtime.pathname}' `);
+        this.core.socketBE.on('connection', backendSocketForClient => {
+            this.core.ctx.logRealtime &&
+                console.info(`[backend] client connected to namespace "${nspPathRealtime.pathname}", ` +
+                    ` host: ${this.core.ctx.host}`);
+            backendSocketForClient.on(Symbols__NS__REALTIME.ROOM_SUBSCRIBE_CUSTOM(this.core.ctx.contextName), roomName => {
+                this.core.ctx.logRealtime &&
+                    console.info(`Joining room ${roomName} in namespace  REALTIME` +
+                        ` host: ${this.core.ctx.contextName}/${this.core.ctx.host}`);
+                backendSocketForClient.join(roomName);
+            });
+            backendSocketForClient.on(Symbols__NS__REALTIME.ROOM_SUBSCRIBE_ENTITY_UPDATE_EVENTS(this.core.ctx.contextName), roomName => {
+                this.core.ctx.logRealtime &&
+                    console.info(`[backend] Joining room ${roomName} in namespace  REALTIME` +
+                        ` host: ${this.core.ctx.contextName}/${this.core.ctx.host}`);
+                backendSocketForClient.join(roomName);
+            });
+            backendSocketForClient.on(Symbols__NS__REALTIME.ROOM_SUBSCRIBE_ENTITY_PROPERTY_UPDATE_EVENTS(this.core.ctx.contextName), roomName => {
+                this.core.ctx.logRealtime &&
+                    console.info(`[backend] Joining room ${roomName} in namespace REALTIME ` +
+                        ` host: ${this.core.ctx.contextName}/${this.core.ctx.host}`);
+                backendSocketForClient.join(roomName);
+            });
+            backendSocketForClient.on(Symbols__NS__REALTIME.ROOM_UNSUBSCRIBE_CUSTOM(this.core.ctx.contextName), roomName => {
+                this.core.ctx.logRealtime &&
+                    console.info(`[backend] Leaving room ${roomName} in namespace  REALTIME` +
+                        ` host: ${this.core.ctx.contextName}/${this.core.ctx.host}`);
+                backendSocketForClient.leave(roomName);
+            });
+            backendSocketForClient.on(Symbols__NS__REALTIME.ROOM_UNSUBSCRIBE_ENTITY_UPDATE_EVENTS(this.core.ctx.contextName), roomName => {
+                this.core.ctx.logRealtime &&
+                    console.info(`[backend] Leaving room ${roomName} in namespace REALTIME ` +
+                        ` host: ${this.core.ctx.contextName}/${this.core.ctx.host}`);
+                backendSocketForClient.leave(roomName);
+            });
+            backendSocketForClient.on(Symbols__NS__REALTIME.ROOM_UNSUBSCRIBE_ENTITY_PROPERTY_UPDATE_EVENTS(this.core.ctx.contextName), roomName => {
+                this.core.ctx.logRealtime &&
+                    console.info(`[backend] Leaving room ${roomName} in namespace REALTIME ` +
+                        ` host: ${this.core.ctx.contextName}/${this.core.ctx.host}`);
+                backendSocketForClient.leave(roomName);
+            });
+        });
+        //#endregion
+        //#endregion
     }
-    this.init();
-  }
-  //#region methods & getters / init
-  init() {
-    const nspPathGlobal = this.core.pathFor();
-    const nspPathRealtime = this.core.pathFor(
-      Symbols__NS__REALTIME.NAMESPACE(this.core.ctx.contextName)
-    );
-    const cors = {
-      origin: this.core.ctx.frontendHostUri.origin,
-      // only origin needs to be set - pathname not needed
-      methods: this.core.allHttpMethods
-    };
-    this.core.connectSocketBE = this.core.strategy.ioServer(
-      UtilsOs__NS__isWebSQL ? this.core.ctx.uriOrigin : this.core.ctx.serverTcpUdp,
-      {
-        path: nspPathGlobal.pathname,
-        cors
-      },
-      // @ts-ignore
-      this.core.ctx
-    );
-    this.core.ctx.logRealtime && console.info(
-      `[backend] CREATE GLOBAL NAMESPACE: '${this.core.connectSocketBE.path()}' , path: '${nspPathGlobal.pathname}'`
-    );
-    this.core.connectSocketBE.on("connection", (clientSocket) => {
-      this.core.ctx.logRealtime && console.info(
-        `[backend] client connected to namespace "${nspPathGlobal.pathname}",  host: ${this.core.ctx.host}`
-      );
-    });
-    this.core.socketBE = this.core.strategy.ioServer(
-      UtilsOs__NS__isWebSQL || UtilsOs__NS__isElectron ? this.core.ctx.uriOrigin : this.core.ctx.serverTcpUdp,
-      {
-        path: nspPathRealtime.pathname,
-        cors
-      },
-      // @ts-ignore
-      this.core.ctx
-    );
-    this.core.ctx.logRealtime && console.info(
-      `[backend] CREATE REALTIME NAMESPACE: '${this.core.socketBE.path()}' , path: '${nspPathRealtime.pathname}' `
-    );
-    this.core.socketBE.on("connection", (backendSocketForClient) => {
-      this.core.ctx.logRealtime && console.info(
-        `[backend] client connected to namespace "${nspPathRealtime.pathname}",  host: ${this.core.ctx.host}`
-      );
-      backendSocketForClient.on(
-        Symbols__NS__REALTIME.ROOM_SUBSCRIBE_CUSTOM(this.core.ctx.contextName),
-        (roomName) => {
-          this.core.ctx.logRealtime && console.info(
-            `Joining room ${roomName} in namespace  REALTIME host: ${this.core.ctx.contextName}/${this.core.ctx.host}`
-          );
-          backendSocketForClient.join(roomName);
+    //#endregion
+    //#region methods & getters / trigger changes
+    // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+    triggerChanges(entityObjOrClass, property, valueOfUniqueProperty, customEvent, customEventData) {
+        // console.log('customEventData', customEventData);
+        // console.info('__triger entity changes');
+        //#region @websql
+        let roomName;
+        if (this.core.ctx.disabledRealtime || this.core.ctx.isRemoteHost) {
+            return;
         }
-      );
-      backendSocketForClient.on(
-        Symbols__NS__REALTIME.ROOM_SUBSCRIBE_ENTITY_UPDATE_EVENTS(
-          this.core.ctx.contextName
-        ),
-        (roomName) => {
-          this.core.ctx.logRealtime && console.info(
-            `[backend] Joining room ${roomName} in namespace  REALTIME host: ${this.core.ctx.contextName}/${this.core.ctx.host}`
-          );
-          backendSocketForClient.join(roomName);
+        if (customEvent) {
+            roomName = Symbols__NS__REALTIME.ROOM_NAME_CUSTOM(this.core.ctx.contextName, customEvent);
         }
-      );
-      backendSocketForClient.on(
-        Symbols__NS__REALTIME.ROOM_SUBSCRIBE_ENTITY_PROPERTY_UPDATE_EVENTS(
-          this.core.ctx.contextName
-        ),
-        (roomName) => {
-          this.core.ctx.logRealtime && console.info(
-            `[backend] Joining room ${roomName} in namespace REALTIME  host: ${this.core.ctx.contextName}/${this.core.ctx.host}`
-          );
-          backendSocketForClient.join(roomName);
+        else {
+            let entityFn = entityObjOrClass;
+            const entityIsObject = !___NS__isFunction(entityObjOrClass) && ___NS__isObject(entityObjOrClass);
+            if (entityIsObject) {
+                entityFn = ClassHelpers__NS__getClassFnFromObject(entityObjOrClass);
+            }
+            const uniqueKey = ClassHelpers__NS__getUniqueKey(entityFn);
+            if (entityIsObject) {
+                valueOfUniqueProperty = entityObjOrClass[uniqueKey];
+            }
+            if (!valueOfUniqueProperty) {
+                Helpers__NS__error(`[Taon][Realtime] Entity without iD ! ${ClassHelpers__NS__getName(entityFn)} `, true, true);
+                return;
+            }
+            roomName = ___NS__isString(property)
+                ? Symbols__NS__REALTIME.ROOM_NAME_UPDATE_ENTITY_PROPERTY(this.core.ctx.contextName, ClassHelpers__NS__getName(entityFn), property, valueOfUniqueProperty)
+                : Symbols__NS__REALTIME.ROOM_NAME_UPDATE_ENTITY(this.core.ctx.contextName, ClassHelpers__NS__getName(entityFn), valueOfUniqueProperty);
+        }
+        this.core.socketBE.in(roomName).emit(roomName, // roomName == eventName in room na
+        customEvent ? customEventData : '');
+        //#endregion
+    }
+    //#endregion
+    //#region entity changes
+    //#region methods & getters / trigger entity changes
+    triggerEntityChanges(entityObjOrClass, 
+    /**
+     * value of unique key property of entity instance
+     * (this value is not needed if entityObjOrClass is instance of entity)
+     */
+    idToTrigger) {
+        if (this.core.ctx.disabledRealtime) {
+            const className = ClassHelpers__NS__getName(entityObjOrClass);
+            console.warn(`[Taon][TriggerEntityChanges] Entity "${className}' is not realtime`);
+            return;
         }
-      );
-      backendSocketForClient.on(
-        Symbols__NS__REALTIME.ROOM_UNSUBSCRIBE_CUSTOM(this.core.ctx.contextName),
-        (roomName) => {
-          this.core.ctx.logRealtime && console.info(
-            `[backend] Leaving room ${roomName} in namespace  REALTIME host: ${this.core.ctx.contextName}/${this.core.ctx.host}`
-          );
-          backendSocketForClient.leave(roomName);
+        this.triggerChanges(entityObjOrClass, void 0, idToTrigger);
+    }
+    //#endregion
+    //#region methods & getters / trigger entity property changes
+    triggerEntityPropertyChanges(entityObjOrClass, 
+    /**
+     * property name or array of property names that changed
+     * for entity instance
+     */
+    property, 
+    /**
+     * value of unique key property of entity instance
+     * (this value is not needed if entityObjOrClass is instance of entity)
+     */
+    idToTrigger) {
+        if (this.core.ctx.disabledRealtime) {
+            const className = ClassHelpers__NS__getName(entityObjOrClass);
+            console.warn(`[Taon][TriggerEntityPropertyChanges][property=${property}] Entity "${className}' is not realtime`);
+            return;
         }
-      );
-      backendSocketForClient.on(
-        Symbols__NS__REALTIME.ROOM_UNSUBSCRIBE_ENTITY_UPDATE_EVENTS(
-          this.core.ctx.contextName
-        ),
-        (roomName) => {
-          this.core.ctx.logRealtime && console.info(
-            `[backend] Leaving room ${roomName} in namespace REALTIME  host: ${this.core.ctx.contextName}/${this.core.ctx.host}`
-          );
-          backendSocketForClient.leave(roomName);
+        if (___NS__isArray(property)) {
+            property.forEach(propertyFromArr => {
+                this.triggerChanges(entityObjOrClass, propertyFromArr, idToTrigger);
+            });
         }
-      );
-      backendSocketForClient.on(
-        Symbols__NS__REALTIME.ROOM_UNSUBSCRIBE_ENTITY_PROPERTY_UPDATE_EVENTS(
-          this.core.ctx.contextName
-        ),
-        (roomName) => {
-          this.core.ctx.logRealtime && console.info(
-            `[backend] Leaving room ${roomName} in namespace REALTIME  host: ${this.core.ctx.contextName}/${this.core.ctx.host}`
-          );
-          backendSocketForClient.leave(roomName);
+        else {
+            this.triggerChanges(entityObjOrClass, property, idToTrigger);
         }
-      );
-    });
-  }
-  //#endregion
-  //#region methods & getters / trigger changes
-  // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
-  triggerChanges(entityObjOrClass, property, valueOfUniqueProperty, customEvent, customEventData) {
-    let roomName;
-    if (this.core.ctx.disabledRealtime || this.core.ctx.isRemoteHost) {
-      return;
-    }
-    if (customEvent) {
-      roomName = Symbols__NS__REALTIME.ROOM_NAME_CUSTOM(
-        this.core.ctx.contextName,
-        customEvent
-      );
-    } else {
-      let entityFn = entityObjOrClass;
-      const entityIsObject = !___NS__isFunction(entityObjOrClass) && ___NS__isObject(entityObjOrClass);
-      if (entityIsObject) {
-        entityFn = ClassHelpers__NS__getClassFnFromObject(entityObjOrClass);
-      }
-      const uniqueKey = ClassHelpers__NS__getUniqueKey(entityFn);
-      if (entityIsObject) {
-        valueOfUniqueProperty = entityObjOrClass[uniqueKey];
-      }
-      if (!valueOfUniqueProperty) {
-        Helpers__NS__error(
-          `[Taon][Realtime] Entity without iD ! ${ClassHelpers__NS__getName(
-            entityFn
-          )} `,
-          true,
-          true
-        );
-        return;
-      }
-      roomName = ___NS__isString(property) ? Symbols__NS__REALTIME.ROOM_NAME_UPDATE_ENTITY_PROPERTY(
-        this.core.ctx.contextName,
-        ClassHelpers__NS__getName(entityFn),
-        property,
-        valueOfUniqueProperty
-      ) : Symbols__NS__REALTIME.ROOM_NAME_UPDATE_ENTITY(
-        this.core.ctx.contextName,
-        ClassHelpers__NS__getName(entityFn),
-        valueOfUniqueProperty
-      );
     }
-    this.core.socketBE.in(roomName).emit(
-      roomName,
-      // roomName == eventName in room na
-      customEvent ? customEventData : ""
-    );
-  }
-  //#endregion
-  //#region entity changes
-  //#region methods & getters / trigger entity changes
-  triggerEntityChanges(entityObjOrClass, idToTrigger) {
-    if (this.core.ctx.disabledRealtime) {
-      const className = ClassHelpers__NS__getName(entityObjOrClass);
-      console.warn(
-        `[Taon][TriggerEntityChanges] Entity "${className}' is not realtime`
-      );
-      return;
-    }
-    this.triggerChanges(entityObjOrClass, void 0, idToTrigger);
-  }
-  //#endregion
-  //#region methods & getters / trigger entity property changes
-  triggerEntityPropertyChanges(entityObjOrClass, property, idToTrigger) {
-    if (this.core.ctx.disabledRealtime) {
-      const className = ClassHelpers__NS__getName(entityObjOrClass);
-      console.warn(
-        `[Taon][TriggerEntityPropertyChanges][property=${property}] Entity "${className}' is not realtime`
-      );
-      return;
+    //#endregion
+    //#region methods & getters / trigger entity table changes
+    triggerEntityTableChanges(entityClassOrInstance) {
+        const className = ClassHelpers__NS__getName(entityClassOrInstance);
+        if (this.core.ctx.disabledRealtime) {
+            console.warn(`[Taon][TriggerEntityTableChanges] Entity "${className}' is not realtime`);
+            return;
+        }
+        this.triggerChanges(entityClassOrInstance, void 0, void 0, Symbols__NS__REALTIME.TABLE_CHANGE(this.core.ctx.contextName, className));
     }
-    if (___NS__isArray(property)) {
-      property.forEach((propertyFromArr) => {
-        this.triggerChanges(
-          entityObjOrClass,
-          propertyFromArr,
-          idToTrigger
-        );
-      });
-    } else {
-      this.triggerChanges(entityObjOrClass, property, idToTrigger);
+    //#endregion
+    //#endregion
+    //#region custom changes
+    //#region methods & getters / trigger custom event
+    triggerCustomEvent(customEvent, dataToPush) {
+        this.triggerChanges(void 0, void 0, void 0, customEvent, dataToPush);
     }
-  }
-  //#endregion
-  //#region methods & getters / trigger entity table changes
-  triggerEntityTableChanges(entityClassOrInstance) {
-    const className = ClassHelpers__NS__getName(entityClassOrInstance);
-    if (this.core.ctx.disabledRealtime) {
-      console.warn(
-        `[Taon][TriggerEntityTableChanges] Entity "${className}' is not realtime`
-      );
-      return;
+    //#endregion
+    //#region methods & getters / listen custom events from users
+    /**
+     * Listen to custom events from users
+     * @param customEvent  global event name
+     */
+    listenChangesCustomEvent(customEvent) {
+        //#region @websqlFunc
+        const sub = new Subject();
+        this.core.socketBE.on('connection', backendSocketForClient => {
+            backendSocketForClient.on(customEvent, (data, ...args) => {
+                sub.next(data);
+            });
+        });
+        return sub.asObservable();
+        //#endregion
     }
-    this.triggerChanges(
-      entityClassOrInstance,
-      void 0,
-      void 0,
-      Symbols__NS__REALTIME.TABLE_CHANGE(this.core.ctx.contextName, className)
-    );
-  }
-  //#endregion
-  //#endregion
-  //#region custom changes
-  //#region methods & getters / trigger custom event
-  triggerCustomEvent(customEvent, dataToPush) {
-    this.triggerChanges(void 0, void 0, void 0, customEvent, dataToPush);
-  }
-  //#endregion
-  //#region methods & getters / listen custom events from users
-  /**
-   * Listen to custom events from users
-   * @param customEvent  global event name
-   */
-  listenChangesCustomEvent(customEvent) {
-    const sub = new Subject();
-    this.core.socketBE.on("connection", (backendSocketForClient) => {
-      backendSocketForClient.on(customEvent, (data, ...args) => {
-        sub.next(data);
-      });
-    });
-    return sub.asObservable();
-  }
-  //#endregion
-  //#endregion
 }
-export {
-  RealtimeServer
-};

package/lib-prod/realtime/realtime-strategy/index.js

@@ -1,4 +1,4 @@
-export * from "./realtime-strategy";
-export * from "./realtime-strategy-ipc";
-export * from "./realtime-strategy-mock";
-export * from "./realtime-strategy-socket-io";
+export * from './realtime-strategy';
+export * from './realtime-strategy-ipc';
+export * from './realtime-strategy-mock';
+export * from './realtime-strategy-socket-io';