@magic-xpa/engine 4.1300.0-dev4130.142 → 4.1300.0-dev4130.145

package/package.json

@@ -1,13 +1,15 @@
 {
   "name": "@magic-xpa/engine",
-  "version": "4.1300.0-dev4130.142",
+  "version": "4.1300.0-dev4130.145",
   "description": "magic engine package",
   "license": "SEE LICENSE IN EULA.pdf",
   "dependencies": {
-    "@magic-xpa/mscorelib": "4.1300.0-dev4130.142",
-    "@magic-xpa/utils": "4.1300.0-dev4130.142",
-    "@magic-xpa/gui": "4.1300.0-dev4130.142",
+    "@magic-xpa/mscorelib": "4.1300.0-dev4130.145",
+    "@magic-xpa/utils": "4.1300.0-dev4130.145",
+    "@magic-xpa/gui": "4.1300.0-dev4130.145",
     "@angular/common": "^21.1.4",
+    "socket.io": "^4.8.3",
+    "socket.io-client": "^4.8.3",
     "tslib": "^2.3.0"
   },
   "module": "fesm2022/magic-xpa-engine.mjs",

package/types/magic-xpa-engine.d.ts

@@ -3,7 +3,7 @@ import { StringBuilder, List, RefParam, IComparable, Dictionary, Stack, Applicat
 import { StorageAttribute, XmlParser, CallOperationMode, MgControlType, TableBehaviour, LnkEval_Cond, LnkMode, UniqueTskSort, ForceExit, Priority, ViewRefreshMode, Logger_LogLevels, Order } from '@magic-xpa/utils';
 import { Subject } from 'rxjs/internal/Subject';
 import { HttpClient, HttpHeaders, HttpResponse } from '@angular/common/http';
-import { Subject as Subject$1 } from 'rxjs';
+import { Subject as Subject$1, Observable } from 'rxjs';
 
 declare enum EventSubType {
     Normal = 0,
@@ -3736,6 +3736,7 @@ declare class EventsManager implements IEventsManager {
     AddRouteEvent(task: ITask, code: number, routerpath: string, routerOutletName: string, routeParams: List<any>): void;
     AddRouterClosedEvent(task: Task): void;
     AddLastSavedRouteEvent(srcTask: Task, args: ArgumentsList): void;
+    AddTopicPublishedEvent(task: ITask, topic: string, message: string): void;
     AddExternalValueEvent(ctrl: MgControl, value: any, refreshDisplay: boolean): void;
     addGuiTriggeredEventWithCtrlAndCodeAndLine(ctrl: MgControlBase, code: number, line: number): void;
     addGuiTriggeredEventWithCtrlAndLineAndCodeAndIsProductClick(ctrl: MgControlBase, code: number, line: number, isProduceClick: boolean): void;
@@ -4630,10 +4631,88 @@ declare class Scrambler {
     static UnScramble(inVal: string, beginOffSet: number, endOffSet: number): string;
 }
 
+declare class SubscriberClient {
+    private static instance;
+    private socket;
+    private subscribedTopics;
+    private messageSubject;
+    private subscriptionsDataSubject;
+    private constructor();
+    /**
+     * Get the singleton instance of SubscriberClient
+     */
+    static getInstance(task: TaskBase): SubscriberClient;
+    /**
+     * Subscribe to a specific topic
+     * @param topic The topic to subscribe to
+     */
+    subscribe(topic: string): void;
+    /**
+     * Subscribe to multiple topics at once
+     * @param topics Array of topics to subscribe to
+     */
+    subscribeToTopics(topics: string[]): void;
+    /**
+     * Unsubscribe from a specific topic
+     * @param topic The topic to unsubscribe from
+     */
+    unsubscribe(topic: string): void;
+    /**
+     * Unsubscribe from multiple topics at once
+     * @param topics Array of topics to unsubscribe from
+     */
+    unsubscribeFromTopics(topics: string[]): void;
+    /**
+     * Unsubscribe from all topics
+     */
+    unsubscribeFromAll(): void;
+    /**
+     * Check if subscribed to a specific topic
+     * @param topic The topic to check
+     * @returns true if subscribed, false otherwise
+     */
+    isSubscribed(topic: string): boolean;
+    /**
+     * Get all currently subscribed topics
+     * @returns Array of subscribed topics
+     */
+    getSubscribedTopics(): string[];
+    /**
+     * Get an Observable for incoming messages from all subscribed topics
+     * @returns Observable that emits message data
+     */
+    onMessage(): Observable<{
+        topic: string;
+        message: any;
+    }>;
+    /**
+     * Get an Observable for incoming messages from a specific topic
+     * @param topic The topic to filter messages for
+     * @returns Observable that emits message data for the specified topic
+     */
+    onMessageForTopic(topic: string): Observable<{
+        topic: string;
+        message: any;
+    }>;
+    /**
+     * Get current subscriptions (for debugging)
+     */
+    getSubscriptions(): void;
+    /**
+     * Listen for subscriptions data
+     * @returns Observable that emits subscriptions list
+     */
+    onSubscriptionsData(): Observable<any[]>;
+    /**
+     * Disconnect from the server
+     */
+    disconnect(): void;
+}
+
 declare class UniqueIDUtils {
     private static id;
     static GetUniqueMachineID(): string;
 }
 
-export { AbortCommand, AccessHelper, ActionManager, AddLocateCommand, AddRangeCommand, AddSortCommand, AddUserLocateDataViewCommand, AddUserLocateRemoteDataViewCommand, AddUserRangeDataviewCommand, AddUserRangeRemoteDataViewCommand, AddUserSortDataViewCommand, AddUserSortRemoteDataViewCommand, Argument, ArgumentsList, Boundary, BrowserEscEventCommand, CachedFileQueryCommand, ClearEventsOnStopExecution, ClientManager, ClientOriginatedCommand, ClientOriginatedCommandSerializer, ClientOriginatedCommandTaskTag, ClientRefreshCommand, ClientTargetedCommandBase, ClientTargetedCommandType, ColumnSortEventCommand, CommandFactory, CommandSerializationHelper, CommandsProcessorBase, CommandsProcessorBase_SendingInstruction, CommandsProcessorBase_SessionStage, CommandsProcessorManager, CommandsTable, CompMainPrgTable, ComputeEventCommand, ConstInterface, ConstUtils, ContextTerminationEventCommand, ContextTimeoutResetCommand, ControlItemsRefreshCommand, CookieService, CreatedFormVector, CurrentClientVersion, DataSourceIdKey, DataView, DataViewBase, DataViewCommandBase, DataViewCommandType, DataViewOutputCommand, DataviewCommand, DataviewHeaderBase, DataviewHeaderFactory, DataviewHeaders, DataviewHeadersSaxHandler, DataviewManager, DataviewManagerBase, DcValuesReference, DummyDataViewCommand, DvCache, EnhancedVerifyCommand, EnvParamsTable, Environment, EnvironmentDetails, EvaluateCommand, Event, EventCommand, EventHandler, EventHandlerPosition, EventSubType, EventsAllowedType, EventsManager, ExecOperCommand, ExecutionStack, ExecutionStackEntry, ExpDesc, ExpStrTracker, ExpTable, Expression, ExpressionDict, ExpressionEvaluator, ExpressionLocalJpn, Expression_ReturnValue, FetchDataControlValuesEventCommand, Field, FieldBase, FieldsTable as FieldsTableExt, FlowMonitorInterface, FlowMonitorQueue, FormsTable, GUIManager, GlobalCommandsManager, GlobalParams, GlobalParamsQueryCommand, GuiEventsProcessor, HandlersTable, HeapSort, HttpClientAsync, HttpClientBase, HttpClientEvents, HttpClientSync, HttpManager, HttpUtility, IClientTargetedCommand, IndexChangeEventCommand, IniputForceWriteCommand, InteractiveCommunicationsFailureHandler, Key, LanguageData, LastFocusedManager, MGData, MGDataCollection, MagicBridge, MgControl, MgForm, MgPriorityBlockingQueue, MgPriorityQueue, MirrorExpVal, MirrorPrmMap, MirrorString, NonReversibleExitEventCommand, NullValueException, OpenURLCommand, OpeningTaskDetails, Operation, OperationTable, ParamParseResult, PrmMap, QueryCommand, RCTimer, Recompute, RecomputeCommand, RecomputeTable, Recompute_RcmpBy, Record, RecordOutOfDataViewException, RecordOutOfDataViewException_ExceptionType, RecordsTable, RefreshEventCommand, RefreshScreenEventCommand, RemoteCommandsProcessor, RemoteControlItemsRefreshCommand, RemoteDataViewCommandBase, RemoteDataViewCommandFactory, RemoteDataViewCommandUpdateNonModifiable, RemoteDataviewHeader, RemoteDataviewManager, RemoteTaskService, RequestMethod, ResetLocateCommand, ResetRangeCommand, ResetSortCommand, ResetUserLocateRemoteDataviewCommand, ResetUserRangeRemoteDataviewCommand, ResetUserSortRemoteDataviewCommand, ResultCommand, ResultValue, RetVals, ReturnResult, ReturnResultBase, RollbackEventCommand, RollbackEventCommand_RollbackType, RunTimeEvent, RunTimeEventBase, SET_DISPLAYLINE_BY_DV, Scrambler, SelectProgramCommand, ServerConfig, ServerError, SetTransactionStateDataviewCommand, SetTransactionStateRemoteDataViewCommand, Sort, SortCollection, SubformOpenEventCommand, SubformRefreshEventCommand, TableCache, TableCacheManager, Task, TaskBase, TaskServiceBase, TaskTransactionManager, Task_Direction, Task_Flow, Task_SubformExecModeEnum, TasksTable, Transaction, TransactionCommand, UniqueIDUtils, UnloadCommand, UserDetails, UserEventsTable, UserRange, VerifyCommand, WriteMessageToServerLogCommand, XMLBasedCommandBuilder, XMLBasedDcValuesBuilder, YesNoExp, getGuiEventObj };
+export { AbortCommand, AccessHelper, ActionManager, AddLocateCommand, AddRangeCommand, AddSortCommand, AddUserLocateDataViewCommand, AddUserLocateRemoteDataViewCommand, AddUserRangeDataviewCommand, AddUserRangeRemoteDataViewCommand, AddUserSortDataViewCommand, AddUserSortRemoteDataViewCommand, Argument, ArgumentsList, Boundary, BrowserEscEventCommand, CachedFileQueryCommand, ClearEventsOnStopExecution, ClientManager, ClientOriginatedCommand, ClientOriginatedCommandSerializer, ClientOriginatedCommandTaskTag, ClientRefreshCommand, ClientTargetedCommandBase, ClientTargetedCommandType, ColumnSortEventCommand, CommandFactory, CommandSerializationHelper, CommandsProcessorBase, CommandsProcessorBase_SendingInstruction, CommandsProcessorBase_SessionStage, CommandsProcessorManager, CommandsTable, CompMainPrgTable, ComputeEventCommand, ConstInterface, ConstUtils, ContextTerminationEventCommand, ContextTimeoutResetCommand, ControlItemsRefreshCommand, CookieService, CreatedFormVector, CurrentClientVersion, DataSourceIdKey, DataView, DataViewBase, DataViewCommandBase, DataViewCommandType, DataViewOutputCommand, DataviewCommand, DataviewHeaderBase, DataviewHeaderFactory, DataviewHeaders, DataviewHeadersSaxHandler, DataviewManager, DataviewManagerBase, DcValuesReference, DummyDataViewCommand, DvCache, EnhancedVerifyCommand, EnvParamsTable, Environment, EnvironmentDetails, EvaluateCommand, Event, EventCommand, EventHandler, EventHandlerPosition, EventSubType, EventsAllowedType, EventsManager, ExecOperCommand, ExecutionStack, ExecutionStackEntry, ExpDesc, ExpStrTracker, ExpTable, Expression, ExpressionDict, ExpressionEvaluator, ExpressionLocalJpn, Expression_ReturnValue, FetchDataControlValuesEventCommand, Field, FieldBase, FieldsTable as FieldsTableExt, FlowMonitorInterface, FlowMonitorQueue, FormsTable, GUIManager, GlobalCommandsManager, GlobalParams, GlobalParamsQueryCommand, GuiEventsProcessor, HandlersTable, HeapSort, HttpClientAsync, HttpClientBase, HttpClientEvents, HttpClientSync, HttpManager, HttpUtility, IClientTargetedCommand, IndexChangeEventCommand, IniputForceWriteCommand, InteractiveCommunicationsFailureHandler, Key, LanguageData, LastFocusedManager, MGData, MGDataCollection, MagicBridge, MgControl, MgForm, MgPriorityBlockingQueue, MgPriorityQueue, MirrorExpVal, MirrorPrmMap, MirrorString, NonReversibleExitEventCommand, NullValueException, OpenURLCommand, OpeningTaskDetails, Operation, OperationTable, ParamParseResult, PrmMap, QueryCommand, RCTimer, Recompute, RecomputeCommand, RecomputeTable, Recompute_RcmpBy, Record, RecordOutOfDataViewException, RecordOutOfDataViewException_ExceptionType, RecordsTable, RefreshEventCommand, RefreshScreenEventCommand, RemoteCommandsProcessor, RemoteControlItemsRefreshCommand, RemoteDataViewCommandBase, RemoteDataViewCommandFactory, RemoteDataViewCommandUpdateNonModifiable, RemoteDataviewHeader, RemoteDataviewManager, RemoteTaskService, RequestMethod, ResetLocateCommand, ResetRangeCommand, ResetSortCommand, ResetUserLocateRemoteDataviewCommand, ResetUserRangeRemoteDataviewCommand, ResetUserSortRemoteDataviewCommand, ResultCommand, ResultValue, RetVals, ReturnResult, ReturnResultBase, RollbackEventCommand, RollbackEventCommand_RollbackType, RunTimeEvent, RunTimeEventBase, SET_DISPLAYLINE_BY_DV, Scrambler, SelectProgramCommand, ServerConfig, ServerError, SetTransactionStateDataviewCommand, SetTransactionStateRemoteDataViewCommand, Sort, SortCollection, SubformOpenEventCommand, SubformRefreshEventCommand, SubscriberClient, TableCache, TableCacheManager, Task, TaskBase, TaskServiceBase, TaskTransactionManager, Task_Direction, Task_Flow, Task_SubformExecModeEnum, TasksTable, Transaction, TransactionCommand, UniqueIDUtils, UnloadCommand, UserDetails, UserEventsTable, UserRange, VerifyCommand, WriteMessageToServerLogCommand, XMLBasedCommandBuilder, XMLBasedDcValuesBuilder, YesNoExp, getGuiEventObj };
 export type { IClientCommand, IClientToServerCommandInfo, ICommandTaskTag, ICommandsTable, ICommunicationsFailureHandler, IConnectionStateManager, IDataSourceViewDefinition, IDataviewHeader, IEventsManager, IGuiEvent, ILanguageData, IMGDataCollection, IMirrorXML, IRecordsTable, IResultValue, IServerConfig, MgBlockingQueue };