@aemforms/af-core 0.22.4 → 0.22.8

package/lib/BaseNode.js

@@ -109,16 +109,24 @@ class BaseNode {
             //look for property
             if (prop.startsWith('$')) {
                 prop = prop.substr(1);
-                if (prop === 'parent') {
-                    return this[prop].getRuleNode();
-                }
                 //@ts-ignore
                 //@todo: create a list of properties that are allowed
                 //@ts-ignore
                 // return only non functional properties in this object
                 if (typeof this[prop] !== 'function') {
                     //@ts-ignore
-                    return this[prop];
+                    const retValue = this[prop];
+                    if (retValue instanceof BaseNode) {
+                        //$parent
+                        return retValue.getRuleNode();
+                    }
+                    else if (retValue instanceof Array) {
+                        //$items
+                        return retValue.map(r => r instanceof BaseNode ? r.getRuleNode() : r);
+                    }
+                    else {
+                        return retValue;
+                    }
                 }
             }
             else {

package/lib/Container.d.ts

@@ -74,6 +74,10 @@ declare abstract class Container<T extends ContainerJson & RulesJson> extends Sc
             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;
         } | {
@@ -156,6 +160,10 @@ declare abstract class Container<T extends ContainerJson & RulesJson> extends Sc
                 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;
@@ -246,6 +254,10 @@ declare abstract class Container<T extends ContainerJson & RulesJson> extends Sc
                     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;

package/lib/Container.js

@@ -94,7 +94,7 @@ class Container extends Scriptable_1.default {
             });
         }
     }
-    _addChild(itemJson, index) {
+    _addChild(itemJson, index, cloneIds = false) {
         // get first non transparent parent
         // eslint-disable-next-line @typescript-eslint/no-this-alias
         let nonTransparentParent = this;
@@ -105,7 +105,8 @@ class Container extends Scriptable_1.default {
         if (typeof index !== 'number' || index > nonTransparentParent._children.length) {
             index = this._children.length;
         }
-        const itemTemplate = Object.assign({ index }, (0, JsonUtils_1.deepClone)(itemJson));
+        const form = this.form;
+        const itemTemplate = Object.assign({ index }, (0, JsonUtils_1.deepClone)(itemJson, cloneIds ? () => { return form.getUniqueId(); } : undefined));
         //@ts-ignore
         const retVal = this._createChild(itemTemplate, { parent: this, index });
         this._addChildToRuleNode(retVal, { parent: nonTransparentParent });
@@ -182,7 +183,7 @@ class Container extends Scriptable_1.default {
                 if (typeof index !== 'number' || index > this._children.length) {
                     index = this._children.length;
                 }
-                const retVal = this._addChild(this._itemTemplate, action.payload);
+                const retVal = this._addChild(this._itemTemplate, action.payload, true);
                 const _data = retVal.defaultDataModel(index);
                 if (_data) {
                     dataNode.$addDataNode(index, _data);
@@ -199,6 +200,10 @@ class Container extends Scriptable_1.default {
      */
     removeItem(action) {
         if (action.type === 'removeItem' && 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();
             //@ts-ignore

package/lib/DateField.d.ts

@@ -0,0 +1,5 @@
+import Field from './Field';
+declare class DateField extends Field {
+    protected _applyDefaults(): void;
+}
+export default DateField;

package/lib/DateField.js

@@ -0,0 +1,35 @@
+"use strict";
+/*
+ *
+ *  * Copyright 2022 Adobe, Inc.
+ *  *
+ *  * Your access and use of this software is governed by the Adobe Customer Feedback Program Terms and Conditions or other Beta License Agreement signed by your employer and Adobe, Inc.. This software is NOT open source and may not be used without one of the foregoing licenses. Even with a foregoing license, your access and use of this file is limited to the earlier of (a) 180 days, (b) general availability of the product(s) which utilize this software (i.e. AEM Forms), (c) January 1, 2023, (d) Adobe providing notice to you that you may no longer use the software or that your beta trial has otherwise ended.
+ *  *
+ *  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL ADOBE NOR ITS THIRD PARTY PROVIDERS AND PARTNERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Field_1 = __importDefault(require("./Field"));
+const af_formatters_1 = require("@aemforms/af-formatters");
+class DateField extends Field_1.default {
+    _applyDefaults() {
+        super._applyDefaults();
+        const locale = new Intl.DateTimeFormat().resolvedOptions().locale;
+        if (!this._jsonModel.editFormat) {
+            this._jsonModel.editFormat = 'short';
+        }
+        if (!this._jsonModel.displayFormat) {
+            this._jsonModel.displayFormat = this._jsonModel.editFormat;
+        }
+        if (!this._jsonModel.placeholder) {
+            this._jsonModel.placeholder = (0, af_formatters_1.getSkeleton)(this._jsonModel.editFormat, locale);
+        }
+        if (!this._jsonModel.description) {
+            this._jsonModel.description = `To enter today's date use ${(0, af_formatters_1.formatDate)(new Date(), locale, this._jsonModel.editFormat)}`;
+        }
+    }
+}
+exports.default = DateField;

package/lib/Field.d.ts

@@ -32,8 +32,12 @@ declare class Field extends Scriptable<FieldJson> implements FieldModel {
      */
     protected _getFallbackType(): string | undefined;
     protected _applyDefaults(): void;
+    get editFormat(): string | undefined;
+    get displayFormat(): string | undefined;
+    get placeholder(): string | undefined;
     get readOnly(): boolean | undefined;
     set readOnly(e: boolean | undefined);
+    get language(): string;
     get enabled(): boolean | undefined;
     set enabled(e: boolean | undefined);
     get valid(): boolean | undefined;
@@ -53,6 +57,8 @@ declare class Field extends Scriptable<FieldJson> implements FieldModel {
      * @private
      */
     private isEmpty;
+    get editValue(): any;
+    get displayValue(): any;
     get value(): any;
     set value(v: any);
     valueOf(): any;
@@ -104,9 +110,7 @@ declare class Field extends Scriptable<FieldJson> implements FieldModel {
             value: T_2[];
         };
         minLength: (constraint: number, value: string) => {
-            value: string; /**
-             * returns the format constraint
-             */
+            value: string;
             valid: boolean;
         };
         maxLength: (constraint: number, value: string) => {
@@ -183,5 +187,55 @@ declare class Field extends Scriptable<FieldJson> implements FieldModel {
      * @private
      */
     defaultDataModel(name: string | number): DataValue;
+    getState(): {
+        editValue: any;
+        displayValue: any;
+        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?: 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;
+        emptyValue?: "" | "undefined" | "null" | undefined;
+        id: string;
+    };
 }
 export default Field;

package/lib/Field.js

@@ -18,6 +18,7 @@ const SchemaUtils_1 = require("./utils/SchemaUtils");
 const DataValue_1 = __importDefault(require("./data/DataValue"));
 const BaseNode_1 = require("./BaseNode");
 const EmptyDataValue_1 = __importDefault(require("./data/EmptyDataValue"));
+const af_formatters_1 = require("@aemforms/af-formatters");
 /**
  * Defines a form object field which implements {@link FieldModel | field model} interface
  */
@@ -99,12 +100,25 @@ class Field extends Scriptable_1.default {
             this._jsonModel.step = undefined;
         }
     }
+    get editFormat() {
+        return this._jsonModel.editFormat;
+    }
+    get displayFormat() {
+        return this._jsonModel.displayFormat;
+    }
+    get placeholder() {
+        return this._jsonModel.placeholder;
+    }
     get readOnly() {
         return this._jsonModel.readOnly;
     }
     set readOnly(e) {
         this._setProperty('readOnly', e);
     }
+    get language() {
+        //todo: add this in the specification and take it as a property
+        return Intl.DateTimeFormat().resolvedOptions().locale;
+    }
     get enabled() {
         return this._jsonModel.enabled;
     }
@@ -162,6 +176,24 @@ class Field extends Scriptable_1.default {
     isEmpty() {
         return this._jsonModel.value === undefined || this._jsonModel.value === null || this._jsonModel.value === '';
     }
+    get editValue() {
+        const format = this.editFormat;
+        if (this.format == 'date' && this.value != null && this.valid !== false) {
+            return (0, af_formatters_1.formatDate)(new Date(this.value), this.language, format);
+        }
+        else {
+            return this.value;
+        }
+    }
+    get displayValue() {
+        const format = this.displayFormat;
+        if (this.format == 'date' && this.value != null && this.valid !== false) {
+            return (0, af_formatters_1.formatDate)(new Date(this.value), this.language, format);
+        }
+        else {
+            return this.value;
+        }
+    }
     get value() {
         //@ts-ignore
         this.ruleEngine.trackDependency(this);
@@ -329,7 +361,7 @@ class Field extends Scriptable_1.default {
                 (this.isArrayType() && this.required ? value.length > 0 : true);
             constraint = 'required';
         }
-        if (valid) {
+        if (valid && value != this.emptyValue) {
             const invalidConstraint = supportedConstraints.find(key => {
                 if (key in elem) {
                     // @ts-ignore
@@ -419,7 +451,7 @@ class Field extends Scriptable_1.default {
             this.triggerValidationEvent(changes);
             this.notifyDependents(new controller_1.Change({ changes: Object.values(changes) }));
         }
-        return this.valid ? [new types_1.ValidationError()] : [new types_1.ValidationError(this.id, [this._jsonModel.errorMessage])];
+        return this.valid ? [] : [new types_1.ValidationError(this.id, [this._jsonModel.errorMessage])];
     }
     importData(contextualDataModel) {
         this._bindToDataModel(contextualDataModel);
@@ -438,5 +470,8 @@ class Field extends Scriptable_1.default {
     defaultDataModel(name) {
         return new DataValue_1.default(name, this.isEmpty() ? this.emptyValue : this._jsonModel.value, this.type || 'string');
     }
+    getState() {
+        return Object.assign(Object.assign({}, super.getState()), { editValue: this.editValue, displayValue: this.displayValue });
+    }
 }
 exports.default = Field;

package/lib/Fieldset.js

@@ -15,9 +15,10 @@ 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/Controller");
+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
@@ -40,6 +41,9 @@ const createChild = (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);
         }
@@ -63,8 +67,8 @@ class Fieldset extends Container_1.default {
     constructor(params, _options) {
         super(params, _options);
         this._applyDefaults();
-        this.queueEvent(new Controller_1.Initialize());
-        this.queueEvent(new Controller_1.ExecuteRule());
+        this.queueEvent(new controller_1.Initialize());
+        this.queueEvent(new controller_1.ExecuteRule());
     }
     _applyDefaults() {
         Object.entries(defaults).map(([key, value]) => {

package/lib/FileUpload.d.ts

@@ -13,7 +13,6 @@ declare class FileUpload extends Field implements FieldModel {
         enabled: boolean;
         visible: boolean;
     };
-    private static extractFileInfo;
     /**
      * Returns the max file size in bytes as per IEC specification
      */

package/lib/FileUpload.js

@@ -58,75 +58,6 @@ class FileUpload extends Field_1.default {
     _getDefaults() {
         return Object.assign(Object.assign({}, super._getDefaults()), { accept: ['audio/*', 'video/*', 'image/*', 'text/*', 'application/pdf'], maxFileSize: '2MB', type: 'file' });
     }
-    static extractFileInfo(files) {
-        return (files instanceof Array ? files : [files])
-            .map((file) => {
-            let retVal = null;
-            if (file instanceof FileObject_1.FileObject) {
-                retVal = file;
-            }
-            else if (typeof File !== 'undefined' && file instanceof File) {
-                // case: file object
-                retVal = {
-                    name: file.name,
-                    mediaType: file.type,
-                    size: file.size,
-                    data: file
-                };
-            }
-            else if (typeof file === 'string' && (0, ValidationUtils_1.isDataUrl)(file)) {
-                // case: data URL
-                const { blob, name } = (0, FormUtils_1.dataURItoBlob)(file);
-                retVal = {
-                    name: name,
-                    mediaType: blob.type,
-                    size: blob.size,
-                    data: blob
-                };
-            }
-            else {
-                // case: string as file object
-                let jFile = file;
-                try {
-                    jFile = JSON.parse(file);
-                    retVal = jFile;
-                }
-                catch (ex) {
-                    // do nothing
-                }
-                if (typeof (jFile === null || jFile === void 0 ? void 0 : jFile.data) === 'string' && (0, ValidationUtils_1.isDataUrl)(jFile === null || jFile === void 0 ? void 0 : jFile.data)) {
-                    // case: data URL
-                    const { blob } = (0, FormUtils_1.dataURItoBlob)(jFile === null || jFile === void 0 ? void 0 : jFile.data);
-                    retVal = {
-                        name: jFile === null || jFile === void 0 ? void 0 : jFile.name,
-                        mediaType: jFile === null || jFile === void 0 ? void 0 : jFile.type,
-                        size: blob.size,
-                        data: blob
-                    };
-                }
-                else if (typeof jFile === 'string') {
-                    // case: data as external url
-                    const fileName = jFile.split('/').pop();
-                    retVal = {
-                        name: fileName,
-                        mediaType: 'application/octet-stream',
-                        size: 0,
-                        data: jFile
-                    };
-                }
-                else if (jFile instanceof Object) {
-                    // todo: just added for ease of integration for the view layer
-                    retVal = {
-                        name: jFile === null || jFile === void 0 ? void 0 : jFile.name,
-                        mediaType: jFile === null || jFile === void 0 ? void 0 : jFile.type,
-                        size: jFile === null || jFile === void 0 ? void 0 : jFile.size,
-                        data: jFile === null || jFile === void 0 ? void 0 : jFile.data
-                    };
-                }
-            }
-            return new FileObject_1.FileObject(retVal);
-        });
-    }
     /**
      * Returns the max file size in bytes as per IEC specification
      */
@@ -246,10 +177,9 @@ class FileUpload extends Field_1.default {
             // store file list here
             const typeRes = this.typeCheck(value);
             const acceptRes = this.acceptCheck(value);
-            const changes = this._setProperty('value', typeRes.value, false);
-            let fileInfoPayload = FileUpload.extractFileInfo(value);
+            let fileInfoPayload = (0, FormUtils_1.extractFileInfo)(value);
             fileInfoPayload = this.coerce(fileInfoPayload);
-            this._setProperty('value', fileInfoPayload, false);
+            const changes = this._setProperty('value', fileInfoPayload, false);
             if (changes.length > 0) {
                 const dataNode = this.getDataNode();
                 if (typeof dataNode !== 'undefined') {
@@ -314,7 +244,7 @@ class FileUpload extends Field_1.default {
             let newValue = value;
             // only if not undefined, proceed further
             if (value != null) {
-                const fileObj = FileUpload.extractFileInfo(value);
+                const fileObj = (0, FormUtils_1.extractFileInfo)(value);
                 newValue = this.coerce(fileObj);
                 // is this needed ?
                 this.form.getEventQueue().queue(this, (0, Controller_1.propertyChange)('value', newValue, this._jsonModel.value));

package/lib/Form.d.ts

@@ -158,6 +158,10 @@ declare class Form extends Container<FormJson> implements FormModel {
             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;
         } | {
@@ -246,6 +250,10 @@ declare class Form extends Container<FormJson> implements FormModel {
                 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;
@@ -342,6 +350,10 @@ declare class Form extends Container<FormJson> implements FormModel {
                     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;

package/lib/Form.js

@@ -217,7 +217,8 @@ class Form extends Container_1.default {
     submit(action, context) {
         // if no errors, only then submit
         if (this.validate().length === 0) {
-            (0, FunctionRuntime_1.submit)(context, action.payload.success, action.payload.error, action.payload.submit_as, action.payload.data);
+            const payload = (action === null || action === void 0 ? void 0 : action.payload) || {};
+            (0, FunctionRuntime_1.submit)(context, payload === null || payload === void 0 ? void 0 : payload.success, payload === null || payload === void 0 ? void 0 : payload.error, payload === null || payload === void 0 ? void 0 : payload.submit_as, payload === null || payload === void 0 ? void 0 : payload.data);
         }
     }
     getElement(id) {

package/lib/Scriptable.js

@@ -133,7 +133,18 @@ class Scriptable extends BaseNode_1.BaseNode {
                 // 3. child
                 if (prop.startsWith('$')) {
                     //this returns children as well, so adding an explicit check for property name
-                    return target.self[prop];
+                    const retValue = target.self[prop];
+                    if (retValue instanceof BaseNode_1.BaseNode) {
+                        //$parent
+                        return retValue.getRuleNode();
+                    }
+                    else if (retValue instanceof Array) {
+                        //$items
+                        return retValue.map(r => r instanceof BaseNode_1.BaseNode ? r.getRuleNode() : r);
+                    }
+                    else {
+                        return retValue;
+                    }
                 }
                 else {
                     if (prop in target.siblings) {

package/lib/controller/Controller.d.ts

@@ -160,6 +160,12 @@ export declare class ValidationComplete extends ActionImpl {
      */
     constructor(payload?: Array<ValidationError>, dispatch?: boolean);
 }
+export declare class Focus extends ActionImpl {
+    /**
+     * @constructor
+     */
+    constructor();
+}
 /**
  * Implementation of `submit` event. The submit event is triggered on the Form.
  * To trigger the submit event, submit function needs to be invoked or one can invoke dispatchEvent API.

package/lib/controller/Controller.js

@@ -7,7 +7,7 @@
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL ADOBE NOR ITS THIRD PARTY PROVIDERS AND PARTNERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RemoveItem = exports.AddItem = exports.CustomEvent = exports.FieldChanged = exports.Submit = exports.ValidationComplete = exports.Blur = exports.Click = exports.FormLoad = exports.Initialize = exports.propertyChange = exports.ExecuteRule = exports.Valid = exports.Invalid = exports.Change = exports.ActionImpl = void 0;
+exports.RemoveItem = exports.AddItem = exports.CustomEvent = exports.FieldChanged = exports.Submit = exports.Focus = exports.ValidationComplete = exports.Blur = exports.Click = exports.FormLoad = exports.Initialize = exports.propertyChange = exports.ExecuteRule = exports.Valid = exports.Invalid = exports.Change = exports.ActionImpl = void 0;
 /**
  * Implementation of generic event
  * @private
@@ -199,6 +199,15 @@ class ValidationComplete extends ActionImpl {
     }
 }
 exports.ValidationComplete = ValidationComplete;
+class Focus extends ActionImpl {
+    /**
+     * @constructor
+     */
+    constructor() {
+        super({}, 'focus', { dispatch: false });
+    }
+}
+exports.Focus = Focus;
 /**
  * Implementation of `submit` event. The submit event is triggered on the Form.
  * To trigger the submit event, submit function needs to be invoked or one can invoke dispatchEvent API.

package/lib/index.d.ts

@@ -11,7 +11,7 @@ export * from './controller/index';
 export * from './utils/TranslationUtils';
 export * from './utils/JsonUtils';
 export * from './utils/SchemaUtils';
-import { getFileSizeInBytes } from './utils/FormUtils';
+import { getFileSizeInBytes, extractFileInfo } from './utils/FormUtils';
 import { BaseNode } from './BaseNode';
 import Checkbox from './Checkbox';
 import CheckboxGroup from './CheckboxGroup';
@@ -24,4 +24,4 @@ import FormMetaData from './FormMetaData';
 import Node from './Node';
 import Scriptable from './Scriptable';
 import Form from './Form';
-export { Form, BaseNode, Checkbox, CheckboxGroup, Container, Field, Fieldset, FileObject, FileUpload, FormMetaData, Node, Scriptable, getFileSizeInBytes };
+export { Form, BaseNode, Checkbox, CheckboxGroup, Container, Field, Fieldset, FileObject, FileUpload, FormMetaData, Node, Scriptable, getFileSizeInBytes, extractFileInfo };

package/lib/index.js

@@ -24,7 +24,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFileSizeInBytes = exports.Scriptable = exports.Node = exports.FormMetaData = exports.FileUpload = exports.FileObject = exports.Fieldset = exports.Field = exports.Container = exports.CheckboxGroup = exports.Checkbox = exports.BaseNode = exports.Form = void 0;
+exports.extractFileInfo = exports.getFileSizeInBytes = exports.Scriptable = exports.Node = exports.FormMetaData = exports.FileUpload = exports.FileObject = exports.Fieldset = exports.Field = exports.Container = exports.CheckboxGroup = exports.Checkbox = exports.BaseNode = exports.Form = void 0;
 __exportStar(require("./FormInstance"), exports);
 __exportStar(require("./types/index"), exports);
 __exportStar(require("./controller/index"), exports);
@@ -33,6 +33,7 @@ __exportStar(require("./utils/JsonUtils"), exports);
 __exportStar(require("./utils/SchemaUtils"), exports);
 const FormUtils_1 = require("./utils/FormUtils");
 Object.defineProperty(exports, "getFileSizeInBytes", { enumerable: true, get: function () { return FormUtils_1.getFileSizeInBytes; } });
+Object.defineProperty(exports, "extractFileInfo", { enumerable: true, get: function () { return FormUtils_1.extractFileInfo; } });
 const BaseNode_1 = require("./BaseNode");
 Object.defineProperty(exports, "BaseNode", { enumerable: true, get: function () { return BaseNode_1.BaseNode; } });
 const Checkbox_1 = __importDefault(require("./Checkbox"));

package/lib/rules/FunctionRuntime.d.ts

@@ -42,6 +42,13 @@ declare class FunctionRuntimeImpl {
             _func: (args: Array<unknown>, data: unknown, interpreter: any) => {};
             _signature: never[];
         };
+        /**
+         *
+         * @name dispatchEvent
+         * @param [element] element on which to trigger the event. If not defined the event will be triggered on entire form
+         * @param eventName name of the event to trigger
+         * @param payload payload to pass in the event
+         */
         dispatchEvent: {
             _func: (args: Array<unknown>, data: unknown, interpreter: any) => {};
             _signature: never[];

package/lib/rules/FunctionRuntime.js

@@ -199,12 +199,17 @@ class FunctionRuntimeImpl {
             validate: {
                 _func: (args, data, interpreter) => {
                     const element = args[0];
+                    let validation;
                     if (typeof element === 'string' || typeof element === 'undefined') {
-                        return interpreter.globals.form.validate();
+                        validation = interpreter.globals.form.validate();
                     }
                     else {
-                        return interpreter.globals.form.getElement(element.$id).validate();
+                        validation = interpreter.globals.form.getElement(element.$id).validate();
                     }
+                    if (Array.isArray(validation) && validation.length) {
+                        interpreter.globals.form.logger.error('Form Validation Error');
+                    }
+                    return validation;
                 },
                 _signature: []
             },
@@ -262,6 +267,13 @@ class FunctionRuntimeImpl {
                 },
                 _signature: []
             },
+            /**
+             *
+             * @name dispatchEvent
+             * @param [element] element on which to trigger the event. If not defined the event will be triggered on entire form
+             * @param eventName name of the event to trigger
+             * @param payload payload to pass in the event
+             */
             dispatchEvent: {
                 _func: (args, data, interpreter) => {
                     const element = args[0];

package/lib/types/Json.d.ts

@@ -93,6 +93,10 @@ export declare type FieldJson = BaseJson & TranslationFieldJson & {
     valid?: boolean;
     default?: any;
     value?: any;
+    displayFormat?: string;
+    editFormat?: string;
+    editValue?: string;
+    displayValue?: string;
     emptyValue?: 'null' | 'undefined' | '';
 };
 /** Type for `form container properties` based on `adaptive form specification` */

package/lib/types/Model.d.ts

@@ -222,6 +222,22 @@ export interface FieldModel extends BaseModel, ScriptableField, WithState<FieldJ
      * Parent of the current field
      */
     parent: ContainerModel;
+    /**
+     * format in which user will edit the value
+     */
+    readonly editFormat?: string;
+    /**
+     * format in which user will see the value after update
+     */
+    readonly displayFormat?: string;
+    /**
+     * value to be displayed to the user after update
+     */
+    readonly displayValue?: string;
+    /**
+     * value to be displayed to the user for edit
+     */
+    readonly editValue?: string;
 }
 /**
  * Defines form meta data properties

package/lib/utils/FormUtils.d.ts

@@ -1,4 +1,5 @@
 import { ContainerModel } from '../types';
+import { FileObject } from '../FileObject';
 /**
  * Utility to generate a random word from seed
  * @param l seed value
@@ -36,6 +37,12 @@ export declare const sizeToBytes: (size: number, symbol: string) => number;
  * @private
  */
 export declare const IdGenerator: (initial?: number) => Generator<string, void, string>;
+/**
+ * Utility to extract {@link FileObject} from string or HTML File data type
+ * @param files list of files as string , string [] of file[]
+ * @returns list of {@link FileObject}
+ */
+export declare const extractFileInfo: (files: string[] | string | File[]) => FileObject[];
 /**
  * Utility to convert data URI to a `blob` object
  * @param dataURI uri to convert to blob

package/lib/utils/FormUtils.js

@@ -7,11 +7,13 @@
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL ADOBE NOR ITS THIRD PARTY PROVIDERS AND PARTNERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.dataURItoBlob = exports.IdGenerator = exports.sizeToBytes = exports.getFileSizeInBytes = exports.getAttachments = exports.isEmpty = exports.randomWord = void 0;
+exports.dataURItoBlob = exports.extractFileInfo = exports.IdGenerator = exports.sizeToBytes = exports.getFileSizeInBytes = exports.getAttachments = exports.isEmpty = exports.randomWord = void 0;
 /**
  * Defines generic utilities to interact with form runtime model
  */
 const JsonUtils_1 = require("./JsonUtils");
+const FileObject_1 = require("../FileObject");
+const ValidationUtils_1 = require("./ValidationUtils");
 const chars = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_'.split('');
 const fileSizeRegex = /^(\d*\.?\d+)(\\?(?=[KMGT])([KMGT])(?:i?B)?|B?)$/i;
 /**
@@ -133,6 +135,81 @@ const IdGenerator = function* (initial = 50) {
     } while (ids.length > 0);
 };
 exports.IdGenerator = IdGenerator;
+/**
+ * Utility to extract {@link FileObject} from string or HTML File data type
+ * @param files list of files as string , string [] of file[]
+ * @returns list of {@link FileObject}
+ */
+const extractFileInfo = (files) => {
+    return (files instanceof Array ? files : [files])
+        .map((file) => {
+        let retVal = null;
+        if (file instanceof FileObject_1.FileObject) {
+            retVal = file;
+        }
+        else if (typeof File !== 'undefined' && file instanceof File) {
+            // case: file object
+            retVal = {
+                name: file.name,
+                mediaType: file.type,
+                size: file.size,
+                data: file
+            };
+        }
+        else if (typeof file === 'string' && (0, ValidationUtils_1.isDataUrl)(file)) {
+            // case: data URL
+            const { blob, name } = (0, exports.dataURItoBlob)(file);
+            retVal = {
+                name: name,
+                mediaType: blob.type,
+                size: blob.size,
+                data: blob
+            };
+        }
+        else {
+            // case: string as file object
+            let jFile = file;
+            try {
+                jFile = JSON.parse(file);
+                retVal = jFile;
+            }
+            catch (ex) {
+                // do nothing
+            }
+            if (typeof (jFile === null || jFile === void 0 ? void 0 : jFile.data) === 'string' && (0, ValidationUtils_1.isDataUrl)(jFile === null || jFile === void 0 ? void 0 : jFile.data)) {
+                // case: data URL
+                const { blob } = (0, exports.dataURItoBlob)(jFile === null || jFile === void 0 ? void 0 : jFile.data);
+                retVal = {
+                    name: jFile === null || jFile === void 0 ? void 0 : jFile.name,
+                    mediaType: jFile === null || jFile === void 0 ? void 0 : jFile.type,
+                    size: blob.size,
+                    data: blob
+                };
+            }
+            else if (typeof jFile === 'string') {
+                // case: data as external url
+                const fileName = jFile.split('/').pop();
+                retVal = {
+                    name: fileName,
+                    mediaType: 'application/octet-stream',
+                    size: 0,
+                    data: jFile
+                };
+            }
+            else if (typeof jFile === 'object') {
+                // todo: just added for ease of integration for the view layer
+                retVal = {
+                    name: jFile === null || jFile === void 0 ? void 0 : jFile.name,
+                    mediaType: (jFile === null || jFile === void 0 ? void 0 : jFile.type) || (jFile === null || jFile === void 0 ? void 0 : jFile.mediaType),
+                    size: jFile === null || jFile === void 0 ? void 0 : jFile.size,
+                    data: jFile === null || jFile === void 0 ? void 0 : jFile.data
+                };
+            }
+        }
+        return new FileObject_1.FileObject(retVal);
+    });
+};
+exports.extractFileInfo = extractFileInfo;
 /**
  * Utility to convert data URI to a `blob` object
  * @param dataURI uri to convert to blob

package/lib/utils/JsonUtils.d.ts

@@ -34,12 +34,19 @@ export declare const isCheckbox: (item: FieldsetJson | FieldJson) => boolean;
  * @returns `true` if `item` is a form check box group, `false` otherwise
  */
 export declare const isCheckboxGroup: (item: FieldsetJson | FieldJson) => boolean;
+/**
+ * Checks if the input item provided is a date field
+ * @param item  input item it could be {@link FieldsetJson | Fieldset} or {@link FieldJson | Field}
+ * @returns `true` if `item` is a form check box group, `false` otherwise
+ */
+export declare const isDateField: (item: FieldsetJson | FieldJson) => boolean;
 /**
  * Clones an object completely including any nested objects or arrays
  * @param obj
+ * @param idGenerator
  * @private
  */
-export declare function deepClone(obj: any): any;
+export declare function deepClone(obj: any, idGenerator?: () => string): any;
 /**
  * Checks if the key got added in current object
  * @param currentObj

package/lib/utils/JsonUtils.js

@@ -7,7 +7,7 @@
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL ADOBE NOR ITS THIRD PARTY PROVIDERS AND PARTNERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.jsonString = exports.checkIfKeyAdded = exports.deepClone = exports.isCheckboxGroup = exports.isCheckbox = exports.checkIfConstraintsArePresent = exports.isFile = exports.getProperty = void 0;
+exports.jsonString = exports.checkIfKeyAdded = exports.deepClone = exports.isDateField = exports.isCheckboxGroup = exports.isCheckbox = exports.checkIfConstraintsArePresent = exports.isFile = exports.getProperty = void 0;
 /**
  * Defines generic utilities to interact with form model definition which is represented as json
  */
@@ -74,26 +74,41 @@ const isCheckboxGroup = function (item) {
     return fieldType === 'checkbox-group';
 };
 exports.isCheckboxGroup = isCheckboxGroup;
+/**
+ * Checks if the input item provided is a date field
+ * @param item  input item it could be {@link FieldsetJson | Fieldset} or {@link FieldJson | Field}
+ * @returns `true` if `item` is a form check box group, `false` otherwise
+ */
+const isDateField = function (item) {
+    const fieldType = (item === null || item === void 0 ? void 0 : item.fieldType) || (0, SchemaUtils_1.defaultFieldTypes)(item);
+    return (fieldType === 'text-input' && (item === null || item === void 0 ? void 0 : item.format) === 'date') || fieldType === 'date-input';
+};
+exports.isDateField = isDateField;
 /**
  * Clones an object completely including any nested objects or arrays
  * @param obj
+ * @param idGenerator
  * @private
  */
-function deepClone(obj) {
+function deepClone(obj, idGenerator) {
     let result;
     if (obj instanceof Array) {
         result = [];
-        result = obj.map(x => deepClone(x));
+        result = obj.map(x => deepClone(x, idGenerator));
     }
     else if (typeof obj === 'object' && obj !== null) {
         result = {};
         Object.entries(obj).forEach(([key, value]) => {
-            result[key] = deepClone(value);
+            result[key] = deepClone(value, idGenerator);
         });
     }
     else {
         result = obj;
     }
+    //if idGenerator is specified, and id exists in the object
+    if (idGenerator && result && result.id) {
+        result.id = idGenerator();
+    }
     return result;
 }
 exports.deepClone = deepClone;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aemforms/af-core",
-  "version": "0.22.4",
+  "version": "0.22.8",
   "description": "Core Module for Forms Runtime",
   "author": "Adobe Systems",
   "license": "Adobe Proprietary",
@@ -34,10 +34,11 @@
     "docs": "npx typedoc --options .typedoc.cjs"
   },
   "dependencies": {
-    "@adobe/json-formula": "git+https://git@github.com/adobe/json-formula.git#e246367c091948140db6f581806114ee482dcd1a"
+    "@adobe/json-formula": "^0.1.44",
+    "@aemforms/af-formatters": "^0.22.8"
   },
   "devDependencies": {
-    "@types/jest": "26.0.24",
+    "@types/jest": "^27.5.1",
     "@types/lodash": "^4.14.171",
     "@typescript-eslint/eslint-plugin": "^4.28.2",
     "@typescript-eslint/parser": "^4.28.2",
@@ -48,11 +49,11 @@
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^5.1.0",
     "form-data": "^4.0.0",
-    "jest": "26.6.0",
+    "jest": "^27.5.1",
     "jest-junit": "^12.2.0",
     "nock": "^13.1.3",
     "node-fetch": "^2.6.1",
-    "ts-jest": "26.5.6",
+    "ts-jest": "^27.1.4",
     "typedoc": "0.22.11",
     "typedoc-plugin-markdown": "3.11.13",
     "typescript": "^4.3.5"