@aemforms/af-core 0.22.18 → 0.22.20

package/lib/{BaseNode.d.ts → esm/BaseNode.d.ts}

@@ -1,13 +1,7 @@
-import { Action, BaseJson, BaseModel, callbackFn, ContainerModel, FormModel, Primitives, ValidationError } from './types';
-import DataGroup from './data/DataGroup';
-import DataValue from './data/DataValue';
-/**
- * Defines the properties that are editable. These properties can be modified during rule execution.
- */
+import { Action, BaseJson, BaseModel, callbackFn, ContainerModel, FormModel, Primitives, ValidationError } from './types/index.js';
+import DataGroup from './data/DataGroup.js';
+import DataValue from './data/DataValue.js';
 export declare const editableProperties: string[];
-/**
- * Defines props that are dynamic and can be changed at runtime.
- */
 export declare const dynamicProps: string[];
 export declare const staticFields: string[];
 export declare const target: unique symbol;
@@ -15,13 +9,10 @@ export declare const qualifiedName: unique symbol;
 export declare function dependencyTracked(): (target: BaseNode<any>, propertyKey: string, descriptor: PropertyDescriptor) => void;
 export declare const include: (...fieldTypes: string[]) => (target: BaseNode<any>, propertyKey: string, descriptor: PropertyDescriptor) => void;
 export declare const exclude: (...fieldTypes: string[]) => (target: BaseNode<any>, propertyKey: string, descriptor: PropertyDescriptor) => void;
-/**
- * Defines a generic base class which all objects of form runtime model should extend from.
- * @typeparam T type of the form object which extends from {@link BaseJson | base type}
- */
 export declare abstract class BaseNode<T extends BaseJson> implements BaseModel {
     private _options;
     private _ruleNode;
+    private _lang?;
     private _callbacks;
     private _dependents;
     protected _jsonModel: T & {
@@ -29,31 +20,21 @@ export declare abstract class BaseNode<T extends BaseJson> implements BaseModel
     };
     private _tokens;
     get isContainer(): boolean;
-    /**
-     * @constructor
-     * @param params
-     * @param _options
-     * @private
-     */
     constructor(params: T, _options: {
         form: FormModel;
         parent: ContainerModel;
     });
     abstract value: Primitives;
+    abstract reset(): any;
     protected setupRuleNode(): void;
-    /**
-     * @private
-     */
     ruleNodeReference(): this;
-    /**
-     * @private
-     */
     getRuleNode(): any;
     private getFromRule;
     get id(): string;
     get index(): number;
     get parent(): ContainerModel;
     get type(): string | undefined;
+    get repeatable(): any;
     get fieldType(): string;
     get ':type'(): string;
     get name(): string | undefined;
@@ -63,13 +44,10 @@ export declare abstract class BaseNode<T extends BaseJson> implements BaseModel
     get visible(): boolean | undefined;
     set visible(v: boolean | undefined);
     get form(): FormModel;
-    get ruleEngine(): import("./rules/RuleEngine").default;
-    get label(): import("./types").Label | undefined;
-    set label(l: import("./types").Label | undefined);
+    get ruleEngine(): import("./rules/RuleEngine.js").default;
+    get label(): import("./types/Json.js").Label | undefined;
+    set label(l: import("./types/Json.js").Label | undefined);
     get uniqueItems(): boolean | undefined;
-    /**
-     * Transparent form fields are meant only for creation of view. They are also not part of data
-     */
     isTransparent(): boolean;
     getState(): T & {
         properties: {
@@ -80,49 +58,25 @@ export declare abstract class BaseNode<T extends BaseJson> implements BaseModel
         qualifiedName: any;
         events: {};
         rules: {};
+        repeatable: boolean | undefined;
         ':type': string;
         id: string;
     };
-    /**
-     * @private
-     */
     subscribe(callback: callbackFn, eventName?: string): {
         unsubscribe: () => void;
     };
-    /**
-     * @private
-     */
     _addDependent(dependent: BaseModel): void;
-    /**
-     * @private
-     */
     removeDependent(dependent: BaseModel): void;
     abstract validate(): Array<ValidationError>;
     abstract executeAction(action: Action): any;
-    /**
-     * @private
-     */
     queueEvent(action: Action): void;
     dispatch(action: Action): void;
-    /**
-     * @private
-     */
     notifyDependents(action: Action): void;
-    /**
-     * @param prop
-     * @param newValue
-     * @private
-     */
     _setProperty<T>(prop: string, newValue: T, notify?: boolean): any;
-    /**
-     * @private
-     */
     _bindToDataModel(contextualDataModel: DataGroup): void;
     private _data?;
-    /**
-     * @private
-     */
     getDataNode(): DataValue | undefined;
+    get language(): string | undefined;
     get properties(): {
         [key: string]: any;
     };
@@ -132,18 +86,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
-     */
     _initialize(): void;
-    /**
-     * Checks whether there are any updates in the properties. If there are applies them to the
-     * json model as well.
-     * @param propNames
-     * @param updates
-     * @private
-     */
     protected _applyUpdates(propNames: string[], updates: any): any;
     get qualifiedName(): any;
     focus(): void;

package/lib/{BaseNode.js → esm/BaseNode.js}

@@ -1,29 +1,13 @@
-"use strict";
-/*
- * Copyright 2022 Adobe, Inc.
- *
- * Your access and use of this software is governed by the Adobe Customer Feedback Program Terms and Conditions or other Beta License Agreement signed by your employer and Adobe, Inc.. This software is NOT open source and may not be used without one of the foregoing licenses. Even with a foregoing license, your access and use of this file is limited to the earlier of (a) 180 days, (b) general availability of the product(s) which utilize this software (i.e. AEM Forms), (c) January 1, 2023, (d) Adobe providing notice to you that you may no longer use the software or that your beta trial has otherwise ended.
- *
- * 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.
- */
 var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
     var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
     if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
     else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-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 controller_1 = require("./controller");
-const DataRefParser_1 = require("./utils/DataRefParser");
-const EmptyDataValue_1 = __importDefault(require("./data/EmptyDataValue"));
-/**
- * Defines the properties that are editable. These properties can be modified during rule execution.
- */
-exports.editableProperties = [
+import { ExecuteRule, propertyChange } from './controller/Events.js';
+import { resolveData, TOK_GLOBAL, tokenize } from './utils/DataRefParser.js';
+import NullDataValue from './data/EmptyDataValue.js';
+export const editableProperties = [
     'value',
     'label',
     'description',
@@ -34,39 +18,23 @@ exports.editableProperties = [
     'enumNames',
     'required',
     'properties',
-    // 'enforceEnum', // not exposed for now
     'exclusiveMinimum',
     'exclusiveMaximum',
-    //    'maxLength',
     'maximum',
     'maxItems',
-    //    'minLength',
     'minimum',
     'minItems'
-    //    'step'
-    // 'placeholder' // not exposed for now.
 ];
-/**
- * Defines props that are dynamic and can be changed at runtime.
- */
-exports.dynamicProps = [
-    ...exports.editableProperties,
+export const dynamicProps = [
+    ...editableProperties,
     'valid',
     'index',
     'activeChild'
 ];
-exports.staticFields = ['plain-text', 'image'];
-/**
- * Implementation of action with target
- * @private
- */
+export const staticFields = ['plain-text', 'image'];
 class ActionImplWithTarget {
-    /**
-     * @constructor
-     * @param _action
-     * @param _target
-     * @private
-     */
+    _action;
+    _target;
     constructor(_action, _target) {
         this._action = _action;
         this._target = _target;
@@ -93,26 +61,23 @@ class ActionImplWithTarget {
         return this._action.toString();
     }
 }
-exports.target = Symbol('target');
-exports.qualifiedName = Symbol('qualifiedName');
-function dependencyTracked() {
+export const target = Symbol('target');
+export const qualifiedName = Symbol('qualifiedName');
+export function dependencyTracked() {
     return function (target, propertyKey, descriptor) {
         const get = descriptor.get;
         if (get != undefined) {
             descriptor.get = function () {
-                // @ts-ignore
                 this.ruleEngine.trackDependency(this);
                 return get.call(this);
             };
         }
     };
 }
-exports.dependencyTracked = dependencyTracked;
 const addOnly = (includeOrExclude) => (...fieldTypes) => (target, propertyKey, descriptor) => {
     const get = descriptor.get;
     if (get != undefined) {
         descriptor.get = function () {
-            // @ts-ignore
             if (fieldTypes.indexOf(this.fieldType) > -1 === includeOrExclude) {
                 return get.call(this);
             }
@@ -122,44 +87,34 @@ const addOnly = (includeOrExclude) => (...fieldTypes) => (target, propertyKey, d
     const set = descriptor.set;
     if (set != undefined) {
         descriptor.set = function (value) {
-            // @ts-ignore
             if (fieldTypes.indexOf(this.fieldType) > -1 === includeOrExclude) {
                 set.call(this, value);
             }
         };
     }
 };
-exports.include = addOnly(true);
-exports.exclude = addOnly(false);
-/**
- * Defines a generic base class which all objects of form runtime model should extend from.
- * @typeparam T type of the form object which extends from {@link BaseJson | base type}
- */
-class BaseNode {
-    /**
-     * @constructor
-     * @param params
-     * @param _options
-     * @private
-     */
-    constructor(params, 
-    //@ts_ignore
-    _options) {
-        this._options = _options;
-        this._callbacks = {};
-        this._dependents = [];
-        this._tokens = [];
-        //@ts-ignore
-        this[exports.qualifiedName] = null;
-        this._jsonModel = Object.assign(Object.assign({}, params), { 
-            //@ts-ignore
-            id: 'id' in params ? params.id : this.form.getUniqueId() });
-    }
+export const include = addOnly(true);
+export const exclude = addOnly(false);
+export class BaseNode {
+    _options;
+    _ruleNode;
+    _lang = '';
+    _callbacks = {};
+    _dependents = [];
+    _jsonModel;
+    _tokens = [];
     get isContainer() {
         return false;
     }
+    constructor(params, _options) {
+        this._options = _options;
+        this[qualifiedName] = null;
+        this._jsonModel = {
+            ...params,
+            id: 'id' in params ? params.id : this.form.getUniqueId()
+        };
+    }
     setupRuleNode() {
-        // eslint-disable-next-line @typescript-eslint/no-this-alias
         const self = this;
         this._ruleNode = new Proxy(this.ruleNodeReference(), {
             get: (ruleNodeReference, prop) => {
@@ -167,15 +122,9 @@ class BaseNode {
             }
         });
     }
-    /**
-     * @private
-     */
     ruleNodeReference() {
         return this;
     }
-    /**
-     * @private
-     */
     getRuleNode() {
         return this._ruleNode;
     }
@@ -183,26 +132,18 @@ class BaseNode {
         if (prop === Symbol.toPrimitive || (prop === 'valueOf' && !ruleNodeReference.hasOwnProperty('valueOf'))) {
             return this.valueOf;
         }
-        else if (prop === exports.target) {
+        else if (prop === target) {
             return this;
         }
         else if (typeof (prop) === 'string') {
-            //look for property
             if (prop.startsWith('$')) {
                 prop = prop.substr(1);
-                //@ts-ignore
-                //@todo: create a list of properties that are allowed
-                //@ts-ignore
-                // return only non functional properties in this object
                 if (typeof this[prop] !== 'function') {
-                    //@ts-ignore
                     const retValue = this[prop];
                     if (retValue instanceof BaseNode) {
-                        //$parent
                         return retValue.getRuleNode();
                     }
                     else if (retValue instanceof Array) {
-                        //$items
                         return retValue.map(r => r instanceof BaseNode ? r.getRuleNode() : r);
                     }
                     else {
@@ -211,12 +152,10 @@ class BaseNode {
                 }
             }
             else {
-                //look in the items
                 if (ruleNodeReference.hasOwnProperty(prop)) {
                     return ruleNodeReference[prop];
                 }
-                else if (typeof ruleNodeReference[prop] === 'function') { //todo : create allow list of functions
-                    //to support panel instanceof Array panel1.map(..)
+                else if (typeof ruleNodeReference[prop] === 'function') {
                     return ruleNodeReference[prop];
                 }
             }
@@ -237,6 +176,9 @@ class BaseNode {
     get type() {
         return this._jsonModel.type;
     }
+    get repeatable() {
+        return this.parent?.hasDynamicItems();
+    }
     get fieldType() {
         return this._jsonModel.fieldType || 'text-input';
     }
@@ -260,7 +202,7 @@ class BaseNode {
     }
     set visible(v) {
         if (v !== this._jsonModel.visible) {
-            const changeAction = (0, controller_1.propertyChange)('visible', v, this._jsonModel.visible);
+            const changeAction = propertyChange('visible', v, this._jsonModel.visible);
             this._jsonModel.visible = v;
             this.notifyDependents(changeAction);
         }
@@ -276,64 +218,58 @@ class BaseNode {
     }
     set label(l) {
         if (l !== this._jsonModel.label) {
-            const changeAction = (0, controller_1.propertyChange)('label', l, this._jsonModel.label);
-            this._jsonModel = Object.assign(Object.assign({}, this._jsonModel), { label: l });
+            const changeAction = propertyChange('label', l, this._jsonModel.label);
+            this._jsonModel = {
+                ...this._jsonModel,
+                label: l
+            };
             this.notifyDependents(changeAction);
         }
     }
     get uniqueItems() {
         return this._jsonModel.uniqueItems;
     }
-    /**
-     * Transparent form fields are meant only for creation of view. They are also not part of data
-     */
     isTransparent() {
-        var _a;
-        // named form fields are not transparent
-        // @ts-ignore
-        // 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';
+        const isNonTransparent = this.parent?._jsonModel.type === 'array';
         return !this._jsonModel.name && !isNonTransparent;
     }
     getState() {
-        return Object.assign(Object.assign({}, this._jsonModel), { properties: this.properties, index: this.index, parent: undefined, qualifiedName: this.qualifiedName, events: {}, rules: {}, ':type': this[':type'] });
+        return {
+            ...this._jsonModel,
+            properties: this.properties,
+            index: this.index,
+            parent: undefined,
+            qualifiedName: this.qualifiedName,
+            events: {},
+            rules: {},
+            repeatable: this.repeatable === true ? true : undefined,
+            ':type': this[':type']
+        };
     }
-    /**
-     * @private
-     */
     subscribe(callback, eventName = 'change') {
         this._callbacks[eventName] = this._callbacks[eventName] || [];
         this._callbacks[eventName].push(callback);
-        //console.log(`subscription added : ${this._elem.id}, count : ${this._callbacks[eventName].length}`);
         return {
             unsubscribe: () => {
                 this._callbacks[eventName] = this._callbacks[eventName].filter(x => x !== callback);
-                //console.log(`subscription removed : ${this._elem.id}, count : ${this._callbacks[eventName].length}`);
             }
         };
     }
-    /**
-     * @private
-     */
     _addDependent(dependent) {
         if (this._dependents.find(({ node }) => node === dependent) === undefined) {
             const subscription = this.subscribe((change) => {
                 const changes = change.payload.changes;
-                const propsToLook = [...exports.dynamicProps, 'items'];
-                // @ts-ignore
+                const propsToLook = [...dynamicProps, 'items'];
                 const isPropChanged = changes.findIndex(x => {
                     return propsToLook.indexOf(x.propertyName) > -1;
                 }) > -1;
                 if (isPropChanged) {
-                    dependent.dispatch(new controller_1.ExecuteRule());
+                    dependent.dispatch(new ExecuteRule());
                 }
             });
             this._dependents.push({ node: dependent, subscription });
         }
     }
-    /**
-     * @private
-     */
     removeDependent(dependent) {
         const index = this._dependents.findIndex(({ node }) => node === dependent);
         if (index > -1) {
@@ -341,9 +277,6 @@ class BaseNode {
             this._dependents.splice(index, 1);
         }
     }
-    /**
-     * @private
-     */
     queueEvent(action) {
         const actionWithTarget = new ActionImplWithTarget(action, this);
         this.form.getEventQueue().queue(this, actionWithTarget, ['valid', 'invalid'].indexOf(actionWithTarget.type) > -1);
@@ -352,22 +285,13 @@ class BaseNode {
         this.queueEvent(action);
         this.form.getEventQueue().runPendingQueue();
     }
-    /**
-     * @private
-     */
     notifyDependents(action) {
         const handlers = this._callbacks[action.type] || [];
         handlers.forEach(x => {
             x(new ActionImplWithTarget(action, this));
         });
     }
-    /**
-     * @param prop
-     * @param newValue
-     * @private
-     */
     _setProperty(prop, newValue, notify = true) {
-        //@ts-ignore
         const oldValue = this._jsonModel[prop];
         let isValueSame = false;
         if (newValue !== null && oldValue !== null &&
@@ -375,13 +299,11 @@ class BaseNode {
             isValueSame = JSON.stringify(newValue) === JSON.stringify(oldValue);
         }
         else {
-            // @ts-ignore
             isValueSame = oldValue === newValue;
         }
         if (!isValueSame) {
-            //@ts-ignore
             this._jsonModel[prop] = newValue;
-            const changeAction = (0, controller_1.propertyChange)(prop, newValue, oldValue);
+            const changeAction = propertyChange(prop, newValue, oldValue);
             if (notify) {
                 this.notifyDependents(changeAction);
             }
@@ -389,9 +311,6 @@ class BaseNode {
         }
         return [];
     }
-    /**
-     * @private
-     */
     _bindToDataModel(contextualDataModel) {
         if (this.id === '$form') {
             this._data = contextualDataModel;
@@ -399,30 +318,27 @@ class BaseNode {
         }
         const dataRef = this._jsonModel.dataRef;
         let _data, _parent = contextualDataModel, _key = '';
-        if (dataRef === null) { // null data binding
-            _data = EmptyDataValue_1.default;
+        if (dataRef === null) {
+            _data = NullDataValue;
         }
-        else if (dataRef !== undefined) { // explicit data binding
+        else if (dataRef !== undefined) {
             if (this._tokens.length === 0) {
-                this._tokens = (0, DataRefParser_1.tokenize)(dataRef);
+                this._tokens = tokenize(dataRef);
             }
             let searchData = contextualDataModel;
-            if (this._tokens[0].type === DataRefParser_1.TOK_GLOBAL) {
+            if (this._tokens[0].type === TOK_GLOBAL) {
                 searchData = this.form.getDataNode();
             }
             if (typeof searchData !== 'undefined') {
                 const name = this._tokens[this._tokens.length - 1].value;
                 const create = this.defaultDataModel(name);
-                _data = (0, DataRefParser_1.resolveData)(searchData, this._tokens, create);
-                // @ts-ignore
-                _parent = (0, DataRefParser_1.resolveData)(searchData, this._tokens.slice(0, -1));
+                _data = resolveData(searchData, this._tokens, create);
+                _parent = resolveData(searchData, this._tokens.slice(0, -1));
                 _key = name;
             }
         }
-        else { // name data binding
-            // static fields do not have name bindings
-            if ( //@ts-ignore
-            contextualDataModel !== EmptyDataValue_1.default && exports.staticFields.indexOf(this.fieldType) === -1) {
+        else {
+            if (contextualDataModel !== NullDataValue && staticFields.indexOf(this.fieldType) === -1) {
                 _parent = contextualDataModel;
                 const name = this._jsonModel.name || '';
                 const key = contextualDataModel.$type === 'array' ? this.index : name;
@@ -443,26 +359,34 @@ class BaseNode {
             }
         }
         if (_data) {
-            //@ts-ignore
-            if (!this.isContainer && _parent !== EmptyDataValue_1.default && _data !== EmptyDataValue_1.default) {
-                _data = _data === null || _data === void 0 ? void 0 : _data.$convertToDataValue();
+            if (!this.isContainer && _parent !== NullDataValue && _data !== NullDataValue) {
+                _data = _data?.$convertToDataValue();
                 _parent.$addDataNode(_key, _data, true);
             }
-            _data === null || _data === void 0 ? void 0 : _data.$bindToField(this);
+            _data?.$bindToField(this);
             this._data = _data;
         }
     }
-    /**
-     * @private
-     */
+    _data;
     getDataNode() {
         return this._data;
     }
+    get language() {
+        if (!this._lang) {
+            if (this.parent) {
+                this._lang = this.parent.language;
+            }
+            else {
+                this._lang = Intl.DateTimeFormat().resolvedOptions().locale;
+            }
+        }
+        return this._lang;
+    }
     get properties() {
         return this._jsonModel.properties || {};
     }
     set properties(p) {
-        this._setProperty('properties', Object.assign({}, p));
+        this._setProperty('properties', { ...p });
     }
     getNonTransparentParent() {
         let nonTransparentParent = this.parent;
@@ -471,31 +395,18 @@ class BaseNode {
         }
         return nonTransparentParent;
     }
-    /**
-     * called after the node is inserted in the parent
-     * @private
-     */
     _initialize() {
         if (typeof this._data === 'undefined') {
             let dataNode, parent = this.parent;
             do {
-                //@ts-ignore
                 dataNode = parent.getDataNode();
                 parent = parent.parent;
             } while (dataNode === undefined);
             this._bindToDataModel(dataNode);
         }
     }
-    /**
-     * Checks whether there are any updates in the properties. If there are applies them to the
-     * json model as well.
-     * @param propNames
-     * @param updates
-     * @private
-     */
     _applyUpdates(propNames, updates) {
         return propNames.reduce((acc, propertyName) => {
-            //@ts-ignore
             const currentValue = updates[propertyName];
             const changes = this._setProperty(propertyName, currentValue, false);
             if (changes.length > 0) {
@@ -508,23 +419,17 @@ class BaseNode {
         if (this.isTransparent()) {
             return null;
         }
-        // @ts-ignore
-        if (this[exports.qualifiedName] !== null) {
-            // @ts-ignore
-            return this[exports.qualifiedName];
+        if (this[qualifiedName] !== null) {
+            return this[qualifiedName];
         }
-        // use qualified name
         const parent = this.getNonTransparentParent();
         if (parent && parent.type === 'array') {
-            //@ts-ignore
-            this[exports.qualifiedName] = `${parent.qualifiedName}[${this.index}]`;
+            this[qualifiedName] = `${parent.qualifiedName}[${this.index}]`;
         }
         else {
-            //@ts-ignore
-            this[exports.qualifiedName] = `${parent.qualifiedName}.${this.name}`;
+            this[qualifiedName] = `${parent.qualifiedName}.${this.name}`;
         }
-        //@ts-ignore
-        return this[exports.qualifiedName];
+        return this[qualifiedName];
     }
     focus() {
         if (this.parent) {
@@ -547,4 +452,3 @@ __decorate([
 __decorate([
     dependencyTracked()
 ], BaseNode.prototype, "properties", null);
-exports.BaseNode = BaseNode;