@aemforms/af-core 0.22.136 → 0.22.138

package/esm/types/src/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/esm/types/src/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/esm/types/src/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/esm/types/src/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/esm/types/src/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;

package/esm/types/src/rules/RuleEngine.d.ts

@@ -12,7 +12,7 @@ declare class RuleEngine {
         ast: any;
     };
     execute(node: any, data: any, globals: any, useValueOf: boolean | undefined, eString: string): any;
-    trackDependency(subscriber: BaseModel): void;
+    trackDependency(subscriber: BaseModel, propertyName?: string): void;
     setDependencyTracking(track: boolean): void;
     getDependencyTracking(): boolean;
 }

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

@@ -79,7 +79,7 @@ export interface BaseModel extends ConstraintsJson, WithController {
     getRuleNode(): any;
     ruleNodeReference(): any;
     _initialize(mode?: FormCreationMode): any;
-    _addDependent(dependent: BaseModel): any;
+    _addDependent(dependent: BaseModel, propertyName?: string): any;
     _eventSource: EventSource;
     readonly fragment: string;
 }

package/lib/BaseNode.d.ts

@@ -1,4 +1,5 @@
 import { Action, BaseJson, BaseModel, callbackFn, ContainerModel, FormCreationMode, FormModel, Primitives, ValidationError, EventSource } from './types/index';
+import { PropertiesManager } from './PropertiesManager.js';
 import DataGroup from './data/DataGroup';
 import DataValue from './data/DataValue';
 export declare const editableProperties: string[];
@@ -22,6 +23,7 @@ export declare abstract class BaseNode<T extends BaseJson> implements BaseModel
     _eventSource: EventSource;
     protected _fragment: string;
     protected _idSet: Set<string> | undefined;
+    private _propertiesManager;
     protected createIdSet(): Set<string> | undefined;
     get isContainer(): boolean;
     constructor(params: T, _options: {
@@ -56,9 +58,15 @@ export declare abstract class BaseNode<T extends BaseJson> implements BaseModel
     set label(l: import("./types/Json").Label | undefined);
     get uniqueItems(): boolean | undefined;
     isTransparent(): boolean;
-    getDependents(): string[];
+    getDependents(): {
+        id: string;
+        propertyName: string | undefined;
+    }[];
     getState(forRestore?: boolean): T & {
-        _dependents?: string[] | undefined;
+        _dependents?: {
+            id: string;
+            propertyName: string | undefined;
+        }[] | undefined;
         allowedComponents?: undefined;
         columnClassNames?: undefined;
         columnCount?: undefined;
@@ -78,7 +86,7 @@ export declare abstract class BaseNode<T extends BaseJson> implements BaseModel
     subscribe(callback: callbackFn, eventName?: string): {
         unsubscribe: () => void;
     };
-    _addDependent(dependent: BaseModel): void;
+    _addDependent(dependent: BaseModel, propertyName?: string): void;
     removeDependent(dependent: BaseModel): void;
     abstract validate(): Array<ValidationError>;
     abstract executeAction(action: Action): any;
@@ -98,6 +106,7 @@ export declare abstract class BaseNode<T extends BaseJson> implements BaseModel
     set properties(p: {
         [key: string]: any;
     });
+    getPropertiesManager(): PropertiesManager;
     abstract defaultDataModel(name: string | number): DataValue | undefined;
     abstract syncDataAndFormModel(a?: DataValue | DataGroup): any;
     getNonTransparentParent(): ContainerModel;

package/lib/BaseNode.js

@@ -12,6 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseNode = exports.exclude = exports.include = exports.dependencyTracked = exports.qualifiedName = exports.target = exports.staticFields = exports.dynamicProps = exports.editableProperties = void 0;
 const index_1 = require("./types/index");
 const Events_1 = require("./controller/Events");
+const PropertiesManager_js_1 = require("./PropertiesManager.js");
 const DataRefParser_1 = require("./utils/DataRefParser");
 const EmptyDataValue_1 = __importDefault(require("./data/EmptyDataValue"));
 const ValidationUtils_1 = require("./utils/ValidationUtils");
@@ -86,7 +87,7 @@ function dependencyTracked() {
         const get = descriptor.get;
         if (get != undefined) {
             descriptor.get = function () {
-                this.ruleEngine.trackDependency(this);
+                this.ruleEngine.trackDependency(this, propertyKey);
                 return get.call(this);
             };
         }
@@ -133,6 +134,7 @@ class BaseNode {
         else if ((_b = this.parent) === null || _b === void 0 ? void 0 : _b.fragment) {
             this._fragment = this.parent.fragment;
         }
+        this._propertiesManager = new PropertiesManager_js_1.PropertiesManager(this);
     }
     createIdSet() {
         return new Set();
@@ -256,7 +258,11 @@ class BaseNode {
         return this._jsonModel.label;
     }
     set label(l) {
-        if (l !== this._jsonModel.label) {
+        const isLabelSame = (l !== null && this._jsonModel.label !== null &&
+            typeof l === 'object' && typeof this._jsonModel.label === 'object') ?
+            JSON.stringify(l) === JSON.stringify(this._jsonModel.label) :
+            l === this._jsonModel.label;
+        if (!isLabelSame) {
             const changeAction = (0, Events_1.propertyChange)('label', l, this._jsonModel.label);
             this._jsonModel = Object.assign(Object.assign({}, this._jsonModel), { label: l });
             this.notifyDependents(changeAction);
@@ -271,20 +277,22 @@ class BaseNode {
         return !this._jsonModel.name && !isNonTransparent;
     }
     getDependents() {
-        return this._dependents.map(x => x.node.id);
+        return this._dependents.map(x => ({ id: x.node.id, propertyName: x.propertyName }));
     }
     getState(forRestore = false) {
-        return Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, this._jsonModel), { properties: this.properties, index: this.index, parent: undefined, qualifiedName: this.qualifiedName }), (this.repeatable === true ? {
-            repeatable: true,
-            minOccur: this.parent.minItems,
-            maxOccur: this.parent.maxItems
-        } : {})), { ':type': this[':type'] }), (forRestore ? {
-            _dependents: this._dependents.length ? this.getDependents() : undefined,
-            allowedComponents: undefined,
-            columnClassNames: undefined,
-            columnCount: undefined,
-            gridClassNames: undefined
-        } : {}));
+        return this.withDependencyTrackingControl(true, () => {
+            return Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, this._jsonModel), { properties: this.properties, index: this.index, parent: undefined, qualifiedName: this.qualifiedName }), (this.repeatable === true ? {
+                repeatable: true,
+                minOccur: this.parent.minItems,
+                maxOccur: this.parent.maxItems
+            } : {})), { ':type': this[':type'] }), (forRestore ? {
+                _dependents: this._dependents.length ? this.getDependents() : undefined,
+                allowedComponents: undefined,
+                columnClassNames: undefined,
+                columnCount: undefined,
+                gridClassNames: undefined
+            } : {}));
+        });
     }
     subscribe(callback, eventName = 'change') {
         this._callbacks[eventName] = this._callbacks[eventName] || [];
@@ -295,13 +303,14 @@ class BaseNode {
             }
         };
     }
-    _addDependent(dependent) {
+    _addDependent(dependent, propertyName) {
         if (this._dependents.find(({ node }) => node === dependent) === undefined) {
             const subscription = this.subscribe((change) => {
                 const changes = change.payload.changes;
                 const propsToLook = [...exports.dynamicProps, 'items'];
                 const isPropChanged = changes.findIndex(x => {
-                    return propsToLook.indexOf(x.propertyName) > -1;
+                    const changedPropertyName = x.propertyName;
+                    return propsToLook.includes(changedPropertyName) || (changedPropertyName.startsWith('properties.') && propertyName === changedPropertyName);
                 }) > -1;
                 if (isPropChanged) {
                     if (this.form.changeEventBehaviour === 'deps') {
@@ -312,7 +321,7 @@ class BaseNode {
                     }
                 }
             });
-            this._dependents.push({ node: dependent, subscription });
+            this._dependents.push({ node: dependent, propertyName, subscription });
         }
     }
     removeDependent(dependent) {
@@ -348,9 +357,9 @@ class BaseNode {
         const depsToRestore = this._jsonModel._dependents;
         if (depsToRestore) {
             depsToRestore.forEach((x) => {
-                const node = this.form.getElement(x);
+                const node = this.form.getElement(x.id);
                 if (node) {
-                    this._addDependent(node);
+                    this._addDependent(node, x.propertyName);
                 }
             });
             this._jsonModel._dependents = undefined;
@@ -476,10 +485,13 @@ class BaseNode {
         return this._lang;
     }
     get properties() {
-        return this._jsonModel.properties || {};
+        return this._propertiesManager.properties;
     }
     set properties(p) {
-        this._setProperty('properties', Object.assign({}, p));
+        this._propertiesManager.properties = p;
+    }
+    getPropertiesManager() {
+        return this._propertiesManager;
     }
     getNonTransparentParent() {
         let nonTransparentParent = this.parent;
@@ -570,7 +582,4 @@ __decorate([
 __decorate([
     dependencyTracked()
 ], BaseNode.prototype, "label", null);
-__decorate([
-    dependencyTracked()
-], BaseNode.prototype, "properties", null);
 exports.BaseNode = BaseNode;

package/lib/Checkbox.d.ts

@@ -129,6 +129,8 @@ declare class Checkbox extends Field {
         errorMessage?: string | undefined;
         properties: {
             [key: string]: any;
+        } & {
+            [key: string]: any;
         };
         repeatable?: boolean | undefined;
         screenReaderText?: string | undefined;
@@ -144,7 +146,10 @@ declare class Checkbox extends Field {
         value?: any;
         displayValueExpression?: string | undefined;
         emptyValue?: "" | "undefined" | "null" | undefined;
-        _dependents?: string[] | undefined;
+        _dependents?: {
+            id: string;
+            propertyName: string | undefined;
+        }[] | undefined;
         allowedComponents?: undefined;
         columnClassNames?: undefined;
         columnCount?: undefined;