@aemforms/af-core 0.22.19 → 0.22.22

package/lib/FormInstance.js

@@ -1,127 +0,0 @@
-"use strict";
-/*
- * Copyright 2022 Adobe, Inc.
- *
- * Your access and use of this software is governed by the Adobe Customer Feedback Program Terms and Conditions or other Beta License Agreement signed by your employer and Adobe, Inc.. This software is NOT open source and may not be used without one of the foregoing licenses. Even with a foregoing license, your access and use of this file is limited to the earlier of (a) 180 days, (b) general availability of the product(s) which utilize this software (i.e. AEM Forms), (c) January 1, 2023, (d) Adobe providing notice to you that you may no longer use the software or that your beta trial has otherwise ended.
- *
- * 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.
- */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fetchForm = exports.validateFormData = exports.validateFormInstance = exports.createFormInstance = void 0;
-const Form_1 = __importDefault(require("./Form"));
-const JsonUtils_1 = require("./utils/JsonUtils");
-const Fetch_1 = require("./utils/Fetch");
-const RuleEngine_1 = __importDefault(require("./rules/RuleEngine"));
-const EventQueue_1 = __importDefault(require("./controller/EventQueue"));
-const Logger_1 = require("./controller/Logger");
-/**
- * Creates form instance using form model definition as per `adaptive form specification`
- * @param formModel form model definition
- * @param callback a callback that recieves the FormModel instance that gets executed before any event in the Form
- * is executed
- * @param logLevel Logging Level for the form. Setting it off will disable the logging
- * @param fModel existing form model, this is additional optimization to prevent creation of form instance
- * @returns {@link FormModel | form model}
- */
-const createFormInstance = (formModel, callback, logLevel = 'error', fModel = undefined) => {
-    try {
-        let f = fModel;
-        if (f == null) {
-            f = new Form_1.default(Object.assign({}, formModel), 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);
-        }
-        if (typeof callback === 'function') {
-            callback(f);
-        }
-        // Once the field or panel is initialized, execute the initialization script
-        // this means initialization happens after prefill and restore
-        // Before execution of calcExp, visibleExp, enabledExp, validate, options, navigationChange, we execute init script
-        //f.queueEvent(new Initialize(undefined, true));
-        //f.queueEvent(new ExecuteRule(undefined, true));
-        f.getEventQueue().runPendingQueue();
-        return f;
-    }
-    catch (e) {
-        console.error(`Unable to create an instance of the Form ${e}`);
-        throw new Error(e);
-    }
-};
-exports.createFormInstance = createFormInstance;
-/**
- * Validates Form model definition with the given data
- * @param formModel     form model definition
- * @param data          form data
- * @deprecated use validateFormData
- * @returns `true`, if form is valid against the given form data, `false` otherwise
- */
-const validateFormInstance = (formModel, data) => {
-    try {
-        const f = new Form_1.default(Object.assign({}, formModel), new RuleEngine_1.default());
-        if (data) {
-            f.importData(data);
-        }
-        return f.validate().length === 0;
-    }
-    catch (e) {
-        throw new Error(e);
-    }
-};
-exports.validateFormInstance = validateFormInstance;
-/**
-* Validates Form model definition with the given data
-* @param formModel     form model definition
-* @param data          form data
-* @deprecated use validateFormData
-* @returns {messages: [], valid: boolean}
-*/
-const validateFormData = (formModel, data) => {
-    try {
-        const f = new Form_1.default(Object.assign({}, formModel), new RuleEngine_1.default());
-        if (data) {
-            f.importData(data);
-        }
-        const res = f.validate();
-        return {
-            messages: res,
-            valid: res.length === 0
-        };
-    }
-    catch (e) {
-        throw new Error(e);
-    }
-};
-exports.validateFormData = validateFormData;
-/**
- * Helper API to fetch form model definition from an AEM instance
- * @param url       URL of the instance
- * @param headers   HTTP headers to pass to the aem instance
- * @returns promise which resolves to the form model definition
- */
-const fetchForm = (url, headers = {}) => {
-    const headerObj = new Headers();
-    Object.entries(headers).forEach(([key, value]) => {
-        headerObj.append(key, value);
-    });
-    return new Promise((resolve, reject) => {
-        (0, Fetch_1.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((0, JsonUtils_1.jsonString)(formObj));
-            }
-        });
-    });
-};
-exports.fetchForm = fetchForm;

package/lib/FormMetaData.d.ts

@@ -1,11 +0,0 @@
-import { FormMetaDataModel, MetaDataJson } from './types';
-import Node from './Node';
-/**
- * Defines form metadata which implements {@link FormMetaDataModel | Form MetaData Model}
- */
-declare class FormMetaData extends Node<MetaDataJson> implements FormMetaDataModel {
-    get version(): string;
-    get locale(): string;
-    get grammar(): string;
-}
-export default FormMetaData;

package/lib/FormMetaData.js

@@ -1,28 +0,0 @@
-"use strict";
-/*
- * Copyright 2022 Adobe, Inc.
- *
- * Your access and use of this software is governed by the Adobe Customer Feedback Program Terms and Conditions or other Beta License Agreement signed by your employer and Adobe, Inc.. This software is NOT open source and may not be used without one of the foregoing licenses. Even with a foregoing license, your access and use of this file is limited to the earlier of (a) 180 days, (b) general availability of the product(s) which utilize this software (i.e. AEM Forms), (c) January 1, 2023, (d) Adobe providing notice to you that you may no longer use the software or that your beta trial has otherwise ended.
- *
- * 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.
- */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const Node_1 = __importDefault(require("./Node"));
-/**
- * Defines form metadata which implements {@link FormMetaDataModel | Form MetaData Model}
- */
-class FormMetaData extends Node_1.default {
-    get version() {
-        return this.getP('version', '');
-    }
-    get locale() {
-        return this.getP('locale', '');
-    }
-    get grammar() {
-        return this.getP('grammar', '');
-    }
-}
-exports.default = FormMetaData;

package/lib/InstanceManager.d.ts

@@ -1,16 +0,0 @@
-import { Action, FieldJson, FieldModel, FieldsetJson, FieldsetModel } from './types';
-import { Fieldset } from './Fieldset';
-export declare class InstanceManager extends Fieldset implements FieldsetModel {
-    get maxOccur(): number;
-    set maxOccur(m: number);
-    get minOccur(): number;
-    /**
-     * @private
-     */
-    addInstance(action: Action): void;
-    /**
-     * @private
-     */
-    removeInstance(action: Action): void;
-    protected _createChild(child: FieldsetJson | FieldJson, options: any): FieldModel | FieldsetModel;
-}

package/lib/InstanceManager.js

@@ -1,53 +0,0 @@
-"use strict";
-/*
- * Copyright 2022 Adobe, Inc.
- *
- * Your access and use of this software is governed by the Adobe Customer Feedback Program Terms and Conditions or other Beta License Agreement signed by your employer and Adobe, Inc.. This software is NOT open source and may not be used without one of the foregoing licenses. Even with a foregoing license, your access and use of this file is limited to the earlier of (a) 180 days, (b) general availability of the product(s) which utilize this software (i.e. AEM Forms), (c) January 1, 2023, (d) Adobe providing notice to you that you may no longer use the software or that your beta trial has otherwise ended.
- *
- * 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.
- */
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InstanceManager = void 0;
-const Fieldset_1 = require("./Fieldset");
-const BaseNode_1 = require("./BaseNode");
-const FormCreationUtils_1 = require("./utils/FormCreationUtils");
-class InstanceManager extends Fieldset_1.Fieldset {
-    get maxOccur() {
-        return this._jsonModel.maxItems;
-    }
-    set maxOccur(m) {
-        this.maxItems = m;
-    }
-    get minOccur() {
-        return this.minItems;
-    }
-    /**
-     * @private
-     */
-    addInstance(action) {
-        return this.addItem(action);
-    }
-    /**
-     * @private
-     */
-    removeInstance(action) {
-        return this.removeItem(action);
-    }
-    _createChild(child, options) {
-        const { parent = this } = options;
-        return (0, FormCreationUtils_1.createChild)(child, { form: this.form, parent: parent }, true);
-    }
-}
-__decorate([
-    (0, BaseNode_1.dependencyTracked)()
-], InstanceManager.prototype, "maxOccur", null);
-__decorate([
-    (0, BaseNode_1.dependencyTracked)()
-], InstanceManager.prototype, "minOccur", null);
-exports.InstanceManager = InstanceManager;

package/lib/Node.d.ts

@@ -1,12 +0,0 @@
-/**
- * Defines generic form object class which any form runtime model (like textbox, checkbox etc)
- * should extend from.
- * @typeparam T type of the node (for example, {@link MetaDataJson | form meta data}
- */
-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/Node.js

@@ -1,27 +0,0 @@
-"use strict";
-/*
- * Copyright 2022 Adobe, Inc.
- *
- * Your access and use of this software is governed by the Adobe Customer Feedback Program Terms and Conditions or other Beta License Agreement signed by your employer and Adobe, Inc.. This software is NOT open source and may not be used without one of the foregoing licenses. Even with a foregoing license, your access and use of this file is limited to the earlier of (a) 180 days, (b) general availability of the product(s) which utilize this software (i.e. AEM Forms), (c) January 1, 2023, (d) Adobe providing notice to you that you may no longer use the software or that your beta trial has otherwise ended.
- *
- * 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 JsonUtils_1 = require("./utils/JsonUtils");
-/**
- * Defines generic form object class which any form runtime model (like textbox, checkbox etc)
- * should extend from.
- * @typeparam T type of the node (for example, {@link MetaDataJson | form meta data}
- */
-class Node {
-    constructor(inputModel) {
-        this._jsonModel = Object.assign({}, inputModel);
-    }
-    getP(key, def) {
-        return (0, JsonUtils_1.getProperty)(this._jsonModel, key, def);
-    }
-    get isContainer() {
-        return false;
-    }
-}
-exports.default = Node;

package/lib/Scriptable.d.ts

@@ -1,31 +0,0 @@
-import { Action, RulesJson, ScriptableField } from './types';
-import { BaseNode } from './BaseNode';
-/**
- * Defines scriptable aspects (ie rules, events) of form runtime model. Any form runtime object which requires
- * execution of rules/events should extend from this class.
- */
-declare abstract class Scriptable<T extends RulesJson> extends BaseNode<T> implements ScriptableField {
-    private _events;
-    private _rules;
-    getRules(): import("./types").Items<string>;
-    private getCompiledRule;
-    private getCompiledEvent;
-    private applyUpdates;
-    protected executeAllRules(context: any): void;
-    private getExpressionScope;
-    private executeEvent;
-    /**
-     * Executes the given rule
-     * @param event
-     * @param context
-     * @private
-     */
-    executeRule(event: Action, context: any): void;
-    executeExpression(expr: string): any;
-    /**
-     * Executes the given action
-     * @param action    {@link Action | event object}
-     */
-    executeAction(action: Action): void;
-}
-export default Scriptable;

package/lib/controller/Controller.d.ts

@@ -1,255 +0,0 @@
-/**
- * Defines all form events
- */
-import { Action, BaseJson, FieldModel, FieldsetModel, FormModel, ValidationError } from '../types';
-/**
- * Implementation of generic event
- * @private
- */
-export declare class ActionImpl implements Action {
-    private _metadata?;
-    protected _type: string;
-    private _payload?;
-    private _target;
-    constructor(payload: any, type: string, _metadata?: any);
-    get type(): string;
-    get payload(): any;
-    get metadata(): any;
-    get target(): FormModel | FieldModel | FieldsetModel;
-    get isCustomEvent(): boolean;
-    protected payloadToJson(): any;
-    toJson(): {
-        payload: any;
-        type: string;
-        isCustomEvent: boolean;
-    };
-    toString(): string;
-}
-/**
- * Payload of change event
- */
-export declare type ChangePayload = {
-    /**
-     * List of changes
-     */
-    changes: Array<{
-        /**
-         * Name of the property which has changed
-         */
-        propertyName: string;
-        /**
-         * Previous value of the property changed
-         */
-        prevValue?: any;
-        /**
-         * Current value of the property changed
-         */
-        currentValue: any;
-    }>;
-};
-/**
- * Implementation of `change` event. The change event is triggered on the field whenever the value of the field is changed
- */
-export declare class Change extends ActionImpl {
-    /**
-     * @constructor
-     * @param [payload] event payload
-     * @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
- */
-export declare class Invalid extends ActionImpl {
-    /**
-     * @constructor
-     * @param [payload] event payload
-     */
-    constructor(payload?: any);
-}
-/**
- * Implementation of `valid` event. The valid event is triggered whenever the field’s valid state is changed from invalid to valid.
- */
-export declare class Valid extends ActionImpl {
-    /**
-     * @constructor
-     * @param [payload] event payload
-     */
-    constructor(payload?: any);
-}
-/**
- * Implementation of an ExecuteRule event.
- * @private
- */
-export declare class ExecuteRule extends ActionImpl {
-    /**
-     * @constructor
-     * @param [payload] event payload
-     * @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?: any, dispatch?: boolean);
-}
-/**
- * Creates a change event
- * @param propertyName  name of the form field property
- * @param currentValue  current value
- * @param prevValue     previous value
- * @returns {@link Change} change event
- */
-export declare const propertyChange: (propertyName: string, currentValue: any, prevValue?: any) => Change;
-/**
- * Implementation of `initialize` event. The event is triggered on all the fields when the form initialisation is complete
- */
-export declare class Initialize extends ActionImpl {
-    /**
-     * @constructor
-     * @param [payload] event payload
-     * @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?: any, dispatch?: boolean);
-}
-/**
- * Implementation of `load` event. The event is when the form initialization is complete
- */
-export declare class FormLoad extends ActionImpl {
-    /**
-     * @constructor
-     */
-    constructor();
-}
-/**
- * Implementation of `click` event. The event is triggered when user clicks on an element.
- */
-export declare class Click extends ActionImpl {
-    /**
-     * @constructor
-     * @param [payload] event payload
-     * @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?: any, dispatch?: boolean);
-}
-/**
- * Implementation of `blur` event. The event is triggered when the element loses focus.
- */
-export declare class Blur extends ActionImpl {
-    /**
-     * @constructor
-     * @param [payload] event payload
-     * @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?: any, dispatch?: boolean);
-}
-/**
- * Implementation of `ValidationComplete` event. The ValidationComplete event is triggered once validation is completed
- * on the form.
- *
- * An example of using this event,
- * ```
- * function onValidationComplete(event) {
- *	 const x = event.payload[0].id;
- *	 // do something with the invalid field
- * }
- * ```
- */
-export declare class ValidationComplete extends ActionImpl {
-    /**
-     * @constructor
-     * @param [payload] event payload (ie) list of {@link ValidationError | validation errors}
-     * @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?: Array<ValidationError>, dispatch?: boolean);
-}
-export declare class Focus extends ActionImpl {
-    /**
-     * @constructor
-     */
-    constructor();
-}
-/**
- * Implementation of `submit` event. The submit event is triggered on the Form.
- * To trigger the submit event, submit function needs to be invoked or one can invoke dispatchEvent API.
- */
-export declare class Submit extends ActionImpl {
-    /**
-     * @constructor
-     * @param [payload] event payload
-     * @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?: any, dispatch?: boolean);
-}
-/**
- * Implementation of `reset` event. The reset event is triggered on the Form.
- * To trigger the reset event, reset function needs to be invoked or one can invoke dispatchEvent API.
- */
-export declare class Reset extends ActionImpl {
-    /**
-     * @constructor
-     * @param [payload] event payload
-     * @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?: any, dispatch?: boolean);
-}
-/**
- * Implementation of `fieldChanged` event. The field changed event is triggered on the field which it has changed.
- */
-export declare class FieldChanged extends ActionImpl {
-    constructor(changes: ChangePayload, field: BaseJson);
-}
-/**
- * Implementation of `custom event`.
- */
-export declare class CustomEvent extends ActionImpl {
-    /**
-     * @constructor
-     * @param [eventName] name of the event
-     * @param [payload] event payload
-     * @param [dispatch] true to trigger the event on all the fields in DFS order starting from the top level form element, false otherwise
-     */
-    constructor(eventName: string, payload?: any, dispatch?: boolean);
-    /**
-     * Defines if the event is custom
-     */
-    get isCustomEvent(): boolean;
-}
-/**
- * Implementation of `addItem` event. The event is triggered on a panel to add a new instance of items inside it.
- */
-export declare class AddItem extends ActionImpl {
-    /**
-     * @constructor
-     * @param [payload] event payload
-     */
-    constructor(payload?: number);
-}
-/**
- * Implementation of `removeItem` event. The event is triggered on a panel to remove an instance of items inside it.
- */
-export declare class RemoveItem extends ActionImpl {
-    /**
-     * @constructor
-     * @param [payload] event payload
-     */
-    constructor(payload?: number);
-}
-/**
- * Implementation of `addInstance` event. The event is triggered on a field to add an instance of it.
- */
-export declare class AddInstance extends ActionImpl {
-    /**
-     * @constructor
-     * @param [payload] event payload
-     */
-    constructor(payload?: number);
-}
-/**
- * Implementation of `removeInstance` event. The event is triggered on a field to remove an instance of it.
- */
-export declare class RemoveInstance extends ActionImpl {
-    /**
-     * @constructor
-     * @param [payload] event payload
-     */
-    constructor(payload?: number);
-}