@aemforms/af-core 0.22.16 → 0.22.18

package/lib/BaseNode.d.ts

@@ -9,8 +9,12 @@ 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;
+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}
@@ -68,6 +72,14 @@ export declare abstract class BaseNode<T extends BaseJson> implements BaseModel
      */
     isTransparent(): boolean;
     getState(): T & {
+        properties: {
+            [key: string]: any;
+        };
+        index: number;
+        parent: undefined;
+        qualifiedName: any;
+        events: {};
+        rules: {};
         ':type': string;
         id: string;
     };
@@ -125,4 +137,14 @@ export declare abstract class BaseNode<T extends BaseJson> implements BaseModel
      * @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

@@ -16,7 +16,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseNode = exports.dependencyTracked = exports.target = exports.dynamicProps = exports.editableProperties = void 0;
+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"));
@@ -37,13 +37,13 @@ exports.editableProperties = [
     // 'enforceEnum', // not exposed for now
     'exclusiveMinimum',
     'exclusiveMaximum',
-    'maxLength',
+    //    'maxLength',
     'maximum',
     'maxItems',
-    'minLength',
+    //    'minLength',
     'minimum',
-    'minItems',
-    'step'
+    'minItems'
+    //    'step'
     // 'placeholder' // not exposed for now.
 ];
 /**
@@ -52,8 +52,10 @@ exports.editableProperties = [
 exports.dynamicProps = [
     ...exports.editableProperties,
     'valid',
-    'index'
+    'index',
+    'activeChild'
 ];
+exports.staticFields = ['plain-text', 'image'];
 /**
  * Implementation of action with target
  * @private
@@ -92,6 +94,7 @@ class ActionImplWithTarget {
     }
 }
 exports.target = Symbol('target');
+exports.qualifiedName = Symbol('qualifiedName');
 function dependencyTracked() {
     return function (target, propertyKey, descriptor) {
         const get = descriptor.get;
@@ -105,6 +108,29 @@ function dependencyTracked() {
     };
 }
 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);
+            }
+            return undefined;
+        };
+    }
+    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}
@@ -123,6 +149,8 @@ class BaseNode {
         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() });
@@ -198,7 +226,10 @@ class BaseNode {
         return this._jsonModel.id;
     }
     get index() {
-        return this.parent.indexOf(this);
+        if (this.parent) {
+            return this.parent.indexOf(this);
+        }
+        return 0;
     }
     get parent() {
         return this._options.parent;
@@ -265,7 +296,7 @@ class BaseNode {
         return !this._jsonModel.name && !isNonTransparent;
     }
     getState() {
-        return Object.assign(Object.assign({}, this._jsonModel), { ':type': this[':type'] });
+        return Object.assign(Object.assign({}, this._jsonModel), { properties: this.properties, index: this.index, parent: undefined, qualifiedName: this.qualifiedName, events: {}, rules: {}, ':type': this[':type'] });
     }
     /**
      * @private
@@ -389,8 +420,9 @@ class BaseNode {
             }
         }
         else { // name data binding
+            // static fields do not have name bindings
             if ( //@ts-ignore
-            contextualDataModel !== EmptyDataValue_1.default) {
+            contextualDataModel !== EmptyDataValue_1.default && exports.staticFields.indexOf(this.fieldType) === -1) {
                 _parent = contextualDataModel;
                 const name = this._jsonModel.name || '';
                 const key = contextualDataModel.$type === 'array' ? this.index : name;
@@ -454,6 +486,51 @@ class BaseNode {
             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) {
+                acc[propertyName] = changes[0];
+            }
+            return acc;
+        }, {});
+    }
+    get qualifiedName() {
+        if (this.isTransparent()) {
+            return null;
+        }
+        // @ts-ignore
+        if (this[exports.qualifiedName] !== null) {
+            // @ts-ignore
+            return this[exports.qualifiedName];
+        }
+        // use qualified name
+        const parent = this.getNonTransparentParent();
+        if (parent && parent.type === 'array') {
+            //@ts-ignore
+            this[exports.qualifiedName] = `${parent.qualifiedName}[${this.index}]`;
+        }
+        else {
+            //@ts-ignore
+            this[exports.qualifiedName] = `${parent.qualifiedName}.${this.name}`;
+        }
+        //@ts-ignore
+        return this[exports.qualifiedName];
+    }
+    focus() {
+        if (this.parent) {
+            this.parent.activeChild = this;
+        }
+    }
 }
 __decorate([
     dependencyTracked()

package/lib/Checkbox.d.ts

@@ -64,6 +64,14 @@ declare class Checkbox extends Field {
             valid: boolean;
             value: any;
         };
+        accept: (constraint: string[], value: any) => {
+            valid: boolean;
+            value: any;
+        };
+        maxFileSize: (constraint: string | number, value: any) => {
+            valid: boolean;
+            value: any;
+        };
     };
     protected _getDefaults(): {
         enforceEnum: boolean;

package/lib/CheckboxGroup.js

@@ -32,6 +32,9 @@ class CheckboxGroup extends Field_1.default {
         if (typeof fallbackType === 'string') {
             return `${fallbackType}[]`;
         }
+        else {
+            return 'string[]';
+        }
     }
     _getDefaults() {
         return Object.assign(Object.assign({}, super._getDefaults()), { enforceEnum: true, enum: [] });

package/lib/Container.d.ts

@@ -1,4 +1,4 @@
-import { Action, ContainerJson, ContainerModel, FieldJson, FieldModel, FieldsetJson, FieldsetModel, RulesJson } from './types';
+import { Action, BaseModel, ContainerJson, ContainerModel, FieldJson, FieldModel, FieldsetJson, FieldsetModel, RulesJson } from './types';
 import Scriptable from './Scriptable';
 import DataGroup from './data/DataGroup';
 /**
@@ -30,12 +30,15 @@ declare abstract class Container<T extends ContainerJson & RulesJson> extends Sc
      */
     hasDynamicItems(): boolean;
     get isContainer(): boolean;
+    private _activeChild;
     /**
      * Returns the current container state
      */
     getState(): T & {
-        ':type': string;
         items: ({
+            id: string;
+            index: number;
+            ':type': string;
             description?: string | undefined;
             rules?: import("./types").Items<string> | undefined;
             events?: import("./types").Items<string | string[] | undefined> | undefined;
@@ -55,22 +58,29 @@ declare abstract class Container<T extends ContainerJson & RulesJson> extends Sc
             minItems?: number | undefined;
             pattern?: string | undefined;
             required?: boolean | undefined;
+            /**
+             * @private
+             */
             step?: number | undefined;
             type?: string | undefined;
             validationExpression?: string | undefined;
             uniqueItems?: boolean | undefined;
             dataRef?: string | null | undefined;
-            ':type': string;
             label?: import("./types").Label | undefined;
             enabled?: boolean | undefined;
             visible?: boolean | undefined;
             name?: string | undefined;
             constraintMessages?: import("./types").ConstraintsMessages | undefined;
-            fieldType?: string | undefined;
+            fieldType?: string | undefined; /**
+             * Returns the current container state
+             */
             errorMessage?: string | undefined;
             properties?: {
                 [key: string]: any;
             } | undefined;
+            screenReaderText?: string | undefined;
+            tooltip?: string | undefined;
+            altText?: string | undefined;
             placeholder?: string | undefined;
             readOnly?: boolean | undefined;
             valid?: boolean | undefined;
@@ -81,8 +91,10 @@ declare abstract class Container<T extends ContainerJson & RulesJson> extends Sc
             editValue?: string | undefined;
             displayValue?: string | undefined;
             emptyValue?: "" | "undefined" | "null" | undefined;
-            id: string;
         } | {
+            id: string;
+            index: number;
+            ':type': string;
             description?: string | undefined;
             rules?: import("./types").Items<string> | undefined;
             events?: import("./types").Items<string | string[] | undefined> | undefined;
@@ -102,213 +114,42 @@ declare abstract class Container<T extends ContainerJson & RulesJson> extends Sc
             minItems?: number | undefined;
             pattern?: string | undefined;
             required?: boolean | undefined;
+            /**
+             * @private
+             */
             step?: number | undefined;
             type?: "object" | "array" | undefined;
             validationExpression?: string | undefined;
             uniqueItems?: boolean | undefined;
             dataRef?: string | null | undefined;
-            ':type'?: string | undefined;
             label?: import("./types").Label | undefined;
             enabled?: boolean | undefined;
             visible?: boolean | undefined;
             name?: string | undefined;
             constraintMessages?: import("./types").ConstraintsMessages | undefined;
-            fieldType?: string | undefined;
+            fieldType?: string | undefined; /**
+             * Returns the current container state
+             */
             errorMessage?: string | undefined;
             properties?: {
                 [key: string]: any;
             } | undefined;
-            items: (FieldJson | ContainerJson)[] & (({
-                description?: string | undefined;
-            } & RulesJson & {
-                enumNames?: string[] | undefined;
-                enum?: any[] | undefined;
-            } & {
-                accept?: string[] | undefined;
-                enforceEnum?: boolean | undefined;
-                exclusiveMinimum?: number | undefined;
-                exclusiveMaximum?: number | undefined;
-                format?: string | undefined;
-                maxFileSize?: string | number | undefined;
-                maxLength?: number | undefined;
-                maximum?: number | undefined;
-                maxItems?: number | undefined;
-                minLength?: number | undefined;
-                minimum?: 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;
-                ':type'?: string | undefined;
-                label?: import("./types").Label | undefined;
-                enabled?: boolean | undefined;
-                visible?: boolean | undefined;
-                name?: string | undefined;
-                constraintMessages?: import("./types").ConstraintsMessages | undefined;
-                fieldType?: string | undefined;
-                errorMessage?: string | undefined;
-                properties?: {
-                    [key: string]: any;
-                } | undefined;
-            } & {
-                placeholder?: string | undefined;
-            } & {
-                readOnly?: boolean | undefined;
-                valid?: boolean | undefined;
-                default?: any;
-                value?: any;
-                displayFormat?: string | undefined;
-                editFormat?: string | undefined;
-                editValue?: string | undefined;
-                displayValue?: string | undefined;
-                emptyValue?: "" | "undefined" | "null" | undefined;
-            } & {
-                id: string;
-                ':type': string;
-            }) | ({
-                description?: string | undefined;
-            } & RulesJson & {
-                enumNames?: string[] | undefined;
-                enum?: any[] | undefined;
-            } & {
-                accept?: string[] | undefined;
-                enforceEnum?: boolean | undefined;
-                exclusiveMinimum?: number | undefined;
-                exclusiveMaximum?: number | undefined;
-                format?: string | undefined;
-                maxFileSize?: string | number | undefined;
-                maxLength?: number | undefined;
-                maximum?: number | undefined;
-                maxItems?: number | undefined;
-                minLength?: number | undefined;
-                minimum?: 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;
-                ':type'?: string | undefined;
-                label?: import("./types").Label | undefined;
-                enabled?: boolean | undefined;
-                visible?: boolean | undefined;
-                name?: string | undefined;
-                constraintMessages?: import("./types").ConstraintsMessages | undefined;
-                fieldType?: string | undefined;
-                errorMessage?: string | undefined;
-                properties?: {
-                    [key: string]: any;
-                } | undefined;
-            } & {
-                items: (FieldJson | ContainerJson)[];
-                initialItems?: number | undefined;
-            } & {
-                id: string;
-                items: (({
-                    description?: string | undefined;
-                } & RulesJson & {
-                    enumNames?: string[] | undefined;
-                    enum?: any[] | undefined;
-                } & {
-                    accept?: string[] | undefined;
-                    enforceEnum?: boolean | undefined;
-                    exclusiveMinimum?: number | undefined;
-                    exclusiveMaximum?: number | undefined;
-                    format?: string | undefined;
-                    maxFileSize?: string | number | undefined;
-                    maxLength?: number | undefined;
-                    maximum?: number | undefined;
-                    maxItems?: number | undefined;
-                    minLength?: number | undefined;
-                    minimum?: 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;
-                    ':type'?: string | undefined;
-                    label?: import("./types").Label | undefined;
-                    enabled?: boolean | undefined;
-                    visible?: boolean | undefined;
-                    name?: string | undefined;
-                    constraintMessages?: import("./types").ConstraintsMessages | undefined;
-                    fieldType?: string | undefined;
-                    errorMessage?: string | undefined;
-                    properties?: {
-                        [key: string]: any;
-                    } | undefined;
-                } & {
-                    placeholder?: string | undefined;
-                } & {
-                    readOnly?: boolean | undefined;
-                    valid?: boolean | undefined;
-                    default?: any;
-                    value?: any;
-                    displayFormat?: string | undefined;
-                    editFormat?: string | undefined;
-                    editValue?: string | undefined;
-                    displayValue?: string | undefined;
-                    emptyValue?: "" | "undefined" | "null" | undefined;
-                } & {
-                    id: string;
-                    ':type': string;
-                }) | ({
-                    description?: string | undefined;
-                } & RulesJson & {
-                    enumNames?: string[] | undefined;
-                    enum?: any[] | undefined;
-                } & {
-                    accept?: string[] | undefined;
-                    enforceEnum?: boolean | undefined;
-                    exclusiveMinimum?: number | undefined;
-                    exclusiveMaximum?: number | undefined;
-                    format?: string | undefined;
-                    maxFileSize?: string | number | undefined;
-                    maxLength?: number | undefined;
-                    maximum?: number | undefined;
-                    maxItems?: number | undefined;
-                    minLength?: number | undefined;
-                    minimum?: 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;
-                    ':type'?: string | undefined;
-                    label?: import("./types").Label | undefined;
-                    enabled?: boolean | undefined;
-                    visible?: boolean | undefined;
-                    name?: string | undefined;
-                    constraintMessages?: import("./types").ConstraintsMessages | undefined;
-                    fieldType?: string | undefined;
-                    errorMessage?: string | undefined;
-                    properties?: {
-                        [key: string]: any;
-                    } | undefined;
-                } & {
-                    items: (FieldJson | ContainerJson)[];
-                    initialItems?: number | undefined;
-                } & any))[];
-            }))[];
+            screenReaderText?: string | undefined;
+            tooltip?: string | undefined;
+            altText?: string | undefined;
+            items: (FieldJson | ContainerJson)[] & import("./types").State<FieldJson | ContainerJson>[];
             initialItems?: number | undefined;
-            id: string;
+            activeChild?: string | undefined;
         })[];
+        properties: {
+            [key: string]: any;
+        };
+        index: number;
+        parent: undefined;
+        qualifiedName: any;
+        events: {};
+        rules: {};
+        ':type': string;
         id: string;
     };
     protected abstract _createChild(child: FieldsetJson | FieldJson): FieldModel | FieldsetModel;
@@ -352,5 +193,7 @@ declare abstract class Container<T extends ContainerJson & RulesJson> extends Sc
      * @private
      */
     syncDataAndFormModel(contextualDataModel?: DataGroup): void;
+    get activeChild(): BaseModel | null;
+    set activeChild(c: BaseModel | null);
 }
 export default Container;

package/lib/Container.js

@@ -30,6 +30,7 @@ class Container extends Scriptable_1.default {
         super(...arguments);
         this._children = [];
         this._itemTemplate = null;
+        this._activeChild = null;
     }
     /**
      * @private
@@ -74,7 +75,7 @@ class Container extends Scriptable_1.default {
      * Returns the current container state
      */
     getState() {
-        return Object.assign(Object.assign({}, this._jsonModel), { ':type': this[':type'], items: this._children.map(x => {
+        return Object.assign(Object.assign({}, super.getState()), { items: this._children.map(x => {
                 return Object.assign({}, x.getState());
             }) });
     }
@@ -153,7 +154,7 @@ class Container extends Scriptable_1.default {
      */
     _initialize() {
         super._initialize();
-        const items = this._jsonModel.items;
+        const items = this._jsonModel.items || [];
         this._jsonModel.items = [];
         this._childrenReference = this._jsonModel.type == 'array' ? [] : {};
         if (this._jsonModel.type == 'array' && items.length === 1 && this.getDataNode() != null) {
@@ -182,6 +183,9 @@ class Container extends Scriptable_1.default {
             this._jsonModel.maxItems = this._children.length;
             this._jsonModel.initialItems = this._children.length;
         }
+        else {
+            this.form.logger.warn('A container exists with no items.');
+        }
         this.setupRuleNode();
     }
     /**
@@ -202,7 +206,7 @@ class Container extends Scriptable_1.default {
                     dataNode.$addDataNode(index, _data);
                 }
                 retVal._initialize();
-                this.notifyDependents((0, controller_1.propertyChange)('items', retVal.getState, null));
+                this.notifyDependents((0, controller_1.propertyChange)('items', retVal.getState(), null));
                 retVal.dispatch(new controller_1.Initialize());
                 retVal.dispatch(new controller_1.ExecuteRule());
                 for (let i = index + 1; i < this._children.length; i++) {
@@ -301,6 +305,26 @@ class Container extends Scriptable_1.default {
             x.importData(contextualDataModel);
         });
     }
+    get activeChild() {
+        return this._activeChild;
+    }
+    set activeChild(c) {
+        if (c !== this._activeChild) {
+            let activeChild = this._activeChild;
+            while (activeChild instanceof Container) {
+                const temp = activeChild.activeChild;
+                activeChild.activeChild = null;
+                activeChild = temp;
+            }
+            const change = (0, controller_1.propertyChange)('activeChild', c, this._activeChild);
+            this._activeChild = c;
+            if (this.parent && c !== null) {
+                this.parent.activeChild = this;
+            }
+            this._jsonModel.activeChild = c === null || c === void 0 ? void 0 : c.id;
+            this.notifyDependents(change);
+        }
+    }
 }
 __decorate([
     (0, BaseNode_1.dependencyTracked)()
@@ -308,4 +332,7 @@ __decorate([
 __decorate([
     (0, BaseNode_1.dependencyTracked)()
 ], Container.prototype, "minItems", null);
+__decorate([
+    (0, BaseNode_1.dependencyTracked)()
+], Container.prototype, "activeChild", null);
 exports.default = Container;