@aemforms/af-core 0.22.136 → 0.22.138

package/lib/Container.d.ts

@@ -1,4 +1,4 @@
-import { Action, BaseModel, ContainerJson, ContainerModel, FieldModel, FieldsetModel, FormCreationMode, FormModel, IFormFieldFactory, RulesJson } from './types/index';
+import { Action, BaseModel, ContainerJson, ContainerModel, FieldJson, FieldModel, FieldsetModel, FormCreationMode, FormModel, IFormFieldFactory, RulesJson } from './types/index';
 import Scriptable from './Scriptable';
 import DataGroup from './data/DataGroup';
 declare abstract class Container<T extends ContainerJson & RulesJson> extends Scriptable<T> implements ContainerModel {
@@ -29,12 +29,126 @@ declare abstract class Container<T extends ContainerJson & RulesJson> extends Sc
     private _getFormAndSitesState;
     private getItemsState;
     getState(isRepeatableChild?: boolean, forRestore?: boolean): T & {
-        items: any[];
         enabled: boolean | undefined;
         readOnly: any;
+        _itemTemplate?: {
+            description?: string | undefined;
+            rules?: import("./types/Json").Items<string> | undefined;
+            events?: import("./types/Json").Items<string | string[] | undefined> | undefined;
+            enumNames?: string[] | undefined;
+            enum?: any[] | undefined;
+            accept?: string[] | undefined;
+            enforceEnum?: boolean | undefined;
+            exclusiveMinimum?: string | number | undefined;
+            exclusiveMaximum?: string | number | undefined;
+            format?: string | undefined;
+            maxFileSize?: string | number | undefined;
+            maxLength?: number | undefined;
+            maximum?: string | number | undefined;
+            maxItems?: number | undefined;
+            minOccur?: number | undefined;
+            maxOccur?: number | undefined;
+            minLength?: number | undefined;
+            minimum?: string | number | undefined;
+            minItems?: number | undefined;
+            pattern?: string | undefined;
+            required?: boolean | undefined;
+            step?: number | undefined;
+            type?: string | undefined;
+            validationExpression?: string | undefined;
+            uniqueItems?: boolean | undefined;
+            dataRef?: string | null | undefined;
+            lang?: string | undefined;
+            ':type'?: string | undefined;
+            appliedCssClassNames?: string | undefined;
+            label?: import("./types/Json").Label | undefined;
+            enabled?: boolean | undefined;
+            visible?: boolean | undefined;
+            name?: string | undefined;
+            constraintMessages?: import("./types/Json").ConstraintsMessages | undefined;
+            fieldType?: string | undefined;
+            errorMessage?: string | undefined;
+            properties?: {
+                [key: string]: any;
+            } | undefined;
+            repeatable?: boolean | undefined;
+            screenReaderText?: string | undefined;
+            tooltip?: string | undefined;
+            altText?: string | undefined;
+            viewType?: string | undefined;
+            buttonType?: string | undefined;
+            placeholder?: string | undefined;
+            readOnly?: boolean | undefined;
+            valid?: boolean | undefined;
+            validity?: any;
+            validationMessage?: string | undefined;
+            default?: any;
+            value?: any;
+            displayFormat?: string | undefined;
+            editFormat?: string | undefined;
+            editValue?: string | undefined;
+            displayValue?: string | undefined;
+            displayValueExpression?: string | undefined;
+            emptyValue?: "" | "undefined" | "null" | undefined;
+            checked?: boolean | undefined;
+        } | {
+            description?: string | undefined;
+            rules?: import("./types/Json").Items<string> | undefined;
+            events?: import("./types/Json").Items<string | string[] | undefined> | undefined;
+            enumNames?: string[] | undefined;
+            enum?: any[] | undefined;
+            accept?: string[] | undefined;
+            enforceEnum?: boolean | undefined;
+            exclusiveMinimum?: string | number | undefined;
+            exclusiveMaximum?: string | number | undefined;
+            format?: string | undefined;
+            maxFileSize?: string | number | undefined;
+            maxLength?: number | undefined;
+            maximum?: string | number | undefined;
+            maxItems?: number | undefined;
+            minOccur?: number | undefined;
+            maxOccur?: number | undefined;
+            minLength?: number | undefined;
+            minimum?: string | number | undefined;
+            minItems?: number | undefined;
+            pattern?: string | undefined;
+            required?: boolean | undefined;
+            step?: number | undefined;
+            type?: "object" | "array" | undefined;
+            validationExpression?: string | undefined;
+            uniqueItems?: boolean | undefined;
+            dataRef?: string | null | undefined;
+            lang?: string | undefined;
+            ':type'?: string | undefined;
+            appliedCssClassNames?: string | undefined;
+            label?: import("./types/Json").Label | undefined;
+            enabled?: boolean | undefined;
+            visible?: boolean | undefined;
+            name?: string | undefined;
+            constraintMessages?: import("./types/Json").ConstraintsMessages | undefined;
+            fieldType?: string | undefined;
+            errorMessage?: string | undefined;
+            properties?: {
+                [key: string]: any;
+            } | undefined;
+            repeatable?: boolean | undefined;
+            screenReaderText?: string | undefined;
+            tooltip?: string | undefined;
+            altText?: string | undefined;
+            viewType?: string | undefined;
+            buttonType?: string | undefined;
+            items: (FieldJson | ContainerJson)[];
+            initialItems?: number | undefined;
+            activeChild?: string | undefined;
+            readOnly?: boolean | undefined;
+        } | undefined;
+        items: any[];
         ':items'?: undefined;
         ':itemsOrder'?: undefined;
-        _dependents?: string[] | undefined;
+        _dependents?: {
+            id: string;
+            propertyName: string | undefined;
+        }[] | undefined;
         allowedComponents?: undefined;
         columnClassNames?: undefined;
         columnCount?: undefined;

package/lib/Container.js

@@ -98,25 +98,25 @@ class Container extends Scriptable_1.default {
         }) : [];
     }
     getItemsState(isRepeatableChild = false, forRestore = false) {
-        if (this._jsonModel.type === 'array' || (0, JsonUtils_1.isRepeatable)(this._jsonModel) || isRepeatableChild) {
-            if (isRepeatableChild) {
-                return this._getFormAndSitesState(isRepeatableChild, forRestore);
-            }
-            else {
-                return this._children.map(x => {
-                    return Object.assign({}, x.getState(true, forRestore));
-                });
-            }
+        const isThisContainerRepeatable = this._jsonModel.type === 'array' || (0, JsonUtils_1.isRepeatable)(this._jsonModel);
+        if (isThisContainerRepeatable) {
+            return this._children.map(x => {
+                return Object.assign({}, x.getState(true, forRestore));
+            });
         }
         else {
             return this._getFormAndSitesState(isRepeatableChild, forRestore);
         }
     }
     getState(isRepeatableChild = false, forRestore = false) {
-        return Object.assign(Object.assign(Object.assign({}, super.getState(forRestore)), (forRestore ? {
-            ':items': undefined,
-            ':itemsOrder': undefined
-        } : {})), { items: this.getItemsState(isRepeatableChild, forRestore), enabled: this.enabled, readOnly: this.readOnly });
+        return this.withDependencyTrackingControl(true, () => {
+            return Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, super.getState(forRestore)), (forRestore ? {
+                ':items': undefined,
+                ':itemsOrder': undefined
+            } : {})), { items: this.getItemsState(isRepeatableChild, forRestore) }), ((this._jsonModel.type === 'array' || (0, JsonUtils_1.isRepeatable)(this._jsonModel)) && this._itemTemplate ? {
+                _itemTemplate: Object.assign({}, this._itemTemplate)
+            } : {})), { enabled: this.enabled, readOnly: this.readOnly });
+        });
     }
     _createChild(child, options) {
         return this.fieldFactory.createField(child, options);
@@ -148,10 +148,10 @@ class Container extends Scriptable_1.default {
             Object.defineProperty(parent._childrenReference, name, {
                 get: () => {
                     if (child.isContainer && child.hasDynamicItems()) {
-                        self.ruleEngine.trackDependency(child);
+                        self.ruleEngine.trackDependency(child, 'items');
                     }
                     if (self.hasDynamicItems()) {
-                        self.ruleEngine.trackDependency(self);
+                        self.ruleEngine.trackDependency(self, 'items');
                         if (this._children[name] !== undefined) {
                             return this._children[name].getRuleNode();
                         }
@@ -214,7 +214,8 @@ class Container extends Scriptable_1.default {
         const items = this._jsonModel.items || [];
         this._childrenReference = this._jsonModel.type == 'array' ? [] : {};
         if (this._canHaveRepeatingChildren(mode)) {
-            this._itemTemplate = (0, JsonUtils_1.deepClone)(items[0]);
+            this._itemTemplate = this._jsonModel._itemTemplate || (0, JsonUtils_1.deepClone)(items[0]);
+            this._jsonModel._itemTemplate = undefined;
             if (mode === 'restore') {
                 this._itemTemplate.repeatable = undefined;
             }
@@ -401,9 +402,8 @@ class Container extends Scriptable_1.default {
             if (items2Remove > 0) {
                 for (let i = 0; i < items2Remove; i++) {
                     this._childrenReference.pop();
-                    this._children.pop();
+                    result.removed.push(this._children.pop());
                 }
-                result.removed.push(...this._children);
             }
         }
         this._children.forEach(x => {

package/lib/Field.d.ts

@@ -197,6 +197,8 @@ declare class Field extends Scriptable<FieldJson> implements FieldModel {
         errorMessage?: string | undefined;
         properties: {
             [key: string]: any;
+        } & {
+            [key: string]: any;
         };
         repeatable?: boolean | undefined;
         screenReaderText?: string | undefined;
@@ -213,7 +215,10 @@ declare class Field extends Scriptable<FieldJson> implements FieldModel {
         displayValueExpression?: string | undefined;
         emptyValue?: "" | "undefined" | "null" | undefined;
         checked?: boolean | undefined;
-        _dependents?: string[] | undefined;
+        _dependents?: {
+            id: string;
+            propertyName: string | undefined;
+        }[] | undefined;
         allowedComponents?: undefined;
         columnClassNames?: undefined;
         columnCount?: undefined;

package/lib/Field.js

@@ -445,7 +445,7 @@ class Field extends Scriptable_1.default {
     valueOf() {
         const obj = this[BaseNode_1.target];
         const actualField = obj === undefined ? this : obj;
-        actualField.ruleEngine.trackDependency(actualField);
+        actualField.ruleEngine.trackDependency(actualField, 'value');
         return actualField._jsonModel.value || null;
     }
     toString() {

package/lib/Form.d.ts

@@ -4,7 +4,7 @@ import SubmitMetaData from './SubmitMetaData';
 import EventQueue from './controller/EventQueue';
 import { LogLevel, Logger } from './controller/Logger';
 import RuleEngine from './rules/RuleEngine';
-import { Action, BaseModel, FieldModel, FieldsetModel, FocusOption, FormCreationMode, FormJson, FormModel, IFormFieldFactory } from './types/index';
+import { Action, BaseModel, FieldModel, FieldsetModel, FocusOption, FormCreationMode, FormJson, FormModel, IFormFieldFactory, Items } from './types/index';
 import { Version } from './utils/Version';
 export declare const currentVersion: Version;
 declare class Form extends Container<FormJson> implements FormModel {
@@ -97,12 +97,126 @@ declare class Form extends Container<FormJson> implements FormModel {
         adaptiveform?: string | undefined;
         lang?: string | undefined;
     } & {
-        items: any[];
         enabled: boolean | undefined;
         readOnly: any;
+        _itemTemplate?: {
+            description?: string | undefined;
+            rules?: Items<string> | undefined;
+            events?: Items<string | string[] | undefined> | undefined;
+            enumNames?: string[] | undefined;
+            enum?: any[] | undefined;
+            accept?: string[] | undefined;
+            enforceEnum?: boolean | undefined;
+            exclusiveMinimum?: string | number | undefined;
+            exclusiveMaximum?: string | number | undefined;
+            format?: string | undefined;
+            maxFileSize?: string | number | undefined;
+            maxLength?: number | undefined;
+            maximum?: string | number | undefined;
+            maxItems?: number | undefined;
+            minOccur?: number | undefined;
+            maxOccur?: number | undefined;
+            minLength?: number | undefined;
+            minimum?: string | number | undefined;
+            minItems?: number | undefined;
+            pattern?: string | undefined;
+            required?: boolean | undefined;
+            step?: number | undefined;
+            type?: string | undefined;
+            validationExpression?: string | undefined;
+            uniqueItems?: boolean | undefined;
+            dataRef?: string | null | undefined;
+            lang?: string | undefined;
+            ':type'?: string | undefined;
+            appliedCssClassNames?: string | undefined;
+            label?: import("./types/Json").Label | undefined;
+            enabled?: boolean | undefined;
+            visible?: boolean | undefined;
+            name?: string | undefined;
+            constraintMessages?: import("./types/Json").ConstraintsMessages | undefined;
+            fieldType?: string | undefined;
+            errorMessage?: string | undefined;
+            properties?: {
+                [key: string]: any;
+            } | undefined;
+            repeatable?: boolean | undefined;
+            screenReaderText?: string | undefined;
+            tooltip?: string | undefined;
+            altText?: string | undefined;
+            viewType?: string | undefined;
+            buttonType?: string | undefined;
+            placeholder?: string | undefined;
+            readOnly?: boolean | undefined;
+            valid?: boolean | undefined;
+            validity?: any;
+            validationMessage?: string | undefined;
+            default?: any;
+            value?: any;
+            displayFormat?: string | undefined;
+            editFormat?: string | undefined;
+            editValue?: string | undefined;
+            displayValue?: string | undefined;
+            displayValueExpression?: string | undefined;
+            emptyValue?: "" | "undefined" | "null" | undefined;
+            checked?: boolean | undefined;
+        } | {
+            description?: string | undefined;
+            rules?: Items<string> | undefined;
+            events?: Items<string | string[] | undefined> | undefined;
+            enumNames?: string[] | undefined;
+            enum?: any[] | undefined;
+            accept?: string[] | undefined;
+            enforceEnum?: boolean | undefined;
+            exclusiveMinimum?: string | number | undefined;
+            exclusiveMaximum?: string | number | undefined;
+            format?: string | undefined;
+            maxFileSize?: string | number | undefined;
+            maxLength?: number | undefined;
+            maximum?: string | number | undefined;
+            maxItems?: number | undefined;
+            minOccur?: number | undefined;
+            maxOccur?: number | undefined;
+            minLength?: number | undefined;
+            minimum?: string | number | undefined;
+            minItems?: number | undefined;
+            pattern?: string | undefined;
+            required?: boolean | undefined;
+            step?: number | undefined;
+            type?: "object" | "array" | undefined;
+            validationExpression?: string | undefined;
+            uniqueItems?: boolean | undefined;
+            dataRef?: string | null | undefined;
+            lang?: string | undefined;
+            ':type'?: string | undefined;
+            appliedCssClassNames?: string | undefined;
+            label?: import("./types/Json").Label | undefined;
+            enabled?: boolean | undefined;
+            visible?: boolean | undefined;
+            name?: string | undefined;
+            constraintMessages?: import("./types/Json").ConstraintsMessages | undefined;
+            fieldType?: string | undefined;
+            errorMessage?: string | undefined;
+            properties?: {
+                [key: string]: any;
+            } | undefined;
+            repeatable?: boolean | undefined;
+            screenReaderText?: string | undefined;
+            tooltip?: string | undefined;
+            altText?: string | undefined;
+            viewType?: string | undefined;
+            buttonType?: string | undefined;
+            items: (import("./types/Json").FieldJson | import("./types/Json").ContainerJson)[];
+            initialItems?: number | undefined;
+            activeChild?: string | undefined;
+            readOnly?: boolean | undefined;
+        } | undefined;
+        items: any[];
         ':items'?: undefined;
         ':itemsOrder'?: undefined;
-        _dependents?: string[] | undefined;
+        _dependents?: {
+            id: string;
+            propertyName: string | undefined;
+        }[] | undefined;
         allowedComponents?: undefined;
         columnClassNames?: undefined;
         columnCount?: undefined;

package/lib/PropertiesManager.d.ts

@@ -0,0 +1,14 @@
+export class PropertiesManager {
+    constructor(host: any);
+    host: any;
+    _definedProperties: Set<any>;
+    _propertiesWrapper: {};
+    _initialized: boolean;
+    set properties(arg: {});
+    get properties(): {};
+    ensurePropertyDescriptor(propertyName: any): void;
+    _setupInitialProperties(): void;
+    _ensurePropertyDescriptor(prop: any): void;
+    updateNestedProperty(propertyPath: any, value: any): void;
+    updateSimpleProperty(propertyName: any, value: any): void;
+}

package/lib/PropertiesManager.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PropertiesManager = void 0;
+const Events_1 = require("./controller/Events");
+class PropertiesManager {
+    constructor(host) {
+        this.host = host;
+        this._definedProperties = new Set();
+        this._propertiesWrapper = {};
+        this._initialized = false;
+    }
+    get properties() {
+        if (!this._initialized) {
+            this._setupInitialProperties();
+            this._initialized = true;
+        }
+        return this._propertiesWrapper;
+    }
+    set properties(p) {
+        const oldProperties = this.host._jsonModel.properties || {};
+        const newProperties = Object.assign({}, p);
+        this.host._jsonModel.properties = newProperties;
+        Object.keys(newProperties).forEach(prop => {
+            this._ensurePropertyDescriptor(prop);
+        });
+        Object.keys(Object.assign(Object.assign({}, oldProperties), newProperties)).forEach(prop => {
+            if (oldProperties[prop] !== newProperties[prop]) {
+                const changeAction = (0, Events_1.propertyChange)(`properties.${prop}`, newProperties[prop], oldProperties[prop]);
+                this.host.notifyDependents(changeAction);
+            }
+        });
+    }
+    ensurePropertyDescriptor(propertyName) {
+        this._ensurePropertyDescriptor(propertyName);
+    }
+    _setupInitialProperties() {
+        const properties = this.host._jsonModel.properties || {};
+        Object.keys(properties).forEach(prop => {
+            this._ensurePropertyDescriptor(prop);
+        });
+        if (!this.host._jsonModel.properties) {
+            this.host._jsonModel.properties = {};
+        }
+    }
+    _ensurePropertyDescriptor(prop) {
+        if (this._definedProperties.has(prop)) {
+            return;
+        }
+        Object.defineProperty(this._propertiesWrapper, prop, {
+            get: () => {
+                if (!prop.startsWith('fd:')) {
+                    this.host.ruleEngine.trackDependency(this.host, `properties.${prop}`);
+                }
+                const properties = this.host._jsonModel.properties || {};
+                return properties[prop];
+            },
+            set: (value) => {
+                const properties = this.host._jsonModel.properties || {};
+                const oldValue = properties[prop];
+                if (oldValue !== value) {
+                    const updatedProperties = Object.assign(Object.assign({}, properties), { [prop]: value });
+                    this.host._jsonModel.properties = updatedProperties;
+                    const changeAction = (0, Events_1.propertyChange)(`properties.${prop}`, value, oldValue);
+                    this.host.notifyDependents(changeAction);
+                }
+            },
+            enumerable: true,
+            configurable: true
+        });
+        this._definedProperties.add(prop);
+    }
+    updateNestedProperty(propertyPath, value) {
+        const parts = propertyPath.split('.');
+        const topLevelProp = parts[0];
+        this._ensurePropertyDescriptor(topLevelProp);
+        const properties = this.host._jsonModel.properties || {};
+        const updatedProperties = JSON.parse(JSON.stringify(properties));
+        const currentObj = updatedProperties[topLevelProp] || {};
+        updatedProperties[topLevelProp] = currentObj;
+        let parentObj = currentObj;
+        for (let i = 1; i < parts.length - 1; i++) {
+            if (!parentObj[parts[i]]) {
+                parentObj[parts[i]] = {};
+            }
+            else if (typeof parentObj[parts[i]] !== 'object') {
+                parentObj[parts[i]] = {};
+            }
+            parentObj = parentObj[parts[i]];
+        }
+        const finalProp = parts[parts.length - 1];
+        const oldValue = parentObj[finalProp];
+        parentObj[finalProp] = value;
+        this.host._jsonModel.properties = updatedProperties;
+        const changeAction = (0, Events_1.propertyChange)(`properties.${propertyPath}`, value, oldValue);
+        this.host.notifyDependents(changeAction);
+    }
+    updateSimpleProperty(propertyName, value) {
+        this._ensurePropertyDescriptor(propertyName);
+        this._propertiesWrapper[propertyName] = value;
+    }
+}
+exports.PropertiesManager = PropertiesManager;

package/lib/controller/EventQueue.js

@@ -47,10 +47,22 @@ class EventQueue {
             events = [events];
         }
         events.forEach(e => {
+            var _a;
             const evntNode = new EventNode(node, e);
             const counter = this._runningEventCount[evntNode.valueOf()] || 0;
             if (counter < EventQueue.MAX_EVENT_CYCLE_COUNT) {
-                this.logger.info(`Queued event : ${e.type} node: ${node.id} - ${node.name}`);
+                let payloadAsStr = '';
+                if ((e === null || e === void 0 ? void 0 : e.type) === 'change' && !((_a = e === null || e === void 0 ? void 0 : e.payload) === null || _a === void 0 ? void 0 : _a.changes.map(_ => _.propertyName).includes('activeChild'))) {
+                    payloadAsStr = JSON.stringify(e.payload.changes, null, 2);
+                }
+                else if (e === null || e === void 0 ? void 0 : e.type.includes('setProperty')) {
+                    payloadAsStr = JSON.stringify(e.payload, null, 2);
+                }
+                if (this.logger.isLevelEnabled('info')) {
+                    node.withDependencyTrackingControl(true, () => {
+                        this.logger.info(`Queued event : ${e.type} node: ${node.id} - ${node.qualifiedName} - ${payloadAsStr}`);
+                    });
+                }
                 if (priority) {
                     const index = this._isProcessing ? 1 : 0;
                     this._pendingEvents.splice(index, 0, evntNode);

package/lib/controller/Logger.d.ts

@@ -6,6 +6,7 @@ export declare class Logger {
     warn(msg: string): void;
     error(msg: string): void;
     log(msg: string, level: LogFunction): void;
+    isLevelEnabled(level: LogFunction): boolean;
     private logLevel;
     constructor(logLevel?: LogLevel);
 }

package/lib/controller/Logger.js

@@ -29,5 +29,8 @@ class Logger {
             console[level](msg);
         }
     }
+    isLevelEnabled(level) {
+        return this.logLevel !== 0 && this.logLevel <= levels[level];
+    }
 }
 exports.Logger = Logger;

package/lib/rules/FunctionRuntime.d.ts

@@ -33,7 +33,7 @@ declare class FunctionRuntimeImpl {
             _signature: never[];
         };
         importData: {
-            _func: (args: Array<unknown>, data: unknown, interpreter: any) => {};
+            _func: (args: Array<unknown>, data: unknown, interpreter: any) => any;
             _signature: never[];
         };
         submitForm: {
@@ -44,6 +44,14 @@ declare class FunctionRuntimeImpl {
             _func: (args: Array<unknown>, data: unknown, interpreter: any) => {};
             _signature: never[];
         };
+        setVariable: {
+            _func: (args: Array<unknown>, data: unknown, interpreter: any) => {};
+            _signature: never[];
+        };
+        getVariable: {
+            _func: (args: Array<unknown>, data: unknown, interpreter: any) => any;
+            _signature: never[];
+        };
         request: {
             _func: (args: Array<unknown>, data: unknown, interpreter: any) => Promise<any>;
             _signature: never[];
@@ -99,6 +107,10 @@ declare class FunctionRuntimeImpl {
             _func: (args: Array<unknown>, data: unknown, interpreter: any) => number;
             _signature: never[];
         };
+        today: {
+            _func: () => number;
+            _signature: never[];
+        };
     };
 }
 export declare const FunctionRuntime: FunctionRuntimeImpl;