taon 21.0.44 → 21.0.45

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

@@ -0,0 +1,398 @@
+//#region imports
+import { URL } from 'url'; // @backend
+
+import { Observable, Subject } from 'rxjs';
+import { ___NS__add, ___NS__after, ___NS__ary, ___NS__assign, ___NS__assignIn, ___NS__assignInWith, ___NS__assignWith, ___NS__at, ___NS__attempt, ___NS__before, ___NS__bind, ___NS__bindAll, ___NS__bindKey, ___NS__camelCase, ___NS__capitalize, ___NS__castArray, ___NS__ceil, ___NS__chain, ___NS__chunk, ___NS__clamp, ___NS__clone, ___NS__cloneDeep, ___NS__cloneDeepWith, ___NS__cloneWith, ___NS__compact, ___NS__concat, ___NS__cond, ___NS__conforms, ___NS__conformsTo, ___NS__constant, ___NS__countBy, ___NS__create, ___NS__curry, ___NS__curryRight, ___NS__debounce, ___NS__deburr, ___NS__defaults, ___NS__defaultsDeep, ___NS__defaultTo, ___NS__defer, ___NS__delay, ___NS__difference, ___NS__differenceBy, ___NS__differenceWith, ___NS__divide, ___NS__drop, ___NS__dropRight, ___NS__dropRightWhile, ___NS__dropWhile, ___NS__each, ___NS__eachRight, ___NS__endsWith, ___NS__entries, ___NS__entriesIn, ___NS__eq, ___NS__escape, ___NS__escapeRegExp, ___NS__every, ___NS__extend, ___NS__extendWith, ___NS__fill, ___NS__filter, ___NS__find, ___NS__findIndex, ___NS__findKey, ___NS__findLast, ___NS__findLastIndex, ___NS__findLastKey, ___NS__first, ___NS__flatMap, ___NS__flatMapDeep, ___NS__flatMapDepth, ___NS__flatten, ___NS__flattenDeep, ___NS__flattenDepth, ___NS__flip, ___NS__floor, ___NS__flow, ___NS__flowRight, ___NS__forEach, ___NS__forEachRight, ___NS__forIn, ___NS__forInRight, ___NS__forOwn, ___NS__forOwnRight, ___NS__fromPairs, ___NS__functions, ___NS__functionsIn, ___NS__get, ___NS__groupBy, ___NS__gt, ___NS__gte, ___NS__has, ___NS__hasIn, ___NS__head, ___NS__identity, ___NS__includes, ___NS__indexOf, ___NS__initial, ___NS__inRange, ___NS__intersection, ___NS__intersectionBy, ___NS__intersectionWith, ___NS__invert, ___NS__invertBy, ___NS__invoke, ___NS__invokeMap, ___NS__isArguments, ___NS__isArray, ___NS__isArrayBuffer, ___NS__isArrayLike, ___NS__isArrayLikeObject, ___NS__isBoolean, ___NS__isBuffer, ___NS__isDate, ___NS__isElement, ___NS__isEmpty, ___NS__isEqual, ___NS__isEqualWith, ___NS__isError, ___NS__isFinite, ___NS__isFunction, ___NS__isInteger, ___NS__isLength, ___NS__isMap, ___NS__isMatch, ___NS__isMatchWith, ___NS__isNaN, ___NS__isNative, ___NS__isNil, ___NS__isNull, ___NS__isNumber, ___NS__isObject, ___NS__isObjectLike, ___NS__isPlainObject, ___NS__isRegExp, ___NS__isSafeInteger, ___NS__isSet, ___NS__isString, ___NS__isSymbol, ___NS__isTypedArray, ___NS__isUndefined, ___NS__isWeakMap, ___NS__isWeakSet, ___NS__iteratee, ___NS__join, ___NS__kebabCase, ___NS__keyBy, ___NS__keys, ___NS__keysIn, ___NS__last, ___NS__lastIndexOf, ___NS__lowerCase, ___NS__lowerFirst, ___NS__lt, ___NS__lte, ___NS__map, ___NS__mapKeys, ___NS__mapValues, ___NS__matches, ___NS__matchesProperty, ___NS__max, ___NS__maxBy, ___NS__mean, ___NS__meanBy, ___NS__memoize, ___NS__merge, ___NS__mergeWith, ___NS__method, ___NS__methodOf, ___NS__min, ___NS__minBy, ___NS__mixin, ___NS__multiply, ___NS__negate, ___NS__noop, ___NS__now, ___NS__nth, ___NS__nthArg, ___NS__omit, ___NS__omitBy, ___NS__once, ___NS__orderBy, ___NS__over, ___NS__overArgs, ___NS__overEvery, ___NS__overSome, ___NS__pad, ___NS__padEnd, ___NS__padStart, ___NS__parseInt, ___NS__partial, ___NS__partialRight, ___NS__partition, ___NS__pick, ___NS__pickBy, ___NS__property, ___NS__propertyOf, ___NS__pull, ___NS__pullAll, ___NS__pullAllBy, ___NS__pullAllWith, ___NS__pullAt, ___NS__random, ___NS__range, ___NS__rangeRight, ___NS__rearg, ___NS__reduce, ___NS__reduceRight, ___NS__reject, ___NS__remove, ___NS__repeat, ___NS__replace, ___NS__rest, ___NS__result, ___NS__reverse, ___NS__round, ___NS__sample, ___NS__sampleSize, ___NS__set, ___NS__setWith, ___NS__shuffle, ___NS__size, ___NS__slice, ___NS__snakeCase, ___NS__some, ___NS__sortBy, ___NS__sortedIndex, ___NS__sortedIndexBy, ___NS__sortedIndexOf, ___NS__sortedLastIndex, ___NS__sortedLastIndexBy, ___NS__sortedLastIndexOf, ___NS__sortedUniq, ___NS__sortedUniqBy, ___NS__split, ___NS__spread, ___NS__startCase, ___NS__startsWith, ___NS__stubArray, ___NS__stubFalse, ___NS__stubObject, ___NS__stubString, ___NS__stubTrue, ___NS__subtract, ___NS__sum, ___NS__sumBy, ___NS__tail, ___NS__take, ___NS__takeRight, ___NS__takeRightWhile, ___NS__takeWhile, ___NS__tap, ___NS__template, ___NS__templateSettings, ___NS__throttle, ___NS__thru, ___NS__times, ___NS__toArray, ___NS__toFinite, ___NS__toInteger, ___NS__toLength, ___NS__toLower, ___NS__toNumber, ___NS__toPairs, ___NS__toPairsIn, ___NS__toPath, ___NS__toPlainObject, ___NS__toSafeInteger, ___NS__toString, ___NS__toUpper, ___NS__transform, ___NS__trim, ___NS__trimEnd, ___NS__trimStart, ___NS__truncate, ___NS__unary, ___NS__unescape, ___NS__union, ___NS__unionBy, ___NS__unionWith, ___NS__uniq, ___NS__uniqBy, ___NS__uniqueId, ___NS__uniqWith, ___NS__unset, ___NS__unzip, ___NS__unzipWith, ___NS__update, ___NS__updateWith, ___NS__upperCase, ___NS__upperFirst, ___NS__values, ___NS__valuesIn, ___NS__without, ___NS__words, ___NS__wrap, ___NS__xor, ___NS__xorBy, ___NS__xorWith, ___NS__zip, ___NS__zipObject, ___NS__zipObjectDeep, ___NS__zipWith, Helpers__NS___fixCommand, Helpers__NS__bigMaxBuffer, Helpers__NS__checkProcess, Helpers__NS__cleanExit, Helpers__NS__clearConsole, Helpers__NS__command, Helpers__NS__commandOutputAsString, Helpers__NS__commandOutputAsStringAsync, Helpers__NS__compilationWrapper, Helpers__NS__contain, Helpers__NS__createFolder, Helpers__NS__createSymLink, Helpers__NS__error, Helpers__NS__execute, Helpers__NS__exists, Helpers__NS__filesFrom, Helpers__NS__foldersFrom, Helpers__NS__getFilesFrom, Helpers__NS__getFoldersFrom, Helpers__NS__getIsBrowser, Helpers__NS__getIsElectron, Helpers__NS__getIsNode, Helpers__NS__getIsRunningInGitBash, Helpers__NS__getIsSupportedTaonTerminal, Helpers__NS__getIsVerboseMode, Helpers__NS__getIsWebSQL, Helpers__NS__getIsWsl, Helpers__NS__getStdio, Helpers__NS__hideNodeWarnings, Helpers__NS__info, Helpers__NS__isBlob, Helpers__NS__isBuffer, Helpers__NS__isClass, Helpers__NS__isExistedSymlink, Helpers__NS__isFile, Helpers__NS__isFolder, Helpers__NS__isRunningInDocker, Helpers__NS__isRunningInLinuxGraphicsCapableEnvironment, Helpers__NS__isSymlinkFileExitedOrUnexisted, Helpers__NS__isSymlinkThatMatchesUrl, Helpers__NS__isUnexistedLink, Helpers__NS__killOnPort, Helpers__NS__killProcess, Helpers__NS__killProcessByPort, Helpers__NS__linksToFolderFrom, Helpers__NS__linksToFoldersFrom, Helpers__NS__log, Helpers__NS__logError, Helpers__NS__logInfo, Helpers__NS__logProc, Helpers__NS__logSuccess, Helpers__NS__logWarn, Helpers__NS__mediaTypeFromSrc, Helpers__NS__mkdirp, Helpers__NS__modifyLineByLine, Helpers__NS__msgCacheClear, Helpers__NS__openFolderInFileExplorer, Helpers__NS__parse, Helpers__NS__pathContainLink, Helpers__NS__questionYesNo, Helpers__NS__readFile, Helpers__NS__readJson, Helpers__NS__readJson5, Helpers__NS__readJsonC, Helpers__NS__relative, Helpers__NS__remove, Helpers__NS__removeEmptyLineFromString, Helpers__NS__removeFileIfExists, Helpers__NS__removeFolderIfExists, Helpers__NS__removeIfExists, Helpers__NS__removeSlashAtBegin, Helpers__NS__removeSlashAtEnd, Helpers__NS__removeSymlinks, Helpers__NS__renderError, Helpers__NS__replaceLinesInFile, Helpers__NS__run, Helpers__NS__runAsyncIn, Helpers__NS__runSyncIn, Helpers__NS__runSyncOrAsync, Helpers__NS__sleep, Helpers__NS__stopApplication, Helpers__NS__stringify, Helpers__NS__success, Helpers__NS__taskDone, Helpers__NS__taskStarted, Helpers__NS__throwError, Helpers__NS__timeout, Helpers__NS__tryCatchError, Helpers__NS__tryReadFile, Helpers__NS__tryRemoveDir, Helpers__NS__values, Helpers__NS__wait, Helpers__NS__warn, Helpers__NS__writeFile, Helpers__NS__writeJson, Helpers__NS__writeJson5, Helpers__NS__writeJsonC, UtilsOs__NS__commandExistsAsync, UtilsOs__NS__commandExistsSync, UtilsOs__NS__detectEditor, UtilsOs__NS__Editor, UtilsOs__NS__EDITOR_PROCESSES, UtilsOs__NS__EditorArr, UtilsOs__NS__EditorProcess, UtilsOs__NS__getEditorSettingsJsonPath, UtilsOs__NS__getRealHomeDir, UtilsOs__NS__isBrowser, UtilsOs__NS__isDockerAvailable, UtilsOs__NS__isElectron, UtilsOs__NS__isNode, UtilsOs__NS__isNodeVersionOk, UtilsOs__NS__isPortInUse, UtilsOs__NS__isRunningInBrowser, UtilsOs__NS__isRunningInCliMode, UtilsOs__NS__isRunningInDocker, UtilsOs__NS__isRunningInElectron, UtilsOs__NS__isRunningInLinuxGraphicsCapableEnvironment, UtilsOs__NS__isRunningInMochaTest, UtilsOs__NS__isRunningInNode, UtilsOs__NS__isRunningInOsWithGraphicsCapableEnvironment, UtilsOs__NS__isRunningInSSRMode, UtilsOs__NS__isRunningInVscodeExtension, UtilsOs__NS__isRunningInWebSQL, UtilsOs__NS__isRunningInWindows, UtilsOs__NS__isRunningInWindowsCmd, UtilsOs__NS__isRunningInWindowsPowerShell, UtilsOs__NS__isRunningInWsl, UtilsOs__NS__isRunningNodeDebugger, UtilsOs__NS__isSSRMode, UtilsOs__NS__isVscodeExtension, UtilsOs__NS__isWebSQL, UtilsOs__NS__killAllEditor, UtilsOs__NS__openFolderInFileExplorer, UtilsOs__NS__openFolderInVSCode, UtilsOs__NS__pipxNestedPackageExists, UtilsOs__NS__pipxPackageExists, UtilsOs__NS__pythonModuleExists, UtilsOs__NS__UnknownEditor } from 'tnp-core/lib-prod';
+
+import type { TaonBaseEntity } from '../base-classes/base-entity';
+import { ClassHelpers__NS__asyncHandler, ClassHelpers__NS__ensureClassConfig, ClassHelpers__NS__ensureMethodConfig, ClassHelpers__NS__getClassConfig, ClassHelpers__NS__getClassFnFromObject, ClassHelpers__NS__getControllerConfigs, ClassHelpers__NS__getFullInternalName, ClassHelpers__NS__getMethodsNames, ClassHelpers__NS__getName, ClassHelpers__NS__getOrginalClass, ClassHelpers__NS__getUniqueKey, ClassHelpers__NS__hasParentClassWithName, ClassHelpers__NS__isContextClassObject, ClassHelpers__NS__setName } from '../helpers/class-helpers';
+import { Symbols__NS__classMethodsNames, Symbols__NS__classNameStaticProperty, Symbols__NS__ctxInClassOrClassObj, Symbols__NS__fullClassNameStaticProperty, Symbols__NS__metadata, Symbols__NS__old, Symbols__NS__orignalClass, Symbols__NS__orignalClassClonesObj, Symbols__NS__REALTIME } from '../symbols';
+
+import { RealtimeCore } from './realtime-core';
+
+//#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(private core: RealtimeCore) {
+    this.core = core;
+    if (core.ctx.disabledRealtime || this.core.ctx.isRemoteHost) {
+      return;
+    }
+    //#region @websql
+    this.init();
+    //#endregion
+  }
+
+  //#region methods & getters / init
+  private 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
+  }
+  //#endregion
+
+  //#region methods & getters / trigger changes
+  // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+  private triggerChanges(
+    entityObjOrClass: Function | object,
+    property?: string,
+    valueOfUniqueProperty?: number | string,
+    customEvent?: string,
+    customEventData?: any,
+  ) {
+    // console.log('customEventData', customEventData);
+    // console.info('__triger entity changes');
+    //#region @websql
+
+    let roomName: string;
+
+    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 as Function;
+      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
+  public triggerEntityChanges(
+    entityObjOrClass: Function | object,
+    /**
+     * value of unique key property of entity instance
+     * (this value is not needed if entityObjOrClass is instance of entity)
+     */
+    idToTrigger?: number | string,
+  ): void {
+    if (this.core.ctx.disabledRealtime) {
+      const className = ClassHelpers__NS__getName(entityObjOrClass);
+
+      console.warn(
+        `[Taon][TriggerEntityChanges] Entity "${className}' is not realtime`,
+      );
+      return;
+    }
+    this.triggerChanges(entityObjOrClass as any, void 0, idToTrigger);
+  }
+  //#endregion
+
+  //#region methods & getters / trigger entity property changes
+  public triggerEntityPropertyChanges(
+    entityObjOrClass: Function | object,
+    /**
+     * property name or array of property names that changed
+     * for entity instance
+     */
+    property: string | string[],
+    /**
+     * value of unique key property of entity instance
+     * (this value is not needed if entityObjOrClass is instance of entity)
+     */
+    idToTrigger?: number | string,
+  ): void {
+    if (this.core.ctx.disabledRealtime) {
+      const className = ClassHelpers__NS__getName(entityObjOrClass);
+
+      console.warn(
+        `[Taon][TriggerEntityPropertyChanges][property=${
+          property as string
+        }] Entity "${className}' is not realtime`,
+      );
+      return;
+    }
+
+    if (___NS__isArray(property)) {
+      property.forEach(propertyFromArr => {
+        this.triggerChanges(
+          entityObjOrClass,
+          propertyFromArr as any,
+          idToTrigger,
+        );
+      });
+    } else {
+      this.triggerChanges(entityObjOrClass, property as any, idToTrigger);
+    }
+  }
+  //#endregion
+
+  //#region methods & getters / trigger entity table changes
+  public triggerEntityTableChanges(
+    entityClassOrInstance: Function | object,
+  ): void {
+    const className = ClassHelpers__NS__getName(entityClassOrInstance);
+
+    if (this.core.ctx.disabledRealtime) {
+      console.warn(
+        `[Taon][TriggerEntityTableChanges] Entity "${className}' is not realtime`,
+      );
+      return;
+    }
+
+    this.triggerChanges(
+      entityClassOrInstance as any,
+      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
+  public triggerCustomEvent(customEvent: string, dataToPush: any): void {
+    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: string): Observable<any> {
+    //#region @websqlFunc
+    const sub = new Subject<any>();
+
+    this.core.socketBE.on('connection', backendSocketForClient => {
+      backendSocketForClient.on(customEvent, (data, ...args) => {
+        sub.next(data);
+      });
+    });
+
+    return sub.asObservable();
+    //#endregion
+  }
+  //#endregion
+
+  //#endregion
+}

package/lib-prod/realtime/realtime-strategy/{index.d.ts → index.ts}

@@ -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-socket-io';