@aemforms/af-core 0.22.19 → 0.22.22

package/lib/esm/Form.js

@@ -0,0 +1,208 @@
+/*************************************************************************
+* ADOBE CONFIDENTIAL
+* ___________________
+*
+* Copyright 2022 Adobe
+* All Rights Reserved.
+*
+* NOTICE: All information contained herein is, and remains
+* the property of Adobe and its suppliers, if any. The intellectual
+* and technical concepts contained herein are proprietary to Adobe
+* and its suppliers and are protected by all applicable intellectual
+* property laws, including trade secret and copyright laws.
+* Dissemination of this information or reproduction of this material
+* is strictly forbidden unless prior written permission is obtained
+* from Adobe.
+
+* Adobe permits you to use and modify this file solely in accordance with
+* the terms of the Adobe license agreement accompanying it.
+*************************************************************************/
+
+import Container from './Container.js';
+import FormMetaData from './FormMetaData.js';
+import EventQueue from './controller/EventQueue.js';
+import { Logger } from './controller/Logger.js';
+import { IdGenerator, getAttachments } from './utils/FormUtils.js';
+import DataGroup from './data/DataGroup.js';
+import { submit } from './rules/FunctionRuntime.js';
+import { Initialize, ExecuteRule, FormLoad, FieldChanged, ValidationComplete } from './controller/Events.js';
+import './BaseNode-dc59ab07.js';
+import './utils/DataRefParser.js';
+import './data/DataValue.js';
+import './data/EmptyDataValue.js';
+import './utils/JsonUtils.js';
+import './types/Json.js';
+import './utils/SchemaUtils.js';
+import './Scriptable.js';
+import './Node.js';
+import './FileObject.js';
+import './utils/Fetch.js';
+
+class Form extends Container {
+    _ruleEngine;
+    _eventQueue;
+    _fields = {};
+    _ids;
+    _invalidFields = [];
+    _logger;
+    constructor(n, fieldFactory, _ruleEngine, _eventQueue = new EventQueue(), logLevel = 'off') {
+        super(n, { fieldFactory: fieldFactory });
+        this._ruleEngine = _ruleEngine;
+        this._eventQueue = _eventQueue;
+        this._logger = new Logger(logLevel);
+        this.queueEvent(new Initialize());
+        this.queueEvent(new ExecuteRule());
+        this._ids = IdGenerator();
+        this._bindToDataModel(new DataGroup('$form', {}));
+        this._initialize();
+        this.queueEvent(new FormLoad());
+    }
+    get logger() {
+        return this._logger;
+    }
+    dataRefRegex = /("[^"]+?"|[^.]+?)(?:\.|$)/g;
+    get metaData() {
+        const metaData = this._jsonModel.metadata || {};
+        return new FormMetaData(metaData);
+    }
+    get action() {
+        return this._jsonModel.action;
+    }
+    get lang() {
+        return this._jsonModel.lang || 'en';
+    }
+    importData(dataModel) {
+        this._bindToDataModel(new DataGroup('$form', dataModel));
+        this.syncDataAndFormModel(this.getDataNode());
+        this._eventQueue.runPendingQueue();
+    }
+    exportData() {
+        return this.getDataNode()?.$value;
+    }
+    setFocus(field) {
+        const parent = field.parent;
+        const currentField = field;
+        while (parent != null && parent.activeChild != currentField) {
+            parent.activeChild = currentField;
+        }
+    }
+    getState() {
+        const self = this;
+        const res = super.getState();
+        res.id = '$form';
+        Object.defineProperty(res, 'data', {
+            get: function () {
+                return self.exportData();
+            }
+        });
+        Object.defineProperty(res, 'attachments', {
+            get: function () {
+                return getAttachments(self);
+            }
+        });
+        return res;
+    }
+    get type() {
+        return 'object';
+    }
+    isTransparent() {
+        return false;
+    }
+    get form() {
+        return this;
+    }
+    get ruleEngine() {
+        return this._ruleEngine;
+    }
+    getUniqueId() {
+        if (this._ids == null) {
+            return '';
+        }
+        return this._ids.next().value;
+    }
+    fieldAdded(field) {
+        this._fields[field.id] = field;
+        field.subscribe((action) => {
+            if (this._invalidFields.indexOf(action.target.id) === -1) {
+                this._invalidFields.push(action.target.id);
+            }
+        }, 'invalid');
+        field.subscribe((action) => {
+            const index = this._invalidFields.indexOf(action.target.id);
+            if (index > -1) {
+                this._invalidFields.splice(index, 1);
+            }
+        }, 'valid');
+        field.subscribe((action) => {
+            const field = action.target.getState();
+            if (field) {
+                const fieldChangedAction = new FieldChanged(action.payload.changes, field);
+                this.dispatch(fieldChangedAction);
+            }
+        });
+    }
+    visit(callBack) {
+        this.traverseChild(this, callBack);
+    }
+    traverseChild(container, callBack) {
+        container.items.forEach((field) => {
+            if (field.isContainer) {
+                this.traverseChild(field, callBack);
+            }
+            callBack(field);
+        });
+    }
+    validate() {
+        const validationErrors = super.validate();
+        this.dispatch(new ValidationComplete(validationErrors));
+        return validationErrors;
+    }
+    isValid() {
+        return this._invalidFields.length === 0;
+    }
+    dispatch(action) {
+        if (action.type === 'submit') {
+            super.queueEvent(action);
+            this._eventQueue.runPendingQueue();
+        }
+        else {
+            super.dispatch(action);
+        }
+    }
+    submit(action, context) {
+        if (this.validate().length === 0) {
+            const payload = action?.payload || {};
+            submit(context, payload?.success, payload?.error, payload?.submit_as, payload?.data);
+        }
+    }
+    reset() {
+        super.reset();
+        this._invalidFields = [];
+    }
+    getElement(id) {
+        if (id == this.id) {
+            return this;
+        }
+        return this._fields[id];
+    }
+    get qualifiedName() {
+        return '$form';
+    }
+    getEventQueue() {
+        return this._eventQueue;
+    }
+    get name() {
+        return '$form';
+    }
+    get value() {
+        return null;
+    }
+    get id() {
+        return '$form';
+    }
+    get title() {
+        return this._jsonModel.title || '';
+    }
+}
+
+export { Form as default };

package/lib/esm/FormInstance.d.ts

@@ -0,0 +1,13 @@
+import { FormModel } from './types/index.js';
+import { LogLevel } from './controller/Logger.js';
+import { CustomFunction, FunctionDefinition } from './rules/FunctionRuntime.js';
+export declare const createFormInstance: (formModel: any, callback?: ((f: FormModel) => any) | undefined, logLevel?: LogLevel, fModel?: any) => FormModel;
+export declare const validateFormInstance: (formModel: any, data: any) => boolean;
+export declare const validateFormData: (formModel: any, data: any) => {
+    messages: any[];
+    valid: boolean;
+};
+export declare const fetchForm: (url: string, headers?: any) => Promise<string>;
+export declare const registerFunctions: (functions: {
+    [key: string]: Function | FunctionDefinition;
+}) => void;

package/lib/esm/FormInstance.js

@@ -0,0 +1,129 @@
+/*************************************************************************
+* ADOBE CONFIDENTIAL
+* ___________________
+*
+* Copyright 2022 Adobe
+* All Rights Reserved.
+*
+* NOTICE: All information contained herein is, and remains
+* the property of Adobe and its suppliers, if any. The intellectual
+* and technical concepts contained herein are proprietary to Adobe
+* and its suppliers and are protected by all applicable intellectual
+* property laws, including trade secret and copyright laws.
+* Dissemination of this information or reproduction of this material
+* is strictly forbidden unless prior written permission is obtained
+* from Adobe.
+
+* Adobe permits you to use and modify this file solely in accordance with
+* the terms of the Adobe license agreement accompanying it.
+*************************************************************************/
+
+import Form from './Form.js';
+import { jsonString } from './utils/JsonUtils.js';
+import { request } from './utils/Fetch.js';
+import RuleEngine from './rules/RuleEngine.js';
+import EventQueue from './controller/EventQueue.js';
+import { Logger } from './controller/Logger.js';
+import { FormFieldFactory } from './utils/FormCreationUtils.js';
+import { FunctionRuntime } from './rules/FunctionRuntime.js';
+import './Container.js';
+import './BaseNode-dc59ab07.js';
+import './controller/Events.js';
+import './utils/DataRefParser.js';
+import './data/DataGroup.js';
+import './data/DataValue.js';
+import './data/EmptyDataValue.js';
+import './Scriptable.js';
+import './types/Json.js';
+import './utils/SchemaUtils.js';
+import './FormMetaData.js';
+import './Node.js';
+import './utils/FormUtils.js';
+import './FileObject.js';
+import '@adobe/json-formula';
+import './InstanceManager.js';
+import './Fieldset.js';
+import './FileUpload.js';
+import './Field.js';
+import './types/Model.js';
+import './utils/ValidationUtils.js';
+import '@aemforms/af-formatters';
+import './Checkbox.js';
+import './CheckboxGroup.js';
+import './DateField.js';
+
+const createFormInstance = (formModel, callback, logLevel = 'error', fModel = undefined) => {
+    try {
+        let f = fModel;
+        if (f == null) {
+            f = new Form({ ...formModel }, FormFieldFactory, new RuleEngine(), new EventQueue(new Logger(logLevel)), logLevel);
+        }
+        const formData = formModel?.data;
+        if (formData) {
+            f.importData(formData);
+        }
+        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 validateFormInstance = (formModel, data) => {
+    try {
+        const f = new Form({ ...formModel }, FormFieldFactory, new RuleEngine());
+        if (data) {
+            f.importData(data);
+        }
+        return f.validate().length === 0;
+    }
+    catch (e) {
+        throw new Error(e);
+    }
+};
+const validateFormData = (formModel, data) => {
+    try {
+        const f = new Form({ ...formModel }, FormFieldFactory, new RuleEngine());
+        if (data) {
+            f.importData(data);
+        }
+        const res = f.validate();
+        return {
+            messages: res,
+            valid: res.length === 0
+        };
+    }
+    catch (e) {
+        throw new Error(e);
+    }
+};
+const fetchForm = (url, headers = {}) => {
+    const headerObj = new Headers();
+    Object.entries(headers).forEach(([key, value]) => {
+        headerObj.append(key, value);
+    });
+    return new Promise((resolve, reject) => {
+        request(`${url}.model.json`, null, { headers }).then((response) => {
+            if (response.status !== 200) {
+                reject('Not Found');
+            }
+            else {
+                let formObj = response.body;
+                if ('model' in formObj) {
+                    const { model } = formObj;
+                    formObj = model;
+                }
+                resolve(jsonString(formObj));
+            }
+        });
+    });
+};
+const registerFunctions = (functions) => {
+    FunctionRuntime.registerFunctions(functions);
+};
+
+export { createFormInstance, fetchForm, registerFunctions, validateFormData, validateFormInstance };

package/lib/esm/FormMetaData.d.ts

@@ -0,0 +1,7 @@
+import { FormMetaDataModel, MetaDataJson } from './types/index.js';
+import Node from './Node.js';
+declare class FormMetaData extends Node<MetaDataJson> implements FormMetaDataModel {
+    get version(): string;
+    get grammar(): string;
+}
+export default FormMetaData;

package/lib/esm/FormMetaData.js

@@ -0,0 +1,35 @@
+/*************************************************************************
+* ADOBE CONFIDENTIAL
+* ___________________
+*
+* Copyright 2022 Adobe
+* All Rights Reserved.
+*
+* NOTICE: All information contained herein is, and remains
+* the property of Adobe and its suppliers, if any. The intellectual
+* and technical concepts contained herein are proprietary to Adobe
+* and its suppliers and are protected by all applicable intellectual
+* property laws, including trade secret and copyright laws.
+* Dissemination of this information or reproduction of this material
+* is strictly forbidden unless prior written permission is obtained
+* from Adobe.
+
+* Adobe permits you to use and modify this file solely in accordance with
+* the terms of the Adobe license agreement accompanying it.
+*************************************************************************/
+
+import Node from './Node.js';
+import './utils/JsonUtils.js';
+import './types/Json.js';
+import './utils/SchemaUtils.js';
+
+class FormMetaData extends Node {
+    get version() {
+        return this.getP('version', '');
+    }
+    get grammar() {
+        return this.getP('grammar', '');
+    }
+}
+
+export { FormMetaData as default };

package/lib/esm/InstanceManager.d.ts

@@ -0,0 +1,9 @@
+import { Action, FieldsetModel } from './types/index.js';
+import { Fieldset } from './Fieldset.js';
+export declare class InstanceManager extends Fieldset implements FieldsetModel {
+    get maxOccur(): number;
+    set maxOccur(m: number);
+    get minOccur(): number;
+    addInstance(action: Action): void;
+    removeInstance(action: Action): void;
+}

package/lib/esm/InstanceManager.js

@@ -0,0 +1,58 @@
+/*************************************************************************
+* ADOBE CONFIDENTIAL
+* ___________________
+*
+* Copyright 2022 Adobe
+* All Rights Reserved.
+*
+* NOTICE: All information contained herein is, and remains
+* the property of Adobe and its suppliers, if any. The intellectual
+* and technical concepts contained herein are proprietary to Adobe
+* and its suppliers and are protected by all applicable intellectual
+* property laws, including trade secret and copyright laws.
+* Dissemination of this information or reproduction of this material
+* is strictly forbidden unless prior written permission is obtained
+* from Adobe.
+
+* Adobe permits you to use and modify this file solely in accordance with
+* the terms of the Adobe license agreement accompanying it.
+*************************************************************************/
+
+import { _ as __decorate, d as dependencyTracked } from './BaseNode-dc59ab07.js';
+import { Fieldset } from './Fieldset.js';
+import './controller/Events.js';
+import './utils/DataRefParser.js';
+import './data/DataGroup.js';
+import './data/DataValue.js';
+import './data/EmptyDataValue.js';
+import './Container.js';
+import './utils/JsonUtils.js';
+import './types/Json.js';
+import './utils/SchemaUtils.js';
+import './Scriptable.js';
+
+class InstanceManager extends Fieldset {
+    get maxOccur() {
+        return this._jsonModel.maxItems;
+    }
+    set maxOccur(m) {
+        this.maxItems = m;
+    }
+    get minOccur() {
+        return this.minItems;
+    }
+    addInstance(action) {
+        return this.addItem(action);
+    }
+    removeInstance(action) {
+        return this.removeItem(action);
+    }
+}
+__decorate([
+    dependencyTracked()
+], InstanceManager.prototype, "maxOccur", null);
+__decorate([
+    dependencyTracked()
+], InstanceManager.prototype, "minOccur", null);
+
+export { InstanceManager };

package/lib/esm/Node.d.ts

@@ -0,0 +1,7 @@
+declare class Node<T> {
+    protected _jsonModel: T;
+    constructor(inputModel: T);
+    protected getP<S>(key: string, def: S): S;
+    get isContainer(): boolean;
+}
+export default Node;

package/lib/esm/Node.js

@@ -0,0 +1,40 @@
+/*************************************************************************
+* ADOBE CONFIDENTIAL
+* ___________________
+*
+* Copyright 2022 Adobe
+* All Rights Reserved.
+*
+* NOTICE: All information contained herein is, and remains
+* the property of Adobe and its suppliers, if any. The intellectual
+* and technical concepts contained herein are proprietary to Adobe
+* and its suppliers and are protected by all applicable intellectual
+* property laws, including trade secret and copyright laws.
+* Dissemination of this information or reproduction of this material
+* is strictly forbidden unless prior written permission is obtained
+* from Adobe.
+
+* Adobe permits you to use and modify this file solely in accordance with
+* the terms of the Adobe license agreement accompanying it.
+*************************************************************************/
+
+import { getProperty } from './utils/JsonUtils.js';
+import './types/Json.js';
+import './utils/SchemaUtils.js';
+
+class Node {
+    _jsonModel;
+    constructor(inputModel) {
+        this._jsonModel = {
+            ...inputModel
+        };
+    }
+    getP(key, def) {
+        return getProperty(this._jsonModel, key, def);
+    }
+    get isContainer() {
+        return false;
+    }
+}
+
+export { Node as default };

package/lib/esm/Scriptable.d.ts

@@ -0,0 +1,17 @@
+import { Action, RulesJson, ScriptableField } from './types/index.js';
+import { BaseNode } from './BaseNode.js';
+declare abstract class Scriptable<T extends RulesJson> extends BaseNode<T> implements ScriptableField {
+    private _events;
+    private _rules;
+    getRules(): import("./types/Json.js").Items<string>;
+    private getCompiledRule;
+    private getCompiledEvent;
+    private applyUpdates;
+    protected executeAllRules(context: any): void;
+    private getExpressionScope;
+    private executeEvent;
+    executeRule(event: Action, context: any): void;
+    executeExpression(expr: string): any;
+    executeAction(action: Action): void;
+}
+export default Scriptable;