@aemforms/af-core 0.22.16 → 0.22.18

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
@@ -61,8 +58,11 @@ declare class Field extends Scriptable<FieldJson> implements FieldModel {
     private isEmpty;
     get editValue(): any;
     get displayValue(): any;
+    protected getDataNodeValue(typedValue: any): any;
     get value(): any;
     set value(v: any);
+    protected _updateRuleNodeReference(value: any): void;
+    protected getInternalType(): string | undefined;
     valueOf(): any;
     toString(): any;
     /**
@@ -70,6 +70,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
@@ -105,10 +107,7 @@ declare class Field extends Scriptable<FieldJson> implements FieldModel {
         };
         maxItems: <T_1>(constraint: number, value: T_1[]) => {
             valid: boolean;
-            value: T_1[]; /**
-             * Returns the error message for a given constraint
-             * @param constraint
-             */
+            value: T_1[];
         };
         uniqueItems: <T_2>(constraint: boolean, value: T_2[]) => {
             valid: boolean;
@@ -134,6 +133,14 @@ declare class Field extends Scriptable<FieldJson> implements FieldModel {
             valid: boolean;
             value: any;
         };
+        accept: (constraint: string[], value: any) => {
+            valid: boolean;
+            value: any;
+        };
+        maxFileSize: (constraint: string | number, value: any) => {
+            valid: boolean;
+            value: any;
+        };
     };
     /**
      * returns whether the field is array type or not
@@ -168,20 +175,23 @@ 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
      */
     protected evaluateConstraints(): any;
     triggerValidationEvent(changes: any): 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;
     /**
      * Validates the current form object
      */
@@ -196,8 +206,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;
@@ -227,9 +237,12 @@ declare class Field extends Scriptable<FieldJson> implements FieldModel {
         constraintMessages?: ConstraintsMessages | undefined;
         fieldType?: string | undefined;
         errorMessage?: string | undefined;
-        properties?: {
+        properties: {
             [key: string]: any;
-        } | undefined;
+        };
+        screenReaderText?: string | undefined;
+        tooltip?: string | undefined;
+        altText?: string | undefined;
         placeholder?: string | undefined;
         readOnly?: boolean | undefined;
         valid?: boolean | undefined;
@@ -238,6 +251,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,11 +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) {
-            this._jsonModel.value = this._jsonModel.default;
+            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
@@ -113,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;
         }
     }
@@ -175,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
@@ -211,6 +285,9 @@ class Field extends Scriptable_1.default {
             return this.value;
         }
     }
+    getDataNodeValue(typedValue) {
+        return this.isEmpty() ? this.emptyValue : typedValue;
+    }
     get value() {
         if (this._jsonModel.value === undefined) {
             return null;
@@ -220,30 +297,19 @@ class Field extends Scriptable_1.default {
         }
     }
     set value(v) {
-        var _a;
+        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._jsonModel.type || 'string', v);
+        const typeRes = Constraints.type(this.getInternalType() || 'string', v);
         const changes = this._setProperty('value', typeRes.value, false);
         let uniqueRes = { valid: true };
         if (changes.length > 0) {
-            if ((_a = this.type) === null || _a === void 0 ? void 0 : _a.endsWith('[]')) {
-                if (typeRes.value != null) {
-                    typeRes.value.forEach((val, index) => {
-                        this._ruleNodeReference[index] = val;
-                    });
-                    while (typeRes.value.length !== this._ruleNodeReference.length) {
-                        this._ruleNodeReference.pop();
-                    }
-                }
-                else {
-                    while (this._ruleNodeReference.length !== 0) {
-                        this._ruleNodeReference.pop();
-                    }
-                }
-            }
-            const dataNode = this.getDataNode();
+            this._updateRuleNodeReference(typeRes.value);
             if (typeof dataNode !== 'undefined') {
-                dataNode.setValue(this.isEmpty() ? this.emptyValue : this._jsonModel.value, this._jsonModel.value);
+                dataNode.setValue(this.getDataNodeValue(this._jsonModel.value), this._jsonModel.value, this);
             }
             if (this.parent.uniqueItems && this.parent.type === 'array') {
                 // @ts-ignore
@@ -267,6 +333,27 @@ class Field extends Scriptable_1.default {
             this.dispatch(changeAction);
         }
     }
+    _updateRuleNodeReference(value) {
+        var _a;
+        if ((_a = this.type) === null || _a === void 0 ? void 0 : _a.endsWith('[]')) {
+            if (value != null) {
+                value.forEach((val, index) => {
+                    this._ruleNodeReference[index] = val;
+                });
+                while (value.length !== this._ruleNodeReference.length) {
+                    this._ruleNodeReference.pop();
+                }
+            }
+            else {
+                while (this._ruleNodeReference.length !== 0) {
+                    this._ruleNodeReference.pop();
+                }
+            }
+        }
+    }
+    getInternalType() {
+        return this.type;
+    }
     valueOf() {
         // @ts-ignore
         const obj = this[BaseNode_1.target];
@@ -289,6 +376,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
@@ -363,7 +456,10 @@ class Field extends Scriptable_1.default {
                     default:
                         return ValidationUtils_1.ValidConstraints.string;
                 }
+            case 'file':
+                return ValidationUtils_1.ValidConstraints.file;
             case 'number':
+            case 'integer':
                 return ValidationUtils_1.ValidConstraints.number;
         }
         if (this.isArrayType()) {
@@ -375,7 +471,62 @@ 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;
     }
     /**
      * @private
@@ -394,7 +545,8 @@ class Field extends Scriptable_1.default {
         }
         if (valid && value != this.emptyValue) {
             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
@@ -455,24 +607,6 @@ class Field extends Scriptable_1.default {
             }
         }
     }
-    /**
-     * 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;
-        }, {});
-    }
     /**
      * Validates the current form object
      */
@@ -499,17 +633,20 @@ class Field extends Scriptable_1.default {
      * @private
      */
     defaultDataModel(name) {
-        return new DataValue_1.default(name, this.isEmpty() ? this.emptyValue : 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)()
@@ -523,7 +660,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/FileObject.d.ts

@@ -8,10 +8,12 @@ export declare class FileObject implements IFileObject {
     name: string;
     size: number;
     constructor(init?: Partial<FileObject>);
+    get type(): string;
     toJSON(): {
         name: string;
         size: number;
         mediaType: string;
         data: any;
     };
+    equals(obj: IFileObject): boolean;
 }

package/lib/FileObject.js

@@ -18,6 +18,9 @@ class FileObject {
         this.size = 0;
         Object.assign(this, init);
     }
+    get type() {
+        return this.mediaType;
+    }
     toJSON() {
         return {
             'name': this.name,
@@ -26,5 +29,11 @@ class FileObject {
             'data': this.data.toString()
         };
     }
+    equals(obj) {
+        return (this.data === obj.data &&
+            this.mediaType === obj.mediaType &&
+            this.name === obj.name &&
+            this.size === obj.size);
+    }
 }
 exports.FileObject = FileObject;

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
      */
@@ -28,19 +29,9 @@ declare class FileUpload extends Field implements FieldModel {
      * @private
      */
     protected _applyUpdates(propNames: string[], updates: any): any;
-    typeCheck(value: any): {
-        valid: boolean;
-        value: any;
-    };
-    checkFileType(type: any): boolean;
-    acceptCheck(value: any): {
-        valid: boolean;
-        value: any;
-    };
-    get value(): any;
-    set value(value: any);
+    protected getInternalType(): "file" | "file[]";
+    protected getDataNodeValue(typedValue: any): any;
     private _serialize;
-    private coerce;
     importData(dataModel: DataGroup): void;
 }
 export default FileUpload;