@magic-xpa/engine 4.1300.0-dev4130.30 → 4.1300.0-dev4130.301

package/package.json

@@ -1,13 +1,15 @@
 {
   "name": "@magic-xpa/engine",
-  "version": "4.1300.0-dev4130.30",
+  "version": "4.1300.0-dev4130.301",
   "description": "magic engine package",
   "license": "SEE LICENSE IN EULA.pdf",
   "dependencies": {
-    "@magic-xpa/mscorelib": "4.1300.0-dev4130.30",
-    "@magic-xpa/utils": "4.1300.0-dev4130.30",
-    "@magic-xpa/gui": "4.1300.0-dev4130.30",
-    "@angular/common": "^21.1.3",
+    "@magic-xpa/mscorelib": "4.1300.0-dev4130.301",
+    "@magic-xpa/utils": "4.1300.0-dev4130.301",
+    "@magic-xpa/gui": "4.1300.0-dev4130.301",
+    "@angular/common": "^22.1.1",
+    "socket.io": "^4.8.3",
+    "socket.io-client": "^4.8.3",
     "tslib": "^2.3.0"
   },
   "module": "fesm2022/magic-xpa-engine.mjs",
@@ -22,6 +24,7 @@
     }
   },
   "sideEffects": false,
+  "type": "module",
   "scripts": {
     "prepublishOnly": "node --eval \"console.error('ERROR: Trying to publish a package that has been compiled in full compilation mode. This is not allowed.\\nPlease delete and rebuild the package with partial compilation mode, before attempting to publish.\\n')\" && exit 1"
   }

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

@@ -4,6 +4,7 @@ import { StorageAttribute, XmlParser, CallOperationMode, MgControlType, TableBeh
 import { Subject } from 'rxjs/internal/Subject';
 import { HttpClient, HttpHeaders, HttpResponse } from '@angular/common/http';
 import { Subject as Subject$1 } from 'rxjs';
+import { Socket } from 'socket.io-client';
 
 declare enum EventSubType {
     Normal = 0,
@@ -2733,6 +2734,8 @@ declare class ConstInterface {
     static MG_ATTR_SPECIAL_REUSE_TABLE_EDITOR: string;
     static MG_TAG_LAST_ROUTE: string;
     static RC_TOKEN_CACHED_FILE: string;
+    static MG_TAG_PUBSUB_SERVER_URI: string;
+    static WC_TOKEN_PUBSUB_SUBSCRIBE: string;
 }
 
 declare let CurrentClientVersion: string;
@@ -3512,6 +3515,7 @@ declare class Environment implements IEnvironment {
     private _dropUserFormats;
     private _webclientReinitSession;
     private _specialValNewPolicy;
+    private _pubsubServerURI;
     static Instance: Environment;
     get Language(): string;
     IgnoreReplaceDecimalSeparator: boolean;
@@ -3578,6 +3582,7 @@ declare class Environment implements IEnvironment {
     GetDropUserFormats(): string;
     GetSpecialValNewPolicy(): boolean;
     GetSpecialCancelOnCreate(): boolean;
+    GetPubSubServerURI(): string;
 }
 declare class EnvironmentDetails {
     private _createInModifyMode;
@@ -3733,6 +3738,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;
@@ -3939,6 +3945,70 @@ declare class ExpressionEvaluator extends GuiExpressionEvaluator {
     private eval_op_time_brk;
     private eval_op_addDateTime;
     private eval_op_difdt;
+    /**
+     * Safely extracts date/time parts from a JS Date using Intl.DateTimeFormat.
+     *
+     * WHY: Native JS Date has known pitfalls — century year bug (year < 100 mapped to 1900+year),
+     * silent leap year rollovers, DST gaps, and 0-based months. Intl.DateTimeFormat avoids all
+     * of these by using the browser's IANA timezone database internally.
+     *
+     * Used by both eval_op_localToUTC and eval_op_utcToLocal as a single safe extraction point.
+     *
+     * @param date     - A valid JS Date object
+     * @param timeZone - IANA timezone string (e.g. 'Asia/Kolkata', 'UTC').
+     *                   Defaults to browser's local timezone — correct for any user, any country.
+     * @returns Parsed parts (month is 1-based) or null if date is invalid
+     */
+    private convertDateTimeParts;
+    /**
+     * Validates that a time value (in total seconds) is within a valid day range
+     */
+    private isValidTimeSec;
+    /**
+     * Splits total seconds since midnight into hours, minutes, seconds.
+     * e.g. 3661 → { hours: 1, minutes: 1, seconds: 1 }
+     */
+    private splitTimeSec;
+    /**
+     * Writes a time (seconds) and date (Magic numeric) into their respective output fields.
+     */
+    private writeDateTimeToFields;
+    /**
+     * Converts local date/time to UTC and writes the result into output fields.
+     *
+     * Edge cases handled:
+     *  - Century years  — setFullYear() avoids JS year < 100 bug
+     *  - Leap years     — round-trip validation catches silent date rollovers
+     *  - DST gaps       — Intl.DateTimeFormat resolves correctly per IANA tz rules
+     *  - DST ambiguity  — Intl uses first occurrence consistently
+     *  - Cross-midnight — JS Date handles automatically
+     *  - Out-of-range   — time < 0 or > 86399 explicitly rejected
+     *
+     * @param resVal       - Output: Boolean result (true = success)
+     * @param localTimeVal - Input: Local time as total seconds since midnight (Magic numeric)
+     * @param localDateVal - Input: Local date as Magic numeric
+     * @param utcTimeVar   - Input: Field index for the UTC time output field
+     * @param utcDateVar   - Input: Field index for the UTC date output field
+     */
+    private eval_op_localToUTC;
+    /**
+     * Converts UTC date/time to local and writes the result into output fields.
+     *
+     * Edge cases handled:
+     *  - Century years  — Date.UTC() does not have the year < 100 bug
+     *  - Leap years     — round-trip validation catches silent date rollovers
+     *  - DST gaps       — Intl.DateTimeFormat resolves to correct local time automatically
+     *  - DST ambiguity  — Intl uses first occurrence consistently
+     *  - Cross-midnight — JS Date handles automatically
+     *  - Out-of-range   — time < 0 or > 86399 explicitly rejected
+     *
+     * @param resVal       - Output: Boolean result (true = success)
+     * @param utcTimeVal   - Input: UTC time as total seconds since midnight (Magic numeric)
+     * @param utcDateVal   - Input: UTC date as Magic numeric
+     * @param localTimeVar - Input: Field index for the local time output field
+     * @param localDateVar - Input: Field index for the local date output field
+     */
+    private eval_op_utcToLocal;
     private eval_op_ndow;
     private eval_op_nmonth;
     mul_add(num: NUM_TYPE, mul: number, add: number): NUM_TYPE;
@@ -4040,9 +4110,13 @@ declare class ExpressionEvaluator extends GuiExpressionEvaluator {
     eval_op_get_cookie(cookieName: string, resVal: ExpVal): void;
     eval_op_delete_cookie(cookieName: string, resVal: ExpVal): void;
     eval_op_route_get(resVal: ExpVal): void;
+    eval_op_route_param_count_get(resVal: ExpVal): void;
+    eval_op_route_param_get(val1: ExpVal, resVal: ExpVal): void;
     private params2arguments;
     private eval_op_Hash;
     private toWordArray;
+    private eval_op_Subscribe;
+    private eval_op_UnSubscribe;
 }
 declare class NullValueException extends Exception {
     private _attr;
@@ -4273,6 +4347,8 @@ declare class RemoteCommandsProcessor extends CommandsProcessorBase {
     PrepareRequest(serializeTasks: boolean): Promise<string>;
     ProcessResponse(response: string, currMgdID: number, openingTaskDetails: OpeningTaskDetails, res: IResultValue): Promise<void>;
     ProcessRecovery(): Promise<void>;
+    GetSubscriptionTokenFromServer(topics: string[]): Promise<string>;
+    SubscribeTopics(topics: Set<string>, socket: Socket): Promise<void>;
 }
 
 declare class RemoteControlItemsRefreshCommand extends RemoteDataViewCommandBase {
@@ -4625,10 +4701,43 @@ declare class Scrambler {
     static UnScramble(inVal: string, beginOffSet: number, endOffSet: number): string;
 }
 
+declare class SubscriberClient {
+    private static instance;
+    private socket;
+    private subscribedTopics;
+    static SubscribeTopics_Event: (topics: Set<string>, socket: Socket) => Promise<void>;
+    private constructor();
+    /**
+     * Get the singleton instance of SubscriberClient
+     */
+    static getInstance(task: TaskBase): SubscriberClient;
+    /**
+     * Subscribe to multiple topics at once
+     * @param topics Array of topics to subscribe to
+     */
+    subscribe(topics: string[], token: string): void;
+    /**
+     * Unsubscribe from multiple topics at once
+     * @param topics Array of topics to unsubscribe from
+     */
+    unsubscribe(topics: string[]): void;
+    /**
+     * Unsubscribe from all topics
+     * TODO: To be called when client explicitly disconnects from the server. Alternately, if middleware receives a disconnect request, it can also unsubscribe from all topics from its own side.
+     */
+    unsubscribeFromAll(): void;
+    /**
+     * Disconnect from the server
+     * TODO: To be called when client explicitly disconnects from the server.
+     */
+    disconnect(): void;
+    static SubscribeTopics(topics: Set<string>, socket: Socket): Promise<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 };