@aemforms/af-core 0.22.110 → 0.22.112

package/esm/afb-runtime.js

@@ -1874,6 +1874,9 @@ class Scriptable extends BaseNode {
         let updates;
         if (node) {
             updates = this.ruleEngine.execute(node, this.getExpressionScope(), context, false, eString);
+            if (updates instanceof Promise) {
+                this.form.addPromises(updates);
+            }
         }
         if (typeof updates !== 'undefined' && updates != null) {
             this.applyUpdates(updates);
@@ -3069,8 +3072,7 @@ class FunctionRuntimeImpl {
                         success = valueOf(args[4]);
                         error = valueOf(args[5]);
                     }
-                    request(interpreter.globals, uri, httpVerb, payload, success, error, headers);
-                    return {};
+                    return request(interpreter.globals, uri, httpVerb, payload, success, error, headers);
                 },
                 _signature: []
             },
@@ -3226,6 +3228,7 @@ class Form extends Container {
     _ids;
     _invalidFields = [];
     _exportDataAttachmentMap = {};
+    promises = [];
     _captcha = null;
     constructor(n, fieldFactory, _ruleEngine, _eventQueue = new EventQueue(), logLevel = 'off', mode = 'create') {
         super(n, { fieldFactory: fieldFactory, mode });
@@ -3249,6 +3252,17 @@ class Form extends Container {
             this.queueEvent(new FormLoad());
         }
     }
+    addPromises(updates) {
+        this.promises.push(updates);
+    }
+    async waitForPromises() {
+        let length = 0;
+        while (this.promises.length > length) {
+            length = this.promises.length;
+            await Promise.all(this.promises);
+        }
+        this.promises = [];
+    }
     _applyDefaultsInModel() {
         const current = this.specVersion;
         this._jsonModel.properties = this._jsonModel.properties || {};
@@ -4735,7 +4749,7 @@ class Captcha extends Field {
         super(params, _options);
         this._captchaDisplayMode = params.captchaDisplayMode;
         this._captchaProvider = params.captchaProvider;
-        this._captchaSiteKey = params.siteKey;
+        this._captchaSiteKey = params.captchaSiteKey;
     }
     getDataNode() {
         return undefined;
@@ -4847,23 +4861,40 @@ class FormFieldFactoryImpl {
 }
 const FormFieldFactory = new FormFieldFactoryImpl();
 
+const createFormInstanceHelper = (formModel, logLevel, fModel) => {
+    let f = fModel;
+    if (f == null) {
+        formModel = sitesModelToFormModel(formModel);
+        f = new Form({ ...formModel }, FormFieldFactory, new RuleEngine(), new EventQueue(new Logger(logLevel)), logLevel);
+    }
+    const formData = formModel?.data;
+    if (formData) {
+        f.importData(formData);
+    }
+    return f;
+};
 const createFormInstance = (formModel, callback, logLevel = 'error', fModel = undefined) => {
     try {
-        let f = fModel;
-        {
-            if (f == null) {
-                formModel = sitesModelToFormModel(formModel);
-                f = new Form({ ...formModel }, FormFieldFactory, new RuleEngine(), new EventQueue(new Logger(logLevel)), logLevel);
-            }
-        }
-        const formData = formModel?.data;
-        if (formData) {
-            f.importData(formData);
+        const f = createFormInstanceHelper(formModel, logLevel, fModel);
+        if (typeof callback === 'function') {
+            callback(f);
         }
+        f.getEventQueue().runPendingQueue();
+        return f;
+    }
+    catch (e) {
+        console.error(`Unable to create an instance of the Form ${e}`);
+        throw new Error(e);
+    }
+};
+const createFormInstanceSync = async (formModel, callback, logLevel = 'error', fModel = undefined) => {
+    try {
+        const f = createFormInstanceHelper(formModel, logLevel, fModel);
         if (typeof callback === 'function') {
             callback(f);
         }
         f.getEventQueue().runPendingQueue();
+        await f.waitForPromises();
         return f;
     }
     catch (e) {
@@ -4943,4 +4974,4 @@ const registerFunctions = (functions) => {
     FunctionRuntime.registerFunctions(functions);
 };
 
-export { createFormInstance, fetchForm, registerFunctions, restoreFormInstance, validateFormData, validateFormInstance };
+export { createFormInstance, createFormInstanceSync, fetchForm, registerFunctions, restoreFormInstance, validateFormData, validateFormInstance };

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

@@ -0,0 +1,20 @@
+export declare const FIELD_TYPE: {
+    TEXT_INPUT: string;
+    EMAIL: string;
+    CAPTCHA: string;
+    MULTILINE_INPUT: string;
+    NUMBER_INPUT: string;
+    DATE_INPUT: string;
+    FILE_INPUT: string;
+    DROP_DOWN: string;
+    RADIO_GROUP: string;
+    PLAIN_TEXT: string;
+    CHECKBOX: string;
+    BUTTON: string;
+    PANEL: string;
+    FORM: string;
+    CHECKBOX_GROUP: string;
+    IMAGE: string;
+    TELEPHONE: string;
+    PASSWORD: string;
+};

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

@@ -16,8 +16,11 @@ declare class Form extends Container<FormJson> implements FormModel {
     _ids: Generator<string, void, string>;
     private _invalidFields;
     _exportDataAttachmentMap: Record<string, any>;
+    private promises;
     private _captcha;
     constructor(n: FormJson, fieldFactory: IFormFieldFactory, _ruleEngine: RuleEngine, _eventQueue?: EventQueue, logLevel?: LogLevel, mode?: FormCreationMode);
+    addPromises(updates: Promise<any>): void;
+    waitForPromises(): Promise<void>;
     protected _applyDefaultsInModel(): void;
     private _logger;
     get activeField(): FieldModel;

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

@@ -5,6 +5,7 @@ export declare const createFormInstance: {
     (formModel: any, callback?: ((f: FormModel) => any) | undefined, logLevel?: LogLevel, fModel?: any): FormModel;
     currentVersion: import("./utils/Version").Version;
 };
+export declare const createFormInstanceSync: (formModel: any, callback?: ((f: FormModel) => any) | undefined, logLevel?: LogLevel, fModel?: any) => Promise<FormModel>;
 export declare const restoreFormInstance: (formModel: any, data?: any, { logLevel }?: {
     logLevel: LogLevel;
 }) => FormModel;

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

@@ -4,6 +4,7 @@ export * from './controller/Events';
 export * from './utils/TranslationUtils';
 export * from './utils/JsonUtils';
 export * from './utils/SchemaUtils';
+export * from './Constant';
 import { getFileSizeInBytes, extractFileInfo, isEmpty, readAttachments } from './utils/FormUtils';
 import { BaseNode } from './BaseNode';
 import Checkbox from './Checkbox';

package/esm/types/src/rules/FunctionRuntime.d.ts

@@ -45,7 +45,7 @@ declare class FunctionRuntimeImpl {
             _signature: never[];
         };
         request: {
-            _func: (args: Array<unknown>, data: unknown, interpreter: any) => {};
+            _func: (args: Array<unknown>, data: unknown, interpreter: any) => Promise<void>;
             _signature: never[];
         };
         awaitFn: {

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

@@ -104,7 +104,7 @@ export type FieldJson = BaseJson & TranslationFieldJson & {
 export type CaptchaJson = FieldJson & {
     captchaDisplayMode?: CaptchaDisplayMode | undefined;
     captchaProvider?: string | undefined;
-    siteKey?: string | undefined;
+    captchaSiteKey?: string | undefined;
 };
 export type ContainerJson = BaseJson & {
     items: Array<FieldJson | ContainerJson>;

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

@@ -132,6 +132,8 @@ export interface FormModel extends ContainerModel, WithState<FormJson> {
     resolveQualifiedName(qualifiedName: string): FieldModel | FieldsetModel | null;
     fieldAdded(field: FieldModel | FieldsetModel): void;
     readonly changeEventBehaviour: 'deps' | 'self';
+    addPromises(updates: Promise<any>): void;
+    waitForPromises(): any;
 }
 export interface IFormFieldFactory {
     createField(child: FieldsetJson | FieldJson, options: {

package/lib/Captcha.js

@@ -9,7 +9,7 @@ class Captcha extends Field_1.default {
         super(params, _options);
         this._captchaDisplayMode = params.captchaDisplayMode;
         this._captchaProvider = params.captchaProvider;
-        this._captchaSiteKey = params.siteKey;
+        this._captchaSiteKey = params.captchaSiteKey;
     }
     getDataNode() {
         return undefined;

package/lib/Constant.d.ts

@@ -0,0 +1,20 @@
+export declare const FIELD_TYPE: {
+    TEXT_INPUT: string;
+    EMAIL: string;
+    CAPTCHA: string;
+    MULTILINE_INPUT: string;
+    NUMBER_INPUT: string;
+    DATE_INPUT: string;
+    FILE_INPUT: string;
+    DROP_DOWN: string;
+    RADIO_GROUP: string;
+    PLAIN_TEXT: string;
+    CHECKBOX: string;
+    BUTTON: string;
+    PANEL: string;
+    FORM: string;
+    CHECKBOX_GROUP: string;
+    IMAGE: string;
+    TELEPHONE: string;
+    PASSWORD: string;
+};

package/lib/Constant.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FIELD_TYPE = void 0;
+exports.FIELD_TYPE = {
+    TEXT_INPUT: 'text-input',
+    EMAIL: 'email',
+    CAPTCHA: 'captcha',
+    MULTILINE_INPUT: 'multiline-input',
+    NUMBER_INPUT: 'number-input',
+    DATE_INPUT: 'date-input',
+    FILE_INPUT: 'file-input',
+    DROP_DOWN: 'drop-down',
+    RADIO_GROUP: 'radio-group',
+    PLAIN_TEXT: 'plain-text',
+    CHECKBOX: 'checkbox',
+    BUTTON: 'button',
+    PANEL: 'panel',
+    FORM: 'form',
+    CHECKBOX_GROUP: 'checkbox-group',
+    IMAGE: 'image',
+    TELEPHONE: 'tel',
+    PASSWORD: 'password'
+};

package/lib/Form.d.ts

@@ -16,8 +16,11 @@ declare class Form extends Container<FormJson> implements FormModel {
     _ids: Generator<string, void, string>;
     private _invalidFields;
     _exportDataAttachmentMap: Record<string, any>;
+    private promises;
     private _captcha;
     constructor(n: FormJson, fieldFactory: IFormFieldFactory, _ruleEngine: RuleEngine, _eventQueue?: EventQueue, logLevel?: LogLevel, mode?: FormCreationMode);
+    addPromises(updates: Promise<any>): void;
+    waitForPromises(): Promise<void>;
     protected _applyDefaultsInModel(): void;
     private _logger;
     get activeField(): FieldModel;

package/lib/Form.js

@@ -1,4 +1,13 @@
 "use strict";
+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());
+    });
+};
 var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
     if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
@@ -33,6 +42,7 @@ class Form extends Container_1.default {
         this._fields = {};
         this._invalidFields = [];
         this._exportDataAttachmentMap = {};
+        this.promises = [];
         this._captcha = null;
         this.dataRefRegex = /("[^"]+?"|[^.]+?)(?:\.|$)/g;
         this._logger = new Logger_1.Logger(logLevel);
@@ -53,6 +63,19 @@ class Form extends Container_1.default {
             this.queueEvent(new Events_1.FormLoad());
         }
     }
+    addPromises(updates) {
+        this.promises.push(updates);
+    }
+    waitForPromises() {
+        return __awaiter(this, void 0, void 0, function* () {
+            let length = 0;
+            while (this.promises.length > length) {
+                length = this.promises.length;
+                yield Promise.all(this.promises);
+            }
+            this.promises = [];
+        });
+    }
     _applyDefaultsInModel() {
         const current = this.specVersion;
         this._jsonModel.properties = this._jsonModel.properties || {};

package/lib/FormInstance.d.ts

@@ -5,6 +5,7 @@ export declare const createFormInstance: {
     (formModel: any, callback?: ((f: FormModel) => any) | undefined, logLevel?: LogLevel, fModel?: any): FormModel;
     currentVersion: import("./utils/Version").Version;
 };
+export declare const createFormInstanceSync: (formModel: any, callback?: ((f: FormModel) => any) | undefined, logLevel?: LogLevel, fModel?: any) => Promise<FormModel>;
 export declare const restoreFormInstance: (formModel: any, data?: any, { logLevel }?: {
     logLevel: LogLevel;
 }) => FormModel;

package/lib/FormInstance.js

@@ -22,11 +22,20 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+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());
+    });
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.registerFunctions = exports.fetchForm = exports.validateFormData = exports.validateFormInstance = exports.restoreFormInstance = exports.createFormInstance = void 0;
+exports.registerFunctions = exports.fetchForm = exports.validateFormData = exports.validateFormInstance = exports.restoreFormInstance = exports.createFormInstanceSync = exports.createFormInstance = void 0;
 const Form_1 = __importStar(require("./Form"));
 const JsonUtils_1 = require("./utils/JsonUtils");
 const Fetch_1 = require("./utils/Fetch");
@@ -37,19 +46,21 @@ const FormCreationUtils_1 = require("./utils/FormCreationUtils");
 const FunctionRuntime_1 = require("./rules/FunctionRuntime");
 const FormUtils_1 = require("./utils/FormUtils");
 const DataGroup_1 = __importDefault(require("./data/DataGroup"));
+const createFormInstanceHelper = (formModel, logLevel, fModel) => {
+    let f = fModel;
+    if (f == null) {
+        formModel = (0, FormUtils_1.sitesModelToFormModel)(formModel);
+        f = new Form_1.default(Object.assign({}, formModel), FormCreationUtils_1.FormFieldFactory, new RuleEngine_1.default(), new EventQueue_1.default(new Logger_1.Logger(logLevel)), logLevel);
+    }
+    const formData = formModel === null || formModel === void 0 ? void 0 : formModel.data;
+    if (formData) {
+        f.importData(formData);
+    }
+    return f;
+};
 const createFormInstance = (formModel, callback, logLevel = 'error', fModel = undefined) => {
     try {
-        let f = fModel;
-        {
-            if (f == null) {
-                formModel = (0, FormUtils_1.sitesModelToFormModel)(formModel);
-                f = new Form_1.default(Object.assign({}, formModel), FormCreationUtils_1.FormFieldFactory, new RuleEngine_1.default(), new EventQueue_1.default(new Logger_1.Logger(logLevel)), logLevel);
-            }
-        }
-        const formData = formModel === null || formModel === void 0 ? void 0 : formModel.data;
-        if (formData) {
-            f.importData(formData);
-        }
+        const f = createFormInstanceHelper(formModel, logLevel, fModel);
         if (typeof callback === 'function') {
             callback(f);
         }
@@ -62,6 +73,22 @@ const createFormInstance = (formModel, callback, logLevel = 'error', fModel = un
     }
 };
 exports.createFormInstance = createFormInstance;
+const createFormInstanceSync = (formModel, callback, logLevel = 'error', fModel = undefined) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        const f = createFormInstanceHelper(formModel, logLevel, fModel);
+        if (typeof callback === 'function') {
+            callback(f);
+        }
+        f.getEventQueue().runPendingQueue();
+        yield f.waitForPromises();
+        return f;
+    }
+    catch (e) {
+        console.error(`Unable to create an instance of the Form ${e}`);
+        throw new Error(e);
+    }
+});
+exports.createFormInstanceSync = createFormInstanceSync;
 exports.createFormInstance.currentVersion = Form_1.currentVersion;
 const defaultOptions = {
     logLevel: 'error'

package/lib/Scriptable.js

@@ -141,6 +141,9 @@ class Scriptable extends BaseNode_1.BaseNode {
         let updates;
         if (node) {
             updates = this.ruleEngine.execute(node, this.getExpressionScope(), context, false, eString);
+            if (updates instanceof Promise) {
+                this.form.addPromises(updates);
+            }
         }
         if (typeof updates !== 'undefined' && updates != null) {
             this.applyUpdates(updates);

package/lib/index.d.ts

@@ -4,6 +4,7 @@ export * from './controller/Events';
 export * from './utils/TranslationUtils';
 export * from './utils/JsonUtils';
 export * from './utils/SchemaUtils';
+export * from './Constant';
 import { getFileSizeInBytes, extractFileInfo, isEmpty, readAttachments } from './utils/FormUtils';
 import { BaseNode } from './BaseNode';
 import Checkbox from './Checkbox';

package/lib/index.js

@@ -24,6 +24,7 @@ __exportStar(require("./controller/Events"), exports);
 __exportStar(require("./utils/TranslationUtils"), exports);
 __exportStar(require("./utils/JsonUtils"), exports);
 __exportStar(require("./utils/SchemaUtils"), exports);
+__exportStar(require("./Constant"), exports);
 const FormUtils_1 = require("./utils/FormUtils");
 Object.defineProperty(exports, "getFileSizeInBytes", { enumerable: true, get: function () { return FormUtils_1.getFileSizeInBytes; } });
 Object.defineProperty(exports, "extractFileInfo", { enumerable: true, get: function () { return FormUtils_1.extractFileInfo; } });

package/lib/rules/FunctionRuntime.d.ts

@@ -45,7 +45,7 @@ declare class FunctionRuntimeImpl {
             _signature: never[];
         };
         request: {
-            _func: (args: Array<unknown>, data: unknown, interpreter: any) => {};
+            _func: (args: Array<unknown>, data: unknown, interpreter: any) => Promise<void>;
             _signature: never[];
         };
         awaitFn: {

package/lib/rules/FunctionRuntime.js

@@ -447,8 +447,7 @@ class FunctionRuntimeImpl {
                         success = valueOf(args[4]);
                         error = valueOf(args[5]);
                     }
-                    (0, exports.request)(interpreter.globals, uri, httpVerb, payload, success, error, headers);
-                    return {};
+                    return (0, exports.request)(interpreter.globals, uri, httpVerb, payload, success, error, headers);
                 },
                 _signature: []
             },

package/lib/types/Json.d.ts

@@ -104,7 +104,7 @@ export declare type FieldJson = BaseJson & TranslationFieldJson & {
 export declare type CaptchaJson = FieldJson & {
     captchaDisplayMode?: CaptchaDisplayMode | undefined;
     captchaProvider?: string | undefined;
-    siteKey?: string | undefined;
+    captchaSiteKey?: string | undefined;
 };
 export declare type ContainerJson = BaseJson & {
     items: Array<FieldJson | ContainerJson>;

package/lib/types/Model.d.ts

@@ -132,6 +132,8 @@ export interface FormModel extends ContainerModel, WithState<FormJson> {
     resolveQualifiedName(qualifiedName: string): FieldModel | FieldsetModel | null;
     fieldAdded(field: FieldModel | FieldsetModel): void;
     readonly changeEventBehaviour: 'deps' | 'self';
+    addPromises(updates: Promise<any>): void;
+    waitForPromises(): any;
 }
 export interface IFormFieldFactory {
     createField(child: FieldsetJson | FieldJson, options: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aemforms/af-core",
-  "version": "0.22.110",
+  "version": "0.22.112",
   "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.110"
+    "@aemforms/af-formatters": "^0.22.112"
   },
   "devDependencies": {
     "@babel/preset-env": "^7.20.2",