@aemforms/af-core 0.22.17 → 0.22.18

package/lib/BaseNode.d.ts

@@ -9,9 +9,12 @@ export declare const editableProperties: string[];
  * Defines props that are dynamic and can be changed at runtime.
  */
 export declare const dynamicProps: string[];
+export declare const staticFields: string[];
 export declare const target: unique symbol;
 export declare const qualifiedName: unique symbol;
 export declare function dependencyTracked(): (target: BaseNode<any>, propertyKey: string, descriptor: PropertyDescriptor) => void;
+export declare const include: (...fieldTypes: string[]) => (target: BaseNode<any>, propertyKey: string, descriptor: PropertyDescriptor) => void;
+export declare const exclude: (...fieldTypes: string[]) => (target: BaseNode<any>, propertyKey: string, descriptor: PropertyDescriptor) => void;
 /**
  * Defines a generic base class which all objects of form runtime model should extend from.
  * @typeparam T type of the form object which extends from {@link BaseJson | base type}
@@ -69,6 +72,14 @@ export declare abstract class BaseNode<T extends BaseJson> implements BaseModel
      */
     isTransparent(): boolean;
     getState(): T & {
+        properties: {
+            [key: string]: any;
+        };
+        index: number;
+        parent: undefined;
+        qualifiedName: any;
+        events: {};
+        rules: {};
         ':type': string;
         id: string;
     };

package/lib/BaseNode.js

@@ -16,7 +16,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseNode = exports.dependencyTracked = exports.qualifiedName = exports.target = exports.dynamicProps = exports.editableProperties = void 0;
+exports.BaseNode = exports.exclude = exports.include = exports.dependencyTracked = exports.qualifiedName = exports.target = exports.staticFields = exports.dynamicProps = exports.editableProperties = void 0;
 const controller_1 = require("./controller");
 const DataRefParser_1 = require("./utils/DataRefParser");
 const EmptyDataValue_1 = __importDefault(require("./data/EmptyDataValue"));
@@ -37,13 +37,13 @@ exports.editableProperties = [
     // 'enforceEnum', // not exposed for now
     'exclusiveMinimum',
     'exclusiveMaximum',
-    'maxLength',
+    //    'maxLength',
     'maximum',
     'maxItems',
-    'minLength',
+    //    'minLength',
     'minimum',
-    'minItems',
-    'step'
+    'minItems'
+    //    'step'
     // 'placeholder' // not exposed for now.
 ];
 /**
@@ -55,6 +55,7 @@ exports.dynamicProps = [
     'index',
     'activeChild'
 ];
+exports.staticFields = ['plain-text', 'image'];
 /**
  * Implementation of action with target
  * @private
@@ -107,6 +108,29 @@ function dependencyTracked() {
     };
 }
 exports.dependencyTracked = dependencyTracked;
+const addOnly = (includeOrExclude) => (...fieldTypes) => (target, propertyKey, descriptor) => {
+    const get = descriptor.get;
+    if (get != undefined) {
+        descriptor.get = function () {
+            // @ts-ignore
+            if (fieldTypes.indexOf(this.fieldType) > -1 === includeOrExclude) {
+                return get.call(this);
+            }
+            return undefined;
+        };
+    }
+    const set = descriptor.set;
+    if (set != undefined) {
+        descriptor.set = function (value) {
+            // @ts-ignore
+            if (fieldTypes.indexOf(this.fieldType) > -1 === includeOrExclude) {
+                set.call(this, value);
+            }
+        };
+    }
+};
+exports.include = addOnly(true);
+exports.exclude = addOnly(false);
 /**
  * Defines a generic base class which all objects of form runtime model should extend from.
  * @typeparam T type of the form object which extends from {@link BaseJson | base type}
@@ -202,7 +226,10 @@ class BaseNode {
         return this._jsonModel.id;
     }
     get index() {
-        return this.parent.indexOf(this);
+        if (this.parent) {
+            return this.parent.indexOf(this);
+        }
+        return 0;
     }
     get parent() {
         return this._options.parent;
@@ -269,7 +296,7 @@ class BaseNode {
         return !this._jsonModel.name && !isNonTransparent;
     }
     getState() {
-        return Object.assign(Object.assign({}, this._jsonModel), { ':type': this[':type'] });
+        return Object.assign(Object.assign({}, this._jsonModel), { properties: this.properties, index: this.index, parent: undefined, qualifiedName: this.qualifiedName, events: {}, rules: {}, ':type': this[':type'] });
     }
     /**
      * @private
@@ -393,8 +420,9 @@ class BaseNode {
             }
         }
         else { // name data binding
+            // static fields do not have name bindings
             if ( //@ts-ignore
-            contextualDataModel !== EmptyDataValue_1.default) {
+            contextualDataModel !== EmptyDataValue_1.default && exports.staticFields.indexOf(this.fieldType) === -1) {
                 _parent = contextualDataModel;
                 const name = this._jsonModel.name || '';
                 const key = contextualDataModel.$type === 'array' ? this.index : name;

package/lib/CheckboxGroup.js

@@ -32,6 +32,9 @@ class CheckboxGroup extends Field_1.default {
         if (typeof fallbackType === 'string') {
             return `${fallbackType}[]`;
         }
+        else {
+            return 'string[]';
+        }
     }
     _getDefaults() {
         return Object.assign(Object.assign({}, super._getDefaults()), { enforceEnum: true, enum: [] });

package/lib/Container.d.ts

@@ -35,8 +35,10 @@ declare abstract class Container<T extends ContainerJson & RulesJson> extends Sc
      * Returns the current container state
      */
     getState(): T & {
-        ':type': string;
         items: ({
+            id: string;
+            index: number;
+            ':type': string;
             description?: string | undefined;
             rules?: import("./types").Items<string> | undefined;
             events?: import("./types").Items<string | string[] | undefined> | undefined;
@@ -64,7 +66,6 @@ declare abstract class Container<T extends ContainerJson & RulesJson> extends Sc
             validationExpression?: string | undefined;
             uniqueItems?: boolean | undefined;
             dataRef?: string | null | undefined;
-            ':type': string;
             label?: import("./types").Label | undefined;
             enabled?: boolean | undefined;
             visible?: boolean | undefined;
@@ -77,6 +78,9 @@ declare abstract class Container<T extends ContainerJson & RulesJson> extends Sc
             properties?: {
                 [key: string]: any;
             } | undefined;
+            screenReaderText?: string | undefined;
+            tooltip?: string | undefined;
+            altText?: string | undefined;
             placeholder?: string | undefined;
             readOnly?: boolean | undefined;
             valid?: boolean | undefined;
@@ -87,8 +91,10 @@ declare abstract class Container<T extends ContainerJson & RulesJson> extends Sc
             editValue?: string | undefined;
             displayValue?: string | undefined;
             emptyValue?: "" | "undefined" | "null" | undefined;
-            id: string;
         } | {
+            id: string;
+            index: number;
+            ':type': string;
             description?: string | undefined;
             rules?: import("./types").Items<string> | undefined;
             events?: import("./types").Items<string | string[] | undefined> | undefined;
@@ -116,7 +122,6 @@ declare abstract class Container<T extends ContainerJson & RulesJson> extends Sc
             validationExpression?: string | undefined;
             uniqueItems?: boolean | undefined;
             dataRef?: string | null | undefined;
-            ':type'?: string | undefined;
             label?: import("./types").Label | undefined;
             enabled?: boolean | undefined;
             visible?: boolean | undefined;
@@ -129,220 +134,22 @@ declare abstract class Container<T extends ContainerJson & RulesJson> extends Sc
             properties?: {
                 [key: string]: any;
             } | undefined;
-            items: (FieldJson | ContainerJson)[] & (({
-                description?: string | undefined;
-            } & RulesJson & {
-                enumNames?: string[] | undefined;
-                enum?: any[] | undefined;
-            } & {
-                accept?: string[] | undefined;
-                enforceEnum?: boolean | undefined;
-                exclusiveMinimum?: number | undefined;
-                exclusiveMaximum?: number | undefined;
-                format?: string | undefined;
-                maxFileSize?: string | number | undefined;
-                maxLength?: number | undefined;
-                maximum?: number | undefined;
-                maxItems?: number | undefined;
-                minLength?: number | undefined;
-                minimum?: number | undefined;
-                minItems?: number | undefined;
-                pattern?: string | undefined;
-                required?: boolean | undefined;
-                /**
-                 * @private
-                 */
-                step?: number | undefined;
-                type?: string | undefined;
-                validationExpression?: string | undefined;
-                uniqueItems?: boolean | undefined;
-            } & {
-                dataRef?: string | null | undefined;
-                ':type'?: string | undefined;
-                label?: import("./types").Label | undefined;
-                enabled?: boolean | undefined;
-                visible?: boolean | undefined;
-                name?: string | undefined;
-                constraintMessages?: import("./types").ConstraintsMessages | undefined;
-                fieldType?: string | undefined; /**
-                 * Returns the current container state
-                 */
-                errorMessage?: string | undefined;
-                properties?: {
-                    [key: string]: any;
-                } | undefined;
-            } & {
-                placeholder?: string | undefined;
-            } & {
-                readOnly?: boolean | undefined;
-                valid?: boolean | undefined;
-                default?: any;
-                value?: any;
-                displayFormat?: string | undefined;
-                editFormat?: string | undefined;
-                editValue?: string | undefined;
-                displayValue?: string | undefined;
-                emptyValue?: "" | "undefined" | "null" | undefined;
-            } & {
-                id: string;
-                ':type': string;
-            }) | ({
-                description?: string | undefined;
-            } & RulesJson & {
-                enumNames?: string[] | undefined;
-                enum?: any[] | undefined;
-            } & {
-                accept?: string[] | undefined;
-                enforceEnum?: boolean | undefined;
-                exclusiveMinimum?: number | undefined;
-                exclusiveMaximum?: number | undefined;
-                format?: string | undefined;
-                maxFileSize?: string | number | undefined;
-                maxLength?: number | undefined;
-                maximum?: number | undefined;
-                maxItems?: number | undefined;
-                minLength?: number | undefined;
-                minimum?: number | undefined;
-                minItems?: number | undefined;
-                pattern?: string | undefined;
-                required?: boolean | undefined;
-                /**
-                 * @private
-                 */
-                step?: number | undefined;
-                type?: string | undefined;
-                validationExpression?: string | undefined;
-                uniqueItems?: boolean | undefined;
-            } & {
-                dataRef?: string | null | undefined;
-                ':type'?: string | undefined;
-                label?: import("./types").Label | undefined;
-                enabled?: boolean | undefined;
-                visible?: boolean | undefined;
-                name?: string | undefined;
-                constraintMessages?: import("./types").ConstraintsMessages | undefined;
-                fieldType?: string | undefined; /**
-                 * Returns the current container state
-                 */
-                errorMessage?: string | undefined;
-                properties?: {
-                    [key: string]: any;
-                } | undefined;
-            } & {
-                items: (FieldJson | ContainerJson)[];
-                initialItems?: number | undefined;
-                activeChild?: string | undefined;
-            } & {
-                id: string;
-                items: (({
-                    description?: string | undefined;
-                } & RulesJson & {
-                    enumNames?: string[] | undefined;
-                    enum?: any[] | undefined;
-                } & {
-                    accept?: string[] | undefined;
-                    enforceEnum?: boolean | undefined;
-                    exclusiveMinimum?: number | undefined;
-                    exclusiveMaximum?: number | undefined;
-                    format?: string | undefined;
-                    maxFileSize?: string | number | undefined;
-                    maxLength?: number | undefined;
-                    maximum?: number | undefined;
-                    maxItems?: number | undefined;
-                    minLength?: number | undefined;
-                    minimum?: number | undefined;
-                    minItems?: number | undefined;
-                    pattern?: string | undefined;
-                    required?: boolean | undefined;
-                    /**
-                     * @private
-                     */
-                    step?: number | undefined;
-                    type?: string | undefined;
-                    validationExpression?: string | undefined;
-                    uniqueItems?: boolean | undefined;
-                } & {
-                    dataRef?: string | null | undefined;
-                    ':type'?: string | undefined;
-                    label?: import("./types").Label | undefined;
-                    enabled?: boolean | undefined;
-                    visible?: boolean | undefined;
-                    name?: string | undefined;
-                    constraintMessages?: import("./types").ConstraintsMessages | undefined;
-                    fieldType?: string | undefined; /**
-                     * Returns the current container state
-                     */
-                    errorMessage?: string | undefined;
-                    properties?: {
-                        [key: string]: any;
-                    } | undefined;
-                } & {
-                    placeholder?: string | undefined;
-                } & {
-                    readOnly?: boolean | undefined;
-                    valid?: boolean | undefined;
-                    default?: any;
-                    value?: any;
-                    displayFormat?: string | undefined;
-                    editFormat?: string | undefined;
-                    editValue?: string | undefined;
-                    displayValue?: string | undefined;
-                    emptyValue?: "" | "undefined" | "null" | undefined;
-                } & {
-                    id: string;
-                    ':type': string;
-                }) | ({
-                    description?: string | undefined;
-                } & RulesJson & {
-                    enumNames?: string[] | undefined;
-                    enum?: any[] | undefined;
-                } & {
-                    accept?: string[] | undefined;
-                    enforceEnum?: boolean | undefined;
-                    exclusiveMinimum?: number | undefined;
-                    exclusiveMaximum?: number | undefined;
-                    format?: string | undefined;
-                    maxFileSize?: string | number | undefined;
-                    maxLength?: number | undefined;
-                    maximum?: number | undefined;
-                    maxItems?: number | undefined;
-                    minLength?: number | undefined;
-                    minimum?: number | undefined;
-                    minItems?: number | undefined;
-                    pattern?: string | undefined;
-                    required?: boolean | undefined;
-                    /**
-                     * @private
-                     */
-                    step?: number | undefined;
-                    type?: string | undefined;
-                    validationExpression?: string | undefined;
-                    uniqueItems?: boolean | undefined;
-                } & {
-                    dataRef?: string | null | undefined;
-                    ':type'?: string | undefined;
-                    label?: import("./types").Label | undefined;
-                    enabled?: boolean | undefined;
-                    visible?: boolean | undefined;
-                    name?: string | undefined;
-                    constraintMessages?: import("./types").ConstraintsMessages | undefined;
-                    fieldType?: string | undefined; /**
-                     * Returns the current container state
-                     */
-                    errorMessage?: string | undefined;
-                    properties?: {
-                        [key: string]: any;
-                    } | undefined;
-                } & {
-                    items: (FieldJson | ContainerJson)[];
-                    initialItems?: number | undefined;
-                    activeChild?: string | undefined;
-                } & any))[];
-            }))[];
+            screenReaderText?: string | undefined;
+            tooltip?: string | undefined;
+            altText?: string | undefined;
+            items: (FieldJson | ContainerJson)[] & import("./types").State<FieldJson | ContainerJson>[];
             initialItems?: number | undefined;
             activeChild?: string | undefined;
-            id: string;
         })[];
+        properties: {
+            [key: string]: any;
+        };
+        index: number;
+        parent: undefined;
+        qualifiedName: any;
+        events: {};
+        rules: {};
+        ':type': string;
         id: string;
     };
     protected abstract _createChild(child: FieldsetJson | FieldJson): FieldModel | FieldsetModel;

package/lib/Container.js

@@ -75,7 +75,7 @@ class Container extends Scriptable_1.default {
      * Returns the current container state
      */
     getState() {
-        return Object.assign(Object.assign({}, this._jsonModel), { ':type': this[':type'], items: this._children.map(x => {
+        return Object.assign(Object.assign({}, super.getState()), { items: this._children.map(x => {
                 return Object.assign({}, x.getState());
             }) });
     }
@@ -154,7 +154,7 @@ class Container extends Scriptable_1.default {
      */
     _initialize() {
         super._initialize();
-        const items = this._jsonModel.items;
+        const items = this._jsonModel.items || [];
         this._jsonModel.items = [];
         this._childrenReference = this._jsonModel.type == 'array' ? [] : {};
         if (this._jsonModel.type == 'array' && items.length === 1 && this.getDataNode() != null) {
@@ -183,6 +183,9 @@ class Container extends Scriptable_1.default {
             this._jsonModel.maxItems = this._children.length;
             this._jsonModel.initialItems = this._children.length;
         }
+        else {
+            this.form.logger.warn('A container exists with no items.');
+        }
         this.setupRuleNode();
     }
     /**
@@ -203,7 +206,7 @@ class Container extends Scriptable_1.default {
                     dataNode.$addDataNode(index, _data);
                 }
                 retVal._initialize();
-                this.notifyDependents((0, controller_1.propertyChange)('items', retVal.getState, null));
+                this.notifyDependents((0, controller_1.propertyChange)('items', retVal.getState(), null));
                 retVal.dispatch(new controller_1.Initialize());
                 retVal.dispatch(new controller_1.ExecuteRule());
                 for (let i = index + 1; i < this._children.length; i++) {

package/lib/Field.d.ts

@@ -2,9 +2,6 @@ import { ConstraintsMessages, ContainerModel, FieldJson, FieldModel, FormModel,
 import Scriptable from './Scriptable';
 import DataValue from './data/DataValue';
 import DataGroup from './data/DataGroup';
-/**
- * Defines a form object field which implements {@link FieldModel | field model} interface
- */
 declare class Field extends Scriptable<FieldJson> implements FieldModel {
     /**
      * @param params
@@ -73,6 +70,8 @@ declare class Field extends Scriptable<FieldJson> implements FieldModel {
      * @param constraint
      */
     getErrorMessage(constraint: keyof (ConstraintsMessages)): string;
+    get errorMessage(): string | undefined;
+    get screenReaderText(): string | undefined;
     /**
      *
      * @private
@@ -176,7 +175,18 @@ declare class Field extends Scriptable<FieldJson> implements FieldModel {
     /**
      * returns the format constraint
      */
-    get format(): string;
+    get format(): string | undefined;
+    get enforceEnum(): boolean | undefined;
+    get tooltip(): string | undefined;
+    get maxLength(): number | undefined;
+    get minLength(): number | undefined;
+    get pattern(): string | undefined;
+    get step(): number | undefined;
+    get exclusiveMinimum(): number | undefined;
+    set exclusiveMinimum(eM: number | undefined);
+    get exclusiveMaximum(): number | undefined;
+    set exclusiveMaximum(eM: number | undefined);
+    get default(): any;
     /**
      * @private
      */
@@ -196,8 +206,8 @@ declare class Field extends Scriptable<FieldJson> implements FieldModel {
         editValue: any;
         displayValue: any;
         description?: string | undefined;
-        rules?: import("./types").Items<string> | undefined;
-        events?: import("./types").Items<string | string[] | undefined> | undefined;
+        rules: import("./types").Items<string> & {};
+        events: import("./types").Items<string | string[] | undefined> & {};
         enumNames?: string[] | undefined;
         enum?: any[] | undefined;
         accept?: string[] | undefined;
@@ -227,9 +237,12 @@ declare class Field extends Scriptable<FieldJson> implements FieldModel {
         constraintMessages?: ConstraintsMessages | undefined;
         fieldType?: string | undefined;
         errorMessage?: string | undefined;
-        properties?: {
+        properties: {
             [key: string]: any;
-        } | undefined;
+        };
+        screenReaderText?: string | undefined;
+        tooltip?: string | undefined;
+        altText?: string | undefined;
         placeholder?: string | undefined;
         readOnly?: boolean | undefined;
         valid?: boolean | undefined;
@@ -238,6 +251,9 @@ declare class Field extends Scriptable<FieldJson> implements FieldModel {
         displayFormat?: string | undefined;
         editFormat?: string | undefined;
         emptyValue?: "" | "undefined" | "null" | undefined;
+        index: number;
+        parent: undefined;
+        qualifiedName: any;
         id: string;
     };
 }