@aemforms/af-core 0.22.67 → 0.22.69

package/lib/Fieldset.d.ts

@@ -1,10 +1,11 @@
 import Container from './Container';
-import { ContainerModel, FieldsetJson, FieldsetModel, FormModel, IFormFieldFactory } from './types/index';
+import { ContainerModel, FieldsetJson, FieldsetModel, FormCreationMode, FormModel, IFormFieldFactory } from './types/index';
 export declare class Fieldset extends Container<FieldsetJson> implements FieldsetModel {
     constructor(params: FieldsetJson, _options: {
         form: FormModel;
         parent: ContainerModel;
         fieldFactory: IFormFieldFactory;
+        mode: FormCreationMode;
     });
     protected _getDefaults(): any;
     private _applyDefaults;

package/lib/Form.d.ts

@@ -1,11 +1,10 @@
 import Container from './Container';
-import { Action, BaseModel, FieldModel, FieldsetModel, FormJson, FormModel, IFormFieldFactory } from './types/index';
+import { Action, BaseModel, FieldModel, FieldsetModel, FormCreationMode, FormJson, FocusOption, FormModel, IFormFieldFactory } from './types/index';
 import FormMetaData from './FormMetaData';
 import SubmitMetaData from './SubmitMetaData';
 import EventQueue from './controller/EventQueue';
 import { Logger, LogLevel } from './controller/Logger';
 import RuleEngine from './rules/RuleEngine';
-import { FocusOption } from './types/Model';
 declare class Form extends Container<FormJson> implements FormModel {
     #private;
     private _ruleEngine;
@@ -13,8 +12,8 @@ declare class Form extends Container<FormJson> implements FormModel {
     private _fields;
     _ids: Generator<string, void, string>;
     private _invalidFields;
+    constructor(n: FormJson, fieldFactory: IFormFieldFactory, _ruleEngine: RuleEngine, _eventQueue?: EventQueue, logLevel?: LogLevel, mode?: FormCreationMode);
     private _logger;
-    constructor(n: FormJson, fieldFactory: IFormFieldFactory, _ruleEngine: RuleEngine, _eventQueue?: EventQueue, logLevel?: LogLevel);
     get logger(): Logger;
     private dataRefRegex;
     get metaData(): FormMetaData;
@@ -24,7 +23,7 @@ declare class Form extends Container<FormJson> implements FormModel {
     resolveQualifiedName(qualifiedName: string): FieldModel | FieldsetModel | null;
     exportSubmitMetaData(): SubmitMetaData;
     setFocus(field: BaseModel, focusOption: FocusOption): void;
-    getState(): {
+    getState(forRestore?: boolean): {
         description?: string | undefined;
     } & import("./types/Json").RulesJson & {
         enumNames?: string[] | import("./types/Json").EnumName[] | undefined;
@@ -85,14 +84,19 @@ declare class Form extends Container<FormJson> implements FormModel {
         items: any[];
         enabled: boolean | undefined;
         readOnly: any;
+        ':items'?: undefined;
+        ':itemsOrder'?: undefined;
+        _dependents?: string[] | undefined;
+        allowedComponents?: undefined;
+        columnClassNames?: undefined;
+        columnCount?: undefined;
+        gridClassNames?: undefined;
         properties: {
             [key: string]: any;
         };
         index: number;
         parent: undefined;
         qualifiedName: any;
-        events: {};
-        rules: {};
         repeatable: boolean | undefined;
         ':type': string;
         id: string;

package/lib/Form.js

@@ -10,6 +10,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 var _Form_instances, _Form_getNavigableChildren, _Form_getFirstNavigableChild, _Form_setActiveFirstDeepChild, _Form_getNextItem, _Form_getPreviousItem, _Form_clearCurrentFocus;
 Object.defineProperty(exports, "__esModule", { value: true });
 const Container_1 = __importDefault(require("./Container"));
+const index_1 = require("./types/index");
 const FormMetaData_1 = __importDefault(require("./FormMetaData"));
 const SubmitMetaData_1 = __importDefault(require("./SubmitMetaData"));
 const EventQueue_1 = __importDefault(require("./controller/EventQueue"));
@@ -18,10 +19,9 @@ const FormUtils_1 = require("./utils/FormUtils");
 const DataGroup_1 = __importDefault(require("./data/DataGroup"));
 const FunctionRuntime_1 = require("./rules/FunctionRuntime");
 const Events_1 = require("./controller/Events");
-const Model_1 = require("./types/Model");
 class Form extends Container_1.default {
-    constructor(n, fieldFactory, _ruleEngine, _eventQueue = new EventQueue_1.default(), logLevel = 'off') {
-        super(n, { fieldFactory: fieldFactory });
+    constructor(n, fieldFactory, _ruleEngine, _eventQueue = new EventQueue_1.default(), logLevel = 'off', mode = 'create') {
+        super(n, { fieldFactory: fieldFactory, mode });
         this._ruleEngine = _ruleEngine;
         this._eventQueue = _eventQueue;
         _Form_instances.add(this);
@@ -29,12 +29,16 @@ class Form extends Container_1.default {
         this._invalidFields = [];
         this.dataRefRegex = /("[^"]+?"|[^.]+?)(?:\.|$)/g;
         this._logger = new Logger_1.Logger(logLevel);
-        this.queueEvent(new Events_1.Initialize());
-        this.queueEvent(new Events_1.ExecuteRule());
+        if (mode === 'create') {
+            this.queueEvent(new Events_1.Initialize());
+            this.queueEvent(new Events_1.ExecuteRule());
+        }
         this._ids = (0, FormUtils_1.IdGenerator)();
         this._bindToDataModel(new DataGroup_1.default('$form', {}));
-        this._initialize();
-        this.queueEvent(new Events_1.FormLoad());
+        this._initialize(mode);
+        if (mode === 'create') {
+            this.queueEvent(new Events_1.FormLoad());
+        }
     }
     get logger() {
         return this._logger;
@@ -96,19 +100,19 @@ class Form extends Container_1.default {
             currActiveChildIndex = 0;
             return;
         }
-        if (focusOption === Model_1.FocusOption.NEXT_ITEM) {
+        if (focusOption === index_1.FocusOption.NEXT_ITEM) {
             activeChild = __classPrivateFieldGet(this, _Form_instances, "m", _Form_getNextItem).call(this, currActiveChildIndex, navigableChidren);
         }
-        else if (focusOption === Model_1.FocusOption.PREVIOUS_ITEM) {
+        else if (focusOption === index_1.FocusOption.PREVIOUS_ITEM) {
             activeChild = __classPrivateFieldGet(this, _Form_instances, "m", _Form_getPreviousItem).call(this, currActiveChildIndex, navigableChidren);
         }
         if (activeChild !== null) {
             __classPrivateFieldGet(this, _Form_instances, "m", _Form_setActiveFirstDeepChild).call(this, activeChild);
         }
     }
-    getState() {
+    getState(forRestore = false) {
         const self = this;
-        const res = super.getState();
+        const res = super.getState(false, forRestore);
         res.id = '$form';
         Object.defineProperty(res, 'data', {
             get: function () {
@@ -156,7 +160,25 @@ class Form extends Container_1.default {
         field.subscribe((action) => {
             const field = action.target.getState();
             if (field) {
-                const fieldChangedAction = new Events_1.FieldChanged(action.payload.changes, field);
+                const shallowClone = (obj) => {
+                    if (obj && typeof obj === 'object') {
+                        if (Array.isArray(obj)) {
+                            return obj.map(shallowClone);
+                        }
+                        else {
+                            return Object.assign({}, obj);
+                        }
+                    }
+                    return obj;
+                };
+                const changes = action.payload.changes.map(({ propertyName, currentValue, prevValue }) => {
+                    return {
+                        propertyName,
+                        currentValue: shallowClone(currentValue),
+                        prevValue: shallowClone(prevValue)
+                    };
+                });
+                const fieldChangedAction = new Events_1.FieldChanged(changes, field);
                 this.dispatch(fieldChangedAction);
             }
         });

package/lib/FormInstance.d.ts

@@ -2,6 +2,9 @@ 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 restoreFormInstance: (formModel: any, { logLevel }?: {
+    logLevel: LogLevel;
+}) => FormModel;
 export declare const validateFormInstance: (formModel: any, data: any) => boolean;
 export declare const validateFormData: (formModel: any, data: any) => {
     messages: any[];

package/lib/FormInstance.js

@@ -3,7 +3,7 @@ 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.createFormInstance = void 0;
+exports.registerFunctions = exports.fetchForm = exports.validateFormData = exports.validateFormInstance = exports.restoreFormInstance = exports.createFormInstance = void 0;
 const Form_1 = __importDefault(require("./Form"));
 const JsonUtils_1 = require("./utils/JsonUtils");
 const Fetch_1 = require("./utils/Fetch");
@@ -36,6 +36,21 @@ const createFormInstance = (formModel, callback, logLevel = 'error', fModel = un
     }
 };
 exports.createFormInstance = createFormInstance;
+const defaultOptions = {
+    logLevel: 'error'
+};
+const restoreFormInstance = (formModel, { logLevel } = defaultOptions) => {
+    try {
+        const form = new Form_1.default(Object.assign({}, formModel), FormCreationUtils_1.FormFieldFactory, new RuleEngine_1.default(), new EventQueue_1.default(new Logger_1.Logger(logLevel)), logLevel, 'restore');
+        form.getEventQueue().empty();
+        return form;
+    }
+    catch (e) {
+        console.error(`Unable to restore an instance of the Form ${e}`);
+        throw new Error(e);
+    }
+};
+exports.restoreFormInstance = restoreFormInstance;
 const validateFormInstance = (formModel, data) => {
     try {
         const f = new Form_1.default(Object.assign({}, formModel), FormCreationUtils_1.FormFieldFactory, new RuleEngine_1.default());

package/lib/controller/EventQueue.d.ts

@@ -12,6 +12,7 @@ declare class EventQueue {
     get isProcessing(): boolean;
     isQueued<T extends BaseJson>(node: BaseNode<T>, event: Action): boolean;
     queue<T extends BaseJson>(node: BaseNode<T>, events: Action | Action[], priority?: boolean): void;
+    empty(): void;
     runPendingQueue(): void;
 }
 export default EventQueue;

package/lib/controller/EventQueue.js

@@ -65,6 +65,9 @@ class EventQueue {
             }
         });
     }
+    empty() {
+        this._pendingEvents = [];
+    }
     runPendingQueue() {
         if (this._isProcessing) {
             return;

package/lib/types/Model.d.ts

@@ -39,6 +39,7 @@ export interface WithController {
     subscribe(callback: callbackFn, eventName?: string): Subscription;
     dispatch(action: Action): void;
 }
+export declare type FormCreationMode = 'create' | 'restore';
 export interface BaseModel extends ConstraintsJson, WithController {
     readonly lang?: string;
     readonly name?: string;
@@ -69,7 +70,7 @@ export interface BaseModel extends ConstraintsJson, WithController {
     importData(a?: DataGroup): any;
     getRuleNode(): any;
     ruleNodeReference(): any;
-    _initialize(): any;
+    _initialize(mode?: FormCreationMode): any;
     _addDependent(dependent: BaseModel): any;
 }
 export interface FieldModel extends BaseModel, ScriptableField, WithState<FieldJson> {

package/lib/utils/FormCreationUtils.d.ts

@@ -1,8 +1,9 @@
-import { ContainerModel, FieldJson, FieldModel, FieldsetJson, FieldsetModel, FormModel, IFormFieldFactory } from '../types/index';
+import { ContainerModel, FieldJson, FieldModel, FieldsetJson, FieldsetModel, FormCreationMode, FormModel, IFormFieldFactory } from '../types/index';
 declare class FormFieldFactoryImpl implements IFormFieldFactory {
     createField(child: FieldsetJson | FieldJson, _options: {
         form: FormModel;
         parent: ContainerModel;
+        mode: FormCreationMode;
     }): FieldModel | FieldsetModel;
 }
 export declare const FormFieldFactory: FormFieldFactoryImpl;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aemforms/af-core",
-  "version": "0.22.67",
+  "version": "0.22.69",
   "description": "Core Module for Forms Runtime",
   "author": "Adobe Systems",
   "license": "Adobe Proprietary",
@@ -17,6 +17,7 @@
     "outputDirectory": "./target/test-reports"
   },
   "files": [
+    "esm",
     "lib",
     "LICENSE"
   ],
@@ -28,14 +29,15 @@
     "eslint": "npx eslint src/**",
     "eslint:fix": "npx eslint --fix src/**",
     "test:ci": "jest --silent --coverage",
-    "build": "npm run eslint && npx tsc",
+    "build": "npm run eslint && npx tsc && npm run build:esm",
+    "build:esm": "rollup -c rollup.config.mjs",
     "clean": "rm -rf lib target",
     "prepublishOnly": "npm run build && npm run test",
     "docs": "npx typedoc --options .typedoc.cjs"
   },
   "dependencies": {
     "@adobe/json-formula": "0.1.50",
-    "@aemforms/af-formatters": "^0.22.67"
+    "@aemforms/af-formatters": "^0.22.69"
   },
   "devDependencies": {
     "@babel/preset-env": "^7.20.2",