@aemforms/af-core 0.22.17 → 0.22.19

package/lib/data/DataValue.d.ts

@@ -9,7 +9,7 @@ export default class DataValue {
     private $_name;
     private $_value;
     private $_type;
-    private $_fields;
+    $_fields: Array<FieldModel>;
     constructor($_name: string | number, $_value: any, $_type?: string);
     valueOf(): any;
     get $name(): string | number;

package/lib/data/DataValue.js

@@ -24,6 +24,10 @@ class DataValue {
         return this.$_name;
     }
     get $value() {
+        const enabled = this.$_fields.find(x => x.enabled !== false);
+        if (!enabled && this.$_fields.length) {
+            return undefined;
+        }
         return this.$_value;
     }
     setValue(typedValue, originalValue, fromField) {

package/lib/rules/FunctionRuntime.js

@@ -191,6 +191,12 @@ const createAction = (name, payload = {}) => {
             return new Controller_1.AddItem(payload);
         case 'removeItem':
             return new Controller_1.RemoveItem(payload);
+        case 'reset':
+            return new Controller_1.Reset(payload);
+        case 'addInstance':
+            return new Controller_1.AddInstance(payload);
+        case 'removeInstance':
+            return new Controller_1.RemoveInstance(payload);
         default:
             console.error('invalid action');
     }

package/lib/types/Json.d.ts

@@ -29,6 +29,8 @@ export declare type ConstraintsJson = TranslationConstraintsJson & {
     maxLength?: number;
     maximum?: number;
     maxItems?: number;
+    minOccur?: number;
+    maxOccur?: number;
     minLength?: number;
     minimum?: number;
     minItems?: number;
@@ -82,6 +84,10 @@ export declare type BaseJson = TranslationBaseJson & RulesJson & ConstraintsJson
     properties?: {
         [key: string]: any;
     };
+    repeatable?: boolean;
+    screenReaderText?: string;
+    tooltip?: string;
+    altText?: string;
 };
 /** Type for `form field properties`which can be translated based on `adaptive form specification` */
 declare type TranslationFieldJson = {

package/lib/types/Model.d.ts

@@ -37,16 +37,17 @@ interface WithState<T> {
     /**
      * {@link State | state} of the form object
      */
-    getState: () => State<T>;
+    getState: () => any;
 }
-/** Generic type for a form object state */
-export declare type State<T> = T extends ContainerJson ? T & {
-    id: string;
-    items: Array<State<FieldJson | ContainerJson>>;
-} : T & {
+declare type stateProps = {
     id: string;
+    index: number;
     ':type': string;
 };
+/** Generic type for a form object state */
+export declare type State<T> = stateProps & (T extends ContainerJson ? T & {
+    items: Array<State<FieldJson | ContainerJson>>;
+} : T);
 /**
  * @private
  */
@@ -190,11 +191,19 @@ export interface BaseModel extends ConstraintsJson, WithController {
      * Default value of the Field.
      */
     readonly default?: any;
+    /**
+     * Field is repeatable or not
+     */
+    readonly repeatable?: boolean;
     /**
      * Validates the given form field
      * @returns list of {@link ValidationError | validation errors}
      */
     validate(): Array<ValidationError>;
+    /**
+     * Resets the form model
+     */
+    reset(): any;
     /**
      * Imports data to the form field
      *  @private
@@ -332,6 +341,12 @@ export interface FormModel extends ContainerModel, WithState<FormJson> {
      * @private
      */
     getEventQueue(): EventQueue;
+    /**
+     * visits each element in the form
+     * @param callBack a function which is invoked on each form element
+     * (including container type elements) visited
+     */
+    visit(callBack: (field: FieldModel | FieldsetModel) => void): void;
 }
 /**
  * Defines file object interface.
@@ -344,7 +359,7 @@ export interface IFileObject {
     /**
      * Media type of the file data
      */
-    type: string;
+    mediaType: string;
     /**
      * Data of the file attachment. It can be uri or any file interface specific to channel (in web, it is file object).
      */

package/lib/utils/Fetch.d.ts

@@ -1,3 +1,9 @@
+/**
+ *
+ * @param url
+ * @param data
+ * @param options
+ */
 export declare const request: (url: string, data?: any, options?: RequestOptions) => any;
 export declare type RequestOptions = {
     contentType?: string;
@@ -5,3 +11,4 @@ export declare type RequestOptions = {
     headers?: any;
     mode?: string;
 };
+export declare const convertQueryString: (endpoint: string, payload: string | null) => string;

package/lib/utils/Fetch.js

@@ -6,24 +6,82 @@
  *
  * 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 __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.request = void 0;
+exports.convertQueryString = exports.request = void 0;
+/**
+ *
+ * @param url
+ * @param data
+ * @param options
+ */
 const request = (url, data = null, options = {}) => {
     const opts = Object.assign(Object.assign({}, defaultRequestOptions), options);
-    return fetch(url, Object.assign(Object.assign({}, opts), { body: data })).then((response) => {
-        var _a;
+    const updatedUrl = opts.method === 'GET' && data ? (0, exports.convertQueryString)(url, data) : url;
+    if (opts.method !== 'GET') {
+        opts.body = data;
+    }
+    return fetch(updatedUrl, Object.assign({}, opts)).then((response) => __awaiter(void 0, void 0, void 0, function* () {
+        var _a, _b, _c;
+        let body;
         if (!response.ok) {
-            throw new Error(response.statusText);
-        }
-        if ((_a = response === null || response === void 0 ? void 0 : response.headers.get('Content-Type')) === null || _a === void 0 ? void 0 : _a.includes('application/json')) {
-            return response.json();
+            console.error(`Error fetching response from ${url} : ${response.statusText}`);
+            body = response.statusText;
         }
         else {
-            return response.text();
+            if ((_b = (_a = response === null || response === void 0 ? void 0 : response.headers) === null || _a === void 0 ? void 0 : _a.get('Content-Type')) === null || _b === void 0 ? void 0 : _b.includes('application/json')) {
+                body = yield response.json();
+            }
+            else {
+                body = yield response.text();
+            }
         }
-    });
+        const headers = {};
+        (_c = response === null || response === void 0 ? void 0 : response.headers) === null || _c === void 0 ? void 0 : _c.forEach((value, key) => {
+            headers[key] = value;
+        });
+        return {
+            status: response.status,
+            body,
+            headers
+        };
+    }));
 };
 exports.request = request;
 const defaultRequestOptions = {
     method: 'GET'
 };
+const convertQueryString = (endpoint, payload) => {
+    if (!payload) {
+        return endpoint;
+    }
+    let updatedPayload = {};
+    try {
+        updatedPayload = JSON.parse(payload);
+    }
+    catch (err) {
+        console.log('Query params invalid');
+    }
+    const params = [];
+    Object.keys(updatedPayload).forEach((key) => {
+        if (Array.isArray(updatedPayload[key])) {
+            params.push(`${encodeURIComponent(key)}=${encodeURIComponent(JSON.stringify(updatedPayload[key]))}`);
+        }
+        else {
+            params.push(`${encodeURIComponent(key)}=${encodeURIComponent(updatedPayload[key])}`);
+        }
+    });
+    if (!params.length) {
+        return endpoint;
+    }
+    return endpoint.includes('?') ? `${endpoint}&${params.join('&')}` : `${endpoint}?${params.join('&')}`;
+};
+exports.convertQueryString = convertQueryString;

package/lib/utils/FormCreationUtils.d.ts

@@ -0,0 +1,11 @@
+import { ContainerModel, FieldJson, FieldModel, FieldsetJson, FieldsetModel, FormModel } from '../types';
+/**
+ * Creates a child model inside the given parent
+ * @param child
+ * @param options
+ * @private
+ */
+export declare const createChild: (child: FieldsetJson | FieldJson, options: {
+    form: FormModel;
+    parent: ContainerModel;
+}, repeatableInstance?: boolean) => FieldModel | FieldsetModel;

package/lib/utils/FormCreationUtils.js

@@ -0,0 +1,83 @@
+"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 __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createChild = void 0;
+const InstanceManager_1 = require("../InstanceManager");
+const Fieldset_1 = require("../Fieldset");
+const JsonUtils_1 = require("./JsonUtils");
+const FileUpload_1 = __importDefault(require("../FileUpload"));
+const Checkbox_1 = __importDefault(require("../Checkbox"));
+const CheckboxGroup_1 = __importDefault(require("../CheckboxGroup"));
+const DateField_1 = __importDefault(require("../DateField"));
+const Field_1 = __importDefault(require("../Field"));
+/**
+ * Creates a child model inside the given parent
+ * @param child
+ * @param options
+ * @private
+ */
+const createChild = (child, options, repeatableInstance = false) => {
+    let retVal;
+    // if repeatable is set
+    if ((0, JsonUtils_1.isRepeatable)(child) && !repeatableInstance) {
+        const childItemsWithMinAndMaxOccur = Object.assign(Object.assign({}, child), ('items' in child && { 'type': 'object' }));
+        // remove minOccur and maxOccur from child items
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        const { minOccur, maxOccur } = childItemsWithMinAndMaxOccur, childItems = __rest(childItemsWithMinAndMaxOccur, ["minOccur", "maxOccur"]);
+        const newJson = Object.assign({
+            minItems: child.minOccur || 0,
+            maxItems: child.maxOccur || -1,
+            fieldType: child.fieldType,
+            type: 'array',
+            name: child.name,
+            dataRef: child.dataRef // can't destructure entire child here
+        }, {
+            'items': [childItems]
+        });
+        retVal = new InstanceManager_1.InstanceManager(newJson, options);
+    }
+    else if ('items' in child) {
+        retVal = new Fieldset_1.Fieldset(child, options);
+    }
+    else {
+        if ((0, JsonUtils_1.isFile)(child) || child.fieldType === 'file-input') {
+            // @ts-ignore
+            retVal = new FileUpload_1.default(child, options);
+        }
+        else if ((0, JsonUtils_1.isCheckbox)(child)) {
+            retVal = new Checkbox_1.default(child, options);
+        }
+        else if ((0, JsonUtils_1.isCheckboxGroup)(child)) {
+            retVal = new CheckboxGroup_1.default(child, options);
+        }
+        else if ((0, JsonUtils_1.isDateField)(child)) {
+            retVal = new DateField_1.default(child, options);
+        }
+        else {
+            retVal = new Field_1.default(child, options);
+        }
+    }
+    options.form.fieldAdded(retVal);
+    return retVal;
+};
+exports.createChild = createChild;

package/lib/utils/FormUtils.js

@@ -150,7 +150,7 @@ const extractFileInfo = (file) => {
             // case: file object
             retVal = {
                 name: file.name,
-                type: file.type,
+                mediaType: file.type,
                 size: file.size,
                 data: file
             };
@@ -162,7 +162,7 @@ const extractFileInfo = (file) => {
                 const { blob, name } = result;
                 retVal = {
                     name: name,
-                    type: blob.type,
+                    mediaType: blob.type,
                     size: blob.size,
                     data: blob
                 };
@@ -174,6 +174,9 @@ const extractFileInfo = (file) => {
             try {
                 jFile = JSON.parse(file);
                 retVal = jFile;
+                if (!retVal.mediaType) {
+                    retVal.mediaType = retVal.type;
+                }
             }
             catch (ex) {
                 // do nothing
@@ -185,7 +188,7 @@ const extractFileInfo = (file) => {
                     const blob = result.blob;
                     retVal = {
                         name: jFile === null || jFile === void 0 ? void 0 : jFile.name,
-                        type: jFile === null || jFile === void 0 ? void 0 : jFile.type,
+                        mediaType: (jFile === null || jFile === void 0 ? void 0 : jFile.type) || (jFile === null || jFile === void 0 ? void 0 : jFile.mediaType),
                         size: blob.size,
                         data: blob
                     };
@@ -196,7 +199,7 @@ const extractFileInfo = (file) => {
                 const fileName = jFile.split('/').pop();
                 retVal = {
                     name: fileName,
-                    type: 'application/octet-stream',
+                    mediaType: 'application/octet-stream',
                     size: 0,
                     data: jFile
                 };
@@ -205,7 +208,7 @@ const extractFileInfo = (file) => {
                 // todo: just added for ease of integration for the view layer
                 retVal = {
                     name: jFile === null || jFile === void 0 ? void 0 : jFile.name,
-                    type: jFile === null || jFile === void 0 ? void 0 : jFile.type,
+                    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
                 };

package/lib/utils/JsonUtils.d.ts

@@ -60,3 +60,4 @@ export declare function checkIfKeyAdded(currentObj: any, prevObj: any, objKey: s
  * @return json string
  */
 export declare const jsonString: (obj: any) => string;
+export declare const isRepeatable: (obj: FieldsetJson | FieldJson) => boolean;

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.isDateField = exports.isCheckboxGroup = exports.isCheckbox = exports.checkIfConstraintsArePresent = exports.isFile = exports.getProperty = void 0;
+exports.isRepeatable = 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
  */
@@ -141,3 +141,17 @@ const jsonString = (obj) => {
     return JSON.stringify(obj, null, 2);
 };
 exports.jsonString = jsonString;
+const isRepeatable = (obj) => {
+    return ((obj.repeatable &&
+        // case0: both are undefined
+        ((obj.minOccur === undefined && obj.maxOccur === undefined) ||
+            // case1: if minOccur is specified and maxOccur specified is not equal to zero, then it is repeatable
+            (obj.minOccur !== undefined && obj.maxOccur !== undefined && obj.maxOccur !== 0) ||
+            // case2: if both specified and both equal to zero, then it is not repeatable
+            (obj.minOccur !== undefined && obj.maxOccur !== undefined && obj.minOccur !== 0 && obj.maxOccur !== 0) ||
+            // case3: only if minOccur is specified, then it should be greater than zero for repeatable
+            (obj.minOccur !== undefined && obj.minOccur >= 0) ||
+            // case4: only if maxOccur is specified, then it should be non-zero for repeatable
+            (obj.maxOccur !== undefined && obj.maxOccur !== 0))) || false);
+};
+exports.isRepeatable = isRepeatable;

package/lib/utils/ValidationUtils.js

@@ -49,6 +49,11 @@ exports.isDataUrl = isDataUrl;
  * @returns {@link ValidationResult | Validation result}
  */
 const checkNumber = (inputVal) => {
+    if (inputVal === '' || inputVal == null) {
+        return {
+            value: '', valid: true
+        };
+    }
     let value = parseFloat(inputVal);
     const valid = !isNaN(value);
     if (!valid) {
@@ -58,7 +63,16 @@ const checkNumber = (inputVal) => {
         value, valid
     };
 };
+/**
+ *
+ * @param inputVal
+ */
 const checkInteger = (inputVal) => {
+    if (inputVal == '' || inputVal == null) {
+        return {
+            value: '', valid: true
+        };
+    }
     let value = parseFloat(inputVal);
     const valid = !isNaN(value) && Math.round(value) === value;
     if (!valid) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aemforms/af-core",
-  "version": "0.22.17",
+  "version": "0.22.19",
   "description": "Core Module for Forms Runtime",
   "author": "Adobe Systems",
   "license": "Adobe Proprietary",
@@ -35,7 +35,7 @@
   },
   "dependencies": {
     "@adobe/json-formula": "^0.1.44",
-    "@aemforms/af-formatters": "^0.22.17"
+    "@aemforms/af-formatters": "^0.22.19"
   },
   "devDependencies": {
     "@types/jest": "^27.5.1",