@aemforms/af-core 0.22.102 → 0.22.104

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

@@ -81,6 +81,7 @@ export interface BaseModel extends ConstraintsJson, WithController {
     _initialize(mode?: FormCreationMode): any;
     _addDependent(dependent: BaseModel): any;
     _eventSource: EventSource;
+    readonly fragment: string;
 }
 export interface FieldModel extends BaseModel, ScriptableField, WithState<FieldJson> {
     parent: ContainerModel;
@@ -110,6 +111,7 @@ export interface ContainerModel extends BaseModel, ScriptableField {
     importData(data: any): any;
     isTransparent(): boolean;
     activeChild: BaseModel | null;
+    isFragment: boolean;
 }
 export interface FieldsetModel extends ContainerModel, WithState<FieldsetJson> {
     type?: 'array' | 'object';

package/lib/BaseNode.d.ts

@@ -20,12 +20,14 @@ export declare abstract class BaseNode<T extends BaseJson> implements BaseModel
     };
     private _tokens;
     _eventSource: EventSource;
+    protected _fragment: string;
     get isContainer(): boolean;
     constructor(params: T, _options: {
         form: FormModel;
         parent: ContainerModel;
         mode?: 'create' | 'restore';
     });
+    get fragment(): string;
     abstract value: Primitives;
     abstract reset(): any;
     protected setupRuleNode(): void;

package/lib/BaseNode.js

@@ -116,18 +116,29 @@ exports.include = addOnly(true);
 exports.exclude = addOnly(false);
 class BaseNode {
     constructor(params, _options) {
+        var _a, _b;
         this._options = _options;
         this._lang = '';
         this._callbacks = {};
         this._dependents = [];
         this._tokens = [];
         this._eventSource = index_1.EventSource.CODE;
+        this._fragment = '$form';
         this[exports.qualifiedName] = null;
         this._jsonModel = Object.assign(Object.assign({}, params), { id: 'id' in params ? params.id : this.form.getUniqueId() });
+        if ((_a = this.parent) === null || _a === void 0 ? void 0 : _a.isFragment) {
+            this._fragment = this.parent.qualifiedName;
+        }
+        else if ((_b = this.parent) === null || _b === void 0 ? void 0 : _b.fragment) {
+            this._fragment = this.parent.fragment;
+        }
     }
     get isContainer() {
         return false;
     }
+    get fragment() {
+        return this._fragment;
+    }
     setupRuleNode() {
         const self = this;
         this._ruleNode = new Proxy(this.ruleNodeReference(), {

package/lib/Container.d.ts

@@ -6,6 +6,8 @@ declare abstract class Container<T extends ContainerJson & RulesJson> extends Sc
     protected _childrenReference: any;
     private _itemTemplate;
     private fieldFactory;
+    private _isFragment;
+    private _insideFragment;
     constructor(json: T, _options: {
         form: FormModel;
         parent: ContainerModel;
@@ -56,6 +58,7 @@ declare abstract class Container<T extends ContainerJson & RulesJson> extends Sc
     indexOf(f: FieldModel | FieldsetModel): number;
     defaultDataModel(name: string): DataGroup | undefined;
     _canHaveRepeatingChildren(mode?: FormCreationMode): boolean;
+    get isFragment(): any;
     _initialize(mode?: FormCreationMode): void;
     private _initializeSiteContainer;
     addItem(action: Action): void;
@@ -64,7 +67,6 @@ declare abstract class Container<T extends ContainerJson & RulesJson> extends Sc
     reset(): void;
     validate(): import("./types/Model").ValidationError[];
     dispatch(action: Action): void;
-    createDataGroup(dataModel: any): DataGroup | null;
     importData(dataModel: any): void;
     syncDataAndFormModel(contextualDataModel?: DataGroup): any;
     get activeChild(): BaseModel | null;

package/lib/Container.js

@@ -19,10 +19,14 @@ const notifyChildrenAttributes = [
 ];
 class Container extends Scriptable_1.default {
     constructor(json, _options) {
+        var _a, _b;
         super(json, { form: _options.form, parent: _options.parent, mode: _options.mode });
         this._children = [];
         this._itemTemplate = null;
+        this._isFragment = false;
+        this._insideFragment = false;
         this._activeChild = null;
+        this._isFragment = ((_b = (_a = this._jsonModel) === null || _a === void 0 ? void 0 : _a.properties) === null || _b === void 0 ? void 0 : _b['fd:fragment']) === true;
         this.fieldFactory = _options.fieldFactory;
     }
     _getDefaults() {
@@ -201,6 +205,10 @@ class Container extends Scriptable_1.default {
         return this._jsonModel.type == 'array' && this.getDataNode() != null &&
             (items.length === 1 || (items.length > 0 && items[0].repeatable == true && mode === 'restore'));
     }
+    get isFragment() {
+        var _a, _b;
+        return this._isFragment || ((_b = (_a = this._jsonModel) === null || _a === void 0 ? void 0 : _a.properties) === null || _b === void 0 ? void 0 : _b['fd:fragment']);
+    }
     _initialize(mode) {
         super._initialize(mode);
         const items = this._jsonModel.items || [];
@@ -275,19 +283,7 @@ class Container extends Scriptable_1.default {
         if ((action.type === 'addItem' || action.type == 'addInstance') && this._itemTemplate != null) {
             if ((this._jsonModel.maxItems === -1) || (this._children.length < this._jsonModel.maxItems)) {
                 const dataNode = this.getDataNode();
-                let instanceIndex = null;
-                let instanceData = null;
-                if (typeof action.payload === 'number') {
-                    instanceIndex = action.payload;
-                }
-                else if (typeof action.payload === 'object') {
-                    if ('index' in action.payload) {
-                        instanceIndex = action.payload.index;
-                    }
-                    if ('data' in action.payload) {
-                        instanceData = action.payload.data;
-                    }
-                }
+                let instanceIndex = action.payload;
                 const retVal = this._addChild(this._itemTemplate, action.payload, true);
                 if (typeof instanceIndex !== 'number' || instanceIndex > this._children.length) {
                     instanceIndex = this._children.length;
@@ -303,9 +299,6 @@ class Container extends Scriptable_1.default {
                 for (let i = instanceIndex + 1; i < this._children.length; i++) {
                     this._children[i].dispatch(new Events_1.ExecuteRule());
                 }
-                if (instanceData) {
-                    retVal.importData(instanceData);
-                }
             }
         }
     }
@@ -360,22 +353,15 @@ class Container extends Scriptable_1.default {
     dispatch(action) {
         super.dispatch(action);
     }
-    createDataGroup(dataModel) {
-        var _a;
-        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 set items for container '${this.qualifiedName}' with data model '${dataModel}': ${e.message}`);
-            return null;
-        }
-        return dataGroup;
-    }
     importData(dataModel) {
+        var _a;
         if (typeof this._data !== 'undefined' && this.type === 'array' && Array.isArray(dataModel)) {
-            const dataGroup = this.createDataGroup(dataModel);
-            if (!dataGroup) {
+            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;
@@ -392,13 +378,6 @@ class Container extends Scriptable_1.default {
                 this.notifyDependents((0, Events_1.propertyChange)('items', null, item.getState()));
             });
         }
-        if (typeof this._data !== 'undefined' && this.type === 'object') {
-            const dataGroup = this.createDataGroup(dataModel);
-            if (!dataGroup) {
-                return;
-            }
-            this.syncDataAndFormModel(dataGroup);
-        }
     }
     syncDataAndFormModel(contextualDataModel) {
         const result = {

package/lib/Form.d.ts

@@ -26,6 +26,7 @@ declare class Form extends Container<FormJson> implements FormModel {
     private dataRefRegex;
     get metaData(): FormMetaData;
     get action(): string | undefined;
+    get isFragment(): boolean;
     importData(dataModel: any): void;
     exportData(): any;
     setAdditionalSubmitMetadata(metadata: Record<string, any>): void;

package/lib/Form.js

@@ -83,6 +83,9 @@ class Form extends Container_1.default {
     get action() {
         return this._jsonModel.action;
     }
+    get isFragment() {
+        return false;
+    }
     importData(dataModel) {
         this.bindToDataModel(new DataGroup_1.default('$form', dataModel));
         this.syncDataAndFormModel(this.getDataNode());

package/lib/Scriptable.js

@@ -15,7 +15,11 @@ class Scriptable extends BaseNode_1.BaseNode {
             const eString = rule || this.getRules()[eName];
             if (typeof eString === 'string' && eString.length > 0) {
                 try {
-                    this._rules[eName] = this.ruleEngine.compileRule(eString, this.lang);
+                    let updatedRule = eString;
+                    if (this.fragment !== '$form') {
+                        updatedRule = eString.replaceAll('$form', this.fragment);
+                    }
+                    this._rules[eName] = this.ruleEngine.compileRule(updatedRule, this.lang);
                 }
                 catch (e) {
                     this.form.logger.error(`Unable to compile rule \`"${eName}" : "${eString}"\` Exception : ${e}`);
@@ -37,7 +41,11 @@ class Scriptable extends BaseNode_1.BaseNode {
             if (typeof eString !== 'undefined' && eString.length > 0) {
                 this._events[eName] = eString.map(x => {
                     try {
-                        return this.ruleEngine.compileRule(x, this.lang);
+                        let updatedExpr = x;
+                        if (this.fragment !== '$form') {
+                            updatedExpr = x.replaceAll('$form', this.fragment);
+                        }
+                        return this.ruleEngine.compileRule(updatedExpr, this.lang);
                     }
                     catch (e) {
                         this.form.logger.error(`Unable to compile expression \`"${eName}" : "${eString}"\` Exception : ${e}`);
@@ -74,7 +82,7 @@ class Scriptable extends BaseNode_1.BaseNode {
             entries.forEach(([prop, rule]) => {
                 const node = this.getCompiledRule(prop, rule);
                 if (node) {
-                    const newVal = this.ruleEngine.execute(node, scope, context, true);
+                    const newVal = this.ruleEngine.execute(node, scope, context, true, rule);
                     if (BaseNode_1.editableProperties.indexOf(prop) > -1) {
                         const oldAndNewValueAreEmpty = this.isEmpty() && this.isEmpty(newVal) && prop === 'value';
                         if (!oldAndNewValueAreEmpty) {
@@ -129,10 +137,10 @@ class Scriptable extends BaseNode_1.BaseNode {
         });
         return scope;
     }
-    executeEvent(context, node) {
+    executeEvent(context, node, eString) {
         let updates;
         if (node) {
-            updates = this.ruleEngine.execute(node, this.getExpressionScope(), context);
+            updates = this.ruleEngine.execute(node, this.getExpressionScope(), context, false, eString);
         }
         if (typeof updates !== 'undefined' && updates != null) {
             this.applyUpdates(updates);
@@ -151,7 +159,7 @@ class Scriptable extends BaseNode_1.BaseNode {
             'field': this
         };
         const node = this.ruleEngine.compileRule(expr, this.lang);
-        return this.ruleEngine.execute(node, this.getExpressionScope(), ruleContext);
+        return this.ruleEngine.execute(node, this.getExpressionScope(), ruleContext, false, expr);
     }
     change(event, context) {
         if (this.form.changeEventBehaviour === 'deps') {
@@ -159,6 +167,7 @@ class Scriptable extends BaseNode_1.BaseNode {
         }
     }
     executeAction(action) {
+        var _a;
         const context = {
             'form': this.form,
             '$form': this.form.getRuleNode(),
@@ -173,10 +182,20 @@ class Scriptable extends BaseNode_1.BaseNode {
         const eventName = action.isCustomEvent ? `custom:${action.type}` : action.type;
         const funcName = action.isCustomEvent ? `custom_${action.type}` : action.type;
         const node = this.getCompiledEvent(eventName);
+        const events = (_a = this._jsonModel.events) === null || _a === void 0 ? void 0 : _a[eventName];
         if (funcName in this && typeof this[funcName] === 'function') {
             this[funcName](action, context);
         }
-        node.forEach((n) => this.executeEvent(context, n));
+        node.forEach((n, index) => {
+            let eString = '';
+            if (Array.isArray(events)) {
+                eString = events[index];
+            }
+            else if (typeof events === 'string') {
+                eString = events;
+            }
+            this.executeEvent(context, n, eString);
+        });
         if (action.target === this) {
             this.notifyDependents(action);
         }

package/lib/controller/Events.d.ts

@@ -1,4 +1,8 @@
-import { Action, BaseJson, FieldModel, FieldsetModel, FormModel, ValidationError, EventSource } from '../types/index';
+import { Action, BaseJson, FieldModel, FieldsetModel, FormModel, ValidationError } from '../types/index';
+declare enum EventSource {
+    CODE = "code",
+    UI = "ui"
+}
 declare class ActionImpl implements Action {
     private _metadata?;
     protected _type: string;
@@ -32,10 +36,6 @@ export declare type UIChangePayload = {
     value?: any;
     checked?: boolean;
 };
-export declare type AddItemPayload = {
-    index: number;
-    data: Record<string, any>;
-};
 export declare class Change extends ActionImpl {
     constructor(payload: ChangePayload, dispatch?: boolean);
     withAdditionalChange(change: Change): Change;
@@ -97,13 +97,13 @@ export declare class CustomEvent extends ActionImpl {
     get isCustomEvent(): boolean;
 }
 export declare class AddItem extends ActionImpl {
-    constructor(payload?: number | AddItemPayload);
+    constructor(payload?: number);
 }
 export declare class RemoveItem extends ActionImpl {
     constructor(payload?: number);
 }
 export declare class AddInstance extends ActionImpl {
-    constructor(payload?: number | AddItemPayload);
+    constructor(payload?: number);
 }
 export declare class RemoveInstance extends ActionImpl {
     constructor(payload?: number);

package/lib/controller/Events.js

@@ -1,7 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RemoveInstance = exports.AddInstance = exports.RemoveItem = exports.AddItem = exports.CustomEvent = exports.FieldChanged = exports.Reset = exports.SubmitError = exports.SubmitFailure = exports.SubmitSuccess = exports.Save = exports.Submit = exports.Focus = exports.ValidationComplete = exports.Blur = exports.Click = exports.FormLoad = exports.Initialize = exports.propertyChange = exports.ExecuteRule = exports.Valid = exports.Invalid = exports.UIChange = exports.Change = void 0;
-const index_1 = require("../types/index");
+var EventSource;
+(function (EventSource) {
+    EventSource["CODE"] = "code";
+    EventSource["UI"] = "ui";
+})(EventSource || (EventSource = {}));
 class ActionImpl {
     constructor(payload, type, _metadata) {
         this._metadata = _metadata;
@@ -158,7 +162,7 @@ class Reset extends ActionImpl {
 }
 exports.Reset = Reset;
 class FieldChanged extends ActionImpl {
-    constructor(changes, field, eventSource = index_1.EventSource.CODE) {
+    constructor(changes, field, eventSource = EventSource.CODE) {
         super({
             field,
             changes,

package/lib/rules/FunctionRuntime.js

@@ -143,26 +143,32 @@ const multipartFormData = (data, attachments) => {
     }
     return formData;
 };
-const createAction = (name, payload = {}) => {
+const createAction = (name, payload = {}, dispatch = false) => {
     switch (name) {
         case 'change':
-            return new Events_1.Change(payload);
+            return new Events_1.Change(payload, dispatch);
         case 'submit':
-            return new Events_1.Submit(payload);
+            return new Events_1.Submit(payload, dispatch);
         case 'save':
-            return new Events_1.Save(payload);
+            return new Events_1.Save(payload, dispatch);
         case 'click':
-            return new Events_1.Click(payload);
+            return new Events_1.Click(payload, dispatch);
         case 'addItem':
             return new Events_1.AddItem(payload);
         case 'removeItem':
             return new Events_1.RemoveItem(payload);
         case 'reset':
-            return new Events_1.Reset(payload);
+            return new Events_1.Reset(payload, dispatch);
         case 'addInstance':
             return new Events_1.AddInstance(payload);
         case 'removeInstance':
             return new Events_1.RemoveInstance(payload);
+        case 'invalid':
+            return new Events_1.Invalid(payload);
+        case 'valid':
+            return new Events_1.Valid(payload);
+        case 'initialize':
+            return new Events_1.Initialize(payload, dispatch);
         default:
             console.error('invalid action');
     }
@@ -236,8 +242,8 @@ class FunctionRuntimeImpl {
                                     const args = [target, flag];
                                     return FunctionRuntimeImpl.getInstance().getFunctions().setFocus._func.call(undefined, args, data, interpreter);
                                 },
-                                dispatchEvent: (target, eventName, payload) => {
-                                    const args = [target, eventName, payload];
+                                dispatchEvent: (target, eventName, payload, dispatch) => {
+                                    const args = [target, eventName, payload, dispatch];
                                     return FunctionRuntimeImpl.getInstance().getFunctions().dispatchEvent._func.call(undefined, args, data, interpreter);
                                 },
                                 getFiles: (qualifiedName) => {
@@ -497,9 +503,13 @@ class FunctionRuntimeImpl {
             dispatchEvent: {
                 _func: (args, data, interpreter) => {
                     const element = args[0];
+                    if (element === null && typeof interpreter !== 'string') {
+                        interpreter.debug.push('Invalid argument passed in dispatchEvent. An element is expected');
+                        return {};
+                    }
                     let eventName = valueOf(args[1]);
                     let payload = args.length > 2 ? valueOf(args[2]) : undefined;
-                    let dispatch = false;
+                    let dispatch = args.length > 3 ? valueOf(args[3]) : false;
                     if (typeof element === 'string') {
                         payload = eventName;
                         eventName = element;
@@ -510,7 +520,7 @@ class FunctionRuntimeImpl {
                         event = new Events_1.CustomEvent(eventName.substring('custom:'.length), payload, dispatch);
                     }
                     else {
-                        event = createAction(eventName, payload);
+                        event = createAction(eventName, payload, dispatch);
                     }
                     if (event != null) {
                         if (typeof element === 'string') {

package/lib/rules/RuleEngine.d.ts

@@ -10,7 +10,7 @@ declare class RuleEngine {
         formula: Formula;
         ast: any;
     };
-    execute(node: any, data: any, globals: any, useValueOf?: boolean): any;
+    execute(node: any, data: any, globals: any, useValueOf: boolean | undefined, eString: string): any;
     trackDependency(subscriber: BaseModel): void;
 }
 export default RuleEngine;

package/lib/rules/RuleEngine.js

@@ -27,8 +27,8 @@ class RuleEngine {
         const formula = new json_formula_1.default(this.customFunctions, getStringToNumberFn(locale), this.debugInfo);
         return { formula, ast: formula.compile(rule, this._globalNames) };
     }
-    execute(node, data, globals, useValueOf = false) {
-        var _a, _b, _c, _d, _e, _f;
+    execute(node, data, globals, useValueOf = false, eString) {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
         const { formula, ast } = node;
         const oldContext = this._context;
         this._context = globals;
@@ -39,8 +39,11 @@ class RuleEngine {
         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);
         }
-        while (this.debugInfo.length > 0) {
-            (_f = (_e = (_d = this._context) === null || _d === void 0 ? void 0 : _d.form) === null || _e === void 0 ? void 0 : _e.logger) === null || _f === void 0 ? void 0 : _f.debug(this.debugInfo.pop());
+        if (this.debugInfo.length) {
+            (_f = (_e = (_d = this._context) === null || _d === void 0 ? void 0 : _d.form) === null || _e === void 0 ? void 0 : _e.logger) === null || _f === void 0 ? void 0 : _f.warn(`Form rule expression string: ${eString}`);
+            while (this.debugInfo.length > 0) {
+                (_j = (_h = (_g = this._context) === null || _g === void 0 ? void 0 : _g.form) === null || _h === void 0 ? void 0 : _h.logger) === null || _j === void 0 ? void 0 : _j.warn(this.debugInfo.pop());
+            }
         }
         let finalRes = res;
         if (useValueOf) {

package/lib/types/Model.d.ts

@@ -81,6 +81,7 @@ export interface BaseModel extends ConstraintsJson, WithController {
     _initialize(mode?: FormCreationMode): any;
     _addDependent(dependent: BaseModel): any;
     _eventSource: EventSource;
+    readonly fragment: string;
 }
 export interface FieldModel extends BaseModel, ScriptableField, WithState<FieldJson> {
     parent: ContainerModel;
@@ -110,6 +111,7 @@ export interface ContainerModel extends BaseModel, ScriptableField {
     importData(data: any): any;
     isTransparent(): boolean;
     activeChild: BaseModel | null;
+    isFragment: boolean;
 }
 export interface FieldsetModel extends ContainerModel, WithState<FieldsetJson> {
     type?: 'array' | 'object';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aemforms/af-core",
-  "version": "0.22.102",
+  "version": "0.22.104",
   "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.102"
+    "@aemforms/af-formatters": "^0.22.104"
   },
   "devDependencies": {
     "@babel/preset-env": "^7.20.2",