@aemforms/af-core 0.17.0 → 0.22.0

package/lib/BaseNode.d.ts

@@ -70,11 +70,11 @@ export declare abstract class BaseNode<T extends BaseJson> implements BaseModel
     /**
      * @private
      */
-    addDependent(action: Action): void;
+    _addDependent(dependent: BaseModel): void;
     /**
      * @private
      */
-    removeDependent(action: Action): void;
+    removeDependent(dependent: BaseModel): void;
     abstract validate(): Array<ValidationError>;
     abstract executeAction(action: Action): any;
     /**
@@ -95,7 +95,7 @@ export declare abstract class BaseNode<T extends BaseJson> implements BaseModel
     /**
      * @private
      */
-    _bindToDataModel(contextualDataModel?: DataGroup): void;
+    _bindToDataModel(contextualDataModel: DataGroup): void;
     private _data?;
     /**
      * @private
@@ -109,6 +109,7 @@ export declare abstract class BaseNode<T extends BaseJson> implements BaseModel
     });
     abstract defaultDataModel(name: string | number): DataValue | undefined;
     abstract importData(a: DataGroup): any;
+    getNonTransparentParent(): ContainerModel;
     /**
      * called after the node is inserted in the parent
      * @private

package/lib/BaseNode.js

@@ -189,11 +189,11 @@ class BaseNode {
      * Transparent form fields are meant only for creation of view. They are also not part of data
      */
     isTransparent() {
-        var _a, _b;
+        var _a;
         // named form fields are not transparent
         // @ts-ignore
-        // handling repeatable use-case where first item of array can be unnamed
-        const isNonTransparent = ((_a = this.parent) === null || _a === void 0 ? void 0 : _a._jsonModel.type) === 'array' && ((_b = this.parent) === null || _b === void 0 ? void 0 : _b.items.length) === 1;
+        // handling array use-case as items of array can be unnamed
+        const isNonTransparent = ((_a = this.parent) === null || _a === void 0 ? void 0 : _a._jsonModel.type) === 'array';
         return !this._jsonModel.name && !isNonTransparent;
     }
     getState() {
@@ -216,8 +216,8 @@ class BaseNode {
     /**
      * @private
      */
-    addDependent(action) {
-        if (this._dependents.find(({ node }) => node === action.payload) === undefined) {
+    _addDependent(dependent) {
+        if (this._dependents.find(({ node }) => node === dependent) === undefined) {
             const subscription = this.subscribe((change) => {
                 const changes = change.payload.changes;
                 const propsToLook = ['value', 'items'];
@@ -226,17 +226,17 @@ class BaseNode {
                     return propsToLook.indexOf(x.propertyName) > -1;
                 }) > -1;
                 if (isPropChanged) {
-                    action.payload.dispatch(new controller_1.ExecuteRule());
+                    dependent.dispatch(new controller_1.ExecuteRule());
                 }
             });
-            this._dependents.push({ node: action.payload, subscription });
+            this._dependents.push({ node: dependent, subscription });
         }
     }
     /**
      * @private
      */
-    removeDependent(action) {
-        const index = this._dependents.findIndex(({ node }) => node === action.payload);
+    removeDependent(dependent) {
+        const index = this._dependents.findIndex(({ node }) => node === dependent);
         if (index > -1) {
             this._dependents[index].subscription.unsubscribe();
             this._dependents.splice(index, 1);
@@ -300,10 +300,10 @@ class BaseNode {
         }
         const dataRef = this._jsonModel.dataRef;
         let _data;
-        if (dataRef === null) {
+        if (dataRef === null) { // null data binding
             _data = EmptyDataValue_1.default;
         }
-        else if (dataRef !== undefined) {
+        else if (dataRef !== undefined) { // explicit data binding
             if (this._tokens.length === 0) {
                 this._tokens = (0, DataRefParser_1.tokenize)(dataRef);
             }
@@ -317,35 +317,38 @@ class BaseNode {
                 _data = (0, DataRefParser_1.resolveData)(searchData, this._tokens, create);
             }
         }
-        else {
-            if (contextualDataModel != null) {
+        else { // name data binding
+            if ( //@ts-ignore
+            contextualDataModel !== EmptyDataValue_1.default) {
                 const name = this._jsonModel.name || '';
                 const key = contextualDataModel.$type === 'array' ? this.index : name;
                 if (key !== '') {
                     const create = this.defaultDataModel(key);
                     if (create !== undefined) {
-                        _data = contextualDataModel.$getDataNode(key) || create;
-                        contextualDataModel.$addDataNode(key, _data);
+                        _data = contextualDataModel.$getDataNode(key);
+                        if (_data === undefined) {
+                            _data = create;
+                            contextualDataModel.$addDataNode(key, _data);
+                        }
                     }
                 }
                 else {
-                    _data = EmptyDataValue_1.default;
+                    _data = undefined;
                 }
             }
         }
-        if (!this.isContainer) {
-            _data = _data === null || _data === void 0 ? void 0 : _data.$convertToDataValue();
+        if (_data) {
+            if (!this.isContainer) {
+                _data = _data === null || _data === void 0 ? void 0 : _data.$convertToDataValue();
+            }
+            _data === null || _data === void 0 ? void 0 : _data.$bindToField(this);
+            this._data = _data;
         }
-        _data === null || _data === void 0 ? void 0 : _data.$bindToField(this);
-        this._data = _data;
     }
     /**
      * @private
      */
     getDataNode() {
-        if (this._data === undefined) {
-            return this.parent.getDataNode();
-        }
         return this._data;
     }
     get properties() {
@@ -354,13 +357,25 @@ class BaseNode {
     set properties(p) {
         this._setProperty('properties', Object.assign({}, p));
     }
+    getNonTransparentParent() {
+        let nonTransparentParent = this.parent;
+        while (nonTransparentParent != null && nonTransparentParent.isTransparent()) {
+            nonTransparentParent = nonTransparentParent.parent;
+        }
+        return nonTransparentParent;
+    }
     /**
      * called after the node is inserted in the parent
      * @private
      */
     _initialize() {
         if (typeof this._data === 'undefined') {
-            const dataNode = this.parent.getDataNode();
+            let dataNode, parent = this.parent;
+            do {
+                //@ts-ignore
+                dataNode = parent.getDataNode();
+                parent = parent.parent;
+            } while (dataNode === undefined);
             this._bindToDataModel(dataNode);
         }
     }

package/lib/Checkbox.js

@@ -17,7 +17,7 @@ const ValidationUtils_1 = require("./utils/ValidationUtils");
  * @private
  */
 const requiredConstraint = (offValue) => (constraint, value) => {
-    const valid = ValidationUtils_1.Constraints.required(constraint, value) && (!constraint || value != offValue);
+    const valid = ValidationUtils_1.Constraints.required(constraint, value).valid && (!constraint || value != offValue);
     return { valid, value };
 };
 /**

package/lib/Container.d.ts

@@ -323,7 +323,7 @@ declare abstract class Container<T extends ContainerJson & RulesJson> extends Sc
     /**
      * @private
      */
-    importData(contextualDataModel?: DataGroup): void;
+    importData(contextualDataModel: DataGroup): void;
     /**
      * prefill the form with data on the given element
      * @param dataModel

package/lib/Container.js

@@ -103,22 +103,19 @@ class Container extends Scriptable_1.default {
             nonTransparentParent = nonTransparentParent.parent;
         }
         if (typeof index !== 'number' || index > nonTransparentParent._children.length) {
-            index = nonTransparentParent === null || nonTransparentParent === void 0 ? void 0 : nonTransparentParent._children.length;
+            index = this._children.length;
         }
         const itemTemplate = Object.assign({ index }, (0, JsonUtils_1.deepClone)(itemJson));
         //@ts-ignore
-        const retVal = this._createChild(itemTemplate, { parent: nonTransparentParent, index: index });
+        const retVal = this._createChild(itemTemplate, { parent: this, index });
         this._addChildToRuleNode(retVal, { parent: nonTransparentParent });
-        if (index === (nonTransparentParent === null || nonTransparentParent === void 0 ? void 0 : nonTransparentParent._children.length)) {
-            nonTransparentParent === null || nonTransparentParent === void 0 ? void 0 : nonTransparentParent._children.push(retVal);
-            //(this.getDataNode() as DataGroup).$addDataNode(index);
+        if (index === this._children.length) {
+            this._children.push(retVal);
         }
         else {
             // @ts-ignore
-            nonTransparentParent === null || nonTransparentParent === void 0 ? void 0 : nonTransparentParent._children.splice(index, 0, retVal);
-            //(this.getDataNode() as DataGroup).$addDataNode();
+            this._children.splice(index, 0, retVal);
         }
-        retVal._initialize();
         return retVal;
     }
     indexOf(f) {
@@ -158,12 +155,14 @@ class Container extends Scriptable_1.default {
             }
             for (let i = 0; i < this._jsonModel.initialItems; i++) {
                 //@ts-ignore
-                this._addChild(this._itemTemplate);
+                const child = this._addChild(this._itemTemplate);
+                child._initialize();
             }
         }
         else if (items.length > 0) {
             items.forEach((item) => {
-                this._addChild(item);
+                const child = this._addChild(item);
+                child._initialize();
             });
             this._jsonModel.minItems = this._children.length;
             this._jsonModel.maxItems = this._children.length;
@@ -178,7 +177,17 @@ class Container extends Scriptable_1.default {
         if (action.type === 'addItem' && this._itemTemplate != null) {
             //@ts-ignore
             if ((this._jsonModel.maxItems === -1) || (this._children.length < this._jsonModel.maxItems)) {
+                const dataNode = this.getDataNode();
+                let index = action.payload;
+                if (typeof index !== 'number' || index > this._children.length) {
+                    index = this._children.length;
+                }
                 const retVal = this._addChild(this._itemTemplate, action.payload);
+                const _data = retVal.defaultDataModel(index);
+                if (_data) {
+                    dataNode.$addDataNode(index, _data);
+                }
+                retVal._initialize();
                 this.notifyDependents((0, controller_1.propertyChange)('items', retVal.getState, null));
                 retVal.dispatch(new controller_1.Initialize());
                 retVal.dispatch(new controller_1.ExecuteRule());
@@ -241,7 +250,8 @@ class Container extends Scriptable_1.default {
      */
     importData(contextualDataModel) {
         this._bindToDataModel(contextualDataModel);
-        this.syncDataAndFormModel(this.getDataNode());
+        const dataNode = this.getDataNode() || contextualDataModel;
+        this.syncDataAndFormModel(dataNode);
     }
     /**
      * prefill the form with data on the given element
@@ -262,7 +272,8 @@ class Container extends Scriptable_1.default {
             const items2Remove = Math.min(itemsLength - dataLength, itemsLength - minItems);
             while (items2Add > 0) {
                 items2Add--;
-                this._addChild(this._itemTemplate);
+                const child = this._addChild(this._itemTemplate);
+                child._initialize();
             }
             if (items2Remove > 0) {
                 this._children.splice(dataLength, items2Remove);

package/lib/FileUpload.d.ts

@@ -37,6 +37,6 @@ declare class FileUpload extends Field implements FieldModel {
     set value(value: any);
     private _serialize;
     private coerce;
-    importData(dataModel?: DataGroup): void;
+    importData(dataModel: DataGroup): void;
 }
 export default FileUpload;

package/lib/Scriptable.js

@@ -116,10 +116,10 @@ class Scriptable extends BaseNode_1.BaseNode {
         }
     }
     getExpressionScope() {
-        var _a;
+        const parent = this.getNonTransparentParent();
         const target = {
             self: this.getRuleNode(),
-            siblings: ((_a = this.parent) === null || _a === void 0 ? void 0 : _a.ruleNodeReference()) || {}
+            siblings: (parent === null || parent === void 0 ? void 0 : parent.ruleNodeReference()) || {}
         };
         const scope = new Proxy(target, {
             get: (target, prop) => {

package/lib/controller/EventQueue.d.ts

@@ -11,6 +11,7 @@ import { Logger } from '../Form';
  */
 declare class EventQueue {
     private logger;
+    static readonly MAX_EVENT_CYCLE_COUNT = 10;
     private _runningEventCount;
     private _isProcessing;
     private _pendingEvents;

package/lib/controller/EventQueue.js

@@ -66,7 +66,7 @@ class EventQueue {
             const evntNode = new EventNode(node, e);
             const counter = this._runningEventCount[evntNode.valueOf()] || 0;
             const alreadyExists = this.isQueued(node, e);
-            if (!alreadyExists || counter < 10) {
+            if (!alreadyExists || counter < EventQueue.MAX_EVENT_CYCLE_COUNT) {
                 this.logger.info(`Queued event : ${e.type} node: ${node.id} - ${node.name}`);
                 //console.log(`Event Details ${e.toString()}`)
                 if (priority) {
@@ -78,6 +78,9 @@ class EventQueue {
                 }
                 this._runningEventCount[evntNode.valueOf()] = counter + 1;
             }
+            else {
+                this.logger.info(`Skipped queueing event : ${e.type} node: ${node.id} - ${node.name} with count=${counter}`);
+            }
         });
     }
     runPendingQueue() {
@@ -96,4 +99,5 @@ class EventQueue {
         this._isProcessing = false;
     }
 }
+EventQueue.MAX_EVENT_CYCLE_COUNT = 10;
 exports.default = EventQueue;

package/lib/data/DataGroup.d.ts

@@ -7,11 +7,12 @@ import DataValue from './DataValue';
  */
 export default class DataGroup extends DataValue {
     $_items: {
-        [key: string | number]: DataValue | DataGroup;
-    };
+        [key: string]: DataValue | DataGroup;
+    } | DataValue[] | DataGroup[];
+    private createEntry;
     constructor(_name: string | number, _value: {
-        [key: string | number]: any;
-    }, _type?: string);
+        [key: string]: any;
+    } | any[], _type?: string);
     get $value(): Array<any> | {
         [key: string]: any;
     };
@@ -19,7 +20,7 @@ export default class DataGroup extends DataValue {
     $convertToDataValue(): DataValue;
     $addDataNode(name: string | number, value: DataGroup | DataValue): void;
     $removeDataNode(name: string | number): void;
-    $getDataNode(name: string | number): DataValue | undefined;
+    $getDataNode(name: string | number): any;
     $containsDataNode(name: string | number): boolean;
     get $isDataGroup(): boolean;
 }

package/lib/data/DataGroup.js

@@ -21,18 +21,25 @@ const EmptyDataValue_1 = __importDefault(require("./EmptyDataValue"));
 class DataGroup extends DataValue_1.default {
     constructor(_name, _value, _type = typeof _value) {
         super(_name, _value, _type);
-        this.$_items = {};
-        Object.entries(_value).forEach(([key, value]) => {
-            let x;
-            const t = value instanceof Array ? 'array' : typeof value;
-            if (typeof value === 'object' && value != null) {
-                x = new DataGroup(key, value, t);
-            }
-            else {
-                x = new DataValue_1.default(key, value, t);
-            }
-            this.$_items[key] = x;
-        });
+        if (_value instanceof Array) {
+            this.$_items = _value.map((value, index) => {
+                return this.createEntry(index, value);
+            });
+        }
+        else {
+            this.$_items = Object.fromEntries(Object.entries(_value).map(([key, value]) => {
+                return [key, this.createEntry(key, value)];
+            }));
+        }
+    }
+    createEntry(key, value) {
+        const t = value instanceof Array ? 'array' : typeof value;
+        if (typeof value === 'object' && value != null) {
+            return new DataGroup(key, value, t);
+        }
+        else {
+            return new DataValue_1.default(key, value, t);
+        }
     }
     get $value() {
         if (this.$type === 'array') {
@@ -52,7 +59,13 @@ class DataGroup extends DataValue_1.default {
     }
     $addDataNode(name, value) {
         if (value !== EmptyDataValue_1.default) {
-            this.$_items[name] = value;
+            if (this.$type === 'array') {
+                const index = name;
+                this.$_items.splice(index, 0, value);
+            }
+            else {
+                this.$_items[name] = value;
+            }
         }
     }
     $removeDataNode(name) {

package/lib/rules/RuleEngine.js

@@ -10,21 +10,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const Controller_1 = require("../controller/Controller");
 const json_formula_1 = require("@adobe/json-formula");
 const FunctionRuntime_1 = __importDefault(require("./FunctionRuntime"));
-/**
- * Implementation of AddDependant event
- * @private
- */
-class AddDependent extends Controller_1.ActionImpl {
-    constructor(payload) {
-        super(payload, 'addDependent');
-    }
-    payloadToJson() {
-        return this.payload.getState();
-    }
-}
 /**
  * Implementation of rule engine
  * @private
@@ -60,7 +47,7 @@ class RuleEngine {
      */
     trackDependency(subscriber) {
         if (this._context && this._context.field !== undefined && this._context.field !== subscriber) {
-            subscriber.dispatch(new AddDependent(this._context.field));
+            subscriber._addDependent(this._context.field);
         }
     }
 }

package/lib/types/Json.js

@@ -9,7 +9,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.constraintProps = exports.translationProps = void 0;
 /** Constant for all properties which can be translated based on `adaptive form specification` */
-exports.translationProps = ['description', 'placeholder', 'enum', 'enumNames'];
+exports.translationProps = ['description', 'placeholder', 'enum', 'enumNames', 'label.value'];
 /** Constant for all properties which are constraints based on `adaptive form specification` */
 exports.constraintProps = ['accept', 'enum', 'exclusiveMinimum', 'exclusiveMaximum',
     'format', 'maxFileSize', 'maxLength', 'maximum', 'maxItems',

package/lib/types/Model.d.ts

@@ -208,6 +208,10 @@ export interface BaseModel extends ConstraintsJson, WithController {
      * @private
      */
     _initialize(): any;
+    /**
+     * @private
+     */
+    _addDependent(dependent: BaseModel): any;
 }
 /**
  * Generic field model interface.
@@ -255,6 +259,7 @@ export interface ContainerModel extends BaseModel, ScriptableField {
      * @returns `index` of the item
      */
     indexOf(f: FieldModel | FieldsetModel): number;
+    isTransparent(): boolean;
 }
 /**
  * Generic field set model interface.

package/lib/utils/TranslationUtils.d.ts

@@ -16,6 +16,13 @@ export declare const invalidateTranslation: (input: formElementJson, updates: an
  * @private
  */
 export declare const addTranslationId: (input: formElementJson, additionalTranslationProps?: string[]) => formElementJson;
+/**
+ * Gets the value for the given key from the input, in case of no value, default is returned
+ * @param input             input object
+ * @param key               key to return from input object (key could be comma separated, example, label.value)
+ * @param defaultValue      default value
+ */
+export declare const getOrElse: (input: any, key: string | string[], defaultValue?: any) => any;
 /**
  * @param input
  * @param additionalTranslationProps

package/lib/utils/TranslationUtils.js

@@ -7,7 +7,7 @@
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL ADOBE NOR ITS THIRD PARTY PROVIDERS AND PARTNERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createTranslationObject = exports.createTranslationObj = exports.addTranslationId = exports.invalidateTranslation = exports.CUSTOM_PROPS_KEY = exports.TRANSLATION_ID = exports.TRANSLATION_TOKEN = void 0;
+exports.createTranslationObject = exports.createTranslationObj = exports.getOrElse = exports.addTranslationId = exports.invalidateTranslation = exports.CUSTOM_PROPS_KEY = exports.TRANSLATION_ID = exports.TRANSLATION_TOKEN = void 0;
 /**
  * Defines generic utilities to translated form model definition
  */
@@ -63,11 +63,12 @@ const _createTranslationId = (input, path, transProps) => {
         }
         else {
             // set it only if either of type or fieldType properties is present
-            if ('type' in input ||
+            if (':type' in input ||
+                'type' in input ||
                 'fieldType' in input) {
                 for (const transProp of transProps) {
                     // if property exist add it
-                    if (input[transProp] != null) {
+                    if ((0, exports.getOrElse)(input, transProp) != null) {
                         // if translation id is not yet set, set it
                         if (!(exports.CUSTOM_PROPS_KEY in input)) {
                             input[exports.CUSTOM_PROPS_KEY] = {};
@@ -100,10 +101,11 @@ const _createTranslationObj = (input, translationObj, translationProps) => {
         }
         else {
             for (const translationProp of translationProps) {
-                if (translationProp in input && ((_b = (_a = input === null || input === void 0 ? void 0 : input[exports.CUSTOM_PROPS_KEY]) === null || _a === void 0 ? void 0 : _a[exports.TRANSLATION_ID]) === null || _b === void 0 ? void 0 : _b[translationProp])) {
+                const objValue = (0, exports.getOrElse)(input, translationProp);
+                if (objValue && ((_b = (_a = input === null || input === void 0 ? void 0 : input[exports.CUSTOM_PROPS_KEY]) === null || _a === void 0 ? void 0 : _a[exports.TRANSLATION_ID]) === null || _b === void 0 ? void 0 : _b[translationProp])) {
                     // todo: right now we create only for english
-                    if (input[translationProp] instanceof Array) {
-                        input[translationProp].forEach((item, index) => {
+                    if (objValue instanceof Array) {
+                        objValue.forEach((item, index) => {
                             if (typeof item === 'string') { // only if string, then convert, since values can also be boolean
                                 // @ts-ignore
                                 translationObj[`${input[exports.CUSTOM_PROPS_KEY][exports.TRANSLATION_ID][translationProp]}${exports.TRANSLATION_TOKEN}${index}`] = item;
@@ -112,13 +114,32 @@ const _createTranslationObj = (input, translationObj, translationProps) => {
                     }
                     else {
                         // @ts-ignore
-                        translationObj[`${input[exports.CUSTOM_PROPS_KEY][exports.TRANSLATION_ID][translationProp]}`] = input[translationProp];
+                        translationObj[`${input[exports.CUSTOM_PROPS_KEY][exports.TRANSLATION_ID][translationProp]}`] = objValue;
                     }
                 }
             }
         }
     });
 };
+/**
+ * Gets the value for the given key from the input, in case of no value, default is returned
+ * @param input             input object
+ * @param key               key to return from input object (key could be comma separated, example, label.value)
+ * @param defaultValue      default value
+ */
+const getOrElse = (input, key, defaultValue = null) => {
+    if (!key) {
+        return defaultValue;
+    }
+    const arr = Array.isArray(key) ? key : key.split('.');
+    let objValue = input, index = 0;
+    while (index < arr.length && objValue.hasOwnProperty(arr[index])) {
+        objValue = objValue[arr[index]];
+        index++;
+    }
+    return index == arr.length ? objValue : defaultValue;
+};
+exports.getOrElse = getOrElse;
 /**
  * @param input
  * @param additionalTranslationProps
@@ -143,7 +164,7 @@ const createTranslationObject = (input, additionalTranslationProps = [], bcp47La
     const transProps = [...types_1.translationProps, ...additionalTranslationProps];
     // create a copy of the input
     const inputCopy = JSON.parse(JSON.stringify(input));
-    const obj = (0, exports.createTranslationObj)((0, exports.addTranslationId)(inputCopy), transProps);
+    const obj = (0, exports.createTranslationObj)((0, exports.addTranslationId)(inputCopy, additionalTranslationProps), transProps);
     const langTags = [...defaultBcp47LangTags, ...bcp47LangTags];
     const allLangs = {};
     for (const langTag of langTags) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aemforms/af-core",
-  "version": "0.17.0",
+  "version": "0.22.0",
   "description": "Core Module for Forms Runtime",
   "author": "Adobe Systems",
   "license": "Adobe Proprietary",