@aemforms/af-core 0.22.78 → 0.22.80

package/esm/afb-events.js

@@ -3,6 +3,7 @@ class ActionImpl {
     _type;
     _payload;
     _target;
+    _currentTarget;
     constructor(payload, type, _metadata) {
         this._metadata = _metadata;
         this._payload = payload;
@@ -20,6 +21,9 @@ class ActionImpl {
     get target() {
         return this._target;
     }
+    get currentTarget() {
+        return this._currentTarget;
+    }
     get isCustomEvent() {
         return false;
     }
@@ -106,6 +110,11 @@ class Submit extends ActionImpl {
         super(payload, 'submit', { dispatch });
     }
 }
+class Save extends ActionImpl {
+    constructor(payload, dispatch = false) {
+        super(payload, 'save', { dispatch });
+    }
+}
 class SubmitSuccess extends ActionImpl {
     constructor(payload, dispatch = false) {
         super(payload, 'submitSuccess', { dispatch });
@@ -163,4 +172,4 @@ class RemoveInstance extends ActionImpl {
     }
 }
 
-export { AddInstance, AddItem, Blur, Change, Click, CustomEvent, ExecuteRule, FieldChanged, Focus, FormLoad, Initialize, Invalid, RemoveInstance, RemoveItem, Reset, Submit, SubmitError, SubmitFailure, SubmitSuccess, Valid, ValidationComplete, propertyChange };
+export { AddInstance, AddItem, Blur, Change, Click, CustomEvent, ExecuteRule, FieldChanged, Focus, FormLoad, Initialize, Invalid, RemoveInstance, RemoveItem, Reset, Save, Submit, SubmitError, SubmitFailure, SubmitSuccess, Valid, ValidationComplete, propertyChange };

package/esm/afb-runtime.js

@@ -1,4 +1,4 @@
-import { propertyChange, ExecuteRule, Initialize, RemoveItem, SubmitSuccess, CustomEvent, SubmitError, SubmitFailure, Submit, RemoveInstance, AddInstance, Reset, AddItem, Click, Change, FormLoad, FieldChanged, ValidationComplete, Valid, Invalid } from './afb-events.js';
+import { propertyChange, ExecuteRule, Initialize, RemoveItem, SubmitSuccess, CustomEvent, SubmitError, SubmitFailure, Submit, Save, RemoveInstance, AddInstance, Reset, AddItem, Click, Change, FormLoad, FieldChanged, ValidationComplete, Valid, Invalid } from './afb-events.js';
 import Formula from '@adobe/json-formula';
 import { parseDefaultDate, datetimeToNumber, format, parseDateSkeleton, formatDate, numberToDatetime } from '@aemforms/af-formatters';
 
@@ -1131,9 +1131,17 @@ const staticFields = ['plain-text', 'image'];
 class ActionImplWithTarget {
     _action;
     _target;
+    _currentTarget;
     constructor(_action, _target) {
         this._action = _action;
-        this._target = _target;
+        if (_action.target) {
+            this._currentTarget = _target;
+            this._target = _action.target;
+        }
+        else {
+            this._target = _target;
+            this._currentTarget = _target;
+        }
     }
     get type() {
         return this._action.type;
@@ -1147,6 +1155,9 @@ class ActionImplWithTarget {
     get target() {
         return this._target;
     }
+    get currentTarget() {
+        return this._currentTarget;
+    }
     get isCustomEvent() {
         return this._action.isCustomEvent;
     }
@@ -1331,9 +1342,12 @@ class BaseNode {
         return this._jsonModel.uniqueItems;
     }
     isTransparent() {
-        const isNonTransparent = this.parent?._jsonModel.type === 'array';
+        const isNonTransparent = this.parent?._jsonModel?.type === 'array';
         return !this._jsonModel.name && !isNonTransparent;
     }
+    getDependents() {
+        return this._dependents.map(x => x.node.id);
+    }
     getState(forRestore = false) {
         return {
             ...this._jsonModel,
@@ -1348,7 +1362,7 @@ class BaseNode {
             } : {}),
             ':type': this[':type'],
             ...(forRestore ? {
-                _dependents: this._dependents.length ? this._dependents.map(x => x.node.id) : undefined,
+                _dependents: this._dependents.length ? this.getDependents() : undefined,
                 allowedComponents: undefined,
                 columnClassNames: undefined,
                 columnCount: undefined,
@@ -1374,7 +1388,12 @@ class BaseNode {
                     return propsToLook.indexOf(x.propertyName) > -1;
                 }) > -1;
                 if (isPropChanged) {
-                    dependent.dispatch(new ExecuteRule());
+                    if (this.form.changeEventBehaviour === 'deps') {
+                        dependent.dispatch(change);
+                    }
+                    else {
+                        dependent.dispatch(new ExecuteRule());
+                    }
                 }
             });
             this._dependents.push({ node: dependent, subscription });
@@ -1651,16 +1670,23 @@ class Scriptable extends BaseNode {
         return this._events[eName] || [];
     }
     applyUpdates(updates) {
-        Object.entries(updates).forEach(([key, value]) => {
-            if (key in editableProperties || (key in this && typeof this[key] !== 'function')) {
-                try {
-                    this[key] = value;
-                }
-                catch (e) {
-                    console.error(e);
-                }
+        if (typeof updates === 'object') {
+            if (updates !== null) {
+                Object.entries(updates).forEach(([key, value]) => {
+                    if (key in editableProperties || (key in this && typeof this[key] !== 'function')) {
+                        try {
+                            this[key] = value;
+                        }
+                        catch (e) {
+                            console.error(e);
+                        }
+                    }
+                });
             }
-        });
+        }
+        else if (typeof updates !== 'undefined') {
+            this.value = updates;
+        }
     }
     executeAllRules(context) {
         const entries = Object.entries(this.getRules());
@@ -1748,6 +1774,11 @@ class Scriptable extends BaseNode {
         const node = this.ruleEngine.compileRule(expr, this.lang);
         return this.ruleEngine.execute(node, this.getExpressionScope(), ruleContext);
     }
+    change(event, context) {
+        if (this.form.changeEventBehaviour === 'deps') {
+            this.executeAllRules(context);
+        }
+    }
     executeAction(action) {
         const context = {
             'form': this.form,
@@ -1767,7 +1798,9 @@ class Scriptable extends BaseNode {
             this[funcName](action, context);
         }
         node.forEach((n) => this.executeEvent(context, n));
-        this.notifyDependents(action);
+        if (action.target === this) {
+            this.notifyDependents(action);
+        }
     }
 }
 
@@ -2544,15 +2577,15 @@ const multipartFormData = (data, attachments) => {
     }
     return formData;
 };
-const submit = async (context, success, error, submitAs = 'multipart/form-data', input_data = null) => {
-    const endpoint = context.form.action;
+const submit = async (context, success, error, submitAs = 'multipart/form-data', input_data = null, action = '', metadata = null) => {
+    const endpoint = action || context.form.action;
     let data = input_data;
     if (typeof data != 'object' || data == null) {
         data = context.form.exportData();
     }
     const attachments = getAttachments(context.form, true);
     let submitContentType = submitAs;
-    const submitDataAndMetaData = { 'data': data, 'submitMetadata': context.form.exportSubmitMetaData() };
+    const submitDataAndMetaData = { 'data': data, ...metadata };
     let formData = submitDataAndMetaData;
     if (Object.keys(attachments).length > 0 || submitAs === 'multipart/form-data') {
         formData = multipartFormData(submitDataAndMetaData, attachments);
@@ -2568,6 +2601,8 @@ const createAction = (name, payload = {}) => {
             return new Change(payload);
         case 'submit':
             return new Submit(payload);
+        case 'save':
+            return new Save(payload);
         case 'click':
             return new Click(payload);
         case 'addItem':
@@ -2773,6 +2808,18 @@ class FunctionRuntimeImpl {
                 },
                 _signature: []
             },
+            saveForm: {
+                _func: (args, data, interpreter) => {
+                    const action = toString(args[0]);
+                    const validate_form = args[2] || false;
+                    interpreter.globals.form.dispatch(new Save({
+                        action,
+                        validate_form
+                    }));
+                    return {};
+                },
+                _signature: []
+            },
             request: {
                 _func: (args, data, interpreter) => {
                     const uri = toString(args[0]);
@@ -2860,6 +2907,52 @@ class FunctionRuntimeImpl {
 }
 const FunctionRuntime = FunctionRuntimeImpl.getInstance();
 
+class Version {
+    #minor;
+    #major;
+    #subVersion;
+    #invalid = true;
+    constructor(n) {
+        const match = n.match(/([^.]+)\.([^.]+)(?:\.(.+))?/);
+        if (match) {
+            this.#major = +match[1];
+            this.#minor = +match[2];
+            this.#subVersion = match[3] ? +match[3] : 0;
+            if (isNaN(this.#major) || isNaN(this.#minor) || isNaN(this.#subVersion)) {
+                throw new Error('Invalid version string ' + n);
+            }
+        }
+        else {
+            throw new Error('Invalid version string ' + n);
+        }
+    }
+    get major() {
+        return this.#major;
+    }
+    get minor() {
+        return this.#minor;
+    }
+    get subversion() {
+        return this.#subVersion;
+    }
+    completeMatch(v) {
+        return this.major === v.major &&
+            this.minor === v.minor &&
+            this.#subVersion === v.subversion;
+    }
+    lessThan(v) {
+        return this.major < v.major || (this.major === v.major && (this.minor < v.minor)) || (this.major === v.major && this.minor === v.minor && this.#subVersion < v.subversion);
+    }
+    toString() {
+        return `${this.major}.${this.minor}.${this.subversion}`;
+    }
+    valueOf() {
+        return this.toString();
+    }
+}
+
+const currentVersion = new Version('0.13');
+const changeEventVersion = new Version('0.13');
 class Form extends Container {
     _ruleEngine;
     _eventQueue;
@@ -2871,9 +2964,15 @@ class Form extends Container {
         this._ruleEngine = _ruleEngine;
         this._eventQueue = _eventQueue;
         this._logger = new Logger(logLevel);
+        this._applyDefaultsInModel();
         if (mode === 'create') {
             this.queueEvent(new Initialize());
-            this.queueEvent(new ExecuteRule());
+            if (this.changeEventBehaviour === 'deps') {
+                this.queueEvent(new Change({ changes: [] }));
+            }
+            else {
+                this.queueEvent(new ExecuteRule());
+            }
         }
         this._ids = IdGenerator();
         this._bindToDataModel(new DataGroup('$form', {}));
@@ -2882,10 +2981,21 @@ class Form extends Container {
             this.queueEvent(new FormLoad());
         }
     }
+    _applyDefaultsInModel() {
+        const current = this.specVersion;
+        this._jsonModel.properties = this._jsonModel.properties || {};
+        if (current.lessThan(changeEventVersion) ||
+            typeof this._jsonModel.properties['fd:changeEventBehaviour'] !== 'string') {
+            this._jsonModel.properties['fd:changeEventBehaviour'] = 'self';
+        }
+    }
     _logger;
     get logger() {
         return this._logger;
     }
+    get changeEventBehaviour() {
+        return this.properties['fd:changeEventBehaviour'] === 'deps' ? 'deps' : 'self';
+    }
     dataRefRegex = /("[^"]+?"|[^.]+?)(?:\.|$)/g;
     get metaData() {
         const metaData = this._jsonModel.metadata || {};
@@ -2902,6 +3012,21 @@ class Form extends Container {
     exportData() {
         return this.getDataNode()?.$value;
     }
+    get specVersion() {
+        if (typeof this._jsonModel.adaptiveform === 'string') {
+            try {
+                return new Version(this._jsonModel.adaptiveform);
+            }
+            catch (e) {
+                console.log(e);
+                console.log('Falling back to default version' + currentVersion.toString());
+                return currentVersion;
+            }
+        }
+        else {
+            return currentVersion;
+        }
+    }
     resolveQualifiedName(qualifiedName) {
         let foundFormElement = null;
         this.visit(formElement => {
@@ -3041,7 +3166,7 @@ class Form extends Container {
         }, 'valid');
         field.subscribe((action) => {
             const field = action.target.getState();
-            if (field) {
+            if (action.payload.changes.length > 0 && field) {
                 const shallowClone = (obj) => {
                     if (obj && typeof obj === 'object') {
                         if (Array.isArray(obj)) {
@@ -3099,7 +3224,35 @@ class Form extends Container {
             const payload = action?.payload || {};
             const successEventName = payload?.success ? payload?.success : 'submitSuccess';
             const failureEventName = payload?.error ? payload?.error : 'submitError';
-            submit(context, successEventName, failureEventName, payload?.submit_as, payload?.data);
+            const formAction = payload.action || this.action;
+            const metadata = payload.metadata || {
+                'submitMetadata': this.exportSubmitMetaData()
+            };
+            const contentType = payload?.save_as || payload?.submit_as;
+            submit(context, successEventName, failureEventName, contentType, payload?.data, formAction, metadata);
+        }
+    }
+    save(action, context) {
+        const payload = action?.payload || {};
+        payload.save_as = 'multipart/form-data';
+        payload.metadata = {
+            'draftMetadata': {
+                'lang': this.lang,
+                'draftId': this.properties?.draftId || ''
+            }
+        };
+        payload.success = 'custom:saveSuccess';
+        payload.error = 'custom:saveError';
+        this.submit(action, context);
+        this.subscribe((action) => {
+            this._saveSuccess(action);
+        }, 'saveSuccess');
+    }
+    _saveSuccess(action) {
+        const draftId = action?.payload?.body?.draftId || '';
+        const properties = this.properties;
+        if (draftId && properties) {
+            properties.draftId = draftId;
         }
     }
     reset() {
@@ -3236,7 +3389,7 @@ class Fieldset extends Container {
         return undefined;
     }
     get items() {
-        return super.items;
+        return super.items ? super.items : [];
     }
     get value() {
         return null;
@@ -3277,7 +3430,12 @@ class Field extends Scriptable {
         if (_options.mode !== 'restore') {
             this._applyDefaults();
             this.queueEvent(new Initialize());
-            this.queueEvent(new ExecuteRule());
+            if (this.form.changeEventBehaviour === 'deps') {
+                this.queueEvent(new Change({ changes: [] }));
+            }
+            else {
+                this.queueEvent(new ExecuteRule());
+            }
         }
     }
     _ruleNodeReference = [];
@@ -4302,7 +4460,7 @@ class FormFieldFactoryImpl {
             };
             retVal = new InstanceManager(newJson, options);
         }
-        else if ('items' in child) {
+        else if ('items' in child || child.fieldType === 'panel') {
             retVal = new Fieldset(child, options);
         }
         else {
@@ -4336,9 +4494,11 @@ const FormFieldFactory = new FormFieldFactoryImpl();
 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);
+        {
+            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) {
@@ -4355,6 +4515,7 @@ const createFormInstance = (formModel, callback, logLevel = 'error', fModel = un
         throw new Error(e);
     }
 };
+createFormInstance.currentVersion = currentVersion;
 const defaultOptions = {
     logLevel: 'error'
 };

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

@@ -50,6 +50,7 @@ export declare abstract class BaseNode<T extends BaseJson> implements BaseModel
     set label(l: import("./types/Json").Label | undefined);
     get uniqueItems(): boolean | undefined;
     isTransparent(): boolean;
+    getDependents(): string[];
     getState(forRestore?: boolean): T & {
         _dependents?: string[] | undefined;
         allowedComponents?: undefined;

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

@@ -5,6 +5,8 @@ import SubmitMetaData from './SubmitMetaData';
 import EventQueue from './controller/EventQueue';
 import { Logger, LogLevel } from './controller/Logger';
 import RuleEngine from './rules/RuleEngine';
+import { Version } from './utils/Version';
+export declare const currentVersion: Version;
 declare class Form extends Container<FormJson> implements FormModel {
     #private;
     private _ruleEngine;
@@ -13,13 +15,16 @@ declare class Form extends Container<FormJson> implements FormModel {
     _ids: Generator<string, void, string>;
     private _invalidFields;
     constructor(n: FormJson, fieldFactory: IFormFieldFactory, _ruleEngine: RuleEngine, _eventQueue?: EventQueue, logLevel?: LogLevel, mode?: FormCreationMode);
+    protected _applyDefaultsInModel(): void;
     private _logger;
     get logger(): Logger;
+    get changeEventBehaviour(): "deps" | "self";
     private dataRefRegex;
     get metaData(): FormMetaData;
     get action(): string | undefined;
     importData(dataModel: any): void;
     exportData(): any;
+    get specVersion(): Version;
     resolveQualifiedName(qualifiedName: string): FieldModel | FieldsetModel | null;
     exportSubmitMetaData(): SubmitMetaData;
     setFocus(field: BaseModel, focusOption: FocusOption): void;
@@ -78,7 +83,7 @@ declare class Form extends Container<FormJson> implements FormModel {
         data?: any;
         title?: string | undefined;
         action?: string | undefined;
-        adaptiveForm?: string | undefined;
+        adaptiveform?: string | undefined;
         lang?: string | undefined;
     } & {
         items: any[];
@@ -115,6 +120,8 @@ declare class Form extends Container<FormJson> implements FormModel {
     isValid(): boolean;
     dispatch(action: Action): void;
     submit(action: Action, context: any): void;
+    save(action: Action, context: any): void;
+    _saveSuccess(action: Action): void;
     reset(): void;
     getElement(id: string): FieldModel | FieldsetModel | this;
     get qualifiedName(): string;

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

@@ -1,7 +1,10 @@
 import { FormModel } from './types/index';
 import { LogLevel } from './controller/Logger';
 import { CustomFunction, FunctionDefinition } from './rules/FunctionRuntime';
-export declare const createFormInstance: (formModel: any, callback?: ((f: FormModel) => any) | undefined, logLevel?: LogLevel, fModel?: any) => FormModel;
+export declare const createFormInstance: {
+    (formModel: any, callback?: ((f: FormModel) => any) | undefined, logLevel?: LogLevel, fModel?: any): FormModel;
+    currentVersion: import("./utils/Version").Version;
+};
 export declare const restoreFormInstance: (formModel: any, data?: any, { logLevel }?: {
     logLevel: LogLevel;
 }) => FormModel;

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

@@ -12,6 +12,7 @@ declare abstract class Scriptable<T extends RulesJson> extends BaseNode<T> imple
     private executeEvent;
     executeRule(event: Action, context: any): void;
     executeExpression(expr: string): any;
+    change(event: Action, context: any): void;
     executeAction(action: Action): void;
 }
 export default Scriptable;

package/esm/types/src/controller/Events.d.ts

@@ -4,11 +4,13 @@ declare class ActionImpl implements Action {
     protected _type: string;
     private _payload?;
     private _target;
+    private _currentTarget;
     constructor(payload: any, type: string, _metadata?: any);
     get type(): string;
     get payload(): any;
     get metadata(): any;
     get target(): FormModel | FieldModel | FieldsetModel;
+    get currentTarget(): FormModel | FieldModel | FieldsetModel;
     get isCustomEvent(): boolean;
     protected payloadToJson(): any;
     toJson(): {
@@ -60,6 +62,9 @@ export declare class Focus extends ActionImpl {
 export declare class Submit extends ActionImpl {
     constructor(payload?: any, dispatch?: boolean);
 }
+export declare class Save extends ActionImpl {
+    constructor(payload?: any, dispatch?: boolean);
+}
 export declare class SubmitSuccess extends ActionImpl {
     constructor(payload?: any, dispatch?: boolean);
 }

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

@@ -1,6 +1,6 @@
 type HTTP_VERB = 'GET' | 'POST';
 export declare const request: (context: any, uri: string, httpVerb: HTTP_VERB, payload: any, success: string, error: string, headers: any) => Promise<void>;
-export declare const submit: (context: any, success: string, error: string, submitAs?: 'application/json' | 'multipart/form-data' | 'application/x-www-form-urlencoded', input_data?: any) => Promise<void>;
+export declare const submit: (context: any, success: string, error: string, submitAs?: 'application/json' | 'multipart/form-data' | 'application/x-www-form-urlencoded', input_data?: any, action?: string, metadata?: any) => Promise<void>;
 export type CustomFunction = Function;
 export type FunctionDefinition = {
     _func: CustomFunction;
@@ -40,6 +40,10 @@ declare class FunctionRuntimeImpl {
             _func: (args: Array<unknown>, data: unknown, interpreter: any) => {};
             _signature: never[];
         };
+        saveForm: {
+            _func: (args: Array<unknown>, data: unknown, interpreter: any) => {};
+            _signature: never[];
+        };
         request: {
             _func: (args: Array<unknown>, data: unknown, interpreter: any) => {};
             _signature: never[];

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

@@ -117,7 +117,7 @@ export type FormJson = ContainerJson & {
     data?: any;
     title?: string;
     action?: string;
-    adaptiveForm?: string;
+    adaptiveform?: string;
     lang?: string;
 };
 export type TranslationJson = TranslationBaseJson & TranslationFieldJson & TranslationConstraintsJson;

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

@@ -3,6 +3,7 @@ import RuleEngine from '../rules/RuleEngine';
 import EventQueue from '../controller/EventQueue';
 import DataGroup from '../data/DataGroup';
 import { Logger } from '../controller/Logger';
+import { Version } from '../utils/Version';
 export interface ScriptableField {
     rules?: {
         [key: string]: string;
@@ -10,7 +11,7 @@ export interface ScriptableField {
     events?: {
         [key: string]: string;
     };
-    ruleEngine: RuleEngine;
+    readonly ruleEngine: RuleEngine;
 }
 interface WithState<T> {
     getState: () => any;
@@ -33,6 +34,7 @@ export interface Action {
     readonly isCustomEvent: boolean;
     readonly target: FormModel | FieldModel | FieldsetModel;
     readonly originalAction?: Action;
+    readonly currentTarget: FormModel | FieldModel | FieldsetModel;
 }
 export type callbackFn = (action: Action) => void;
 export interface WithController {
@@ -82,7 +84,7 @@ export interface FieldModel extends BaseModel, ScriptableField, WithState<FieldJ
     readonly editValue?: string;
 }
 export interface FormMetaDataModel {
-    readonly version: string;
+    readonly version?: string;
     readonly grammar: string;
 }
 export interface SubmitMetaDataModel {
@@ -105,6 +107,7 @@ export interface FormModel extends ContainerModel, WithState<FormJson> {
     readonly metadata?: MetaDataJson;
     readonly title: string;
     readonly logger: Logger;
+    readonly specVersion: Version;
     importData(data: any): any;
     exportData(): any;
     getElement(id: string): FieldModel | FormModel | FieldsetModel;
@@ -113,6 +116,7 @@ export interface FormModel extends ContainerModel, WithState<FormJson> {
     visit(callBack: (field: FieldModel | FieldsetModel) => void): void;
     resolveQualifiedName(qualifiedName: string): FieldModel | FieldsetModel | null;
     fieldAdded(field: FieldModel | FieldsetModel): void;
+    readonly changeEventBehaviour: 'deps' | 'self';
 }
 export interface IFormFieldFactory {
     createField(child: FieldsetJson | FieldJson, options: {

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

@@ -0,0 +1,11 @@
+export declare class Version {
+    #private;
+    constructor(n: string);
+    get major(): number;
+    get minor(): number;
+    get subversion(): number;
+    completeMatch(v: Version): boolean;
+    lessThan(v: Version): boolean;
+    toString(): string;
+    valueOf(): string;
+}

package/lib/BaseNode.d.ts

@@ -50,6 +50,7 @@ export declare abstract class BaseNode<T extends BaseJson> implements BaseModel
     set label(l: import("./types/Json").Label | undefined);
     get uniqueItems(): boolean | undefined;
     isTransparent(): boolean;
+    getDependents(): string[];
     getState(forRestore?: boolean): T & {
         _dependents?: string[] | undefined;
         allowedComponents?: undefined;