@aemforms/af-core 0.22.16 → 0.22.18

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;

package/lib/Scriptable.js

@@ -18,12 +18,12 @@ class Scriptable extends BaseNode_1.BaseNode {
         this._events = {};
         this._rules = {};
     }
-    get rules() {
-        return this._jsonModel.rules || {};
+    getRules() {
+        return typeof this._jsonModel.rules !== 'object' ? {} : this._jsonModel.rules;
     }
     getCompiledRule(eName, rule) {
         if (!(eName in this._rules)) {
-            const eString = rule || this.rules[eName];
+            const eString = rule || this.getRules()[eName];
             if (typeof eString === 'string' && eString.length > 0) {
                 try {
                     this._rules[eName] = this.ruleEngine.compileRule(eString);
@@ -76,7 +76,7 @@ class Scriptable extends BaseNode_1.BaseNode {
         });
     }
     executeAllRules(context) {
-        const entries = Object.entries(this.rules);
+        const entries = Object.entries(this.getRules());
         if (entries.length > 0) {
             const scope = this.getExpressionScope();
             entries.forEach(([prop, rule]) => {

package/lib/controller/Controller.d.ts

@@ -57,6 +57,7 @@ export declare class Change extends ActionImpl {
      * @param [dispatch] true to trigger the event on all the fields in DFS order starting from the top level form element, false otherwise
      */
     constructor(payload: ChangePayload, dispatch?: boolean);
+    withAdditionalChange(change: Change): Change;
 }
 /**
  * Implementation of `invalid` event. The invalid event is triggered when a Field’s value becomes invalid after a change event or whenever its value property change

package/lib/controller/Controller.js

@@ -60,6 +60,9 @@ class Change extends ActionImpl {
     constructor(payload, dispatch = false) {
         super(payload, 'change', { dispatch });
     }
+    withAdditionalChange(change) {
+        return new Change(this.payload.changes.concat(change.payload.changes), this.metadata);
+    }
 }
 exports.Change = Change;
 /**

package/lib/controller/EventQueue.d.ts

@@ -3,7 +3,7 @@
  */
 import { Action, BaseJson } from '../types';
 import { BaseNode } from '../BaseNode';
-import { Logger } from '../Form';
+import { Logger } from './Logger';
 /**
  * Implementation of event queue. When a user event, like change or click, is captured the expression to be evaluated
  * must be put in an Event Queue and then evaluated.

package/lib/controller/EventQueue.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 });
-const Form_1 = require("../Form");
+const Logger_1 = require("./Logger");
 /**
  * Implementation of event node
  * @private
@@ -39,7 +39,7 @@ class EventNode {
  * @private
  */
 class EventQueue {
-    constructor(logger = new Form_1.Logger('off')) {
+    constructor(logger = new Logger_1.Logger('off')) {
         this.logger = logger;
         this._isProcessing = false;
         this._pendingEvents = [];

package/lib/controller/Logger.d.ts

@@ -0,0 +1,17 @@
+export declare type LogFunction = 'info' | 'warn' | 'error' | 'debug';
+/**
+ * Logging levels.
+ */
+export declare type LogLevel = 'off' | LogFunction;
+/**
+ * @private
+ */
+export declare class Logger {
+    debug(msg: string): void;
+    info(msg: string): void;
+    warn(msg: string): void;
+    error(msg: string): void;
+    log(msg: string, level: LogFunction): void;
+    private logLevel;
+    constructor(logLevel?: LogLevel);
+}

package/lib/controller/Logger.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Logger = void 0;
+const levels = {
+    off: 0,
+    debug: 1,
+    info: 2,
+    warn: 3,
+    error: 4
+};
+/**
+ * @private
+ */
+class Logger {
+    constructor(logLevel = 'off') {
+        this.logLevel = levels[logLevel];
+    }
+    debug(msg) {
+        this.log(msg, 'debug');
+    }
+    info(msg) {
+        this.log(msg, 'info');
+    }
+    warn(msg) {
+        this.log(msg, 'warn');
+    }
+    error(msg) {
+        this.log(msg, 'error');
+    }
+    log(msg, level) {
+        if (this.logLevel !== 0 && this.logLevel <= levels[level]) {
+            console[level](msg);
+        }
+    }
+}
+exports.Logger = Logger;

package/lib/data/DataValue.d.ts

@@ -14,7 +14,7 @@ export default class DataValue {
     valueOf(): any;
     get $name(): string | number;
     get $value(): any;
-    setValue(typedValue: any, originalValue: any): void;
+    setValue(typedValue: any, originalValue: any, fromField: FieldModel): void;
     get $type(): string;
     $bindToField(field: FieldModel): void;
     $convertToDataValue(): DataValue;

package/lib/data/DataValue.js

@@ -26,10 +26,12 @@ class DataValue {
     get $value() {
         return this.$_value;
     }
-    setValue(typedValue, originalValue) {
+    setValue(typedValue, originalValue, fromField) {
         this.$_value = typedValue;
         this.$_fields.forEach(x => {
-            x.value = originalValue;
+            if (fromField !== x) {
+                x.value = originalValue;
+            }
         });
     }
     get $type() {

package/lib/rules/FunctionRuntime.d.ts

@@ -32,6 +32,10 @@ declare class FunctionRuntimeImpl {
             _func: (args: Array<unknown>, data: unknown, interpreter: any) => any;
             _signature: never[];
         };
+        setFocus: {
+            _func: (args: Array<unknown>, data: unknown, interpreter: any) => void;
+            _signature: never[];
+        };
         getData: {
             _func: (args: unknown, data: unknown, interpreter: any) => any;
             _signature: never[];

package/lib/rules/FunctionRuntime.js

@@ -270,6 +270,19 @@ class FunctionRuntimeImpl {
                 },
                 _signature: []
             },
+            setFocus: {
+                _func: (args, data, interpreter) => {
+                    const element = args[0];
+                    try {
+                        const field = interpreter.globals.form.getElement(element.$id);
+                        interpreter.globals.form.setFocus(field);
+                    }
+                    catch (e) {
+                        interpreter.globals.form.logger.error('Invalid argument passed in setFocus. An element is expected');
+                    }
+                },
+                _signature: []
+            },
             getData: {
                 _func: (args, data, interpreter) => {
                     // deprecated. left for backward compatability.

package/lib/types/Json.d.ts

@@ -82,6 +82,9 @@ export declare type BaseJson = TranslationBaseJson & RulesJson & ConstraintsJson
     properties?: {
         [key: string]: any;
     };
+    screenReaderText?: string;
+    tooltip?: string;
+    altText?: string;
 };
 /** Type for `form field properties`which can be translated based on `adaptive form specification` */
 declare type TranslationFieldJson = {
@@ -103,6 +106,7 @@ export declare type FieldJson = BaseJson & TranslationFieldJson & {
 export declare type ContainerJson = BaseJson & {
     items: Array<FieldJson | ContainerJson>;
     initialItems?: number;
+    activeChild?: string;
 };
 /** Type for `form metadata` based on `adaptive form specification` */
 export declare type MetaDataJson = {

package/lib/types/Model.d.ts

@@ -5,7 +5,7 @@ import { ConstraintsJson, ContainerJson, FieldJson, FieldsetJson, FormJson, Labe
 import RuleEngine from '../rules/RuleEngine';
 import EventQueue from '../controller/EventQueue';
 import DataGroup from '../data/DataGroup';
-import { Logger } from '../Form';
+import { Logger } from '../controller/Logger';
 /**
  * Generic Scriptable field interface. All non-transparent fields which support rule/events
  * should implement this interface
@@ -39,14 +39,15 @@ interface WithState<T> {
      */
     getState: () => State<T>;
 }
-/** 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
  */
@@ -124,6 +125,10 @@ export interface BaseModel extends ConstraintsJson, WithController {
      * The index of the Field within its parent.
      */
     readonly index: number;
+    /**
+     *
+     */
+    readonly qualifiedName: string;
     /**
      * Label to be used for the field.
      */
@@ -276,6 +281,7 @@ export interface ContainerModel extends BaseModel, ScriptableField {
      */
     indexOf(f: FieldModel | FieldsetModel): number;
     isTransparent(): boolean;
+    activeChild: BaseModel | null;
 }
 /**
  * Generic field set model interface.

package/lib/utils/FormUtils.d.ts

@@ -1,5 +1,4 @@
 import { ContainerModel } from '../types';
-import { FileObject } from '../FileObject';
 /**
  * Utility to generate a random word from seed
  * @param l seed value
@@ -24,13 +23,6 @@ export declare const getAttachments: (input: ContainerModel) => any;
  * @returns file size as bytes (in kb) based on IEC specification
  */
 export declare const getFileSizeInBytes: (str: any) => number;
-/**
- * Converts number to bytes based on the symbol as per IEC specification
- * @param size      size as number
- * @param symbol    symbol to use (for example, kb, mb, gb or tb)
- * @returns number as bytes based on the symbol
- */
-export declare const sizeToBytes: (size: number, symbol: string) => number;
 /**
  * ID Generator
  * @param initial
@@ -40,16 +32,16 @@ export declare const sizeToBytes: (size: number, symbol: string) => number;
 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[]
+ * @param file
  * @returns list of {@link FileObject}
  */
-export declare const extractFileInfo: (files: string[] | string | File[]) => FileObject[];
+export declare const extractFileInfo: (file: any) => any;
 /**
  * Utility to convert data URI to a `blob` object
  * @param dataURI uri to convert to blob
  * @returns `Blob` object for the data URI
  */
 export declare const dataURItoBlob: (dataURI: string) => {
-    blob: Blob;
     name: string;
-};
+    blob: Blob;
+} | null;

package/lib/utils/FormUtils.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.dataURItoBlob = exports.extractFileInfo = exports.IdGenerator = exports.sizeToBytes = exports.getFileSizeInBytes = exports.getAttachments = exports.isEmpty = exports.randomWord = void 0;
+exports.dataURItoBlob = exports.extractFileInfo = exports.IdGenerator = exports.getFileSizeInBytes = exports.getAttachments = exports.isEmpty = exports.randomWord = void 0;
 /**
  * Defines generic utilities to interact with form runtime model
  */
@@ -85,7 +85,7 @@ const getFileSizeInBytes = (str) => {
     if (typeof str === 'string') {
         const matches = fileSizeRegex.exec(str.trim());
         if (matches != null) {
-            retVal = (0, exports.sizeToBytes)(parseFloat(matches[1]), (matches[2] || 'kb').toUpperCase());
+            retVal = sizeToBytes(parseFloat(matches[1]), (matches[2] || 'kb').toUpperCase());
         }
     }
     return retVal;
@@ -103,7 +103,6 @@ const sizeToBytes = (size, symbol) => {
     const i = Math.pow(1024, sizes[symbol]);
     return Math.round(size * i);
 };
-exports.sizeToBytes = sizeToBytes;
 /**
  * ID Generator
  * @param initial
@@ -138,12 +137,11 @@ const IdGenerator = function* (initial = 50) {
 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[]
+ * @param file
  * @returns list of {@link FileObject}
  */
-const extractFileInfo = (files) => {
-    return (files instanceof Array ? files : [files])
-        .map((file) => {
+const extractFileInfo = (file) => {
+    if (file !== null) {
         let retVal = null;
         if (file instanceof FileObject_1.FileObject) {
             retVal = file;
@@ -159,13 +157,16 @@ const extractFileInfo = (files) => {
         }
         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
-            };
+            const result = (0, exports.dataURItoBlob)(file);
+            if (result !== null) {
+                const { blob, name } = result;
+                retVal = {
+                    name: name,
+                    mediaType: blob.type,
+                    size: blob.size,
+                    data: blob
+                };
+            }
         }
         else {
             // case: string as file object
@@ -173,19 +174,25 @@ const extractFileInfo = (files) => {
             try {
                 jFile = JSON.parse(file);
                 retVal = jFile;
+                if (!retVal.mediaType) {
+                    retVal.mediaType = retVal.type;
+                }
             }
             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
-                };
+                const result = (0, exports.dataURItoBlob)(jFile === null || jFile === void 0 ? void 0 : jFile.data);
+                if (result !== null) {
+                    const blob = result.blob;
+                    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: blob.size,
+                        data: blob
+                    };
+                }
             }
             else if (typeof jFile === 'string') {
                 // case: data as external url
@@ -207,8 +214,14 @@ const extractFileInfo = (files) => {
                 };
             }
         }
-        return new FileObject_1.FileObject(retVal);
-    });
+        if (retVal !== null && retVal.data != null) {
+            return new FileObject_1.FileObject(retVal);
+        }
+        return null;
+    }
+    else {
+        return null;
+    }
 };
 exports.extractFileInfo = extractFileInfo;
 /**
@@ -217,34 +230,28 @@ exports.extractFileInfo = extractFileInfo;
  * @returns `Blob` object for the data URI
  */
 const dataURItoBlob = (dataURI) => {
-    // Split metadata from data
-    const splitted = dataURI.split(',');
-    // Split params
-    const params = splitted[0].split(';');
-    // Get mime-type from params
-    const type = params[0].replace('data:', '');
-    // Filter the name property from params
-    const properties = params.filter(param => {
-        return param.split('=')[0] === 'name';
-    });
-    // Look for the name and use unknown if no name property.
-    let name;
-    if (properties.length !== 1) {
-        name = 'unknown';
+    const regex = /^data:([a-z]+\/[a-z0-9-+.]+)?(?:;name=([^;]+))?(;base64)?,(.+)$/;
+    const groups = regex.exec(dataURI);
+    if (groups !== null) {
+        const type = groups[1] || '';
+        const name = groups[2] || 'unknown';
+        const isBase64 = typeof groups[3] === 'string';
+        if (isBase64) {
+            const binary = atob(groups[4]);
+            const array = [];
+            for (let i = 0; i < binary.length; i++) {
+                array.push(binary.charCodeAt(i));
+            }
+            const blob = new window.Blob([new Uint8Array(array)], { type });
+            return { name, blob };
+        }
+        else {
+            const blob = new window.Blob([groups[4]], { type });
+            return { name, blob };
+        }
     }
     else {
-        // Because we filtered out the other property,
-        // we only have the name case here.
-        name = properties[0].split('=')[1];
-    }
-    // Built the Uint8Array Blob parameter from the base64 string.
-    const binary = atob(splitted[1]);
-    const array = [];
-    for (let i = 0; i < binary.length; i++) {
-        array.push(binary.charCodeAt(i));
+        return null;
     }
-    // Create the blob object
-    const blob = new window.Blob([new Uint8Array(array)], { type });
-    return { blob, name };
 };
 exports.dataURItoBlob = dataURItoBlob;

package/lib/utils/ValidationUtils.d.ts

@@ -149,5 +149,22 @@ export declare const Constraints: {
         valid: boolean;
         value: any;
     };
+    /**
+     *
+     * @param constraint
+     * @param value
+     */
+    accept: (constraint: string[], value: any) => {
+        valid: boolean;
+        value: any;
+    };
+    /**
+     * @param constraint
+     * @param value
+     */
+    maxFileSize: (constraint: number | string, value: any) => {
+        valid: boolean;
+        value: any;
+    };
 };
 export {};

package/lib/utils/ValidationUtils.js

@@ -8,6 +8,8 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Constraints = exports.ValidConstraints = exports.isDataUrl = void 0;
+const FormUtils_1 = require("./FormUtils");
+const FileObject_1 = require("../FileObject");
 /**
  * Defines generic utilities to validate form runtime model based on the constraints defined
  * as per `adaptive form specification`
@@ -47,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) {
@@ -56,6 +63,25 @@ 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) {
+        value = inputVal;
+    }
+    return {
+        value, valid
+    };
+};
 /**
  * Wraps a non-null value and not an array value into an array
  * @param inputVal input value
@@ -88,6 +114,33 @@ const checkBool = (inputVal) => {
     const value = typeof inputVal === 'boolean' ? inputVal : (valid ? inputVal === 'true' : inputVal);
     return { valid, value };
 };
+/**
+ *
+ * @param inputVal
+ */
+const checkFile = (inputVal) => {
+    const value = (0, FormUtils_1.extractFileInfo)(inputVal);
+    const valid = value !== null;
+    return {
+        value: valid ? value : inputVal,
+        valid
+    };
+};
+/**
+ * validates whether the mediaType is one present in the accepts list
+ * @param mediaType
+ * @param accepts
+ */
+const matchMediaType = (mediaType, accepts) => {
+    return !mediaType || accepts.some((accept) => {
+        const trimmedAccept = accept.trim();
+        const prefixAccept = trimmedAccept.split('/')[0];
+        const suffixAccept = trimmedAccept.split('.')[1];
+        return ((trimmedAccept.includes('*') && mediaType.startsWith(prefixAccept)) ||
+            (trimmedAccept.includes('.') && mediaType.endsWith(suffixAccept)) ||
+            (trimmedAccept === mediaType));
+    });
+};
 /**
  * Validates an array of values using a validator function.
  * @param inputVal
@@ -154,18 +207,25 @@ exports.Constraints = {
                 value = res.value;
                 break;
             case 'integer':
-                value = parseFloat(inputVal);
-                valid = !isNaN(value) && Math.round(value) === value;
-                if (!valid) {
-                    value = inputVal;
-                }
+                res = checkInteger(inputVal);
+                valid = res.valid;
+                value = res.value;
                 break;
-            case 'file' || 'file[]':
-                valid = true;
-                //valid = isFileObject(value);
-                if (!valid) {
-                    value = inputVal;
-                }
+            case 'integer[]':
+                res = partitionArray(inputVal, checkInteger);
+                valid = res[1].length === 0;
+                value = valid ? res[0] : inputVal;
+                break;
+            case 'file':
+                // for file types only, we support setting value via an array
+                res = checkFile(inputVal instanceof Array ? inputVal[0] : inputVal);
+                valid = res.valid;
+                value = res.value;
+                break;
+            case 'file[]':
+                res = partitionArray(inputVal, checkFile);
+                valid = res[1].length === 0;
+                value = valid ? res[0] : inputVal;
                 break;
             case 'number[]':
                 res = partitionArray(inputVal, checkNumber);
@@ -338,5 +398,35 @@ exports.Constraints = {
             valid: constraint.indexOf(value) > -1,
             value
         };
+    },
+    /**
+     *
+     * @param constraint
+     * @param value
+     */
+    accept: (constraint, value) => {
+        if (!constraint || constraint.length === 0 || value === null || value === undefined) {
+            return {
+                valid: true,
+                value
+            };
+        }
+        const tempValue = value instanceof Array ? value : [value];
+        const invalidFile = tempValue.some((file) => !matchMediaType(file.type, constraint));
+        return {
+            valid: !invalidFile,
+            value
+        };
+    },
+    /**
+     * @param constraint
+     * @param value
+     */
+    maxFileSize: (constraint, value) => {
+        const sizeLimit = typeof constraint === 'string' ? (0, FormUtils_1.getFileSizeInBytes)(constraint) : constraint;
+        return {
+            valid: !(value instanceof FileObject_1.FileObject) || value.size <= sizeLimit,
+            value
+        };
     }
 };