@magic-xpa/engine 4.1200.0-ec.131.0 → 4.1201.0-dev000.0

package/README.md

@@ -1,7 +1,7 @@
-# Magic-xpa/engine
-
-This package is part of Magic xpa Web Application Framework. 
-It is used to easily create modern business apps powered by Angular to provide a rich user experience and meet the increasingly complex enterprise business expectations for digital transformation. 
- 
- 
- 
+# Magic-xpa/engine
+
+This package is part of Magic xpa Web Application Framework. 
+It is used to easily create modern business apps powered by Angular to provide a rich user experience and meet the increasingly complex enterprise business expectations for digital transformation. 
+ 
+ 
+ 

package/fesm2022/magic-xpa-engine.mjs

@@ -3,6 +3,7 @@ import { XMLConstants, StorageAttribute, ViewRefreshMode, InternalInterface, Log
 import { RecordUtils, GuiFieldBase, ExpVal, BlobType, FieldDef, GuiTaskBase, MgControlBase, PropInterface, GuiDataCollection, CommandType, Commands, HtmlProperties, ControlTable, Modifiers, KeyboardItem, TaskDefinitionIdTableSaxHandler, DisplayConvertor, VectorType, PIC, MgTimer, GuiConstants, RuntimeContextBase, UsernamePasswordCredentials, Styles, Manager, NUM_TYPE, GuiExpressionEvaluator, ExpressionInterface, DataModificationTypes, GuiDataViewBase, ObjectReferencesCollection, EMPTY_DCREF, ObjectReferenceBase, PropTable, FieldsTable as FieldsTable$1, DcValuesBuilderBase, MgFormBase, GuiEnvironment, TaskDefinitionId, Events, Helps, FocusManager, EventsProcessor, UIBridge } from '@magic-xpa/gui';
 import { HttpHeaders, HttpErrorResponse } from '@angular/common/http';
 import { timer, Subject } from 'rxjs';
+import * as CryptoJS from 'crypto-js';
 
 ///
 /// This class is used to hold references to global objects, using their interfaces/base classes. This allows other objects to access those global objects
@@ -315,6 +316,7 @@ class ConstInterface {
     static MG_ATTR_HANDLER_ONFORM = "HandlerOnForm";
     static MG_ATTR_DROP_USERFORMATS = "dropuserformats";
     static MG_ATTR_CONTROL_NAME = "ControlName";
+    static MG_ATTR_SEARCH_STR = "searchStr";
     static MG_TAG_HIDDEN_CONTOLS = "HiddenControls";
     static MG_ATTR_ISNS = "Isns";
     static MG_ATTR_SPECIAL_CANCEL_ON_CREATE = "SpecialCancelOnCreate";
@@ -7494,6 +7496,9 @@ class RemoteCommandsProcessor extends CommandsProcessorBase {
                     queryParams += `&${ConstInterface.RC_TOKEN_SESSION_ID}=${sessionId}`;
                 }
                 queryParams += `&${ConstInterface.RC_TOKEN_SESSION_COUNT}${sessionCounter}`;
+                queryParams += `&${ConstInterface.RC_INDICATION}`;
+                // To remove the trailing '&' character (added by RC_INDICATION) from the end of the query string
+                queryParams = queryParams.substring(0, queryParams.length - 1);
                 // Insert query parameters in the query string
                 modifiedQuery = u.search.substring(0, ctxIdIdx + CTX_ID_PLACEHOLDER.length - 1) + queryParams + u.search.substring(ctxIdIdx + CTX_ID_PLACEHOLDER.length - 1);
                 // modifiedQuery is updated with file name with base64 encoded.
@@ -9735,6 +9740,17 @@ class ExpressionDict {
         new ExpDesc('B', 0, 1, 1, 'A', false), /* 703- Delete_Cookie */
         null,
         new ExpDesc('U', 0, 0, 0, '', false), /* 705- RouteGet */
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null,
+        new ExpDesc('NO', 0, 2, 2, 'A', false), /* 716- Hash */
     ];
 }
 
@@ -10101,6 +10117,7 @@ class RefreshEventCommand extends EventCommand {
 /// </summary>
 class FetchDataControlValuesEventCommand extends EventCommand {
     ControlName = null;
+    FilterData = null;
     constructor() {
         super(InternalInterface.MG_ACT_FETCH_DATA_CONTROL_VALUES);
     }
@@ -10109,6 +10126,8 @@ class FetchDataControlValuesEventCommand extends EventCommand {
         helper.SerializeTaskTag(this.TaskTag);
         helper.SerializeMagicEvent(this.MagicEvent);
         helper.SerializeAttribute(ConstInterface.MG_ATTR_CONTROL_NAME, this.ControlName);
+        if (this.FilterData != null && this.FilterData != "")
+            helper.SerializeAttribute(ConstInterface.MG_ATTR_SEARCH_STR, this.FilterData);
         return helper.GetString();
     }
     getCommandInfo() {
@@ -10557,6 +10576,7 @@ class SelectProgramCommand extends ExecOperCommand {
 /// </summary>
 class ControlItemsRefreshCommand extends DataviewCommand {
     Control = null;
+    FilterData = null;
     constructor() {
         super();
     }
@@ -10627,11 +10647,12 @@ class CommandFactory {
     /// <param name="taskId"></param>
     /// <param name="control"></param>
     /// <returns></returns>
-    static CreateControlItemsRefreshCommand(taskId, control) {
+    static CreateControlItemsRefreshCommand(taskId, control, filterData) {
         let command = new ControlItemsRefreshCommand();
         command.CommandType = DataViewCommandType.ControlItemsRefresh;
         command.TaskTag = taskId;
         command.Control = control;
+        command.FilterData = filterData;
         return command;
     }
     /// <summary>
@@ -10736,10 +10757,11 @@ class CommandFactory {
     /// <param name="controlName"></param>
     /// <param name="generationParam"></param>
     /// <returns></returns>
-    static CreatecFetchDataControlValuesCommand(taskTag, controlName) {
+    static CreatecFetchDataControlValuesCommand(taskTag, controlName, filterData) {
         let fetchDataControlValuesEventCommand = new FetchDataControlValuesEventCommand();
         fetchDataControlValuesEventCommand.TaskTag = taskTag;
         fetchDataControlValuesEventCommand.ControlName = controlName;
+        fetchDataControlValuesEventCommand.FilterData = filterData;
         return fetchDataControlValuesEventCommand;
     }
     static CreateSubformRefreshCommand(taskTag, subformTaskTag, explicitSubformRefresh) {
@@ -12215,6 +12237,7 @@ class Operation {
     _undo = true;
     _isRoute = false;
     _routerPath = null;
+    _subformExp = null;
     _originalRouterOutletName = null;
     _routeParams = null;
     constructor() {
@@ -12418,6 +12441,10 @@ class Operation {
                 case XMLConstants.MG_ATTR_ROUTER_PATH:
                     this._routerPath = XmlParser.unescape(valueStr);
                     break;
+                case XMLConstants.MG_ATTR_SUBFORM_EXP:
+                    expId = XmlParser.getInt(valueStr);
+                    this._subformExp = taskRef.getExpById(expId);
+                    break;
                 default:
                     Logger.Instance.WriteExceptionToLogWithMsg("There is no such tag in Operation class. Insert case to Operation.initElements for " + attribute);
                     break;
@@ -12480,7 +12507,7 @@ class Operation {
     /// </param>
     /// <param name = "returnedFromServer">true if the server returned the execution to this operation</param>
     /// <returns> boolean for verify and block operations</returns>
-    async execute(returnedFromServer) {
+    async execute(returnedFromServer, desiredRouteName = null) {
         let lastRtEvent = AccessHelper.eventsManager.getLastRtEvent();
         let mprgCreator = null;
         let flowMonitor = FlowMonitorQueue.Instance;
@@ -12525,6 +12552,17 @@ class Operation {
                     await this.operServer(mprgCreator);
                     break;
                 case ConstInterface.MG_OPER_CALL:
+                    if (this._subformExp != null) {
+                        const subformName = await this._subformExp.evaluateWithResultTypeAndLength(StorageAttribute.ALPHA, 30);
+                        if (!subformName || subformName.length > 30) {
+                            const messageKey = !subformName ? MsgInterface.STR_ERR_BLANK_SUBFORM_NAME : MsgInterface.STR_ERR_SUBFORM_NAME_EXCEEDS_LIMIT;
+                            let message = LanguageData.Instance.getConstMessage(messageKey);
+                            message = LanguageData.Instance.translate(message);
+                            this._task.WriteToMessagePane(message);
+                            return false;
+                        }
+                        this._subformCtrlName = subformName;
+                    }
                     if (this._publicName != null) {
                         this.operCallParallel();
                     }
@@ -12554,8 +12592,16 @@ class Operation {
                                     let canRoute = false;
                                     let rtEvnt = AccessHelper.eventsManager.getLastRtEvent();
                                     if (rtEvnt !== null) {
-                                        this._routeParams = rtEvnt.getRouteParamList();
-                                        if ((await rtEvnt.getArgList().getArg(0).getValue(StorageAttribute.ALPHA, 0)).trim() === this._routerPath &&
+                                        // If we are here for default route path, set the routeParams as null because those are relevant only for the original route.
+                                        if (!this._evtHandler.isExecutingDefaultRoute()) {
+                                            desiredRouteName = (await rtEvnt.getArgList().getArg(0).getValue(StorageAttribute.ALPHA, 0)).trim();
+                                            this._routeParams = rtEvnt.getRouteParamList();
+                                        }
+                                        else {
+                                            desiredRouteName = this._evtHandler.getDefaultRouteName();
+                                            this._routeParams = null;
+                                        }
+                                        if (desiredRouteName === this._routerPath &&
                                             ((rtEvnt.getArgList().getArg(1).skipArg() && destSubForm === this._task.getForm().DefaultRouterOutlet) ||
                                                 (!rtEvnt.getArgList().getArg(1).skipArg() && (await rtEvnt.getArgList().getArg(1).getValue(StorageAttribute.ALPHA, 0)).trim() === this._originalRouterOutletName)))
                                             canRoute = true;
@@ -13063,7 +13109,18 @@ class Operation {
     /// </summary>
     /// <returns></returns>
     async canExecute() {
-        return await this.getCondVal();
+        return (this.isOperationAllowedWhileExecutingDefaultRoute() && await this.getCondVal());
+    }
+    isOperationAllowedWhileExecutingDefaultRoute() {
+        let isAllowed = true;
+        if (this._evtHandler.isExecutingDefaultRoute()) {
+            if (this._type == ConstInterface.MG_OPER_BLOCK || this._type == ConstInterface.MG_OPER_ELSE ||
+                (this._type == ConstInterface.MG_OPER_CALL && this._isRoute))
+                return true;
+            else
+                return false;
+        }
+        return isAllowed;
     }
     /// <summary>
     /// </summary>
@@ -13775,6 +13832,9 @@ class ExpressionEvaluator extends GuiExpressionEvaluator {
     static PARENT_LEN = 2; // 2 bytes
     static SHORT_OBJECT_LEN = 2; // 2 bytes
     static LONG_OBJECT_LEN = 4; // 4 bytes
+    static MD5_ALGO_NUM = 1;
+    static SHA1_ALGO_NUM = 2;
+    static SHA2_ALGO_NUM = 3;
     static _recursiveExpCalcCount = 0;
     _charsToTrim = [' ', '\0'];
     _expressionLocalJpn = null;
@@ -15398,6 +15458,12 @@ class ExpressionEvaluator extends GuiExpressionEvaluator {
             case ExpressionInterface.EXP_OP_ROUTEGET:
                 this.eval_op_route_get(resVal);
                 break;
+            case ExpressionInterface.EXP_OP_HASH:
+                val2 = valStack.pop();
+                val1 = valStack.pop();
+                this.eval_op_Hash(val1, val2, resVal);
+                expStrTracker.resetNullResult();
+                break;
             default:
                 return;
         }
@@ -16849,7 +16915,7 @@ class ExpressionEvaluator extends GuiExpressionEvaluator {
                 let control = tsk.getForm().GetCtrl(val1.StrVal);
                 //This function is applicable only for Combo box, List box etc. i.e. for choice controls. Also it will refresh items only if Source table is attached to the data control.
                 if (control != null && control.isChoiceControl() && control.isDataCtrl()) {
-                    let command = CommandFactory.CreateControlItemsRefreshCommand(tsk.getTaskTag(), control);
+                    let command = CommandFactory.CreateControlItemsRefreshCommand(tsk.getTaskTag(), control, "");
                     await tsk.DataviewManager.CurrentDataviewManager.Execute(command);
                     success = true;
                 }
@@ -18364,7 +18430,7 @@ class ExpressionEvaluator extends GuiExpressionEvaluator {
         if (!isNullOrUndefined(args)) {
             // TODO: This is a patch fix put for MXPA-30360. Problem is that the lazy loading components are not loaded in an async way.
             // Hence for the first record cycle the CallJS operation was not working. So, async loading of lazy loaded comps should be
-            // handled. 
+            // handled.
             resVal.StrVal = Commands.addCallJS(form, form.UniqueName, methodName, args);
             resVal.Attr = StorageAttribute.ALPHA;
         }
@@ -18461,6 +18527,35 @@ class ExpressionEvaluator extends GuiExpressionEvaluator {
         }
         return attr;
     }
+    eval_op_Hash(val1, val2, resVal) {
+        resVal.Attr = StorageAttribute.ALPHA;
+        resVal.StrVal = '';
+        if (val1.IsNull || val2.IsNull)
+            return;
+        let str = '';
+        const byteArray = BlobType.getBytes(val2.StrVal);
+        const wordArray = this.toWordArray(byteArray);
+        if (val1.MgNumVal.NUM_2_LONG() === ExpressionEvaluator.MD5_ALGO_NUM)
+            str = CryptoJS.MD5(wordArray).toString();
+        else if (val1.MgNumVal.NUM_2_LONG() === ExpressionEvaluator.SHA1_ALGO_NUM)
+            str = CryptoJS.SHA1(wordArray).toString();
+        else if (val1.MgNumVal.NUM_2_LONG() === ExpressionEvaluator.SHA2_ALGO_NUM)
+            str = CryptoJS.SHA256(wordArray).toString();
+        else
+            Logger.Instance.WriteErrorToLog(LanguageData.Instance.getConstMessage(MsgInterface.STR_ERR_INVALID_HASH_ALGO_NUMBER));
+        resVal.StrVal = str;
+    }
+    // Convert Uint8Array to WordArray
+    toWordArray(u8) {
+        const words = [];
+        for (let i = 0; i < u8.length; i += 4) {
+            words.push(((u8[i] || 0) << 24) |
+                ((u8[i + 1] || 0) << 16) |
+                ((u8[i + 2] || 0) << 8) |
+                (u8[i + 3] || 0));
+        }
+        return CryptoJS.lib.WordArray.create(words, u8.length);
+    }
 }
 /// <summary>
 ///   This exception used when at least one of the operands is null
@@ -22891,6 +22986,9 @@ class DataView extends DataViewBase {
                         break;
                     case XMLConstants.MG_ATTR_TASKID:
                         continue;
+                    case XMLConstants.MG_MAINPRG_CTL_PATH:
+                        this._task.MainPrgCtlPath = valueStr;
+                        break;
                     case ConstInterface.MG_ATTR_LOW_ID:
                         this._lastCreatedRecId = NNumber.Parse(valueStr);
                         break;
@@ -25147,13 +25245,15 @@ class ResultValue {
 
 class RemoteControlItemsRefreshCommand extends RemoteDataViewCommandBase {
     control = null;
+    filterData = null;
     constructor(command) {
         super(command);
         this.control = command.Control;
+        this.filterData = command.FilterData;
     }
     async Execute() {
         let res = new ResultValue();
-        let cmd = CommandFactory.CreatecFetchDataControlValuesCommand(this.Task.getTaskTag(), this.control.getName());
+        let cmd = CommandFactory.CreatecFetchDataControlValuesCommand(this.Task.getTaskTag(), this.control.getName(), this.filterData);
         this.Task.getMGData().CmdsToServer.Add(cmd);
         // Fetch data control values from server.
         await RemoteCommandsProcessor.GetInstance().Execute_1(CommandsProcessorBase_SendingInstruction.TASKS_AND_COMMANDS, CommandsProcessorBase_SessionStage.NORMAL, res);
@@ -28037,6 +28137,8 @@ class EventHandler {
     _scope = null; // Task|Subtask|Global
     _task = null;
     _taskMgdID = -1;
+    _defRouteName = null;
+    _isExecutingDefaultRoute = false;
     /// <summary>
     ///   CTOR
     /// </summary>
@@ -28165,6 +28267,9 @@ class EventHandler {
                 case ConstInterface.MG_ATTR_HANDLER_ONFORM:
                     this._isHandlerOnForm = XmlParser.getBoolean(valueStr);
                     break;
+                case XMLConstants.MG_ATTR_DEF_ROUTER_NAME:
+                    this._defRouteName = XmlParser.unescape(valueStr);
+                    break;
                 default:
                     Logger.Instance.WriteExceptionToLogWithMsg("There is no such tag in EventHandler class. Insert case to EventHandler.initElements for " + attribute);
                     break;
@@ -28393,8 +28498,15 @@ class EventHandler {
                 await this.resetLocalVariables(args);
                 initialLoopStackSize = this._task.getLoopStackSize();
                 let retVals = null;
-                if (this._operationTab.getSize() > 0)
+                if (this._operationTab.getSize() > 0) {
                     retVals = await this.executeOperations(0, this._operationTab.getSize() - 1, taskEnd, mgdID, depth, isChangedCurrWndRef, false, false, -1);
+                    if (retVals == null && this.isRouteHandler() && this.getDefaultRouteName() != null) {
+                        this._isExecutingDefaultRoute = true;
+                        // call again with an additional param Default Route Name
+                        retVals = await this.executeOperations(0, this._operationTab.getSize() - 1, taskEnd, mgdID, depth, isChangedCurrWndRef, false, false, -1);
+                        this._isExecutingDefaultRoute = false;
+                    }
+                }
                 isChangedCurrWnd = isChangedCurrWndRef.value;
                 if (retVals !== null)
                     return retVals;
@@ -28474,6 +28586,9 @@ class EventHandler {
         }
         return new RetVals(retVal, true);
     }
+    isExecutingDefaultRoute() {
+        return this._isExecutingDefaultRoute;
+    }
     /// <summary>
     ///   execute the operations starting from fromIdx and ending at endIdx.
     /// </summary>
@@ -28813,6 +28928,12 @@ class EventHandler {
     getEvent() {
         return this._evt;
     }
+    isRouteHandler() {
+        return (this._evt.getType() == ConstInterface.EVENT_TYPE_INTERNAL && this._evt.getInternalCode() === InternalInterface.MG_ACT_WEBCLIENT_ROUTE);
+    }
+    getDefaultRouteName() {
+        return this._defRouteName;
+    }
     /// <summary>
     ///   get the Id of the event handler
     /// </summary>
@@ -29903,6 +30024,7 @@ class Task extends TaskBase {
     _loopStack = null;
     allowRemoteCmdExecution;
     DelayCommandExecution = false;
+    MainPrgCtlPath = null;
     ///<summary>
     /// This is the task which invoked the handler containing the Call operation.
     /// This member is used for searching the variables like VarIndex(), etc
@@ -30462,6 +30584,12 @@ class Task extends TaskBase {
             message.Append(XMLConstants.START_TAG + XMLConstants.MG_TAG_TASK);
             message.Append(" " + XMLConstants.MG_ATTR_TASKID + "=\"" + this.getTaskTag() + "\"");
             message.Append(" " + ConstInterface.MG_ATTR_TASK_MAINLEVEL + "=\"" + this.getMainLevel() + "\"");
+            if (RemoteCommandsProcessor.IsSessionReInitializing && this.isMainProg) {
+                // While sending context reinitialize request, send the application path for main program
+                // This path will be used to match mainprogram on server side while updating its dataview
+                Debug.Assert(this.MainPrgCtlPath.length > 0);
+                message.Append(" " + XMLConstants.MG_MAINPRG_CTL_PATH + "=\"" + this.MainPrgCtlPath + "\"");
+            }
             message.Append(XMLConstants.TAG_CLOSE);
             await this.DataView.buildXML(message);
             if (this.Form != null && this.Form.Opened)
@@ -37333,6 +37461,13 @@ class EventsManager {
                 case InternalInterface.MG_ACT_SET_EXTERNAL_VALUE:
                     let refreshDisplay = await evt.getArgList().getArgValue(1, StorageAttribute.BOOLEAN, 0) === '1' ? true : false;
                     await ctrl.validateAndSetValueIfAllowed(evt.getValue(), refreshDisplay);
+                    //We will be here if we type in character(s)
+                    //And if the control has Autocomplete Mode and On Demand property set to true, we need to display the autocomplete list
+                    //based on whatever value user has typed. So, excute ControlItemsRefresh command to fetch the data control's values.
+                    if (ctrl.isOnDemandSelectionList()) {
+                        let command = CommandFactory.CreateControlItemsRefreshCommand(task.getTaskTag(), ctrl, evt.getValue());
+                        await task.DataviewManager.CurrentDataviewManager.Execute(command);
+                    }
                     break;
             }
         }
@@ -39507,7 +39642,7 @@ class CommandsTable {
     }
 }
 
-let CurrentClientVersion = '4.1200.0-ec.131.0';
+let CurrentClientVersion = '4.1201.0-dev000.0';
 
 // @dynamic
 class ClientManager {