@aemforms/af-core 0.22.17 → 0.22.18

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
@@ -224,13 +297,17 @@ class Field extends Scriptable_1.default {
         }
     }
     set value(v) {
+        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', v);
         const changes = this._setProperty('value', typeRes.value, false);
         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);
             }
@@ -299,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
@@ -388,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
@@ -407,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
@@ -494,17 +633,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 +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

@@ -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

package/lib/Form.d.ts

@@ -86,6 +86,9 @@ declare class Form extends Container<FormJson> implements FormModel {
         properties?: {
             [key: string]: any;
         } | undefined;
+        screenReaderText?: string | undefined;
+        tooltip?: string | undefined;
+        altText?: string | undefined;
     } & {
         items: (FieldJson | import("./types").ContainerJson)[];
         initialItems?: number | undefined;
@@ -97,8 +100,10 @@ declare class Form extends Container<FormJson> implements FormModel {
         action?: string | undefined;
         adaptiveForm?: string | undefined;
     } & {
-        ':type': string;
         items: ({
+            id: string;
+            index: number;
+            ':type': string;
             description?: string | undefined;
             rules?: Items<string> | undefined;
             events?: Items<string | string[] | undefined> | undefined;
@@ -123,7 +128,6 @@ declare class Form extends Container<FormJson> implements FormModel {
             validationExpression?: string | undefined;
             uniqueItems?: boolean | undefined;
             dataRef?: string | null | undefined;
-            ':type': string;
             label?: import("./types").Label | undefined;
             enabled?: boolean | undefined;
             visible?: boolean | undefined;
@@ -134,7 +138,19 @@ declare class Form extends Container<FormJson> implements FormModel {
             properties?: {
                 [key: string]: any;
             } | undefined;
-            placeholder?: string | undefined;
+            screenReaderText?: string | undefined;
+            tooltip?: string | undefined;
+            altText?: string | undefined;
+            placeholder?: string | undefined; /**
+             * Returns the current state of the form
+             *
+             * To access the form data and attachments, one needs to use the `data` and `attachments` property.
+             * For example,
+             * ```
+             * const data = form.getState().data
+             * const attachments = form.getState().attachments
+             * ```
+             */
             readOnly?: boolean | undefined;
             valid?: boolean | undefined;
             default?: any;
@@ -144,8 +160,10 @@ declare class Form extends Container<FormJson> implements FormModel {
             editValue?: string | undefined;
             displayValue?: string | undefined;
             emptyValue?: "" | "undefined" | "null" | undefined;
-            id: string;
         } | {
+            id: string;
+            index: number;
+            ':type': string;
             description?: string | undefined;
             rules?: Items<string> | undefined;
             events?: Items<string | string[] | undefined> | undefined;
@@ -170,7 +188,6 @@ declare class Form extends Container<FormJson> implements FormModel {
             validationExpression?: string | undefined;
             uniqueItems?: boolean | undefined;
             dataRef?: string | null | undefined;
-            ':type'?: string | undefined;
             label?: import("./types").Label | undefined;
             enabled?: boolean | undefined;
             visible?: boolean | undefined;
@@ -181,200 +198,22 @@ declare class Form extends Container<FormJson> implements FormModel {
             properties?: {
                 [key: string]: any;
             } | undefined;
-            items: (FieldJson | import("./types").ContainerJson)[] & (({
-                description?: string | undefined;
-            } & import("./types").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;
-            } & import("./types").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 | import("./types").ContainerJson)[];
-                initialItems?: number | undefined;
-                activeChild?: string | undefined;
-            } & {
-                id: string;
-                items: (({
-                    description?: string | undefined;
-                } & import("./types").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;
-                } & import("./types").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 | import("./types").ContainerJson)[];
-                    initialItems?: number | undefined;
-                    activeChild?: string | undefined;
-                } & any))[];
-            }))[];
+            screenReaderText?: string | undefined;
+            tooltip?: string | undefined;
+            altText?: string | undefined;
+            items: (FieldJson | import("./types").ContainerJson)[] & import("./types").State<FieldJson | import("./types").ContainerJson>[];
             initialItems?: number | undefined;
             activeChild?: string | undefined;
-            id: string;
         })[];
+        properties: {
+            [key: string]: any;
+        };
+        index: number;
+        parent: undefined;
+        qualifiedName: any;
+        events: {};
+        rules: {};
+        ':type': string;
         id: string;
     };
     get type(): string;

package/lib/Scriptable.d.ts

@@ -7,7 +7,7 @@ import { BaseNode } from './BaseNode';
 declare abstract class Scriptable<T extends RulesJson> extends BaseNode<T> implements ScriptableField {
     private _events;
     private _rules;
-    get rules(): import("./types").Items<string>;
+    getRules(): import("./types").Items<string>;
     private getCompiledRule;
     private getCompiledEvent;
     private applyUpdates;