@aemforms/af-core 0.22.17 → 0.22.19

package/lib/BaseNode.d.ts

@@ -9,9 +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}
@@ -37,6 +40,7 @@ export declare abstract class BaseNode<T extends BaseJson> implements BaseModel
         parent: ContainerModel;
     });
     abstract value: Primitives;
+    abstract reset(): any;
     protected setupRuleNode(): void;
     /**
      * @private
@@ -51,6 +55,7 @@ export declare abstract class BaseNode<T extends BaseJson> implements BaseModel
     get index(): number;
     get parent(): ContainerModel;
     get type(): string | undefined;
+    get repeatable(): boolean;
     get fieldType(): string;
     get ':type'(): string;
     get name(): string | undefined;
@@ -69,6 +74,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;
     };

package/lib/BaseNode.js

@@ -16,10 +16,11 @@ 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.qualifiedName = 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"));
+const JsonUtils_1 = require("./utils/JsonUtils");
 /**
  * Defines the properties that are editable. These properties can be modified during rule execution.
  */
@@ -37,13 +38,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.
 ];
 /**
@@ -55,6 +56,7 @@ exports.dynamicProps = [
     'index',
     'activeChild'
 ];
+exports.staticFields = ['plain-text', 'image'];
 /**
  * Implementation of action with target
  * @private
@@ -107,6 +109,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}
@@ -202,7 +227,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;
@@ -210,6 +238,9 @@ class BaseNode {
     get type() {
         return this._jsonModel.type;
     }
+    get repeatable() {
+        return (0, JsonUtils_1.isRepeatable)(this._jsonModel);
+    }
     get fieldType() {
         return this._jsonModel.fieldType || 'text-input';
     }
@@ -269,7 +300,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
@@ -393,8 +424,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;

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

@@ -35,317 +35,19 @@ declare abstract class Container<T extends ContainerJson & RulesJson> extends Sc
      * Returns the current container state
      */
     getState(): T & {
+        items: any[];
+        properties: {
+            [key: string]: any;
+        };
+        index: number;
+        parent: undefined;
+        qualifiedName: any;
+        events: {};
+        rules: {};
         ':type': string;
-        items: ({
-            description?: string | undefined;
-            rules?: import("./types").Items<string> | undefined;
-            events?: import("./types").Items<string | string[] | undefined> | undefined;
-            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;
-            /**
-             * @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; /**
-             * Returns the current container state
-             */
-            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;
-        } | {
-            description?: string | undefined;
-            rules?: import("./types").Items<string> | undefined;
-            events?: import("./types").Items<string | string[] | undefined> | undefined;
-            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;
-            /**
-             * @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; /**
-             * 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;
-                /**
-                 * @private
-                 */
-                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; /**
-                 * Returns the current container state
-                 */
-                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;
-                /**
-                 * @private
-                 */
-                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; /**
-                 * Returns the current container state
-                 */
-                errorMessage?: string | undefined;
-                properties?: {
-                    [key: string]: any;
-                } | undefined;
-            } & {
-                items: (FieldJson | ContainerJson)[];
-                initialItems?: number | undefined;
-                activeChild?: string | 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;
-                    /**
-                     * @private
-                     */
-                    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; /**
-                     * Returns the current container state
-                     */
-                    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;
-                    /**
-                     * @private
-                     */
-                    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; /**
-                     * Returns the current container state
-                     */
-                    errorMessage?: string | undefined;
-                    properties?: {
-                        [key: string]: any;
-                    } | undefined;
-                } & {
-                    items: (FieldJson | ContainerJson)[];
-                    initialItems?: number | undefined;
-                    activeChild?: string | undefined;
-                } & any))[];
-            }))[];
-            initialItems?: number | undefined;
-            activeChild?: string | undefined;
-            id: string;
-        })[];
         id: string;
     };
-    protected abstract _createChild(child: FieldsetJson | FieldJson): FieldModel | FieldsetModel;
+    protected abstract _createChild(child: FieldsetJson | FieldJson, options: any): FieldModel | FieldsetModel;
     private _addChildToRuleNode;
     private _addChild;
     indexOf(f: FieldModel | FieldsetModel): number;
@@ -369,6 +71,12 @@ declare abstract class Container<T extends ContainerJson & RulesJson> extends Sc
      * @private
      */
     queueEvent(action: Action): void;
+    /**
+     * @summary reset the data of all the Fields present inside this container
+     * @method reset
+     * @private
+     */
+    reset(): void;
     validate(): import("./types").ValidationError[];
     /**
      * @private

package/lib/Container.js

@@ -75,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());
             }) });
     }
@@ -154,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) {
@@ -183,30 +183,33 @@ 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();
     }
     /**
      * @private
      */
     addItem(action) {
-        if (action.type === 'addItem' && this._itemTemplate != null) {
+        if ((action.type === 'addItem' || action.type == 'addInstance') && this._itemTemplate != null) {
             //@ts-ignore
             if ((this._jsonModel.maxItems === -1) || (this._children.length < this._jsonModel.maxItems)) {
                 const dataNode = this.getDataNode();
-                let index = action.payload;
-                if (typeof index !== 'number' || index > this._children.length) {
-                    index = this._children.length;
-                }
+                let instanceIndex = action.payload;
                 const retVal = this._addChild(this._itemTemplate, action.payload, true);
-                const _data = retVal.defaultDataModel(index);
+                if (typeof instanceIndex !== 'number' || instanceIndex > this._children.length) {
+                    instanceIndex = this._children.length;
+                }
+                const _data = retVal.defaultDataModel(instanceIndex);
                 if (_data) {
-                    dataNode.$addDataNode(index, _data);
+                    dataNode.$addDataNode(instanceIndex, _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++) {
+                for (let i = instanceIndex + 1; i < this._children.length; i++) {
                     this._children[i].dispatch(new controller_1.ExecuteRule());
                 }
             }
@@ -216,21 +219,24 @@ class Container extends Scriptable_1.default {
      * @private
      */
     removeItem(action) {
-        if (action.type === 'removeItem' && this._itemTemplate != null) {
+        if ((action.type === 'removeItem' || action.type == 'removeInstance') && this._itemTemplate != null) {
             if (this._children.length == 0) {
                 //can't remove item if there isn't any
                 return;
             }
-            const index = typeof action.payload === 'number' ? action.payload : this._children.length - 1;
-            const state = this._children[index].getState();
+            let instanceIndex = action.payload;
+            if (typeof instanceIndex !== 'number') {
+                instanceIndex = this._children.length - 1;
+            }
+            const state = this._children[instanceIndex].getState();
             //@ts-ignore
             if (this._children.length > this._jsonModel.minItems) {
                 // clear child
                 //remove field
                 this._childrenReference.pop();
-                this._children.splice(index, 1);
-                this.getDataNode().$removeDataNode(index);
-                for (let i = index; i < this._children.length; i++) {
+                this._children.splice(instanceIndex, 1);
+                this.getDataNode().$removeDataNode(instanceIndex);
+                for (let i = instanceIndex; i < this._children.length; i++) {
                     this._children[i].dispatch(new controller_1.ExecuteRule());
                 }
                 this.notifyDependents((0, controller_1.propertyChange)('items', null, state));
@@ -250,6 +256,17 @@ class Container extends Scriptable_1.default {
             });
         }
     }
+    /**
+     * @summary reset the data of all the Fields present inside this container
+     * @method reset
+     * @private
+     */
+    reset() {
+        this.items.forEach(x => {
+            //@ts-ignore
+            x.reset();
+        });
+    }
     validate() {
         return this.items.flatMap(x => {
             return x.validate();