@aemforms/af-core 0.22.19 → 0.22.22

package/lib/{rules → esm/rules}/FunctionRuntime.js

@@ -1,31 +1,31 @@
-"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 __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FunctionRuntime = exports.submit = exports.request = void 0;
-/**
- * Implementation of function runtime in rule engine
- */
-//import {jsonString} from '../utils/JsonUtils';
-const Controller_1 = require("../controller/Controller");
-const Fetch_1 = require("../utils/Fetch");
-const FileObject_1 = require("../FileObject");
-const FormUtils_1 = require("../utils/FormUtils");
-const JsonUtils_1 = require("../utils/JsonUtils");
+/*************************************************************************
+* 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 { CustomEvent, Submit, RemoveInstance, AddInstance, Reset, RemoveItem, AddItem, Click, Change } from '../controller/Events.js';
+import { request as request$1 } from '../utils/Fetch.js';
+import { FileObject } from '../FileObject.js';
+import { getAttachments } from '../utils/FormUtils.js';
+import { jsonString } from '../utils/JsonUtils.js';
+import '../types/Json.js';
+import '../utils/SchemaUtils.js';
+
 const getCustomEventName = (name) => {
     const eName = name;
     if (eName.length > 0 && eName.startsWith('custom:')) {
@@ -33,19 +33,7 @@ const getCustomEventName = (name) => {
     }
     return eName;
 };
-/**
- * Implementation of generic request API. This API can be used to make external web request
- * @param context                   expression execution context(consists of current form, current field, current event)
- * @param uri                       request URI
- * @param httpVerb                  http verb (for example, GET or POST)
- * @param payload                   request payload
- * @param success                   success handler
- * @param error                     error handler
- * @param headers                   headers
- * @private
- */
-const request = (context, uri, httpVerb, payload, success, error, headers) => __awaiter(void 0, void 0, void 0, function* () {
-    var _a;
+const request = async (context, uri, httpVerb, payload, success, error, headers) => {
     const endpoint = uri;
     const requestOptions = {
         method: httpVerb
@@ -53,8 +41,7 @@ const request = (context, uri, httpVerb, payload, success, error, headers) => __
     let result;
     let inputPayload;
     try {
-        if (payload && payload instanceof FileObject_1.FileObject && payload.data instanceof File) {
-            // todo: have to implement array type
+        if (payload && payload instanceof FileObject && payload.data instanceof File) {
             const formData = new FormData();
             formData.append(payload.name, payload.data);
             inputPayload = formData;
@@ -65,13 +52,15 @@ const request = (context, uri, httpVerb, payload, success, error, headers) => __
         else if (payload && typeof payload === 'object' && Object.keys(payload).length > 0) {
             const headerNames = Object.keys(headers);
             if (headerNames.length > 0) {
-                requestOptions.headers = Object.assign(Object.assign({}, headers), (headerNames.indexOf('Content-Type') === -1 ? { 'Content-Type': 'application/json' } : {}) // this should match content type of the payload
-                );
+                requestOptions.headers = {
+                    ...headers,
+                    ...(headerNames.indexOf('Content-Type') === -1 ? { 'Content-Type': 'application/json' } : {})
+                };
             }
             else {
                 requestOptions.headers = { 'Content-Type': 'application/json' };
             }
-            const contentType = ((_a = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers) === null || _a === void 0 ? void 0 : _a['Content-Type']) || 'application/json';
+            const contentType = requestOptions?.headers?.['Content-Type'] || 'application/json';
             if (contentType === 'application/json') {
                 inputPayload = JSON.stringify(payload);
             }
@@ -82,24 +71,22 @@ const request = (context, uri, httpVerb, payload, success, error, headers) => __
                 inputPayload = urlEncoded(payload);
             }
         }
-        result = yield (0, Fetch_1.request)(endpoint, inputPayload, requestOptions);
+        result = await request$1(endpoint, inputPayload, requestOptions);
     }
     catch (e) {
-        //todo: define error payload
         context.form.logger.error('Error invoking a rest API');
         const eName = getCustomEventName(error);
-        context.form.dispatch(new Controller_1.CustomEvent(eName, {}, true));
+        context.form.dispatch(new CustomEvent(eName, {}, true));
         return;
     }
     const eName = getCustomEventName(success);
-    context.form.dispatch(new Controller_1.CustomEvent(eName, result, true));
-});
-exports.request = request;
+    context.form.dispatch(new CustomEvent(eName, result, true));
+};
 const urlEncoded = (data) => {
     const formData = new URLSearchParams();
     Object.entries(data).forEach(([key, value]) => {
         if (value != null && typeof value === 'object') {
-            formData.append(key, (0, JsonUtils_1.jsonString)(value));
+            formData.append(key, jsonString(value));
         }
         else {
             formData.append(key, value);
@@ -107,26 +94,19 @@ const urlEncoded = (data) => {
     });
     return formData;
 };
-/**
- * Create multi part form data using form data and form attachments
- * @param data              form data
- * @param attachments       form events
- * @private
- */
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
 const multipartFormData = (data, attachments) => {
     const formData = new FormData();
     Object.entries(data).forEach(([key, value]) => {
         if (value != null && typeof value === 'object') {
-            formData.append(key, (0, JsonUtils_1.jsonString)(value));
+            formData.append(key, jsonString(value));
         }
         else {
             formData.append(key, value);
         }
     });
     const addAttachmentToFormData = (objValue, formData) => {
-        if ((objValue === null || objValue === void 0 ? void 0 : objValue.data) instanceof File) {
-            let attIdentifier = `${objValue === null || objValue === void 0 ? void 0 : objValue.dataRef}/${objValue === null || objValue === void 0 ? void 0 : objValue.name}`;
+        if (objValue?.data instanceof File) {
+            let attIdentifier = `${objValue?.dataRef}/${objValue?.name}`;
             if (!attIdentifier.startsWith('/')) {
                 attIdentifier = `/${attIdentifier}`;
             }
@@ -134,7 +114,6 @@ const multipartFormData = (data, attachments) => {
         }
     };
     if (attachments) {
-        // @ts-ignore
         Object.keys(attachments).reduce((acc, curr) => {
             const objValue = attachments[curr];
             if (objValue && objValue instanceof Array) {
@@ -147,75 +126,54 @@ const multipartFormData = (data, attachments) => {
     }
     return formData;
 };
-const submit = (context, success, error, submitAs = 'multipart/form-data', input_data = null) => __awaiter(void 0, void 0, void 0, function* () {
+const submit = async (context, success, error, submitAs = 'multipart/form-data', input_data = null) => {
     const endpoint = context.form.action;
     let data = input_data;
     if (typeof data != 'object' || data == null) {
         data = context.form.exportData();
     }
-    // todo: have to implement sending of attachments here
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    const attachments = (0, FormUtils_1.getAttachments)(context.form);
+    const attachments = getAttachments(context.form);
     let submitContentType = submitAs;
-    let formData;
+    const submitDataAndMetaData = { 'data': data, 'submitMetadata': { 'lang': context.form.lang } };
+    let formData = submitDataAndMetaData;
     if (Object.keys(attachments).length > 0 || submitAs === 'multipart/form-data') {
-        formData = multipartFormData({ 'data': data }, attachments);
+        formData = multipartFormData(submitDataAndMetaData, attachments);
         submitContentType = 'multipart/form-data';
     }
-    else {
-        formData = { 'data': data };
-    }
-    // submitContentType = submitAs;
-    // note: don't send multipart/form-data let browser decide on the content type
-    yield (0, exports.request)(context, endpoint, 'POST', formData, success, error, {
+    await request(context, endpoint, 'POST', formData, success, error, {
         'Content-Type': submitContentType
     });
-});
-exports.submit = submit;
-/**
- * Helper function to create an action
- * @param name          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
- * @private
- */
+};
 const createAction = (name, payload = {}) => {
     switch (name) {
         case 'change':
-            return new Controller_1.Change(payload);
+            return new Change(payload);
         case 'submit':
-            return new Controller_1.Submit(payload);
+            return new Submit(payload);
         case 'click':
-            return new Controller_1.Click(payload);
+            return new Click(payload);
         case 'addItem':
-            return new Controller_1.AddItem(payload);
+            return new AddItem(payload);
         case 'removeItem':
-            return new Controller_1.RemoveItem(payload);
+            return new RemoveItem(payload);
         case 'reset':
-            return new Controller_1.Reset(payload);
+            return new Reset(payload);
         case 'addInstance':
-            return new Controller_1.AddInstance(payload);
+            return new AddInstance(payload);
         case 'removeInstance':
-            return new Controller_1.RemoveInstance(payload);
+            return new RemoveInstance(payload);
         default:
             console.error('invalid action');
     }
 };
-/**
- * Implementation of function runtime
- * @private
- */
 class FunctionRuntimeImpl {
-    constructor() {
-        this.customFunctions = {};
-    }
+    customFunctions = {};
     registerFunctions(functions) {
         Object.entries(functions).forEach(([name, funcDef]) => {
             let finalFunction = funcDef;
             if (typeof funcDef === 'function') {
                 finalFunction = {
                     _func: (args) => {
-                        // eslint-disable-next-line @typescript-eslint/ban-types
                         return funcDef(...args);
                     },
                     _signature: []
@@ -236,7 +194,6 @@ class FunctionRuntimeImpl {
         });
     }
     getFunctions() {
-        // todo: remove these once json-formula exposes a way to call them from custom functions
         function isArray(obj) {
             if (obj !== null) {
                 return Object.prototype.toString.call(obj) === '[object Array]';
@@ -291,7 +248,6 @@ class FunctionRuntimeImpl {
             },
             getData: {
                 _func: (args, data, interpreter) => {
-                    // deprecated. left for backward compatability.
                     interpreter.globals.form.logger.warn('The `getData` function is depricated. Use `exportData` instead.');
                     return interpreter.globals.form.exportData();
                 },
@@ -315,12 +271,11 @@ class FunctionRuntimeImpl {
             },
             submitForm: {
                 _func: (args, data, interpreter) => {
-                    // success: string, error: string, submit_as: 'json' | 'multipart' = 'json', data: any = null
                     const success = toString(args[0]);
                     const error = toString(args[1]);
                     const submit_as = args.length > 2 ? toString(args[2]) : 'multipart/form-data';
                     const submit_data = args.length > 3 ? valueOf(args[3]) : null;
-                    interpreter.globals.form.dispatch(new Controller_1.Submit({
+                    interpreter.globals.form.dispatch(new Submit({
                         success,
                         error,
                         submit_as,
@@ -330,7 +285,6 @@ class FunctionRuntimeImpl {
                 },
                 _signature: []
             },
-            // todo: only supports application/json for now
             request: {
                 _func: (args, data, interpreter) => {
                     const uri = toString(args[0]);
@@ -347,18 +301,11 @@ class FunctionRuntimeImpl {
                         success = valueOf(args[4]);
                         error = valueOf(args[5]);
                     }
-                    (0, exports.request)(interpreter.globals, uri, httpVerb, payload, success, error, headers);
+                    request(interpreter.globals, uri, httpVerb, payload, success, error, headers);
                     return {};
                 },
                 _signature: []
             },
-            /**
-             *
-             * @name dispatchEvent
-             * @param [element] element on which to trigger the event. If not defined the event will be triggered on entire form
-             * @param eventName name of the event to trigger
-             * @param payload payload to pass in the event
-             */
             dispatchEvent: {
                 _func: (args, data, interpreter) => {
                     const element = args[0];
@@ -372,7 +319,7 @@ class FunctionRuntimeImpl {
                     }
                     let event;
                     if (eventName.startsWith('custom:')) {
-                        event = new Controller_1.CustomEvent(eventName.substring('custom:'.length), payload, dispatch);
+                        event = new CustomEvent(eventName.substring('custom:'.length), payload, dispatch);
                     }
                     else {
                         event = createAction(eventName, payload);
@@ -390,7 +337,9 @@ class FunctionRuntimeImpl {
                 _signature: []
             }
         };
-        return Object.assign(Object.assign({}, defaultFunctions), this.customFunctions);
+        return { ...defaultFunctions, ...this.customFunctions };
     }
 }
-exports.FunctionRuntime = new FunctionRuntimeImpl();
+const FunctionRuntime = new FunctionRuntimeImpl();
+
+export { FunctionRuntime, request, submit };

package/lib/esm/rules/RuleEngine.d.ts

@@ -0,0 +1,12 @@
+import { BaseModel } from '../types/index.js';
+declare class RuleEngine {
+    private _context;
+    private _globalNames;
+    private formulaEngine;
+    private debugInfo;
+    constructor();
+    compileRule(rule: string): any;
+    execute(node: any, data: any, globals: any, useValueOf?: boolean): any;
+    trackDependency(subscriber: BaseModel): void;
+}
+export default RuleEngine;

package/lib/esm/rules/RuleEngine.js

@@ -0,0 +1,76 @@
+/*************************************************************************
+* 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 Formula from '@adobe/json-formula';
+import { FunctionRuntime } from './FunctionRuntime.js';
+import '../controller/Events.js';
+import '../utils/Fetch.js';
+import '../FileObject.js';
+import '../utils/FormUtils.js';
+import '../utils/JsonUtils.js';
+import '../types/Json.js';
+import '../utils/SchemaUtils.js';
+
+class RuleEngine {
+    _context;
+    _globalNames = [
+        '$form',
+        '$field',
+        '$event'
+    ];
+    formulaEngine;
+    debugInfo = [];
+    constructor() {
+        const customFunctions = FunctionRuntime.getFunctions();
+        this.formulaEngine = new Formula(customFunctions, undefined, this.debugInfo);
+    }
+    compileRule(rule) {
+        return this.formulaEngine.compile(rule, this._globalNames);
+    }
+    execute(node, data, globals, useValueOf = false) {
+        const oldContext = this._context;
+        this._context = globals;
+        let res = undefined;
+        try {
+            res = this.formulaEngine.run(node, data, 'en-US', globals);
+        }
+        catch (err) {
+            this._context?.form?.logger?.error(err);
+        }
+        while (this.debugInfo.length > 0) {
+            this._context?.form?.logger?.debug(this.debugInfo.pop());
+        }
+        let finalRes = res;
+        if (useValueOf) {
+            if (typeof res === 'object' && res !== null) {
+                finalRes = Object.getPrototypeOf(res).valueOf.call(res);
+            }
+        }
+        this._context = oldContext;
+        return finalRes;
+    }
+    trackDependency(subscriber) {
+        if (this._context && this._context.field !== undefined && this._context.field !== subscriber) {
+            subscriber._addDependent(this._context.field);
+        }
+    }
+}
+
+export { RuleEngine as default };

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

@@ -0,0 +1,119 @@
+export type Items<T> = {
+    [key: string]: T;
+};
+export type Primitives = string | number | boolean | null | undefined;
+export type Label = {
+    value: string;
+    richText?: boolean;
+    visible?: boolean;
+};
+type TranslationConstraintsJson = {
+    enumNames?: string[];
+    enum?: any[];
+};
+export type ConstraintsJson = TranslationConstraintsJson & {
+    accept?: string[];
+    enforceEnum?: boolean;
+    exclusiveMinimum?: number;
+    exclusiveMaximum?: number;
+    format?: string;
+    maxFileSize?: number | string;
+    maxLength?: number;
+    maximum?: number;
+    maxItems?: number;
+    minOccur?: number;
+    maxOccur?: number;
+    minLength?: number;
+    minimum?: number;
+    minItems?: number;
+    pattern?: string;
+    required?: boolean;
+    step?: number;
+    type?: string;
+    validationExpression?: string;
+    uniqueItems?: boolean;
+};
+export type ConstraintsMessages = {
+    accept?: string;
+    enum?: string;
+    exclusiveMinimum?: string;
+    exclusiveMaximum?: string;
+    format?: string;
+    maxFileSize?: string;
+    maxLength?: string;
+    maximum?: string;
+    maxItems?: string;
+    minLength?: string;
+    minimum?: string;
+    minItems?: string;
+    uniqueItems?: string;
+    pattern?: string;
+    required?: string;
+    step?: string;
+    type?: string;
+    validationExpression?: string;
+};
+export type RulesJson = {
+    rules?: Items<string>;
+    events?: Items<string[] | string | undefined>;
+};
+type TranslationBaseJson = {
+    description?: string;
+};
+export type BaseJson = TranslationBaseJson & RulesJson & ConstraintsJson & {
+    dataRef?: string | null;
+    ':type'?: string;
+    label?: Label;
+    enabled?: boolean;
+    visible?: boolean;
+    name?: string;
+    constraintMessages?: ConstraintsMessages;
+    fieldType?: string;
+    errorMessage?: string;
+    properties?: {
+        [key: string]: any;
+    };
+    repeatable?: boolean;
+    screenReaderText?: string;
+    tooltip?: string;
+    altText?: string;
+    viewType?: string;
+};
+type TranslationFieldJson = {
+    placeholder?: string;
+};
+export type FieldJson = BaseJson & TranslationFieldJson & {
+    readOnly?: boolean;
+    valid?: boolean;
+    default?: any;
+    value?: any;
+    displayFormat?: string;
+    editFormat?: string;
+    editValue?: string;
+    displayValue?: string;
+    emptyValue?: 'null' | 'undefined' | '';
+};
+export type ContainerJson = BaseJson & {
+    items: Array<FieldJson | ContainerJson>;
+    initialItems?: number;
+    activeChild?: string;
+};
+export type MetaDataJson = {
+    version?: string;
+    grammar?: string;
+};
+export type FieldsetJson = ContainerJson & {
+    'type'?: 'array' | 'object';
+};
+export type FormJson = ContainerJson & {
+    metadata?: MetaDataJson;
+    data?: any;
+    title?: string;
+    action?: string;
+    adaptiveForm?: string;
+    lang?: string;
+};
+export type TranslationJson = TranslationBaseJson & TranslationFieldJson & TranslationConstraintsJson;
+export declare const translationProps: string[];
+export declare const constraintProps: string[];
+export {};

package/lib/esm/types/Json.js

@@ -0,0 +1,29 @@
+/*************************************************************************
+* 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 translationProps = ['description', 'placeholder', 'enum', 'enumNames', 'label.value', 'constraintMessages.accept',
+    'constraintMessages.enum', 'constraintMessages.exclusiveMinimum', 'constraintMessages.exclusiveMaximum', 'constraintMessages.format', 'constraintMessages.maxFileSize', 'constraintMessages.maxLength',
+    'constraintMessages.maximum', 'constraintMessages.maxItems', 'constraintMessages.minLength', 'constraintMessages.minimum', 'constraintMessages.minItems', 'constraintMessages.pattern', 'constraintMessages.required',
+    'constraintMessages.step', 'constraintMessages.type', 'constraintMessages.validationExpression'];
+const constraintProps = ['accept', 'enum', 'exclusiveMinimum', 'exclusiveMaximum',
+    'format', 'maxFileSize', 'maxLength', 'maximum', 'maxItems',
+    'minLength', 'minimum', 'minItems', 'pattern', 'required', 'step', 'validationExpression', 'enumNames'];
+
+export { constraintProps, translationProps };