@aemforms/af-core 0.22.17 → 0.22.19

package/lib/Field.d.ts

@@ -2,9 +2,6 @@ import { ConstraintsMessages, ContainerModel, FieldJson, FieldModel, FormModel,
 import Scriptable from './Scriptable';
 import DataValue from './data/DataValue';
 import DataGroup from './data/DataGroup';
-/**
- * Defines a form object field which implements {@link FieldModel | field model} interface
- */
 declare class Field extends Scriptable<FieldJson> implements FieldModel {
     /**
      * @param params
@@ -62,8 +59,15 @@ declare class Field extends Scriptable<FieldJson> implements FieldModel {
     get editValue(): any;
     get displayValue(): any;
     protected getDataNodeValue(typedValue: any): any;
+    private updateDataNodeAndTypedValue;
     get value(): any;
     set value(v: any);
+    /**
+     * @summary reset the value of the current field to its default
+     * @method reset
+     * @private
+     */
+    reset(): void;
     protected _updateRuleNodeReference(value: any): void;
     protected getInternalType(): string | undefined;
     valueOf(): any;
@@ -73,6 +77,8 @@ declare class Field extends Scriptable<FieldJson> implements FieldModel {
      * @param constraint
      */
     getErrorMessage(constraint: keyof (ConstraintsMessages)): string;
+    get errorMessage(): string | undefined;
+    get screenReaderText(): string | undefined;
     /**
      *
      * @private
@@ -176,7 +182,19 @@ declare class Field extends Scriptable<FieldJson> implements FieldModel {
     /**
      * returns the format constraint
      */
-    get format(): string;
+    get format(): string | undefined;
+    get enforceEnum(): boolean | undefined;
+    get tooltip(): string | undefined;
+    get maxLength(): number | undefined;
+    get minLength(): number | undefined;
+    get pattern(): string | undefined;
+    get step(): number | undefined;
+    get exclusiveMinimum(): number | undefined;
+    set exclusiveMinimum(eM: number | undefined);
+    get exclusiveMaximum(): number | undefined;
+    set exclusiveMaximum(eM: number | undefined);
+    get default(): any;
+    private isNotEmpty;
     /**
      * @private
      */
@@ -196,8 +214,8 @@ declare class Field extends Scriptable<FieldJson> implements FieldModel {
         editValue: any;
         displayValue: any;
         description?: string | undefined;
-        rules?: import("./types").Items<string> | undefined;
-        events?: import("./types").Items<string | string[] | undefined> | undefined;
+        rules: import("./types").Items<string> & {};
+        events: import("./types").Items<string | string[] | undefined> & {};
         enumNames?: string[] | undefined;
         enum?: any[] | undefined;
         accept?: string[] | undefined;
@@ -209,6 +227,8 @@ declare class Field extends Scriptable<FieldJson> implements FieldModel {
         maxLength?: number | undefined;
         maximum?: number | undefined;
         maxItems?: number | undefined;
+        minOccur?: number | undefined;
+        maxOccur?: number | undefined;
         minLength?: number | undefined;
         minimum?: number | undefined;
         minItems?: number | undefined;
@@ -227,9 +247,13 @@ declare class Field extends Scriptable<FieldJson> implements FieldModel {
         constraintMessages?: ConstraintsMessages | undefined;
         fieldType?: string | undefined;
         errorMessage?: string | undefined;
-        properties?: {
+        properties: {
             [key: string]: any;
-        } | undefined;
+        };
+        repeatable?: boolean | undefined;
+        screenReaderText?: string | undefined;
+        tooltip?: string | undefined;
+        altText?: string | undefined;
         placeholder?: string | undefined;
         readOnly?: boolean | undefined;
         valid?: boolean | undefined;
@@ -238,6 +262,9 @@ declare class Field extends Scriptable<FieldJson> implements FieldModel {
         displayFormat?: string | undefined;
         editFormat?: string | undefined;
         emptyValue?: "" | "undefined" | "null" | undefined;
+        index: number;
+        parent: undefined;
+        qualifiedName: any;
         id: string;
     };
 }

package/lib/Field.js

@@ -28,6 +28,7 @@ const af_formatters_1 = require("@aemforms/af-formatters");
 /**
  * Defines a form object field which implements {@link FieldModel | field model} interface
  */
+const validTypes = ['string', 'number', 'boolean', 'file', 'string[]', 'number[]', 'boolean[]', 'file[]', 'array', 'object'];
 class Field extends Scriptable_1.default {
     /**
      * @param params
@@ -73,10 +74,31 @@ class Field extends Scriptable_1.default {
      */
     _getFallbackType() {
         const type = this._jsonModel.type;
-        if (typeof type !== 'string') {
+        let finalType = type;
+        if (typeof type !== 'string' || validTypes.indexOf(type) === -1) {
             const _enum = this.enum;
-            return _enum && _enum.length > 0 ? typeof _enum[0] : 'string';
+            finalType = typeof (_enum === null || _enum === void 0 ? void 0 : _enum[0]);
+            if (finalType === 'undefined' && typeof this._jsonModel.default !== 'undefined') {
+                if (this._jsonModel.default instanceof Array && this._jsonModel.default.length > 0) {
+                    finalType = `${typeof (this._jsonModel.default[0])}[]`;
+                }
+                else {
+                    finalType = typeof (this._jsonModel.default);
+                }
+            }
+            if (finalType.indexOf('undefined') === 0) {
+                const typeMappings = {
+                    'text-input': 'string',
+                    'number-input': 'number',
+                    'date-input': 'string',
+                    'plain-text': 'string',
+                    'image': 'string',
+                    'checkbox': 'boolean'
+                };
+                finalType = typeMappings[this.fieldType];
+            }
         }
+        return finalType;
     }
     _applyDefaults() {
         Object.entries(this._getDefaults()).map(([key, value]) => {
@@ -86,12 +108,23 @@ class Field extends Scriptable_1.default {
                 this._jsonModel[key] = value;
             }
         });
+        const type = this._jsonModel.type;
+        if (typeof type !== 'string' || validTypes.indexOf(type) === -1) {
+            this._jsonModel.type = this._getFallbackType();
+        }
+        if (['plain-text', 'image'].indexOf(this.fieldType) === -1) {
+            this._jsonModel.value = undefined;
+        }
         const value = this._jsonModel.value;
         if (value === undefined) {
             const typedRes = ValidationUtils_1.Constraints.type(this.getInternalType() || 'string', this._jsonModel.default);
             this._jsonModel.value = typedRes.value;
         }
+        if (this._jsonModel.type !== 'string') {
+            this._jsonModel.emptyValue = undefined;
+        }
         if (this._jsonModel.fieldType === undefined) {
+            this.form.logger.error('fieldType property is mandatory. Please ensure all the fields have a fieldType');
             //@ts-ignore
             if (this._jsonModel.viewType) {
                 //@ts-ignore
@@ -114,7 +147,39 @@ class Field extends Scriptable_1.default {
                 this._jsonModel.enum = [true, false];
             }
         }
-        if (typeof this._jsonModel.step !== 'number' || this._jsonModel.type !== 'number') {
+        else {
+            if (typeof this._jsonModel.enumNames === 'undefined') {
+                this._jsonModel.enumNames = this._jsonModel.enum.map(_ => _.toString());
+            }
+            while (this._jsonModel.enumNames.length < this._jsonModel.enum.length) {
+                //@ts-ignore
+                this._jsonModel.enumNames.push(this._jsonModel.enum[this._jsonModel.enumNames.length].toString());
+            }
+        }
+        if (this._jsonModel.type !== 'string') {
+            this._jsonModel.format = undefined;
+            this._jsonModel.pattern = undefined;
+            this._jsonModel.minLength = undefined;
+            this._jsonModel.maxLength = undefined;
+        }
+        else if (this._jsonModel.fieldType === 'date-input') {
+            this._jsonModel.format = 'date';
+        }
+        if (this._jsonModel.type !== 'number' && this._jsonModel.format !== 'date') {
+            this._jsonModel.step = undefined;
+            this._jsonModel.minimum = undefined;
+            this._jsonModel.maximum = undefined;
+            this._jsonModel.exclusiveMinimum = undefined;
+            this._jsonModel.exclusiveMaximum = undefined;
+        }
+        ['minimum', 'maximum', 'exclusiveMinimum', 'exclusiveMaximum'].forEach(c => {
+            //@ts-ignore
+            if (typeof this._jsonModel[c] !== this._jsonModel.type) {
+                //@ts-ignore
+                this._jsonModel[c] = undefined;
+            }
+        });
+        if (typeof this._jsonModel.step !== 'number') {
             this._jsonModel.step = undefined;
         }
     }
@@ -176,16 +241,24 @@ class Field extends Scriptable_1.default {
         this._setProperty('required', r);
     }
     get maximum() {
-        return this._jsonModel.maximum;
+        if (this.type === 'number' || this.format === 'date') {
+            return this._jsonModel.maximum;
+        }
     }
     set maximum(m) {
-        this._setProperty('maximum', m);
+        if (this.type === 'number' || this.format === 'date') {
+            this._setProperty('maximum', m);
+        }
     }
     get minimum() {
-        return this._jsonModel.minimum;
+        if (this.type === 'number' || this.format === 'date') {
+            return this._jsonModel.minimum;
+        }
     }
     set minimum(m) {
-        this._setProperty('minimum', m);
+        if (this.type === 'number' || this.format === 'date') {
+            this._setProperty('minimum', m);
+        }
     }
     /**
      * returns whether the value is empty. Empty value is either a '', undefined or null
@@ -196,7 +269,7 @@ class Field extends Scriptable_1.default {
     }
     get editValue() {
         const format = this.editFormat;
-        if (this.format == 'date' && this.value != null && this.valid !== false) {
+        if (this.format == 'date' && this.isNotEmpty(this.value) && this.valid !== false) {
             return (0, af_formatters_1.formatDate)(new Date(this.value), this.language, format);
         }
         else {
@@ -205,7 +278,7 @@ class Field extends Scriptable_1.default {
     }
     get displayValue() {
         const format = this.displayFormat;
-        if (this.format == 'date' && this.value != null && this.valid !== false) {
+        if (this.format == 'date' && this.isNotEmpty(this.value) && this.valid !== false) {
             return (0, af_formatters_1.formatDate)(new Date(this.value), this.language, format);
         }
         else {
@@ -215,6 +288,23 @@ class Field extends Scriptable_1.default {
     getDataNodeValue(typedValue) {
         return this.isEmpty() ? this.emptyValue : typedValue;
     }
+    updateDataNodeAndTypedValue(val) {
+        const dataNode = this.getDataNode();
+        if (BaseNode_1.staticFields.indexOf(this.fieldType) > -1 && typeof dataNode !== 'undefined') {
+            // if a static field is bound to data node it can not be updated.
+            return;
+        }
+        const Constraints = this._getConstraintObject();
+        const typeRes = Constraints.type(this.getInternalType() || 'string', val);
+        const changes = this._setProperty('value', typeRes.value, false);
+        if (changes.length > 0) {
+            this._updateRuleNodeReference(typeRes.value);
+            if (typeof dataNode !== 'undefined') {
+                dataNode.setValue(this.getDataNodeValue(this._jsonModel.value), this._jsonModel.value, this);
+            }
+        }
+        return changes;
+    }
     get value() {
         if (this._jsonModel.value === undefined) {
             return null;
@@ -224,21 +314,15 @@ class Field extends Scriptable_1.default {
         }
     }
     set value(v) {
-        const Constraints = this._getConstraintObject();
-        const typeRes = Constraints.type(this.getInternalType() || 'string', v);
-        const changes = this._setProperty('value', typeRes.value, false);
+        const changes = this.updateDataNodeAndTypedValue(v);
         let uniqueRes = { valid: true };
-        if (changes.length > 0) {
-            this._updateRuleNodeReference(typeRes.value);
-            const dataNode = this.getDataNode();
-            if (typeof dataNode !== 'undefined') {
-                dataNode.setValue(this.getDataNodeValue(this._jsonModel.value), this._jsonModel.value, this);
-            }
+        if ((changes === null || changes === void 0 ? void 0 : changes.length) > 0) {
+            let updates = {};
+            const typeRes = ValidationUtils_1.Constraints.type(this.getInternalType() || 'string', v);
             if (this.parent.uniqueItems && this.parent.type === 'array') {
                 // @ts-ignore
-                uniqueRes = Constraints.uniqueItems(this.parent.uniqueItems, this.parent.getDataNode().$value);
+                uniqueRes = ValidationUtils_1.Constraints.uniqueItems(this.parent.uniqueItems, this.parent.getDataNode().$value);
             }
-            let updates;
             if (typeRes.valid && uniqueRes.valid) {
                 updates = this.evaluateConstraints();
             }
@@ -256,6 +340,28 @@ class Field extends Scriptable_1.default {
             this.dispatch(changeAction);
         }
     }
+    /**
+     * @summary reset the value of the current field to its default
+     * @method reset
+     * @private
+     */
+    reset() {
+        // update the default value as typed value and also its data node
+        const changes = this.updateDataNodeAndTypedValue(this.default); // set the value to default value during reset
+        // if there are changes, trigger change event and reset the validation state (ie errorMessage and valid state)
+        if (changes.length > 0) {
+            // disable all field validations during field reset.
+            // reset to default state (ie) field is valid and error message set as empty
+            const validationStateChanges = {
+                'valid': undefined,
+                'errorMessage': ''
+            };
+            // only if there are changes, update would contain valid and errorMessage
+            const updates = this._applyUpdates(['valid', 'errorMessage'], validationStateChanges);
+            const changeAction = new controller_1.Change({ changes: changes.concat(Object.values(updates)) });
+            this.dispatch(changeAction);
+        }
+    }
     _updateRuleNodeReference(value) {
         var _a;
         if ((_a = this.type) === null || _a === void 0 ? void 0 : _a.endsWith('[]')) {
@@ -299,6 +405,12 @@ class Field extends Scriptable_1.default {
         var _a;
         return ((_a = this._jsonModel.constraintMessages) === null || _a === void 0 ? void 0 : _a[constraint]) || '';
     }
+    get errorMessage() {
+        return this._jsonModel.errorMessage;
+    }
+    get screenReaderText() {
+        return this._jsonModel.screenReaderText;
+    }
     /**
      *
      * @private
@@ -388,7 +500,65 @@ class Field extends Scriptable_1.default {
      * returns the format constraint
      */
     get format() {
-        return this._jsonModel.format || '';
+        if (typeof this._jsonModel.format === 'undefined') {
+            if (this.type === 'string') {
+                switch (this.fieldType) {
+                    case 'date-input':
+                        this._jsonModel.format = 'date';
+                        break;
+                    case 'file-input':
+                        this._jsonModel.format = 'data-url';
+                        break;
+                }
+            }
+        }
+        return this._jsonModel.format;
+    }
+    get enforceEnum() {
+        return this._jsonModel.enforceEnum;
+    }
+    get tooltip() {
+        return this._jsonModel.tooltip;
+    }
+    get maxLength() {
+        return this._jsonModel.maxLength;
+    }
+    get minLength() {
+        return this._jsonModel.minLength;
+    }
+    get pattern() {
+        return this._jsonModel.pattern;
+    }
+    get step() {
+        if (this.type === 'number' || this.format === 'date') {
+            return this._jsonModel.step;
+        }
+    }
+    get exclusiveMinimum() {
+        if (this.type === 'number' || this.format === 'date') {
+            return this._jsonModel.exclusiveMinimum;
+        }
+    }
+    set exclusiveMinimum(eM) {
+        if (this.type === 'number' || this.format === 'date') {
+            this._jsonModel.exclusiveMinimum = eM;
+        }
+    }
+    get exclusiveMaximum() {
+        if (this.type === 'number' || this.format === 'date') {
+            return this._jsonModel.exclusiveMaximum;
+        }
+    }
+    set exclusiveMaximum(eM) {
+        if (this.type === 'number' || this.format === 'date') {
+            this._jsonModel.exclusiveMaximum = eM;
+        }
+    }
+    get default() {
+        return this._jsonModel.default;
+    }
+    isNotEmpty(value) {
+        return value != null && value !== '';
     }
     /**
      * @private
@@ -405,9 +575,10 @@ class Field extends Scriptable_1.default {
                 (this.isArrayType() && this.required ? value.length > 0 : true);
             constraint = 'required';
         }
-        if (valid && value != this.emptyValue) {
+        if (valid && this.isNotEmpty(value)) {
             const invalidConstraint = supportedConstraints.find(key => {
-                if (key in elem) {
+                // @ts-ignore
+                if (key in elem && elem[key] !== undefined) {
                     // @ts-ignore
                     const restriction = elem[key];
                     // @ts-ignore
@@ -494,17 +665,20 @@ class Field extends Scriptable_1.default {
      * @private
      */
     defaultDataModel(name) {
-        return new DataValue_1.default(name, this.getDataNodeValue(this._jsonModel.value), this.type || 'string');
+        const value = BaseNode_1.staticFields.indexOf(this.fieldType) > -1 ? undefined : this.getDataNodeValue(this._jsonModel.value);
+        return new DataValue_1.default(name, value, this.type || 'string');
     }
     getState() {
         return Object.assign(Object.assign({}, super.getState()), { editValue: this.editValue, displayValue: this.displayValue });
     }
 }
 __decorate([
-    (0, BaseNode_1.dependencyTracked)()
+    (0, BaseNode_1.dependencyTracked)(),
+    (0, BaseNode_1.exclude)('button', 'image', 'plain-text')
 ], Field.prototype, "readOnly", null);
 __decorate([
-    (0, BaseNode_1.dependencyTracked)()
+    (0, BaseNode_1.dependencyTracked)(),
+    (0, BaseNode_1.exclude)('button', 'image', 'plain-text')
 ], Field.prototype, "enabled", null);
 __decorate([
     (0, BaseNode_1.dependencyTracked)()
@@ -518,7 +692,31 @@ __decorate([
 __decorate([
     (0, BaseNode_1.dependencyTracked)()
 ], Field.prototype, "required", null);
+__decorate([
+    (0, BaseNode_1.include)('date-input', 'number-input')
+], Field.prototype, "editValue", null);
+__decorate([
+    (0, BaseNode_1.include)('date-input', 'number-input')
+], Field.prototype, "displayValue", null);
 __decorate([
     (0, BaseNode_1.dependencyTracked)()
 ], Field.prototype, "value", null);
+__decorate([
+    (0, BaseNode_1.include)('text-input', 'date-input', 'file-input')
+], Field.prototype, "format", null);
+__decorate([
+    (0, BaseNode_1.include)('text-input')
+], Field.prototype, "maxLength", null);
+__decorate([
+    (0, BaseNode_1.include)('text-input')
+], Field.prototype, "minLength", null);
+__decorate([
+    (0, BaseNode_1.include)('text-input')
+], Field.prototype, "pattern", null);
+__decorate([
+    (0, BaseNode_1.dependencyTracked)()
+], Field.prototype, "exclusiveMinimum", null);
+__decorate([
+    (0, BaseNode_1.dependencyTracked)()
+], Field.prototype, "exclusiveMaximum", null);
 exports.default = Field;

package/lib/Fieldset.d.ts

@@ -1,15 +1,5 @@
 import Container from './Container';
 import { ContainerModel, FieldJson, FieldModel, FieldsetJson, FieldsetModel, FormModel } from './types';
-/**
- * Creates a child model inside the given parent
- * @param child
- * @param options
- * @private
- */
-export declare const createChild: (child: FieldsetJson | FieldJson, options: {
-    form: FormModel;
-    parent: ContainerModel;
-}) => FieldModel | FieldsetModel;
 /**
  * Defines a field set class which extends from {@link Container | container}
  */

package/lib/Fieldset.js

@@ -10,48 +10,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Fieldset = exports.createChild = void 0;
+exports.Fieldset = void 0;
 const Container_1 = __importDefault(require("./Container"));
-const Field_1 = __importDefault(require("./Field"));
-const FileUpload_1 = __importDefault(require("./FileUpload"));
-const JsonUtils_1 = require("./utils/JsonUtils");
 const controller_1 = require("./controller");
-const Checkbox_1 = __importDefault(require("./Checkbox"));
-const CheckboxGroup_1 = __importDefault(require("./CheckboxGroup"));
-const DateField_1 = __importDefault(require("./DateField"));
-/**
- * Creates a child model inside the given parent
- * @param child
- * @param options
- * @private
- */
-const createChild = (child, options) => {
-    let retVal;
-    if ('items' in child) {
-        retVal = new Fieldset(child, options);
-    }
-    else {
-        if ((0, JsonUtils_1.isFile)(child) || child.fieldType === 'file-input') {
-            // @ts-ignore
-            retVal = new FileUpload_1.default(child, options);
-        }
-        else if ((0, JsonUtils_1.isCheckbox)(child)) {
-            retVal = new Checkbox_1.default(child, options);
-        }
-        else if ((0, JsonUtils_1.isCheckboxGroup)(child)) {
-            retVal = new CheckboxGroup_1.default(child, options);
-        }
-        else if ((0, JsonUtils_1.isDateField)(child)) {
-            retVal = new DateField_1.default(child, options);
-        }
-        else {
-            retVal = new Field_1.default(child, options);
-        }
-    }
-    options.form.fieldAdded(retVal);
-    return retVal;
-};
-exports.createChild = createChild;
+const FormCreationUtils_1 = require("./utils/FormCreationUtils");
 const defaults = {
     visible: true
 };
@@ -89,10 +51,9 @@ class Fieldset extends Container_1.default {
         }
         return undefined;
     }
-    // @ts-ignore
     _createChild(child, options) {
         const { parent = this } = options;
-        return (0, exports.createChild)(child, { form: this.form, parent: parent });
+        return (0, FormCreationUtils_1.createChild)(child, { form: this.form, parent: parent });
     }
     get items() {
         return super.items;

package/lib/FileObject.d.ts

@@ -4,14 +4,15 @@ import { IFileObject } from './types';
  */
 export declare class FileObject implements IFileObject {
     data: any;
-    type: string;
+    mediaType: string;
     name: string;
     size: number;
     constructor(init?: Partial<FileObject>);
+    get type(): string;
     toJSON(): {
         name: string;
         size: number;
-        type: string;
+        mediaType: string;
         data: any;
     };
     equals(obj: IFileObject): boolean;

package/lib/FileObject.js

@@ -13,22 +13,25 @@ exports.FileObject = void 0;
  */
 class FileObject {
     constructor(init) {
-        this.type = 'application/octet-stream';
+        this.mediaType = 'application/octet-stream';
         this.name = 'unknown';
         this.size = 0;
         Object.assign(this, init);
     }
+    get type() {
+        return this.mediaType;
+    }
     toJSON() {
         return {
             'name': this.name,
             'size': this.size,
-            'type': this.type,
+            'mediaType': this.mediaType,
             'data': this.data.toString()
         };
     }
     equals(obj) {
         return (this.data === obj.data &&
-            this.type === obj.type &&
+            this.mediaType === obj.mediaType &&
             this.name === obj.name &&
             this.size === obj.size);
     }

package/lib/FileUpload.d.ts

@@ -8,11 +8,12 @@ declare class FileUpload extends Field implements FieldModel {
     protected _getDefaults(): {
         accept: string[];
         maxFileSize: string;
-        type: string;
         readOnly: boolean;
         enabled: boolean;
         visible: boolean;
+        type: string | undefined;
     };
+    protected _getFallbackType(): string | undefined;
     /**
      * Returns the max file size in bytes as per IEC specification
      */

package/lib/FileUpload.js

@@ -56,7 +56,10 @@ function processFile(file) {
 class FileUpload extends Field_1.default {
     //private _files: FileObject[];
     _getDefaults() {
-        return Object.assign(Object.assign({}, super._getDefaults()), { accept: ['audio/*', 'video/*', 'image/*', 'text/*', 'application/pdf'], maxFileSize: '2MB', type: 'file' });
+        return Object.assign(Object.assign({}, super._getDefaults()), { accept: ['audio/*', 'video/*', 'image/*', 'text/*', 'application/pdf'], maxFileSize: '2MB' });
+    }
+    _getFallbackType() {
+        return 'file';
     }
     /**
      * Returns the max file size in bytes as per IEC specification