@aemforms/af-core 0.22.82 → 0.22.84

package/esm/afb-runtime.js

@@ -147,6 +147,9 @@ const isCaptcha = function (item) {
     const fieldType = item?.fieldType || defaultFieldTypes(item);
     return fieldType === 'captcha';
 };
+const isButton = function (item) {
+    return item?.fieldType === 'button';
+};
 function deepClone(obj, idGenerator) {
     let result;
     if (obj instanceof Array) {
@@ -3003,12 +3006,22 @@ class Form extends Container {
     _applyDefaultsInModel() {
         const current = this.specVersion;
         this._jsonModel.properties = this._jsonModel.properties || {};
+        this._jsonModel.fieldType = this._jsonModel.fieldType || 'form';
         if (current.lessThan(changeEventVersion) ||
             typeof this._jsonModel.properties['fd:changeEventBehaviour'] !== 'string') {
             this._jsonModel.properties['fd:changeEventBehaviour'] = 'self';
         }
     }
     _logger;
+    get activeField() {
+        return this._findActiveField(this);
+    }
+    _findActiveField(field) {
+        if (!field?.isContainer) {
+            return field;
+        }
+        return this._findActiveField(field?.activeChild);
+    }
     get logger() {
         return this._logger;
     }
@@ -4441,6 +4454,20 @@ class Captcha extends Field {
     }
 }
 
+class Button extends Field {
+    click() {
+        if (this._events?.click || !this._jsonModel.buttonType) {
+            return;
+        }
+        if (this._jsonModel.buttonType === 'submit') {
+            return this.form.dispatch(new Submit());
+        }
+        if (this._jsonModel.buttonType === 'reset') {
+            return this.form.dispatch(new Reset());
+        }
+    }
+}
+
 const alternateFieldTypeMapping = {
     'text': 'text-input',
     'number': 'number-input',
@@ -4505,6 +4532,9 @@ class FormFieldFactoryImpl {
             else if (isCaptcha(child)) {
                 retVal = new Captcha(child, options);
             }
+            else if (isButton(child)) {
+                retVal = new Button(child, options);
+            }
             else {
                 retVal = new Field(child, options);
             }

package/esm/types/src/Button.d.ts

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

package/esm/types/src/Checkbox.d.ts

@@ -135,6 +135,7 @@ declare class Checkbox extends Field {
         tooltip?: string | undefined;
         altText?: string | undefined;
         viewType?: string | undefined;
+        buttonType?: string | undefined;
         placeholder?: string | undefined;
         valid?: boolean | undefined;
         validity?: any;

package/esm/types/src/Field.d.ts

@@ -204,6 +204,7 @@ declare class Field extends Scriptable<FieldJson> implements FieldModel {
         tooltip?: string | undefined;
         altText?: string | undefined;
         viewType?: string | undefined;
+        buttonType?: string | undefined;
         placeholder?: string | undefined;
         valid?: boolean | undefined;
         validity?: any;

package/esm/types/src/Form.d.ts

@@ -18,6 +18,8 @@ declare class Form extends Container<FormJson> implements FormModel {
     constructor(n: FormJson, fieldFactory: IFormFieldFactory, _ruleEngine: RuleEngine, _eventQueue?: EventQueue, logLevel?: LogLevel, mode?: FormCreationMode);
     protected _applyDefaultsInModel(): void;
     private _logger;
+    get activeField(): FieldModel;
+    _findActiveField(field: FieldsetModel | FieldModel | null): any;
     get logger(): Logger;
     get changeEventBehaviour(): "deps" | "self";
     private dataRefRegex;
@@ -76,6 +78,7 @@ declare class Form extends Container<FormJson> implements FormModel {
         tooltip?: string | undefined;
         altText?: string | undefined;
         viewType?: string | undefined;
+        buttonType?: string | undefined;
     } & {
         items: (import("./types/Json").FieldJson | import("./types/Json").ContainerJson)[];
         initialItems?: number | undefined;

package/esm/types/src/Scriptable.d.ts

@@ -1,7 +1,9 @@
 import { Action, RulesJson, ScriptableField } from './types/index';
 import { BaseNode } from './BaseNode';
 declare abstract class Scriptable<T extends RulesJson> extends BaseNode<T> implements ScriptableField {
-    private _events;
+    protected _events: {
+        [key: string]: any;
+    };
     private _rules;
     getRules(): import("./types/Json").Items<string>;
     private getCompiledRule;

package/esm/types/src/types/Json.d.ts

@@ -80,6 +80,7 @@ export type BaseJson = TranslationBaseJson & RulesJson & ConstraintsJson & {
     tooltip?: string;
     altText?: string;
     viewType?: string;
+    buttonType?: string;
 };
 type TranslationFieldJson = {
     placeholder?: string;

package/esm/types/src/types/Model.d.ts

@@ -102,6 +102,7 @@ export interface FieldsetModel extends ContainerModel, WithState<FieldsetJson> {
     type?: 'array' | 'object';
 }
 export interface FormModel extends ContainerModel, WithState<FormJson> {
+    activeField: FieldModel;
     readonly id: string;
     readonly data?: any;
     readonly metadata?: MetaDataJson;

package/esm/types/src/utils/JsonUtils.d.ts

@@ -7,6 +7,7 @@ export declare const isCheckboxGroup: (item: FieldsetJson | FieldJson) => boolea
 export declare const isEmailInput: (item: FieldsetJson | FieldJson) => boolean;
 export declare const isDateField: (item: FieldsetJson | FieldJson) => boolean;
 export declare const isCaptcha: (item: FieldsetJson | FieldJson) => boolean;
+export declare const isButton: (item: FieldsetJson | FieldJson) => boolean;
 export declare function deepClone(obj: any, idGenerator?: () => string): any;
 export declare function checkIfKeyAdded(currentObj: any, prevObj: any, objKey: string): boolean;
 export declare const jsonString: (obj: any) => string;

package/lib/Button.d.ts

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

package/lib/Button.js

@@ -0,0 +1,22 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Field_1 = __importDefault(require("./Field"));
+const Events_1 = require("./controller/Events");
+class Button extends Field_1.default {
+    click() {
+        var _a;
+        if (((_a = this._events) === null || _a === void 0 ? void 0 : _a.click) || !this._jsonModel.buttonType) {
+            return;
+        }
+        if (this._jsonModel.buttonType === 'submit') {
+            return this.form.dispatch(new Events_1.Submit());
+        }
+        if (this._jsonModel.buttonType === 'reset') {
+            return this.form.dispatch(new Events_1.Reset());
+        }
+    }
+}
+exports.default = Button;

package/lib/Checkbox.d.ts

@@ -135,6 +135,7 @@ declare class Checkbox extends Field {
         tooltip?: string | undefined;
         altText?: string | undefined;
         viewType?: string | undefined;
+        buttonType?: string | undefined;
         placeholder?: string | undefined;
         valid?: boolean | undefined;
         validity?: any;

package/lib/Field.d.ts

@@ -204,6 +204,7 @@ declare class Field extends Scriptable<FieldJson> implements FieldModel {
         tooltip?: string | undefined;
         altText?: string | undefined;
         viewType?: string | undefined;
+        buttonType?: string | undefined;
         placeholder?: string | undefined;
         valid?: boolean | undefined;
         validity?: any;

package/lib/Form.d.ts

@@ -18,6 +18,8 @@ declare class Form extends Container<FormJson> implements FormModel {
     constructor(n: FormJson, fieldFactory: IFormFieldFactory, _ruleEngine: RuleEngine, _eventQueue?: EventQueue, logLevel?: LogLevel, mode?: FormCreationMode);
     protected _applyDefaultsInModel(): void;
     private _logger;
+    get activeField(): FieldModel;
+    _findActiveField(field: FieldsetModel | FieldModel | null): any;
     get logger(): Logger;
     get changeEventBehaviour(): "deps" | "self";
     private dataRefRegex;
@@ -76,6 +78,7 @@ declare class Form extends Container<FormJson> implements FormModel {
         tooltip?: string | undefined;
         altText?: string | undefined;
         viewType?: string | undefined;
+        buttonType?: string | undefined;
     } & {
         items: (import("./types/Json").FieldJson | import("./types/Json").ContainerJson)[];
         initialItems?: number | undefined;

package/lib/Form.js

@@ -54,11 +54,21 @@ class Form extends Container_1.default {
     _applyDefaultsInModel() {
         const current = this.specVersion;
         this._jsonModel.properties = this._jsonModel.properties || {};
+        this._jsonModel.fieldType = this._jsonModel.fieldType || 'form';
         if (current.lessThan(changeEventVersion) ||
             typeof this._jsonModel.properties['fd:changeEventBehaviour'] !== 'string') {
             this._jsonModel.properties['fd:changeEventBehaviour'] = 'self';
         }
     }
+    get activeField() {
+        return this._findActiveField(this);
+    }
+    _findActiveField(field) {
+        if (!(field === null || field === void 0 ? void 0 : field.isContainer)) {
+            return field;
+        }
+        return this._findActiveField(field === null || field === void 0 ? void 0 : field.activeChild);
+    }
     get logger() {
         return this._logger;
     }

package/lib/Scriptable.d.ts

@@ -1,7 +1,9 @@
 import { Action, RulesJson, ScriptableField } from './types/index';
 import { BaseNode } from './BaseNode';
 declare abstract class Scriptable<T extends RulesJson> extends BaseNode<T> implements ScriptableField {
-    private _events;
+    protected _events: {
+        [key: string]: any;
+    };
     private _rules;
     getRules(): import("./types/Json").Items<string>;
     private getCompiledRule;

package/lib/types/Json.d.ts

@@ -80,6 +80,7 @@ export declare type BaseJson = TranslationBaseJson & RulesJson & ConstraintsJson
     tooltip?: string;
     altText?: string;
     viewType?: string;
+    buttonType?: string;
 };
 declare type TranslationFieldJson = {
     placeholder?: string;

package/lib/types/Model.d.ts

@@ -102,6 +102,7 @@ export interface FieldsetModel extends ContainerModel, WithState<FieldsetJson> {
     type?: 'array' | 'object';
 }
 export interface FormModel extends ContainerModel, WithState<FormJson> {
+    activeField: FieldModel;
     readonly id: string;
     readonly data?: any;
     readonly metadata?: MetaDataJson;

package/lib/utils/FormCreationUtils.js

@@ -14,6 +14,7 @@ const DateField_1 = __importDefault(require("../DateField"));
 const Field_1 = __importDefault(require("../Field"));
 const EmailInput_1 = __importDefault(require("../EmailInput"));
 const Captcha_1 = __importDefault(require("../Captcha"));
+const Button_1 = __importDefault(require("../Button"));
 const alternateFieldTypeMapping = {
     'text': 'text-input',
     'number': 'number-input',
@@ -65,6 +66,9 @@ class FormFieldFactoryImpl {
             else if ((0, JsonUtils_1.isCaptcha)(child)) {
                 retVal = new Captcha_1.default(child, options);
             }
+            else if ((0, JsonUtils_1.isButton)(child)) {
+                retVal = new Button_1.default(child, options);
+            }
             else {
                 retVal = new Field_1.default(child, options);
             }

package/lib/utils/JsonUtils.d.ts

@@ -7,6 +7,7 @@ export declare const isCheckboxGroup: (item: FieldsetJson | FieldJson) => boolea
 export declare const isEmailInput: (item: FieldsetJson | FieldJson) => boolean;
 export declare const isDateField: (item: FieldsetJson | FieldJson) => boolean;
 export declare const isCaptcha: (item: FieldsetJson | FieldJson) => boolean;
+export declare const isButton: (item: FieldsetJson | FieldJson) => boolean;
 export declare function deepClone(obj: any, idGenerator?: () => string): any;
 export declare function checkIfKeyAdded(currentObj: any, prevObj: any, objKey: string): boolean;
 export declare const jsonString: (obj: any) => string;

package/lib/utils/JsonUtils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isRepeatable = exports.jsonString = exports.checkIfKeyAdded = exports.deepClone = exports.isCaptcha = exports.isDateField = exports.isEmailInput = exports.isCheckboxGroup = exports.isCheckbox = exports.checkIfConstraintsArePresent = exports.isFile = exports.getProperty = void 0;
+exports.isRepeatable = exports.jsonString = exports.checkIfKeyAdded = exports.deepClone = exports.isButton = exports.isCaptcha = exports.isDateField = exports.isEmailInput = exports.isCheckboxGroup = exports.isCheckbox = exports.checkIfConstraintsArePresent = exports.isFile = exports.getProperty = void 0;
 const index_1 = require("../types/index");
 const SchemaUtils_1 = require("./SchemaUtils");
 const getProperty = (data, key, def) => {
@@ -51,6 +51,10 @@ const isCaptcha = function (item) {
     return fieldType === 'captcha';
 };
 exports.isCaptcha = isCaptcha;
+const isButton = function (item) {
+    return (item === null || item === void 0 ? void 0 : item.fieldType) === 'button';
+};
+exports.isButton = isButton;
 function deepClone(obj, idGenerator) {
     let result;
     if (obj instanceof Array) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aemforms/af-core",
-  "version": "0.22.82",
+  "version": "0.22.84",
   "description": "Core Module for Forms Runtime",
   "author": "Adobe Systems",
   "license": "Adobe Proprietary",
@@ -37,7 +37,7 @@
   },
   "dependencies": {
     "@adobe/json-formula": "0.1.50",
-    "@aemforms/af-formatters": "^0.22.82"
+    "@aemforms/af-formatters": "^0.22.84"
   },
   "devDependencies": {
     "@babel/preset-env": "^7.20.2",