@aemforms/af-core 0.22.162 → 0.22.164

package/esm/afb-runtime.js

@@ -1457,6 +1457,7 @@ class BaseNode {
     _ruleNode;
     _lang = '';
     _callbacks = {};
+    _onlyViewNotify;
     _dependents = [];
     _jsonModel;
     _tokens = [];
@@ -1647,12 +1648,13 @@ class BaseNode {
             };
         });
     }
-    subscribe(callback, eventName = 'change') {
+    subscribe(callback, eventName = 'change', dependentType = 'view') {
         this._callbacks[eventName] = this._callbacks[eventName] || [];
-        this._callbacks[eventName].push(callback);
+        const entry = { callback, dependentType };
+        this._callbacks[eventName].push(entry);
         return {
             unsubscribe: () => {
-                this._callbacks[eventName] = this._callbacks[eventName].filter(x => x !== callback);
+                this._callbacks[eventName] = this._callbacks[eventName].filter(x => x.callback !== callback);
             }
         };
     }
@@ -1680,7 +1682,7 @@ class BaseNode {
                         dependent.dispatch(new ExecuteRule());
                     }
                 }
-            });
+            }, 'change', 'model');
             this._dependents.push({ node: dependent, propertyName, subscription });
         }
     }
@@ -1692,10 +1694,17 @@ class BaseNode {
         }
     }
     queueEvent(action) {
+        if (this._onlyViewNotify) {
+            return;
+        }
         const actionWithTarget = new ActionImplWithTarget(action, this);
         this.form.getEventQueue().queue(this, actionWithTarget, ['valid', 'invalid'].indexOf(actionWithTarget.type) > -1);
     }
     dispatch(action) {
+        if (this._onlyViewNotify) {
+            this.notifyDependents(new ActionImplWithTarget(action, this));
+            return;
+        }
         this.queueEvent(action);
         this.form.getEventQueue().runPendingQueue();
     }
@@ -1724,10 +1733,14 @@ class BaseNode {
             });
             this._jsonModel._dependents = undefined;
         }
-        const handlers = this._callbacks[action.type] || [];
-        handlers.forEach(x => {
+        const onlyView = this._onlyViewNotify;
+        const entries = this._callbacks[action.type] || [];
+        const toRun = onlyView
+            ? entries.filter(e => e.dependentType === 'view' || e.dependentType === undefined)
+            : entries;
+        toRun.forEach(({ callback }) => {
             this.withDependencyTrackingControl(true, () => {
-                x(new ActionImplWithTarget(action, this));
+                callback(new ActionImplWithTarget(action, this));
             });
         });
     }
@@ -2539,25 +2552,26 @@ class Container extends Scriptable {
         super.dispatch(action);
     }
     importData(dataModel) {
-        if (typeof this._data !== 'undefined' && this.type === 'array' && Array.isArray(dataModel)) {
-            const dataGroup = new DataGroup(this._data.$name, dataModel, this._data.$type, this._data.parent);
-            try {
-                this._data.parent?.$addDataNode(dataGroup.$name, dataGroup, true);
-            }
-            catch (e) {
-                this.form.logger.error(`unable to setItems for ${this.qualifiedName} : ${e}`);
-                return;
-            }
-            this._data = dataGroup;
-            this.syncDataAndFormModel(dataGroup);
-            const newLength = this.items.length;
-            for (let i = 0; i < newLength; i += 1) {
-                this._children[i].dispatch(new ExecuteRule());
-            }
-        }
-        else if (typeof this._data === 'undefined') {
+        if (typeof this._data === 'undefined') {
             console.warn(`Data node is null, hence importData did not work for panel "${this.name}". Check if parent has a dataRef set to null.`);
+            return;
+        }
+        const isArrayPanel = this.type === 'array' && Array.isArray(dataModel);
+        const isObjectPanel = this.type === 'object' && typeof dataModel === 'object' && dataModel !== null && !Array.isArray(dataModel);
+        if (!isArrayPanel && !isObjectPanel) {
+            return;
+        }
+        const dataGroup = new DataGroup(this._data.$name, dataModel, this._data.$type, this._data.parent);
+        try {
+            this._data.parent?.$addDataNode(dataGroup.$name, dataGroup, true);
         }
+        catch (e) {
+            this.form.logger.error(`unable to importData for ${this.qualifiedName} : ${e}`);
+            return;
+        }
+        this._data = dataGroup;
+        this.syncDataAndFormModel(dataGroup);
+        this._children.forEach((child) => child.dispatch(new ExecuteRule()));
     }
     syncDataAndFormModel(contextualDataModel) {
         const result = {
@@ -4201,13 +4215,13 @@ class Form extends Container {
             if (this._invalidFields.indexOf(action.target.id) === -1) {
                 this._invalidFields.push(action.target.id);
             }
-        }, 'invalid');
+        }, 'invalid', 'model');
         field.subscribe((action) => {
             const index = this._invalidFields.indexOf(action.target.id);
             if (index > -1) {
                 this._invalidFields.splice(index, 1);
             }
-        }, 'valid');
+        }, 'valid', 'model');
         field.subscribe((action) => {
             const field = action.target.getState();
             if (action.payload.changes.length > 0 && field) {
@@ -4232,7 +4246,7 @@ class Form extends Container {
                 const fieldChangedAction = new FieldChanged(changes, field, action.payload.eventSource);
                 this.notifyDependents(fieldChangedAction);
             }
-        });
+        }, 'change', 'model');
     }
     visit(callBack) {
         this.traverseChild(this, callBack);
@@ -4379,6 +4393,13 @@ class RuleEngine {
         this._context = globals;
         let res = undefined;
         try {
+            this._context?.form?.logger?.info({
+                message: 'Executing rule',
+                expression: eString,
+                fieldName: this._context.field?.name,
+                fieldId: this._context.field?.id,
+                eventType: this._context?.$event?.type
+            });
             res = formula.run(ast, data, 'en-US', globals);
         }
         catch (err) {
@@ -4875,7 +4896,12 @@ class Field extends Scriptable {
             if (updates.valid) {
                 this.triggerValidationEvent(updates);
             }
-            const changeAction = new Change({ changes: changes.concat(Object.values(updates)), eventSource: this._eventSource });
+            const allChanges = changes.concat(Object.values(updates));
+            const changesWithCurrentState = allChanges.map((change) => {
+                const valueToUse = change.propertyName === 'value' ? this._jsonModel.value : change.currentValue;
+                return { ...change, currentValue: valueToUse };
+            });
+            const changeAction = new Change({ changes: changesWithCurrentState, eventSource: this._eventSource });
             this.dispatch(changeAction);
         }
     }

package/esm/types/src/BaseNode.d.ts

@@ -1,4 +1,4 @@
-import { Action, BaseJson, BaseModel, callbackFn, ContainerModel, FormCreationMode, FormModel, Primitives, ValidationError, EventSource } from './types/index';
+import { Action, BaseJson, BaseModel, callbackFn, ContainerModel, DependentType, FormCreationMode, FormModel, Primitives, ValidationError, EventSource } from './types/index';
 import { PropertiesManager } from './PropertiesManager.js';
 import DataGroup from './data/DataGroup';
 import DataValue from './data/DataValue';
@@ -15,6 +15,7 @@ export declare abstract class BaseNode<T extends BaseJson> implements BaseModel
     private _ruleNode;
     private _lang?;
     private _callbacks;
+    _onlyViewNotify?: boolean;
     private _dependents;
     protected _jsonModel: T & {
         id: string;
@@ -83,7 +84,7 @@ export declare abstract class BaseNode<T extends BaseJson> implements BaseModel
         qualifiedName: any;
         id: string;
     };
-    subscribe(callback: callbackFn, eventName?: string): {
+    subscribe(callback: callbackFn, eventName?: string, dependentType?: DependentType): {
         unsubscribe: () => void;
     };
     _addDependent(dependent: BaseModel, propertyName?: string): void;

package/esm/types/src/types/Model.d.ts

@@ -38,8 +38,9 @@ export interface Action {
     readonly currentTarget: FormModel | FieldModel | FieldsetModel;
 }
 export type callbackFn = (action: Action) => void;
+export type DependentType = 'view' | 'model';
 export interface WithController {
-    subscribe(callback: callbackFn, eventName?: string): Subscription;
+    subscribe(callback: callbackFn, eventName?: string, dependentType?: DependentType): Subscription;
     dispatch(action: Action): void;
 }
 export type FormCreationMode = 'create' | 'restore';
@@ -80,6 +81,7 @@ export interface BaseModel extends ConstraintsJson, WithController {
     ruleNodeReference(): any;
     _initialize(mode?: FormCreationMode): any;
     _addDependent(dependent: BaseModel, propertyName?: string): any;
+    _onlyViewNotify?: boolean;
     _eventSource: EventSource;
     readonly fragment: string;
 }

package/lib/BaseNode.d.ts

@@ -1,4 +1,4 @@
-import { Action, BaseJson, BaseModel, callbackFn, ContainerModel, FormCreationMode, FormModel, Primitives, ValidationError, EventSource } from './types/index';
+import { Action, BaseJson, BaseModel, callbackFn, ContainerModel, DependentType, FormCreationMode, FormModel, Primitives, ValidationError, EventSource } from './types/index';
 import { PropertiesManager } from './PropertiesManager.js';
 import DataGroup from './data/DataGroup';
 import DataValue from './data/DataValue';
@@ -15,6 +15,7 @@ export declare abstract class BaseNode<T extends BaseJson> implements BaseModel
     private _ruleNode;
     private _lang?;
     private _callbacks;
+    _onlyViewNotify?: boolean;
     private _dependents;
     protected _jsonModel: T & {
         id: string;
@@ -83,7 +84,7 @@ export declare abstract class BaseNode<T extends BaseJson> implements BaseModel
         qualifiedName: any;
         id: string;
     };
-    subscribe(callback: callbackFn, eventName?: string): {
+    subscribe(callback: callbackFn, eventName?: string, dependentType?: DependentType): {
         unsubscribe: () => void;
     };
     _addDependent(dependent: BaseModel, propertyName?: string): void;

package/lib/BaseNode.js

@@ -298,12 +298,13 @@ class BaseNode {
             } : {}));
         });
     }
-    subscribe(callback, eventName = 'change') {
+    subscribe(callback, eventName = 'change', dependentType = 'view') {
         this._callbacks[eventName] = this._callbacks[eventName] || [];
-        this._callbacks[eventName].push(callback);
+        const entry = { callback, dependentType };
+        this._callbacks[eventName].push(entry);
         return {
             unsubscribe: () => {
-                this._callbacks[eventName] = this._callbacks[eventName].filter(x => x !== callback);
+                this._callbacks[eventName] = this._callbacks[eventName].filter(x => x.callback !== callback);
             }
         };
     }
@@ -331,7 +332,7 @@ class BaseNode {
                         dependent.dispatch(new Events_1.ExecuteRule());
                     }
                 }
-            });
+            }, 'change', 'model');
             this._dependents.push({ node: dependent, propertyName, subscription });
         }
     }
@@ -343,10 +344,17 @@ class BaseNode {
         }
     }
     queueEvent(action) {
+        if (this._onlyViewNotify) {
+            return;
+        }
         const actionWithTarget = new ActionImplWithTarget(action, this);
         this.form.getEventQueue().queue(this, actionWithTarget, ['valid', 'invalid'].indexOf(actionWithTarget.type) > -1);
     }
     dispatch(action) {
+        if (this._onlyViewNotify) {
+            this.notifyDependents(new ActionImplWithTarget(action, this));
+            return;
+        }
         this.queueEvent(action);
         this.form.getEventQueue().runPendingQueue();
     }
@@ -376,10 +384,14 @@ class BaseNode {
             });
             this._jsonModel._dependents = undefined;
         }
-        const handlers = this._callbacks[action.type] || [];
-        handlers.forEach(x => {
+        const onlyView = this._onlyViewNotify;
+        const entries = this._callbacks[action.type] || [];
+        const toRun = onlyView
+            ? entries.filter(e => e.dependentType === 'view' || e.dependentType === undefined)
+            : entries;
+        toRun.forEach(({ callback }) => {
             this.withDependencyTrackingControl(true, () => {
-                x(new ActionImplWithTarget(action, this));
+                callback(new ActionImplWithTarget(action, this));
             });
         });
     }

package/lib/Container.js

@@ -357,25 +357,26 @@ class Container extends Scriptable_1.default {
     }
     importData(dataModel) {
         var _a;
-        if (typeof this._data !== 'undefined' && this.type === 'array' && Array.isArray(dataModel)) {
-            const dataGroup = new DataGroup_1.default(this._data.$name, dataModel, this._data.$type, this._data.parent);
-            try {
-                (_a = this._data.parent) === null || _a === void 0 ? void 0 : _a.$addDataNode(dataGroup.$name, dataGroup, true);
-            }
-            catch (e) {
-                this.form.logger.error(`unable to setItems for ${this.qualifiedName} : ${e}`);
-                return;
-            }
-            this._data = dataGroup;
-            this.syncDataAndFormModel(dataGroup);
-            const newLength = this.items.length;
-            for (let i = 0; i < newLength; i += 1) {
-                this._children[i].dispatch(new Events_1.ExecuteRule());
-            }
-        }
-        else if (typeof this._data === 'undefined') {
+        if (typeof this._data === 'undefined') {
             console.warn(`Data node is null, hence importData did not work for panel "${this.name}". Check if parent has a dataRef set to null.`);
+            return;
+        }
+        const isArrayPanel = this.type === 'array' && Array.isArray(dataModel);
+        const isObjectPanel = this.type === 'object' && typeof dataModel === 'object' && dataModel !== null && !Array.isArray(dataModel);
+        if (!isArrayPanel && !isObjectPanel) {
+            return;
+        }
+        const dataGroup = new DataGroup_1.default(this._data.$name, dataModel, this._data.$type, this._data.parent);
+        try {
+            (_a = this._data.parent) === null || _a === void 0 ? void 0 : _a.$addDataNode(dataGroup.$name, dataGroup, true);
+        }
+        catch (e) {
+            this.form.logger.error(`unable to importData for ${this.qualifiedName} : ${e}`);
+            return;
         }
+        this._data = dataGroup;
+        this.syncDataAndFormModel(dataGroup);
+        this._children.forEach((child) => child.dispatch(new Events_1.ExecuteRule()));
     }
     syncDataAndFormModel(contextualDataModel) {
         const result = {

package/lib/Field.js

@@ -404,7 +404,12 @@ class Field extends Scriptable_1.default {
             if (updates.valid) {
                 this.triggerValidationEvent(updates);
             }
-            const changeAction = new Events_1.Change({ changes: changes.concat(Object.values(updates)), eventSource: this._eventSource });
+            const allChanges = changes.concat(Object.values(updates));
+            const changesWithCurrentState = allChanges.map((change) => {
+                const valueToUse = change.propertyName === 'value' ? this._jsonModel.value : change.currentValue;
+                return Object.assign(Object.assign({}, change), { currentValue: valueToUse });
+            });
+            const changeAction = new Events_1.Change({ changes: changesWithCurrentState, eventSource: this._eventSource });
             this.dispatch(changeAction);
         }
     }

package/lib/Form.js

@@ -270,13 +270,13 @@ class Form extends Container_1.default {
             if (this._invalidFields.indexOf(action.target.id) === -1) {
                 this._invalidFields.push(action.target.id);
             }
-        }, 'invalid');
+        }, 'invalid', 'model');
         field.subscribe((action) => {
             const index = this._invalidFields.indexOf(action.target.id);
             if (index > -1) {
                 this._invalidFields.splice(index, 1);
             }
-        }, 'valid');
+        }, 'valid', 'model');
         field.subscribe((action) => {
             const field = action.target.getState();
             if (action.payload.changes.length > 0 && field) {
@@ -301,7 +301,7 @@ class Form extends Container_1.default {
                 const fieldChangedAction = new Events_1.FieldChanged(changes, field, action.payload.eventSource);
                 this.notifyDependents(fieldChangedAction);
             }
-        });
+        }, 'change', 'model');
     }
     visit(callBack) {
         this.traverseChild(this, callBack);

package/lib/rules/RuleEngine.js

@@ -30,18 +30,25 @@ class RuleEngine {
         return { formula, ast: formula.compile(rule, this._globalNames) };
     }
     execute(node, data, globals, useValueOf = false, eString) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v;
         const { formula, ast } = node;
         const oldContext = this._context;
         this._context = globals;
         let res = undefined;
         try {
+            (_c = (_b = (_a = this._context) === null || _a === void 0 ? void 0 : _a.form) === null || _b === void 0 ? void 0 : _b.logger) === null || _c === void 0 ? void 0 : _c.info({
+                message: 'Executing rule',
+                expression: eString,
+                fieldName: (_d = this._context.field) === null || _d === void 0 ? void 0 : _d.name,
+                fieldId: (_e = this._context.field) === null || _e === void 0 ? void 0 : _e.id,
+                eventType: (_g = (_f = this._context) === null || _f === void 0 ? void 0 : _f.$event) === null || _g === void 0 ? void 0 : _g.type
+            });
             res = formula.run(ast, data, 'en-US', globals);
         }
         catch (err) {
-            (_c = (_b = (_a = this._context) === null || _a === void 0 ? void 0 : _a.form) === null || _b === void 0 ? void 0 : _b.logger) === null || _c === void 0 ? void 0 : _c.error(err);
-            if ((_d = this._context) === null || _d === void 0 ? void 0 : _d.form) {
-                const field = (_e = this._context) === null || _e === void 0 ? void 0 : _e.field;
+            (_k = (_j = (_h = this._context) === null || _h === void 0 ? void 0 : _h.form) === null || _j === void 0 ? void 0 : _j.logger) === null || _k === void 0 ? void 0 : _k.error(err);
+            if ((_l = this._context) === null || _l === void 0 ? void 0 : _l.form) {
+                const field = (_m = this._context) === null || _m === void 0 ? void 0 : _m.field;
                 const fieldName = field === null || field === void 0 ? void 0 : field.name;
                 const errorMsg = err instanceof Error ? err.message : String(err);
                 const fullError = fieldName
@@ -50,7 +57,7 @@ class RuleEngine {
                 const errorPayload = {
                     name: fieldName,
                     error: fullError,
-                    event: (_g = (_f = this._context) === null || _f === void 0 ? void 0 : _f.$event) === null || _g === void 0 ? void 0 : _g.type,
+                    event: (_p = (_o = this._context) === null || _o === void 0 ? void 0 : _o.$event) === null || _p === void 0 ? void 0 : _p.type,
                     rule: eString,
                     stack: err instanceof Error ? err.stack : undefined
                 };
@@ -58,9 +65,9 @@ class RuleEngine {
             }
         }
         if (this.debugInfo.length) {
-            (_k = (_j = (_h = this._context) === null || _h === void 0 ? void 0 : _h.form) === null || _j === void 0 ? void 0 : _j.logger) === null || _k === void 0 ? void 0 : _k.warn(`Form rule expression string: ${eString}`);
+            (_s = (_r = (_q = this._context) === null || _q === void 0 ? void 0 : _q.form) === null || _r === void 0 ? void 0 : _r.logger) === null || _s === void 0 ? void 0 : _s.warn(`Form rule expression string: ${eString}`);
             while (this.debugInfo.length > 0) {
-                (_o = (_m = (_l = this._context) === null || _l === void 0 ? void 0 : _l.form) === null || _m === void 0 ? void 0 : _m.logger) === null || _o === void 0 ? void 0 : _o.warn(this.debugInfo.pop());
+                (_v = (_u = (_t = this._context) === null || _t === void 0 ? void 0 : _t.form) === null || _u === void 0 ? void 0 : _u.logger) === null || _v === void 0 ? void 0 : _v.warn(this.debugInfo.pop());
             }
         }
         let finalRes = res;

package/lib/types/Model.d.ts

@@ -38,8 +38,9 @@ export interface Action {
     readonly currentTarget: FormModel | FieldModel | FieldsetModel;
 }
 export declare type callbackFn = (action: Action) => void;
+export declare type DependentType = 'view' | 'model';
 export interface WithController {
-    subscribe(callback: callbackFn, eventName?: string): Subscription;
+    subscribe(callback: callbackFn, eventName?: string, dependentType?: DependentType): Subscription;
     dispatch(action: Action): void;
 }
 export declare type FormCreationMode = 'create' | 'restore';
@@ -80,6 +81,7 @@ export interface BaseModel extends ConstraintsJson, WithController {
     ruleNodeReference(): any;
     _initialize(mode?: FormCreationMode): any;
     _addDependent(dependent: BaseModel, propertyName?: string): any;
+    _onlyViewNotify?: boolean;
     _eventSource: EventSource;
     readonly fragment: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aemforms/af-core",
-  "version": "0.22.162",
+  "version": "0.22.164",
   "description": "Core Module for Forms Runtime",
   "author": "Adobe Systems",
   "license": "Adobe Proprietary",
@@ -37,7 +37,7 @@
   },
   "dependencies": {
     "@adobe/json-formula": "0.1.50",
-    "@aemforms/af-formatters": "^0.22.162"
+    "@aemforms/af-formatters": "^0.22.164"
   },
   "devDependencies": {
     "@babel/preset-env": "^7.20.2",