@aemforms/af-core 0.15.0

package/lib/utils/TranslationUtils.js

@@ -0,0 +1,156 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTranslationObject = exports.createTranslationObj = exports.addTranslationId = exports.invalidateTranslation = exports.CUSTOM_PROPS_KEY = exports.TRANSLATION_ID = exports.TRANSLATION_TOKEN = void 0;
+/**
+ * Defines generic utilities to translated form model definition
+ */
+// todo: The API's defined in this file could move to a different package later on
+const types_1 = require("../types");
+/** Token used while creating translation specific properties from `adaptive form specification` */
+exports.TRANSLATION_TOKEN = '##';
+/** Name of the object which holds all translation specific properties */
+exports.TRANSLATION_ID = 'afs:translationIds';
+exports.CUSTOM_PROPS_KEY = 'properties';
+const defaultBcp47LangTags = [
+    'de-DE',
+    'en-US',
+    'es-ES',
+    'fr-FR',
+    'it-IT',
+    'ja-JP',
+    'ko-KR',
+    'pt-BR',
+    'zh-CN',
+    'zh-TW'
+];
+/**
+ * @private
+ */
+const invalidateTranslation = (input, updates) => {
+    types_1.translationProps.forEach((prop) => {
+        var _a, _b, _c, _d;
+        if (prop in updates && ((_b = (_a = input === null || input === void 0 ? void 0 : input[exports.CUSTOM_PROPS_KEY]) === null || _a === void 0 ? void 0 : _a[exports.TRANSLATION_ID]) === null || _b === void 0 ? void 0 : _b[prop])) {
+            (_d = (_c = input === null || input === void 0 ? void 0 : input[exports.CUSTOM_PROPS_KEY]) === null || _c === void 0 ? void 0 : _c[exports.TRANSLATION_ID]) === null || _d === void 0 ? true : delete _d[prop];
+        }
+    });
+};
+exports.invalidateTranslation = invalidateTranslation;
+/**
+ * @private
+ */
+const addTranslationId = (input, additionalTranslationProps = []) => {
+    // don't create a schema copy, add it to the existing
+    const model = input;
+    const transProps = [...types_1.translationProps, ...additionalTranslationProps];
+    _createTranslationId(model, '', transProps);
+    return model;
+};
+exports.addTranslationId = addTranslationId;
+/**
+ * @private
+ */
+const _createTranslationId = (input, path, transProps) => {
+    Object.entries(input).forEach(([key, value]) => {
+        if (typeof value == 'object') {
+            _createTranslationId(value, ((key === 'items') ? path : `${path === '' ? path : path + exports.TRANSLATION_TOKEN}${key}${exports.TRANSLATION_TOKEN}${Math.floor(Math.random() * 10000) + 1}`), transProps);
+        }
+        else {
+            // set it only if either of type or fieldType properties is present
+            if ('type' in input ||
+                'fieldType' in input) {
+                for (const transProp of transProps) {
+                    // if property exist add it
+                    if (input[transProp] != null) {
+                        // if translation id is not yet set, set it
+                        if (!(exports.CUSTOM_PROPS_KEY in input)) {
+                            input[exports.CUSTOM_PROPS_KEY] = {};
+                        }
+                        if (!(exports.TRANSLATION_ID in input[exports.CUSTOM_PROPS_KEY])) {
+                            input[exports.CUSTOM_PROPS_KEY][exports.TRANSLATION_ID] = {};
+                        }
+                        // if transprop is not yet set, set it
+                        // this is done to prevent overwrite
+                        if (!(transProp in input[exports.CUSTOM_PROPS_KEY][exports.TRANSLATION_ID])) {
+                            input[exports.CUSTOM_PROPS_KEY][exports.TRANSLATION_ID][transProp] = `${path}${exports.TRANSLATION_TOKEN}${transProp}${exports.TRANSLATION_TOKEN}${Math.floor(Math.random() * 10000) + 1}`;
+                        }
+                    }
+                }
+            }
+        }
+    });
+};
+/**
+ * @param input
+ * @param translationObj
+ * @param translationProps
+ * @private
+ */
+const _createTranslationObj = (input, translationObj, translationProps) => {
+    Object.values(input).forEach((value) => {
+        var _a, _b;
+        if (typeof value == 'object') {
+            _createTranslationObj(value, translationObj, translationProps);
+        }
+        else {
+            for (const translationProp of translationProps) {
+                if (translationProp in input && ((_b = (_a = input === null || input === void 0 ? void 0 : input[exports.CUSTOM_PROPS_KEY]) === null || _a === void 0 ? void 0 : _a[exports.TRANSLATION_ID]) === null || _b === void 0 ? void 0 : _b[translationProp])) {
+                    // todo: right now we create only for english
+                    if (input[translationProp] instanceof Array) {
+                        input[translationProp].forEach((item, index) => {
+                            if (typeof item === 'string') { // only if string, then convert, since values can also be boolean
+                                // @ts-ignore
+                                translationObj[`${input[exports.CUSTOM_PROPS_KEY][exports.TRANSLATION_ID][translationProp]}${exports.TRANSLATION_TOKEN}${index}`] = item;
+                            }
+                        });
+                    }
+                    else {
+                        // @ts-ignore
+                        translationObj[`${input[exports.CUSTOM_PROPS_KEY][exports.TRANSLATION_ID][translationProp]}`] = input[translationProp];
+                    }
+                }
+            }
+        }
+    });
+};
+/**
+ * @param input
+ * @param additionalTranslationProps
+ * @private
+ */
+const createTranslationObj = (input, additionalTranslationProps = []) => {
+    const obj = {};
+    const transProps = [...types_1.translationProps, ...additionalTranslationProps];
+    _createTranslationObj(input, obj, transProps);
+    return obj;
+};
+exports.createTranslationObj = createTranslationObj;
+/**
+ * Creates translation object with [BCP 47](https://tools.ietf.org/search/bcp47) language tags as key and value is a translation object. Key of translation object is
+ * generated based on the form hierarchy and it is separated by "##" token to signify that the id is machine generated (ie its not a human generated string)
+ * @param input             form model definition
+ * @param additionalTranslationProps    optional properties which needs to be translated, by default, only OOTB properties of form model definition is translated
+ * @param bcp47LangTags     optional additional language tags
+ * @returns translation object for each bcp 47 language tag
+ */
+const createTranslationObject = (input, additionalTranslationProps = [], bcp47LangTags = []) => {
+    const transProps = [...types_1.translationProps, ...additionalTranslationProps];
+    // create a copy of the input
+    const inputCopy = JSON.parse(JSON.stringify(input));
+    const obj = (0, exports.createTranslationObj)((0, exports.addTranslationId)(inputCopy), transProps);
+    const langTags = [...defaultBcp47LangTags, ...bcp47LangTags];
+    const allLangs = {};
+    for (const langTag of langTags) {
+        // todo: added temporarily to test
+        // todo: need to fix this as per machine translation
+        allLangs[langTag] = JSON.parse(JSON.stringify(obj));
+    }
+    return [inputCopy, allLangs];
+};
+exports.createTranslationObject = createTranslationObject;

package/lib/utils/ValidationUtils.d.ts

@@ -0,0 +1,153 @@
+/** Validation result type **/
+declare type ValidationResult = {
+    valid: boolean;
+    value: any;
+};
+export declare const isDataUrl: (str: string) => boolean;
+export declare const ValidConstraints: {
+    date: string[];
+    string: string[];
+    number: string[];
+    array: string[];
+    file: string[];
+};
+/**
+ * Implementation of all constraints defined by `adaptive form specification`
+ */
+export declare const Constraints: {
+    /**
+     * Implementation of type constraint
+     * @param constraint    `type` property of the form object
+     * @param inputVal      value of the form object
+     * @return {@link ValidationResult | validation result}
+     */
+    type: (constraint: string, inputVal: any) => ValidationResult;
+    /**
+     * Implementation of format constraint
+     * @param constraint    `format` property of the form object
+     * @param input         value of the form object
+     * @return {@link ValidationResult | validation result}
+     */
+    format: (constraint: string, input: string) => {
+        valid: boolean;
+        value: string;
+    };
+    /**
+     * Implementation of minimum constraint
+     * @param constraint    `minimum` property of the form object
+     * @param value         value of the form object
+     * @return {@link ValidationResult | validation result}
+     */
+    minimum: (constraint: number, value: number) => {
+        valid: boolean;
+        value: number;
+    };
+    /**
+     * Implementation of maximum constraint
+     * @param constraint    `maximum` property of the form object
+     * @param value         value of the form object
+     * @return {@link ValidationResult | validation result}
+     */
+    maximum: (constraint: number, value: number) => {
+        valid: boolean;
+        value: number;
+    };
+    /**
+     * Implementation of exclusiveMinimum constraint
+     * @param constraint    `minimum` property of the form object
+     * @param value         value of the form object
+     * @return {@link ValidationResult | validation result}
+     */
+    exclusiveMinimum: (constraint: number, value: number) => {
+        valid: boolean;
+        value: number;
+    };
+    /**
+     * Implementation of exclusiveMaximum constraint
+     * @param constraint    `maximum` property of the form object
+     * @param value         value of the form object
+     * @return {@link ValidationResult | validation result}
+     */
+    exclusiveMaximum: (constraint: number, value: number) => {
+        valid: boolean;
+        value: number;
+    };
+    /**
+     * Implementation of the minItems constraint
+     * @param constraint `minItems` constraint from object
+     * @param value value of the form object
+     */
+    minItems: <T>(constraint: number, value: T[]) => {
+        valid: boolean;
+        value: T[];
+    };
+    /**
+     * Implementation of the maxItems constraint
+     * @param constraint `maxItems` constraint from object
+     * @param value value of the form object
+     */
+    maxItems: <T_1>(constraint: number, value: T_1[]) => {
+        valid: boolean;
+        value: T_1[];
+    };
+    /**
+     * Implementation of the uniqueItems constraint
+     * @param constraint `uniqueItems` constraint from object
+     * @param value value of the form object
+     */
+    uniqueItems: <T_2>(constraint: boolean, value: T_2[]) => {
+        valid: boolean;
+        value: T_2[];
+    };
+    /**
+     * Implementation of minLength constraint
+     * @param constraint    `minLength` property of the form object
+     * @param value         value of the form object
+     * @return {@link ValidationResult | validation result}
+     */
+    minLength: (constraint: number, value: string) => {
+        value: string;
+        valid: boolean;
+    };
+    /**
+     * Implementation of maxLength constraint
+     * @param constraint    `maxLength` property of the form object
+     * @param value         value of the form object
+     * @return {@link ValidationResult | validation result}
+     */
+    maxLength: (constraint: number, value: string) => {
+        value: string;
+        valid: boolean;
+    };
+    /**
+     * Implementation of pattern constraint
+     * @param constraint    `pattern` property of the form object
+     * @param value         value of the form object
+     * @return {@link ValidationResult | validation result}
+     */
+    pattern: (constraint: RegExp | string, value: string) => {
+        valid: boolean;
+        value: string;
+    };
+    /**
+     * Implementation of required constraint
+     * @param constraint    `required` property of the form object
+     * @param value         value of the form object
+     * @return {@link ValidationResult | validation result}
+     */
+    required: (constraint: boolean, value: any) => {
+        valid: boolean;
+        value: any;
+    };
+    /**
+     * Implementation of enum constraint
+     * @param constraint    `enum` property of the form object
+     * @param value         value of the form object
+     * @return {@link ValidationResult | validation result}
+     */
+    enum: (constraint: any[], value: any) => {
+        valid: boolean;
+        value: any;
+    };
+};
+export {};

package/lib/utils/ValidationUtils.js

@@ -0,0 +1,339 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Constraints = exports.ValidConstraints = exports.isDataUrl = void 0;
+/**
+ * Defines generic utilities to validate form runtime model based on the constraints defined
+ * as per `adaptive form specification`
+ */
+// issue with import
+//import {FieldJson, isFileObject} from '../types';
+const dateRegex = /^(\d{4})-(\d{1,2})-(\d{1,2})$/;
+const dataUrlRegex = /^data:([a-z]+\/[a-z0-9-+.]+)?;(?:name=(.*);)?base64,(.*)$/;
+const days = [31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31];
+const daysInMonth = (leapYear, month) => {
+    if (leapYear && month == 2) {
+        return 29;
+    }
+    return days[month - 1];
+};
+const isLeapYear = (year) => {
+    return year % 400 === 0 || year % 4 === 0 && year % 100 !== 0;
+};
+const isDataUrl = (str) => {
+    return dataUrlRegex.exec(str.trim()) != null;
+};
+exports.isDataUrl = isDataUrl;
+/**
+ * Checks whether inputVal is valid number value or not
+ *
+ * ```
+ * const x = checkNumber('12')
+ * ```
+ * would return
+ * ```
+ * {
+ *     value : 12,
+ *     valid : true
+ * }
+ * ```
+ * @param inputVal input value
+ * @returns {@link ValidationResult | Validation result}
+ */
+const checkNumber = (inputVal) => {
+    let value = parseFloat(inputVal);
+    const valid = !isNaN(value);
+    if (!valid) {
+        value = inputVal;
+    }
+    return {
+        value, valid
+    };
+};
+/**
+ * Wraps a non-null value and not an array value into an array
+ * @param inputVal input value
+ * @returns wraps the input value into an array
+ */
+const toArray = (inputVal) => {
+    if (inputVal != null && !(inputVal instanceof Array)) {
+        return [inputVal];
+    }
+    return inputVal;
+};
+/**
+ * Checks whether inputVal is valid boolean value or not
+ *
+ * ```
+ * const x = checkBool('false')
+ * ```
+ * would return
+ * ```
+ * {
+ *     value : false,
+ *     valid : true
+ * }
+ * ```
+ * @param inputVal input value
+ * @returns {@link ValidationResult | Validation result}
+ */
+const checkBool = (inputVal) => {
+    const valid = typeof inputVal === 'boolean' || inputVal === 'true' || inputVal === 'false';
+    const value = typeof inputVal === 'boolean' ? inputVal : (valid ? inputVal === 'true' : inputVal);
+    return { valid, value };
+};
+/**
+ * Validates an array of values using a validator function.
+ * @param inputVal
+ * @param validatorFn
+ * @return an array containing two arrays, the first one with all the valid values and the second one with one invalid
+ * value (if there is).
+ */
+const partitionArray = (inputVal, validatorFn) => {
+    const value = toArray(inputVal);
+    if (value == null) {
+        return [[], [value]];
+    }
+    return value.reduce((acc, x) => {
+        if (acc[1].length == 0) {
+            const r = validatorFn(x);
+            const index = r.valid ? 0 : 1;
+            acc[index].push(r.value);
+        }
+        return acc;
+    }, [[], []]);
+};
+exports.ValidConstraints = {
+    date: ['minimum', 'maximum', 'exclusiveMinimum', 'exclusiveMaximum', 'format'],
+    string: ['minLength', 'maxLength', 'pattern'],
+    number: ['minimum', 'maximum', 'exclusiveMinimum', 'exclusiveMaximum'],
+    array: ['minItems', 'maxItems', 'uniqueItems'],
+    file: ['accept', 'maxFileSize']
+};
+/**
+ * Implementation of all constraints defined by `adaptive form specification`
+ */
+exports.Constraints = {
+    /**
+     * Implementation of type constraint
+     * @param constraint    `type` property of the form object
+     * @param inputVal      value of the form object
+     * @return {@link ValidationResult | validation result}
+     */
+    type: (constraint, inputVal) => {
+        let value = inputVal;
+        if (inputVal == undefined) {
+            return {
+                valid: true,
+                value: inputVal
+            };
+        }
+        let valid = true, res;
+        switch (constraint) {
+            case 'string':
+                valid = true;
+                value = inputVal.toString();
+                break;
+            case 'string[]':
+                value = toArray(inputVal);
+                break;
+            case 'number':
+                res = checkNumber(inputVal);
+                value = res.value;
+                valid = res.valid;
+                break;
+            case 'boolean':
+                res = checkBool(inputVal);
+                valid = res.valid;
+                value = res.value;
+                break;
+            case 'integer':
+                value = parseFloat(inputVal);
+                valid = !isNaN(value) && Math.round(value) === value;
+                if (!valid) {
+                    value = inputVal;
+                }
+                break;
+            case 'file' || 'file[]':
+                valid = true;
+                //valid = isFileObject(value);
+                if (!valid) {
+                    value = inputVal;
+                }
+                break;
+            case 'number[]':
+                res = partitionArray(inputVal, checkNumber);
+                valid = res[1].length === 0;
+                value = valid ? res[0] : inputVal;
+                break;
+            case 'boolean[]':
+                res = partitionArray(inputVal, checkBool);
+                valid = res[1].length === 0;
+                value = valid ? res[0] : inputVal;
+                break;
+        }
+        return {
+            valid,
+            value
+        };
+    },
+    /**
+     * Implementation of format constraint
+     * @param constraint    `format` property of the form object
+     * @param input         value of the form object
+     * @return {@link ValidationResult | validation result}
+     */
+    format: (constraint, input) => {
+        let valid = true;
+        const value = input;
+        let res;
+        switch (constraint) {
+            case 'date':
+                res = dateRegex.exec(input.trim());
+                if (res != null) {
+                    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+                    const [match, year, month, date] = res;
+                    const [nMonth, nDate] = [+month, +date];
+                    const leapYear = isLeapYear(+year);
+                    valid = (nMonth >= 1 && nMonth <= 12) &&
+                        (nDate >= 1 && nDate <= daysInMonth(leapYear, nMonth));
+                }
+                else {
+                    valid = false;
+                }
+                break;
+            case 'data-url':
+                // todo: input is of type file, do we need this format ? since value is always of type file object
+                //res = dataUrlRegex.exec(input.trim());
+                //valid = res != null;
+                valid = true;
+                break;
+        }
+        return { valid, value };
+    },
+    //todo : add support for date
+    /**
+     * Implementation of minimum constraint
+     * @param constraint    `minimum` property of the form object
+     * @param value         value of the form object
+     * @return {@link ValidationResult | validation result}
+     */
+    minimum: (constraint, value) => {
+        return { valid: value >= constraint, value };
+    },
+    //todo : add support for date
+    /**
+     * Implementation of maximum constraint
+     * @param constraint    `maximum` property of the form object
+     * @param value         value of the form object
+     * @return {@link ValidationResult | validation result}
+     */
+    maximum: (constraint, value) => {
+        return { valid: value <= constraint, value };
+    },
+    /**
+     * Implementation of exclusiveMinimum constraint
+     * @param constraint    `minimum` property of the form object
+     * @param value         value of the form object
+     * @return {@link ValidationResult | validation result}
+     */
+    exclusiveMinimum: (constraint, value) => {
+        return { valid: value > constraint, value };
+    },
+    //todo : add support for date
+    /**
+     * Implementation of exclusiveMaximum constraint
+     * @param constraint    `maximum` property of the form object
+     * @param value         value of the form object
+     * @return {@link ValidationResult | validation result}
+     */
+    exclusiveMaximum: (constraint, value) => {
+        return { valid: value < constraint, value };
+    },
+    /**
+     * Implementation of the minItems constraint
+     * @param constraint `minItems` constraint from object
+     * @param value value of the form object
+     */
+    minItems: (constraint, value) => {
+        return { valid: (value instanceof Array) && value.length >= constraint, value };
+    },
+    /**
+     * Implementation of the maxItems constraint
+     * @param constraint `maxItems` constraint from object
+     * @param value value of the form object
+     */
+    maxItems: (constraint, value) => {
+        return { valid: (value instanceof Array) && value.length <= constraint, value };
+    },
+    /**
+     * Implementation of the uniqueItems constraint
+     * @param constraint `uniqueItems` constraint from object
+     * @param value value of the form object
+     */
+    uniqueItems: (constraint, value) => {
+        return { valid: !constraint || ((value instanceof Array) && value.length === new Set(value).size), value };
+    },
+    /**
+     * Implementation of minLength constraint
+     * @param constraint    `minLength` property of the form object
+     * @param value         value of the form object
+     * @return {@link ValidationResult | validation result}
+     */
+    minLength: (constraint, value) => {
+        return Object.assign(Object.assign({}, exports.Constraints.minimum(constraint, typeof value === 'string' ? value.length : 0)), { value });
+    },
+    /**
+     * Implementation of maxLength constraint
+     * @param constraint    `maxLength` property of the form object
+     * @param value         value of the form object
+     * @return {@link ValidationResult | validation result}
+     */
+    maxLength: (constraint, value) => {
+        return Object.assign(Object.assign({}, exports.Constraints.maximum(constraint, typeof value === 'string' ? value.length : 0)), { value });
+    },
+    /**
+     * Implementation of pattern constraint
+     * @param constraint    `pattern` property of the form object
+     * @param value         value of the form object
+     * @return {@link ValidationResult | validation result}
+     */
+    pattern: (constraint, value) => {
+        let regex;
+        if (typeof constraint === 'string') {
+            regex = new RegExp(constraint);
+        }
+        else {
+            regex = constraint;
+        }
+        return { valid: regex.test(value), value };
+    },
+    /**
+     * Implementation of required constraint
+     * @param constraint    `required` property of the form object
+     * @param value         value of the form object
+     * @return {@link ValidationResult | validation result}
+     */
+    required: (constraint, value) => {
+        const valid = constraint ? value != null && value !== '' : true;
+        return { valid, value };
+    },
+    /**
+     * Implementation of enum constraint
+     * @param constraint    `enum` property of the form object
+     * @param value         value of the form object
+     * @return {@link ValidationResult | validation result}
+     */
+    enum: (constraint, value) => {
+        return {
+            valid: constraint.indexOf(value) > -1,
+            value
+        };
+    }
+};