@aemforms/af-core 0.22.19 → 0.22.22

package/lib/{Scriptable.js → esm/Scriptable.js}

@@ -1,23 +1,33 @@
-"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 BaseNode_1 = require("./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.
- */
-class Scriptable extends BaseNode_1.BaseNode {
-    constructor() {
-        super(...arguments);
-        this._events = {};
-        this._rules = {};
-    }
+/*************************************************************************
+* 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 { B as BaseNode, a as editableProperties } from './BaseNode-dc59ab07.js';
+import './controller/Events.js';
+import './utils/DataRefParser.js';
+import './data/DataGroup.js';
+import './data/DataValue.js';
+import './data/EmptyDataValue.js';
+
+class Scriptable extends BaseNode {
+    _events = {};
+    _rules = {};
     getRules() {
         return typeof this._jsonModel.rules !== 'object' ? {} : this._jsonModel.rules;
     }
@@ -39,9 +49,8 @@ class Scriptable extends BaseNode_1.BaseNode {
         return this._rules[eName];
     }
     getCompiledEvent(eName) {
-        var _a;
         if (!(eName in this._events)) {
-            let eString = (_a = this._jsonModel.events) === null || _a === void 0 ? void 0 : _a[eName];
+            let eString = this._jsonModel.events?.[eName];
             if (typeof eString === 'string' && eString.length > 0) {
                 eString = [eString];
             }
@@ -61,12 +70,8 @@ class Scriptable extends BaseNode_1.BaseNode {
     }
     applyUpdates(updates) {
         Object.entries(updates).forEach(([key, value]) => {
-            // @ts-ignore
-            // the first check is to disable accessing this.value & this.items property
-            // otherwise that will trigger dependency tracking
-            if (key in BaseNode_1.editableProperties || (key in this && typeof this[key] !== 'function')) {
+            if (key in editableProperties || (key in this && typeof this[key] !== 'function')) {
                 try {
-                    // @ts-ignore
                     this[key] = value;
                 }
                 catch (e) {
@@ -83,8 +88,7 @@ class Scriptable extends BaseNode_1.BaseNode {
                 const node = this.getCompiledRule(prop, rule);
                 if (node) {
                     const newVal = this.ruleEngine.execute(node, scope, context, true);
-                    if (BaseNode_1.editableProperties.indexOf(prop) > -1) {
-                        //@ts-ignore
+                    if (editableProperties.indexOf(prop) > -1) {
                         this[prop] = newVal;
                     }
                     else {
@@ -98,7 +102,7 @@ class Scriptable extends BaseNode_1.BaseNode {
         const parent = this.getNonTransparentParent();
         const target = {
             self: this.getRuleNode(),
-            siblings: (parent === null || parent === void 0 ? void 0 : parent.ruleNodeReference()) || {}
+            siblings: parent?.ruleNodeReference() || {}
         };
         const scope = new Proxy(target, {
             get: (target, prop) => {
@@ -106,20 +110,13 @@ class Scriptable extends BaseNode_1.BaseNode {
                     return 'Object';
                 }
                 prop = prop;
-                // The order of resolution is
-                // 1. property
-                // 2. sibling
-                // 3. child
                 if (prop.startsWith('$')) {
-                    //this returns children as well, so adding an explicit check for property name
                     const retValue = target.self[prop];
-                    if (retValue instanceof BaseNode_1.BaseNode) {
-                        //$parent
+                    if (retValue instanceof BaseNode) {
                         return retValue.getRuleNode();
                     }
                     else if (retValue instanceof Array) {
-                        //$items
-                        return retValue.map(r => r instanceof BaseNode_1.BaseNode ? r.getRuleNode() : r);
+                        return retValue.map(r => r instanceof BaseNode ? r.getRuleNode() : r);
                     }
                     else {
                         return retValue;
@@ -152,12 +149,6 @@ class Scriptable extends BaseNode_1.BaseNode {
             this.applyUpdates(updates);
         }
     }
-    /**
-     * Executes the given rule
-     * @param event
-     * @param context
-     * @private
-     */
     executeRule(event, context) {
         if (typeof event.payload.ruleName === 'undefined') {
             this.executeAllRules(context);
@@ -173,10 +164,6 @@ class Scriptable extends BaseNode_1.BaseNode {
         const node = this.ruleEngine.compileRule(expr);
         return this.ruleEngine.execute(node, this.getExpressionScope(), ruleContext);
     }
-    /**
-     * Executes the given action
-     * @param action    {@link Action | event object}
-     */
     executeAction(action) {
         const context = {
             'form': this.form,
@@ -192,15 +179,12 @@ class Scriptable extends BaseNode_1.BaseNode {
         const eventName = action.isCustomEvent ? `custom:${action.type}` : action.type;
         const funcName = action.isCustomEvent ? `custom_${action.type}` : action.type;
         const node = this.getCompiledEvent(eventName);
-        // @ts-ignore
         if (funcName in this && typeof this[funcName] === 'function') {
-            //@ts-ignore
             this[funcName](action, context);
         }
-        //todo: apply all the updates at the end  or
-        // not trigger the change event until the execution is finished
         node.forEach((n) => this.executeEvent(context, n));
         this.notifyDependents(action);
     }
 }
-exports.default = Scriptable;
+
+export { Scriptable as default };

package/lib/{controller → esm/controller}/EventQueue.d.ts

@@ -1,14 +1,6 @@
-/**
- * Defines event queue and event node
- */
-import { Action, BaseJson } from '../types';
-import { BaseNode } from '../BaseNode';
-import { Logger } from './Logger';
-/**
- * Implementation of event queue. When a user event, like change or click, is captured the expression to be evaluated
- * must be put in an Event Queue and then evaluated.
- * @private
- */
+import { Action, BaseJson } from '../types/index.js';
+import { BaseNode } from '../BaseNode.js';
+import { Logger } from './Logger.js';
 declare class EventQueue {
     private logger;
     static readonly MAX_EVENT_CYCLE_COUNT = 10;

package/lib/{controller → esm/controller}/EventQueue.js

@@ -1,18 +1,28 @@
-"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 Logger_1 = require("./Logger");
-/**
- * Implementation of event node
- * @private
- */
+/*************************************************************************
+* 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 { Logger } from './Logger.js';
+
 class EventNode {
+    _node;
+    _event;
     constructor(_node, _event) {
         this._node = _node;
         this._event = _event;
@@ -33,16 +43,14 @@ class EventNode {
         return this.toString();
     }
 }
-/**
- * Implementation of event queue. When a user event, like change or click, is captured the expression to be evaluated
- * must be put in an Event Queue and then evaluated.
- * @private
- */
 class EventQueue {
-    constructor(logger = new Logger_1.Logger('off')) {
+    logger;
+    static MAX_EVENT_CYCLE_COUNT = 10;
+    _runningEventCount;
+    _isProcessing = false;
+    _pendingEvents = [];
+    constructor(logger = new Logger('off')) {
         this.logger = logger;
-        this._isProcessing = false;
-        this._pendingEvents = [];
         this._runningEventCount = {};
     }
     get length() {
@@ -67,7 +75,6 @@ class EventQueue {
             const counter = this._runningEventCount[evntNode.valueOf()] || 0;
             if (counter < EventQueue.MAX_EVENT_CYCLE_COUNT) {
                 this.logger.info(`Queued event : ${e.type} node: ${node.id} - ${node.name}`);
-                //console.log(`Event Details ${e.toString()}`)
                 if (priority) {
                     const index = this._isProcessing ? 1 : 0;
                     this._pendingEvents.splice(index, 0, evntNode);
@@ -90,7 +97,6 @@ class EventQueue {
         while (this._pendingEvents.length > 0) {
             const e = this._pendingEvents[0];
             this.logger.info(`Dequeued event : ${e.event.type} node: ${e.node.id} - ${e.node.name}`);
-            //console.log(`Event Details ${e.event.toString()}`);
             e.node.executeAction(e.event);
             this._pendingEvents.shift();
         }
@@ -98,5 +104,5 @@ class EventQueue {
         this._isProcessing = false;
     }
 }
-EventQueue.MAX_EVENT_CYCLE_COUNT = 10;
-exports.default = EventQueue;
+
+export { EventQueue as default };

package/lib/esm/controller/Events.d.ts

@@ -0,0 +1,85 @@
+import { Action, BaseJson, FieldModel, FieldsetModel, FormModel, ValidationError } from '../types/index.js';
+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;
+}
+export type ChangePayload = {
+    changes: Array<{
+        propertyName: string;
+        prevValue?: any;
+        currentValue: any;
+    }>;
+};
+export declare class Change extends ActionImpl {
+    constructor(payload: ChangePayload, dispatch?: boolean);
+    withAdditionalChange(change: Change): Change;
+}
+export declare class Invalid extends ActionImpl {
+    constructor(payload?: any);
+}
+export declare class Valid extends ActionImpl {
+    constructor(payload?: any);
+}
+export declare class ExecuteRule extends ActionImpl {
+    constructor(payload?: any, dispatch?: boolean);
+}
+export declare const propertyChange: (propertyName: string, currentValue: any, prevValue?: any) => Change;
+export declare class Initialize extends ActionImpl {
+    constructor(payload?: any, dispatch?: boolean);
+}
+export declare class FormLoad extends ActionImpl {
+    constructor();
+}
+export declare class Click extends ActionImpl {
+    constructor(payload?: any, dispatch?: boolean);
+}
+export declare class Blur extends ActionImpl {
+    constructor(payload?: any, dispatch?: boolean);
+}
+export declare class ValidationComplete extends ActionImpl {
+    constructor(payload?: Array<ValidationError>, dispatch?: boolean);
+}
+export declare class Focus extends ActionImpl {
+    constructor();
+}
+export declare class Submit extends ActionImpl {
+    constructor(payload?: any, dispatch?: boolean);
+}
+export declare class Reset extends ActionImpl {
+    constructor(payload?: any, dispatch?: boolean);
+}
+export declare class FieldChanged extends ActionImpl {
+    constructor(changes: ChangePayload, field: BaseJson);
+}
+export declare class CustomEvent extends ActionImpl {
+    constructor(eventName: string, payload?: any, dispatch?: boolean);
+    get isCustomEvent(): boolean;
+}
+export declare class AddItem extends ActionImpl {
+    constructor(payload?: number);
+}
+export declare class RemoveItem extends ActionImpl {
+    constructor(payload?: number);
+}
+export declare class AddInstance extends ActionImpl {
+    constructor(payload?: number);
+}
+export declare class RemoveInstance extends ActionImpl {
+    constructor(payload?: number);
+}
+export {};

package/lib/esm/controller/Events.js

@@ -0,0 +1,171 @@
+/*************************************************************************
+* 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.
+*************************************************************************/
+
+class ActionImpl {
+    _metadata;
+    _type;
+    _payload;
+    _target;
+    constructor(payload, type, _metadata) {
+        this._metadata = _metadata;
+        this._payload = payload;
+        this._type = type;
+    }
+    get type() {
+        return this._type;
+    }
+    get payload() {
+        return this._payload;
+    }
+    get metadata() {
+        return this._metadata;
+    }
+    get target() {
+        return this._target;
+    }
+    get isCustomEvent() {
+        return false;
+    }
+    payloadToJson() {
+        return this.payload;
+    }
+    toJson() {
+        return {
+            payload: this.payloadToJson(),
+            type: this.type,
+            isCustomEvent: this.isCustomEvent
+        };
+    }
+    toString() {
+        return JSON.stringify(this.toJson());
+    }
+}
+class Change extends ActionImpl {
+    constructor(payload, dispatch = false) {
+        super(payload, 'change', { dispatch });
+    }
+    withAdditionalChange(change) {
+        return new Change(this.payload.changes.concat(change.payload.changes), this.metadata);
+    }
+}
+class Invalid extends ActionImpl {
+    constructor(payload = {}) {
+        super(payload, 'invalid', {});
+    }
+}
+class Valid extends ActionImpl {
+    constructor(payload = {}) {
+        super(payload, 'valid', {});
+    }
+}
+class ExecuteRule extends ActionImpl {
+    constructor(payload = {}, dispatch = false) {
+        super(payload, 'executeRule', { dispatch });
+    }
+}
+const propertyChange = (propertyName, currentValue, prevValue) => {
+    return new Change({
+        changes: [
+            {
+                propertyName,
+                currentValue,
+                prevValue
+            }
+        ]
+    });
+};
+class Initialize extends ActionImpl {
+    constructor(payload, dispatch = false) {
+        super(payload, 'initialize', { dispatch });
+    }
+}
+class FormLoad extends ActionImpl {
+    constructor() {
+        super({}, 'load', { dispatch: false });
+    }
+}
+class Click extends ActionImpl {
+    constructor(payload, dispatch = false) {
+        super(payload, 'click', { dispatch });
+    }
+}
+class Blur extends ActionImpl {
+    constructor(payload, dispatch = false) {
+        super(payload, 'blur', { dispatch });
+    }
+}
+class ValidationComplete extends ActionImpl {
+    constructor(payload, dispatch = false) {
+        super(payload, 'validationComplete', { dispatch });
+    }
+}
+class Focus extends ActionImpl {
+    constructor() {
+        super({}, 'focus', { dispatch: false });
+    }
+}
+class Submit extends ActionImpl {
+    constructor(payload, dispatch = false) {
+        super(payload, 'submit', { dispatch });
+    }
+}
+class Reset extends ActionImpl {
+    constructor(payload, dispatch = false) {
+        super(payload, 'reset', { dispatch });
+    }
+}
+class FieldChanged extends ActionImpl {
+    constructor(changes, field) {
+        super({
+            field,
+            changes
+        }, 'fieldChanged');
+    }
+}
+class CustomEvent extends ActionImpl {
+    constructor(eventName, payload = {}, dispatch = false) {
+        super(payload, eventName, { dispatch });
+    }
+    get isCustomEvent() {
+        return true;
+    }
+}
+class AddItem extends ActionImpl {
+    constructor(payload) {
+        super(payload, 'addItem');
+    }
+}
+class RemoveItem extends ActionImpl {
+    constructor(payload) {
+        super(payload, 'removeItem');
+    }
+}
+class AddInstance extends ActionImpl {
+    constructor(payload) {
+        super(payload, 'addInstance');
+    }
+}
+class RemoveInstance extends ActionImpl {
+    constructor(payload) {
+        super(payload, 'removeInstance');
+    }
+}
+
+export { AddInstance, AddItem, Blur, Change, Click, CustomEvent, ExecuteRule, FieldChanged, Focus, FormLoad, Initialize, Invalid, RemoveInstance, RemoveItem, Reset, Submit, Valid, ValidationComplete, propertyChange };

package/lib/{controller → esm/controller}/Logger.d.ts

@@ -1,11 +1,5 @@
-export declare type LogFunction = 'info' | 'warn' | 'error' | 'debug';
-/**
- * Logging levels.
- */
-export declare type LogLevel = 'off' | LogFunction;
-/**
- * @private
- */
+export type LogFunction = 'info' | 'warn' | 'error' | 'debug';
+export type LogLevel = 'off' | LogFunction;
 export declare class Logger {
     debug(msg: string): void;
     info(msg: string): void;

package/lib/esm/controller/Logger.js

@@ -0,0 +1,52 @@
+/*************************************************************************
+* 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.
+*************************************************************************/
+
+const levels = {
+    off: 0,
+    debug: 1,
+    info: 2,
+    warn: 3,
+    error: 4
+};
+class Logger {
+    debug(msg) {
+        this.log(msg, 'debug');
+    }
+    info(msg) {
+        this.log(msg, 'info');
+    }
+    warn(msg) {
+        this.log(msg, 'warn');
+    }
+    error(msg) {
+        this.log(msg, 'error');
+    }
+    log(msg, level) {
+        if (this.logLevel !== 0 && this.logLevel <= levels[level]) {
+            console[level](msg);
+        }
+    }
+    logLevel;
+    constructor(logLevel = 'off') {
+        this.logLevel = levels[logLevel];
+    }
+}
+
+export { Logger };

package/lib/{data → esm/data}/DataGroup.d.ts

@@ -1,10 +1,4 @@
-/**
- * Defines data group
- */
-import DataValue from './DataValue';
-/**
- * @private
- */
+import DataValue from './DataValue.js';
 export default class DataGroup extends DataValue {
     $_items: {
         [key: string]: DataValue | DataGroup;